Template:StoreTableHead/Sandbox/doc: Difference between revisions

From RuneRealm Wiki
Jump to navigation Jump to search
Content added Content deleted
(Created page with "{{Documentation}} The '''StoreTableHead''' template is to be used in conjunction with {{t|StoreLine}} provide a listing of items that are found in a shop. It also helps to provide a uniform look of how the shop information is presented for all articles about shop on the wiki. ==Usage== <pre>{{StoreTableHead|SellMultiplier=1300|BuyMultiplier=400|Delta=30}} {{StoreLine|Name=Pot|Stock=5}} {{StoreLine|Name=Jug|Stock=2}} {{StoreLine|Name=Empty jug pack|Stock=5|gemw=No}} {{S...")
 
No edit summary
Tag: Reverted
Line 1: Line 1:
{{Documentation}}
{{Documentation}}
{{invokes|StoreTableHead}}


The '''StoreTableHead''' template is to be used in conjunction with {{t|StoreLine}} provide a listing of items that are found in a shop. It also helps to provide a uniform look of how the shop information is presented for all articles about shop on the wiki.
The '''StoreTableHead''' template is to be used in conjunction with {{t|StoreLine}} provide a listing of items that are found in a shop. It also helps to provide a uniform look of how the shop information is presented for all articles about shop on the wiki.


