Difference between revisions of "Template:VendorTableRow/Documentation"
Jump to navigation
Jump to search
Studenterhue (talk | contribs) (Experiment with moving documentation to a separate page, somewhat in imitation of Wikipedia) |
Studenterhue (talk | contribs) m (Studenterhue moved page User:Studenterhue/Template:VendorTableListing/Documentation to Template:VendorTableRow/Documentation without leaving a redirect: Feel ready to move this out of userspace now. Slight name change from VendorTableListing to VendorTableRow, which better reflects the fact that it's used to make tables) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
==Usage== | ==Usage== | ||
<pre> | <pre> | ||
{{ | {{VendorTableRow | ||
|Image= (Format is Filename.extension, e.g. DiscountDanBurritosV2.gif, CigarettePacketV2.png) | |Image= (Format is Filename.extension, e.g. DiscountDanBurritosV2.gif, CigarettePacketV2.png) | ||
|Quantity= | |Quantity= | ||
|Item Name= | |Item Name= | ||
|Note= (Optional, can omit) | |Note= (Optional, can omit) | ||
| Line 15: | Line 14: | ||
}} | }} | ||
</pre> | </pre> | ||
==Parameters== | ==Parameters== | ||
*'''Image''' - An image of the item being sold in the vending machine, naturally. You don't have to add File:/Image:, but you do need to give the extension, e.g. .png, .gif, etc. This only accepts one image, so if the item has a random appearance or whatever, you should probably use a .gif or some such. | *'''Image''' - An image of the item being sold in the vending machine, naturally. You don't have to add File:/Image:, and the template automatically center-aligns images, but you do need to give the extension, e.g. .png, .gif, etc. This only accepts one image, so if the item has a random appearance or whatever, you should probably use a .gif or some such. | ||
*'''Quantity''' - How many appear in the vending machine by default? This accepts ranges. | *'''Quantity''' - How many appear in the vending machine by default? This accepts ranges. | ||
*'''Item | *'''Item Name''' - What's the item's name, duh. Try to use the capitalization and name shown on the UI. While not required, it is highly-recommended that you include a link to info about the item. Links work like any other page, so if you want to, say, link to info on scalpels, you'd do <code><nowiki>[[Medical Objects#Scalpel]]</nowiki></code>. | ||
** | **Redirects also work, as does linking to something within the page, e.g. using <code>#Scalpel</code> instead of <code>Medical Objects#Scalpel</code> if you're working on the [[Medical Objects]] page. | ||
*'''Note''' - If there's something unusual about the item listing, like if it only has a certain chance to appear in the vendor or if the machine randomizes the item's contents, mention it here. If there isn't anything worth noting, you can omit this parameter. This goes in parentheses after the name of the item, so the note doesn't mess with sorting. | *'''Note''' - If there's something unusual about the item listing, like if it only has a certain chance to appear in the vendor or if the machine randomizes the item's contents, mention it here. If there isn't anything worth noting, you can omit this parameter. This goes in parentheses after the name of the item, so the note doesn't mess with sorting. | ||
*'''Price''' - What's its price? This auto-magically adds formatting, including right-align. If the vending machine doesn't show prices for items (e.g. the [[Guide to Hydroponics#GardenGear|GardenGear]]), you can just leave this out. | *'''Price''' - What's its price? This auto-magically adds formatting, including right-align. If the vending machine doesn't show prices for items (e.g. the [[Guide to Hydroponics#GardenGear|GardenGear]]), you can just leave this out. | ||
*'''Is Hidden?''' - Do you need to [[Hacking#Vending Machines and Fabricators|hack]] the vendor to see this item? If so, put <code>Yes</code>; if not, put <code>No</code>. (This parameter is case-sensitive, so <code>yes</code> and <code>no</code> will ''not'' work.) This automatically pipes it into the [[:Template:Yes|Yes]] and [[:Template:No|No templates]], so you don't have to add color formatting or the curly braces ( {{ }} ). | *'''Is Hidden?''' - Do you need to [[Hacking#Vending Machines and Fabricators|hack]] the vendor to see this item? If so, put <code>Yes</code>; if not, put <code>No</code>. (This parameter is case-sensitive, so <code>yes</code> and <code>no</code> will ''not'' work.) This automatically pipes it into the [[:Template:Yes|Yes]] and [[:Template:No|No templates]], so you don't have to add color formatting or the curly braces ( {{ }} ). | ||
Latest revision as of 06:16, 22 July 2023
This template is used to document the contents of vending machines. It shows what an item listed in a vendor looks like, what its name is (with a link to more information about it), how many you can get from the machine, how much it costs (if applicable), and whether the item is hidden/needs to be hacked in.
This is meant to be used alongside Template:VendorTableHeader. Template:VendorTableHeader handles the header for the table, while this template handles the various rows.
Usage
{{VendorTableRow
|Image= (Format is Filename.extension, e.g. DiscountDanBurritosV2.gif, CigarettePacketV2.png)
|Quantity=
|Item Name=
|Note= (Optional, can omit)
|Price= (If price is not shown, can omit)
|Is Hidden?= (Put Yes or No)
}}
Parameters
- Image - An image of the item being sold in the vending machine, naturally. You don't have to add File:/Image:, and the template automatically center-aligns images, but you do need to give the extension, e.g. .png, .gif, etc. This only accepts one image, so if the item has a random appearance or whatever, you should probably use a .gif or some such.
- Quantity - How many appear in the vending machine by default? This accepts ranges.
- Item Name - What's the item's name, duh. Try to use the capitalization and name shown on the UI. While not required, it is highly-recommended that you include a link to info about the item. Links work like any other page, so if you want to, say, link to info on scalpels, you'd do
[[Medical Objects#Scalpel]].- Redirects also work, as does linking to something within the page, e.g. using
#Scalpelinstead ofMedical Objects#Scalpelif you're working on the Medical Objects page.
- Redirects also work, as does linking to something within the page, e.g. using
- Note - If there's something unusual about the item listing, like if it only has a certain chance to appear in the vendor or if the machine randomizes the item's contents, mention it here. If there isn't anything worth noting, you can omit this parameter. This goes in parentheses after the name of the item, so the note doesn't mess with sorting.
- Price - What's its price? This auto-magically adds formatting, including right-align. If the vending machine doesn't show prices for items (e.g. the GardenGear), you can just leave this out.
- Is Hidden? - Do you need to hack the vendor to see this item? If so, put
Yes; if not, putNo. (This parameter is case-sensitive, soyesandnowill not work.) This automatically pipes it into the Yes and No templates, so you don't have to add color formatting or the curly braces ( {{ }} ).