Module:ManualDescriptions

Manual Description Module

This module exists to allow bulk edits to item descriptions, without the need to edit each page individually. Editing the line item that corresponds to the item description you want to modify will result in that wiki page being modified.

You will notice the default item description will say No description available for ITEMNAME. Please edit Module:ManualDescriptions to add one.. This text is automatically modified when this Module is modified.

How to edit the Module

You are currently reading the /doc page of this module. It automatically inserts to the top of the module for easy reading. To edit the module, click Edit source and follow the instructions below.

Creating a new description

To create a new item description, create a new line in the module BEFORE the } at the end of the description list. This brace indicates the end of the description section of this module. Anything written outside of the { } will not be read appropriately.

• Each new description entry must start on a new line AND start with the name of the item page, written exactly as the item page on the wiki.
  • To add a description for the Pearl harpoon page, you would write ["Pearl harpoon"] - This is case sensitive and MUST be enclosed within quotations and a singular bracket.
• Next, type a = after the bracketed item name to indicate the start of the description text.
  • At this point, the line should look like this: ["Pearl harpoon"] =
• Finally, write out your description, making sure it is wrapped in quotation marks, and add a coma to the end of the line after the quotation marks, indicating the line item is complete.
  • The finalized result should look like this: ["Pearl harpoon"] = "The description goes here.",

You can repeat this process for any item descriptions you want to create, even if the item page does not yet exist.

Editing an existing description

• If you are editing an existing description, find the item name located in the singular brackets at the beginning of the line.
  • If you wanted to edit the Dragonite ore description, look for the line item ["Dragonite ore"].
  • From here, you can change any of the text located between the quotation marks.
    • ["Dragonite ore"] = "Edit any of the text within these quotes",
  • Note: You can use any formatting within these quotations. This includes linking to pages utilizing the brackets, adding line breaks using <br>, or any other formatting you wish.

---

-- Module:ManualDescriptions
local p = {}