==Usage==
==Usage==
<pre>{{StoreTableHead|SellMultiplier=1300|BuyMultiplier=400|Delta=30}}
<pre>{{StoreTableHead|sellmultiplier=1300|buymultiplier=400|delta=30}}
{{StoreLine|Name=Pot|Stock=5}}
{{StoreLine|name=Pot|stock=5|restock=9962000}}
{{StoreLine|Name=Jug|Stock=2}}
{{StoreLine|name=Jug|stock=2|restock=}}
{{StoreLine|Name=Empty jug pack|Stock=5|gemw=No}}
{{StoreLine|name=Empty jug pack|stock=5|gemw=No|restock=10}}
{{StoreLine|Name=Shears|Stock=2}}
{{StoreLine|name=Shears|stock=2|restock=10}}
{{StoreLine|Name=Bucket|Stock=3}}
{{StoreLine|name=Bucket|stock=3|restock=10}}
{{StoreLine|Name=Empty bucket pack|Stock=15|gemw=no}}
{{StoreLine|name=Empty bucket pack|stock=15|gemw=no|restock=10}}
{{StoreLine|Name=Bowl|Stock=2}}
{{StoreLine|name=Bowl|stock=2|restock=10}}
{{StoreLine|Name=Pot|DisplayName=Another pot|Stock=5}}
{{StoreLine|name=Pot|displayname=Another pot|stock=5|restock=10}}
{{StoreLine|Name=Empty jug pack|Stock=5|gemw=No}}
{{StoreLine|name=Empty jug pack|stock=5|gemw=No|restock=10}}
{{StoreLine|Name=Fletching cape|Stock=5|smwname=Fletching cape#Untrimmed|gemw=no|Sell=99000|Buy=N/A}}
{{StoreLine|name=Fletching cape|stock=5|smwname=Fletching cape#Untrimmed|gemw=no|sell=99000|buy=N/A|restock=N/A}}
{{StoreLine|name=Elven top (yellow)|stock=100|image=Elven top (white).png|restock=1}}
{{StoreTableBottom}}</pre>
{{StoreTableBottom}}</pre>


Line 20: Line 22:


{{StoreTableHead|sellmultiplier=1300|buymultiplier=400|delta=30}}
{{StoreTableHead|sellmultiplier=1300|buymultiplier=400|delta=30}}
{{StoreLine|name=Pot|stock=5}}
{{StoreLine|name=Pot|stock=5|restock=9962000}}
{{StoreLine|name=Jug|stock=2}}
{{StoreLine|name=Jug|stock=2|restock=}}
{{StoreLine|name=Empty jug pack|stock=5|gemw=No}}
{{StoreLine|name=Empty jug pack|stock=5|gemw=No|restock=10}}
{{StoreLine|name=Shears|stock=2}}
{{StoreLine|name=Shears|stock=2|restock=10}}
{{StoreLine|name=Bucket|stock=3}}
{{StoreLine|name=Bucket|stock=3|restock=10}}
{{StoreLine|name=Empty bucket pack|stock=15|gemw=no}}
{{StoreLine|name=Empty bucket pack|stock=15|gemw=no|restock=10}}
{{StoreLine|name=Bowl|stock=2}}
{{StoreLine|name=Bowl|stock=2|restock=10}}
{{StoreLine|name=Pot|displayname=Another pot|stock=5}}
{{StoreLine|name=Pot|displayname=Another pot|stock=5|restock=10}}
{{StoreLine|name=Empty jug pack|stock=5|gemw=No}}
{{StoreLine|name=Empty jug pack|stock=5|gemw=No|restock=10}}
{{StoreLine|name=Fletching cape|stock=5|smwname=Fletching cape#Untrimmed|gemw=no|sell=99000|buy=N/A}}
{{StoreLine|name=Fletching cape|stock=5|smwname=Fletching cape#Untrimmed|gemw=no|sell=99000|buy=N/A|restock=N/A}}
{{StoreLine|name=Elven top (yellow)|stock=100|image=Elven top (white).png|restock=1}}
{{StoreTableBottom}}
{{StoreTableBottom}}


==Parameters==
==Parameters==
*'''SellMultiplier:''' the store's sell markup
*'''sellmultiplier:''' the store's sell markup
*'''BuyMultiplier:''' the store's buy margin
*'''buymultiplier:''' the store's buy margin
*'''Delta:''' the store's price change for over/understocking
*'''delta:''' the store's price change for over/understocking


===Optional===
===Optional===
*'''NameNotes:''' additional text information for autogenerated store lists (e.g. Karamja gloves or Pisc favour)
*'''namenotes:''' additional text information for autogenerated store lists (e.g. Karamja gloves or Pisc favour)
*'''Currency:''' defaults to "Coins"
*'''currency:''' defaults to "Coins"
*'''smw:''' set to "no" to prevent indexing of this table into {{t|Store locations list}}.
*'''smw:''' set to "No" to prevent indexing of this table into {{t|Store locations list}}. Use this to prevent duplicates (e.g. the store is shown on the store page AND the npc page)
*'''hideGE''' set to "yes" to hide the GE column (if none of the items are tradeable on GE) - you still need to set gemw=yes for the StoreLine template
*'''hideimage''' set to "yes" to hide the image column, for example for stores that sell things that don't necessarily have a fitting icon (e.g. abstract unlocks or abilities)
*'''hideBuy''' set to "yes" to hide the Buy price column (if none of the items are tradeable on GE) - you still need to set Buy=N/A for the StoreLine template
*'''hidege''' set to "yes" to hide the GE column (if none of the items are tradeable on GE) - you still need to set gemw=yes for the StoreLine template
*'''hidebuy''' set to "yes" to hide the Buy price column (if none of the items are tradeable on GE) - you still need to set Buy=N/A for the StoreLine template
*'''hidestock''' set to "yes" to hide the Stock column (useful for minigame and dialogue shops where everything has infinite stock)
*'''hiderestock''' set to "yes" to hide the restock time column
*'''hidecaption''' set to "yes" to hide the table caption
*'''column1:''' Add an additional column with this as contents
*'''column1:''' Add an additional column with this as contents
*'''column2:''' Add an additional column with this as contents
*'''column2:''' Add an additional column with this as contents
Line 51: Line 58:
*[[Template:GEHeader]]
*[[Template:GEHeader]]


<includeonly>[[Category:Table templates]]</includeonly>
<includeonly>[[Category:Table templates]][[Category:Store table templates]]</includeonly>

Revision as of 00:48, 17 October 2024

This is a documentation subpage for Template:StoreTableHead/Sandbox.
It contains usage information, categories, and other content that is not part of the original template page.
Template:StoreTableHead/Sandbox invokes function main in Module:StoreTableHead using Lua.
Template:StoreTableHead/Sandbox invokes Module:StoreTableHead using Lua.

The StoreTableHead template is to be used in conjunction with {{StoreLine}} provide a listing of items that are found in a shop. It also helps to provide a uniform look of how the shop information is presented for all articles about shop on the wiki.

Usage

{{StoreTableHead|sellmultiplier=1300|buymultiplier=400|delta=30}}
{{StoreLine|name=Pot|stock=5|restock=9962000}}
{{StoreLine|name=Jug|stock=2|restock=}}
{{StoreLine|name=Empty jug pack|stock=5|gemw=No|restock=10}}
{{StoreLine|name=Shears|stock=2|restock=10}}
{{StoreLine|name=Bucket|stock=3|restock=10}}
{{StoreLine|name=Empty bucket pack|stock=15|gemw=no|restock=10}}
{{StoreLine|name=Bowl|stock=2|restock=10}}
{{StoreLine|name=Pot|displayname=Another pot|stock=5|restock=10}}
{{StoreLine|name=Empty jug pack|stock=5|gemw=No|restock=10}}
{{StoreLine|name=Fletching cape|stock=5|smwname=Fletching cape#Untrimmed|gemw=no|sell=99000|buy=N/A|restock=N/A}}
{{StoreLine|name=Elven top (yellow)|stock=100|image=Elven top (white).png|restock=1}}
{{StoreTableBottom}}

gives

Sells at: 130.0% • Buys at: 40.0% • Change per: 3.0%
ItemNumber
in stock
Restock
time
Price
sold at
Price
bought at
GE
price
Pot569d 4h 20m (9,962,000t) 1 0 5
Jug2unknown 1 0 3
Empty jug pack56s (10t)Not sold
Shears26s (10t) 1 0 27
Bucket36s (10t) 2 0 59
Empty bucket pack156s (10t)Not sold
Bowl26s (10t) 5 1 16
Another pot56s (10t) 1 0 5
Empty jug pack56s (10t)Not sold
Fletching cape5N/A 99,000N/ANot sold
Elven top (yellow)1000.6s (1t) 6,500 2,000Not sold

Parameters

  • sellmultiplier: the store's sell markup
  • buymultiplier: the store's buy margin
  • delta: the store's price change for over/understocking

Optional

  • namenotes: additional text information for autogenerated store lists (e.g. Karamja gloves or Pisc favour)
  • currency: defaults to "Coins"
  • smw: set to "No" to prevent indexing of this table into {{Store locations list}}. Use this to prevent duplicates (e.g. the store is shown on the store page AND the npc page)
  • hideimage set to "yes" to hide the image column, for example for stores that sell things that don't necessarily have a fitting icon (e.g. abstract unlocks or abilities)
  • hidege set to "yes" to hide the GE column (if none of the items are tradeable on GE) - you still need to set gemw=yes for the StoreLine template
  • hidebuy set to "yes" to hide the Buy price column (if none of the items are tradeable on GE) - you still need to set Buy=N/A for the StoreLine template
  • hidestock set to "yes" to hide the Stock column (useful for minigame and dialogue shops where everything has infinite stock)
  • hiderestock set to "yes" to hide the restock time column
  • hidecaption set to "yes" to hide the table caption
  • column1: Add an additional column with this as contents
  • column2: Add an additional column with this as contents
  • columnX: ... Add an additional column with this as contents

See also