-- Editable data table - contributors modify this directly
local descriptions = {
    ["Dragonite ore"] = "'''Dragonite ore''' is a rare ore used to create [[Dragonite bar]]s.",
	["Luminite ore"] = "'''Luminite ore''' can be crushed using a hammer, chisel, or pestle and mortar, to be turned into [[Luminite flux]], a stackable smelting catalyst used to make high tier bars for [[Smithing]].<br>'''Luminite ore''' can also be crushed into flux by using it on Nurmof at [[Home]], costing [[Skilling token]]s and rewarding no experience. <br><br>In addition to the below drop sources, '''Luminite ore''' can also be mined in donator mining zones at Home, in the mining guild, and south of the Barrows.",
	["Skilling token"] ="[[Skilling token|Skilling tokens]] are a currency dropped by performing skilling actions in August. Skilling tokens can be spent at the [[Skilling Token Store]] for various upgrades and rewards. <br><br>Skilling tokens are tradeable.",
	["$1 Bond"] ="[[Bonds]] are a tradeable item which can be redeemed for [[Donating#Donator_Rank|Donator Rank]] and [[Donating#Donator_Credits|Donator Credits]] equal to the value of the bond.",
	["$5 Bond"] ="[[Bonds]] are a tradeable item which can be redeemed for [[Donating#Donator_Rank|Donator Rank]] and [[Donating#Donator_Credits|Donator Credits]] equal to the value of the bond.",
	["$10 Bond"] ="[[Bonds]] are a tradeable item which can be redeemed for [[Donating#Donator_Rank|Donator Rank]] and [[Donating#Donator_Credits|Donator Credits]] equal to the value of the bond.",
	["$25 Bond"] ="[[Bonds]] are a tradeable item which can be redeemed for [[Donating#Donator_Rank|Donator Rank]] and [[Donating#Donator_Credits|Donator Credits]] equal to the value of the bond.",
	["$50 Bond"] ="[[Bonds]] are a tradeable item which can be redeemed for [[Donating#Donator_Rank|Donator Rank]] and [[Donating#Donator_Credits|Donator Credits]] equal to the value of the bond.",
	["Dragonstone weapon seed"] = "The [[Dragonstone weapon seed]] is used in the creation of [[Gem beast#Weapons_5|Dragonstone weapons]]. Players can create the weapon seed with [[Dragonstone shards]], or receive it as a rare drop from [[Dragonstone Drake]]s.", 
	["Dragonstone armour seed"] = "The [[Dragonstone armour seed]] is used in the creation of [[Gem beast#Armour_5|Dragonstone armour]]. Players can create the armour seed with [[Dragonstone shards]], or receive it as a rare drop from [[Dragonstone Drake]]s.",
["Dragonstone frame"] = "The [[Dragonstone frame]] is used in the creation of all [[Gem beast#Weapons_5|Dragonstone weapons]]. Players can create the frame with [[Dragonstone shards]], or receive it as a rare drop from [[Dragonstone Drake]]s.<br>The [[Dragonstone frame]] can also be used to charge [[Gem beast#Dragonstone|Dragonstone]] weapons.",
["Dragonstone orb"] = "The [[Dragonstone orb]] is used in the creation of the [[Dragonstone staff]]. Players can create the orb with [[Dragonstone shards]], or receive it as a rare drop from [[Dragonstone Drake]]s.<br>The [[Dragonstone orb]] can also be used to charge [[Gem beast#Dragonstone|Dragonstone]] weapons.",
["Dragonstone bowstring"] = "The [[Dragonstone bowstring]] is used in the creation of the [[Dragonstone longbow]] and [[Dragonstone shortbow]]. Players can create the bowstring with [[Dragonstone shards]], or receive it as a rare drop from [[Dragonstone Drake]]s.<br>The [[Dragonstone bowstring]] can also be used to charge [[Gem beast#Dragonstone|Dragonstone]] weapons.",
["Dragonstone spike"] = "The [[Dragonstone spike]] is used in the creation of certain [[Gem beast#Weapons_5|Dragonstone weapons]]. Players can create the spike with [[Dragonstone shards]], or receive it as a rare drop from [[Dragonstone Drake]]s.<br>The [[Dragonstone spike]] can also be used to charge [[Gem beast#Dragonstone|Dragonstone]] weapons.",
["Diamond weapon seed"] = "The [[Diamond weapon seed]] is used in the creation of [[Gem beast#Weapons_4|Diamond weapons]]. Players can create the weapon seed with [[Diamond shards]], or receive it as a rare drop from [[Diamond Beast]]s.", 
["Diamond armour seed"] = "The [[Diamond armour seed]] is used in the creation of [[Gem beast#Armour_4|Diamond armour]]. Players can create the armour seed with [[Diamond shards]], or receive it as a rare drop from [[Diamond Beast]]s.",
["Diamond frame"] = "The [[Diamond frame]] is used in the creation of all [[Gem Beast#Diamond|Diamond]] weapons. Players can create the frame with [[Diamond shards]], or receive it as a rare drop from [[Diamond Beast]]s.<br>The [[Diamond frame]] can also be used to charge [[Gem Beast#Diamond|Diamond]] weapons.",
["Diamond orb"] = "The [[Diamond orb]] is used in the creation of the [[Diamond staff]]. Players can create the weapon seed with [[Diamond shards]], or receive it as a rare drop from [[Diamond Beast]]s.<br>The [[Diamond orb]] can also be used to charge [[Gem Beast#Diamond|Diamond]] weapons.",
["Diamond bowstring"] = "The [[Diamond bowstring]] is used in the creation of the [[Diamond longbow]] and [[Diamond shortbow]]. Players can create the bowstring with [[Diamond shards]], or receive it as a rare drop from [[Diamond Beast]]s.<br>The [[Diamond bowstring]] can also be used to charge [[Gem Beast#Diamond|Diamond]] weapons.",
["Diamond spike"] = "The [[Diamond spike]] is used in the creation of certain [[Gem beast#Weapons_4|Diamond weapons]]. Players can create the spike with [[Diamond shards]], or receive it as a rare drop from [[Diamond Beast]]s.<br>The [[Diamond spike]] can also be used to charge [[Gem Beast#Diamond|Diamond]] weapons.",
["Ruby weapon seed"] = "The [[Ruby weapon seed]] is used in the creation of [[Gem Beast#Weapons_3|Ruby weapons]]. Players can create the weapon seed with [[Ruby shards]], or receive it as a rare drop from [[Ruby Beast]]s.", 
["Ruby armour seed"] = "The [[Ruby armour seed]] is used in the creation of [[Gem Beast#Armour_3|Ruby armour]]. Players can create the armour seed with [[Ruby shards]], or receive it as a rare drop from [[Ruby Beast]]s.",
["Ruby frame"] = "The [[Ruby frame]] is used in the creation of all [[Gem Beast#Weapons_3|Ruby weapons]]. Players can create the frame with [[Ruby shards]], or receive it as a rare drop from [[Ruby Beast]]s.<br>The [[Ruby frame]] can also be used to charge [[Gem Beast#Ruby|Ruby]] weapons.",
["Ruby orb"] = "The [[Ruby orb]] is used in the creation of the [[Ruby staff]]. Players can create the orb with [[Ruby shards]], or receive it as a rare drop from [[Ruby Beast]]s.<br>The [[Ruby orb]] can also be used to charge [[Gem Beast#Ruby|Ruby]] weapons.",
["Ruby bowstring"] = "The [[Ruby bowstring]] is used in the creation of the [[Ruby longbow]] and [[Ruby shortbow]]. Players can create the bowstring with [[Ruby shards]], or receive it as a rare drop from [[Ruby Beast]]s.<br>The [[Ruby bowstring]] can also be used to charge [[Gem Beast#Ruby|Ruby]] weapons.",
["Ruby spike"] = "The [[Ruby spike]] is used in the creation of certain [[Gem Beast#Weapons_3|Ruby weapons]]. Players can create the spike with [[Ruby shards]], or receive it as a rare drop from [[Ruby Beast]]s.<br>The [[Ruby spike]] can also be used to charge [[Gem Beast#Ruby|Ruby]] weapons.",
["Emerald weapon seed"] = "The [[Emerald weapon seed]] is used in the creation of [[Gem Beast#Weapons_2|Emerald weapons]]. Players can create the weapon seed with [[Emerald shards]], or receive it as a rare drop from [[Emerald Beast]]s.", 
["Emerald armour seed"] = "The [[Emerald armour seed]] is used in the creation of [[Gem_beast#Armour_2|Emerald armour]]. Players can create the armour seed with [[Emerald shards]], or receive it as a rare drop from [[Emerald Beast]]s.",
["Emerald frame"] = "The [[Emerald frame]] is used in the creation of all [[[Gem Beast#Armour_2|Emerald weapons]]. Players can create the frame with [[Emerald shards]], or receive it as a rare drop from [[Emerald Beast]]s.<br>The [[Emerald frame]] can also be used to charge [[Gem Beast#Emerald|Emerald]] weapons.",
["Emerald orb"] = "The [[Emerald orb]] is used in the creation of the [[Emerald staff]]. Players can create the orb with [[Emerald shards]], or receive it as a rare drop from [[Emerald Beast]]s.<br>The [[Emerald orb]] can also be used to charge [[Gem Beast#Emerald|Emerald]] weapons.",
["Emerald bowstring"] = "The [[Emerald bowstring]] is used in the creation of the [[Emerald longbow]] and [[Emerald shortbow]]. Players can create the bowstring with [[Emerald shards]], or receive it as a rare drop from [[Emerald Beast]]s.<br>The [[Emerald bowstring]] can also be used to charge [[Gem Beast#Emerald|Emerald]] weapons.",
["Emerald spike"] = "The [[Emerald spike]] is used in the creation of certain [[[Gem Beast#Weapons_2|Emerald weapons]]. Players can create the spike with [[Emerald shards]], or receive it as a rare drop from [[Emerald Beast]]s.<br>The [[Emerald spike]] can also be used to charge [[Gem Beast#Emerald|Emerald]] weapons.",
["Sapphire weapon seed"] = "The [[Sapphire weapon seed]] is used in the creation of [[Gem_beast#Weapons|Sapphire weapons]]. Players can create the weapon seed with [[Sapphire shards]], or receive it as a rare drop from [[Sapphire Beast]]s.", 
["Sapphire armour seed"] = "The [[Sapphire armour seed]] is used in the creation of [[Gem_beast#Armour|Sapphire armour]]. Players can create the armour seed with [[Sapphire shards]], or receive it as a rare drop from [[Sapphire Beast]]s.",
["Sapphire frame"] = "The [[Sapphire frame]] is used in the creation of all [[Gem_beast#Weapons|Sapphire weapons]]. Players can create the frame with [[Sapphire shards]], or receive it as a rare drop from [[Sapphire Beast]]s.<br>The [[Sapphire frame]] can also be used to charge [[Gem Beast#Sapphire|Sapphire]] weapons.",
["Sapphire orb"] = "The [[Sapphire orb]] is used in the creation of the [[Sapphire staff]]. Players can create the orb with [[Sapphire shards]], or receive it as a rare drop from [[Sapphire Beast]]s.<br>The [[Sapphire orb]] can also be used to charge [[Gem Beast#Sapphire|Sapphire]] weapons.",
["Sapphire bowstring"] = "The [[Sapphire bowstring]] is used in the creation of the [[Sapphire longbow]] and [[Sapphire shortbow]]. Players can create the bowstring with [[Sapphire shards]], or receive it as a rare drop from [[Sapphire Beast]]s.<br>The [[Sapphire bowstring]] can also be used to charge [[Gem Beast#Sapphire|Sapphire]] weapons.",
["Sapphire spike"] = "The [[Sapphire spike]] is used in the creation of certain [[Gem_beast#Weapons|Sapphire weapons]]. Players can create the spike with [[Sapphire shards]], or receive it as a rare drop from [[Sapphire Beast]]s.<br>The [[Sapphire spike]] can also be used to charge [[Gem Beast#Sapphire|Sapphire]] weapons.",
	
}

function p.getDescription(frame)
    local itemName = frame.args[1] or ""
    local description = descriptions[itemName]
    
    if description then
        return description
    end
    
    return string.format("''No description available for %s. Please edit [[Module:ManualDescriptions]] to add one.''", itemName)
end

return p