Template:List

From RimWorld Wiki
Jump to: navigation, search


This template lists the contents of the category given as its first argument, e.g. to list all pages in the category Category: Fabric, use:

   {{List|Fabric}}

Result Order and Number

Optionally, you can limit the number of pages listed, sort the list and order it. For example, to list the two most expensive fabrics, breaking ties by ease to work with them, you could use (NB: Whitespace and captitalization matter):

   {{List|Fabric|limit=2|sort=Market Value Base,Work To Make Factor|order=desc,asc}}

This gives:

High-tech nano-fibers woven into sheets. It is somewhat heavy, but is incredibly difficult to break. The secrets of its production are known only to the most advanced glitterworld cultures.

Top-of-the-shelf, incredibly tough and expensive fabric produced only in high-tech Glitterworlds. The only way to acquire it is via trading, or through random drops. If you can somehow afford to outfit your colonists with clothing made of this material, then give yourself a pat on the back.

Market Value 16 Silver
Mass 0.038kg
Stack Limit 75
Hit Points 0 HP/1
Flammability 100%  ?? HP/s
Deterioration 100% 1 HP/d
Material Volume 1:1
Time to Make ×1.8
Hit Points
Flammability
Material for Apparel
Armor Insulation
Blunt ×1.6 +0.03 Cold ×1.1
Sharp ×4 +0.03 Heat ×1.1
Heat ×2 +0.03
Electric ×0 +0

Fabric spun from microfibers extracted from silk-producing Devilstrand mushrooms. Very tough, but insulates no better than cloth.

Devilstrand is a valuable fabric obtained by planting devilstrand mushrooms in a growing zone, trading, or through random drops. The devilstrand mushroom was genetically engineered to produce a high quality silk net. Its name comes from the greed it inspires in people. It is an extremely strong fabric, generally better and more valuable overall than cloth and leather.

Market Value 12 Silver
Mass 0.32kg
Stack Limit 75
Hit Points 100 HP/1
Flammability 100%  ?? HP/s
Deterioration 300% 3 HP/d
Material Volume 1:1
Time to Make ×1.3
Hit Points
Flammability
Material for Apparel
Armor Insulation
Blunt ×1.3 +0.05 Cold ×1
Sharp ×1.8 +0.05 Heat ×1
Heat ×1 +0
Electric ×3 +0.05
... further results


Customizing Result Appearance

The list template calls the template Template:Ask/Item for every page. You can override this with its item parameter. It passes the following parameters to the item template:

Parameter Description
{{{?Name}}} Name of the page
{{{?Image}}} Name of the icon for the page
{{{?Description}}} Description of the page (from XML)
{{{?Note}}} Description of the page (user-set, usually the first paragraph of the page content)
{{{?Tags}}} Name of the template that can produce the tags for the page
{{{userparam}}} Value passed to param= in the list template

How does the template work?

The template uses the Semantic MediaWiki (SMW) extension to get its data. In particular, it uses the {{#ask: ... }} parser function. You can get the full details about how it works in its official documentation, but here are the basics:

Let's return to above example:

   {{List|Fabric|limit=2|sort=Market Value Base,Work To Make Factor|order=desc,asc}}

When MediaWiki expands that template, it becomes:

   {{#ask: [[Category: Fabric]]
    | ?# = Name
    | ?Image
    | ?Description
    | ?Note
    | ?Tags
    | format     = template
    | named args = yes
    | link       = none
    | template   = Ask/Item
    | limit      = 2
    | sort       = Market Value Base,Work To Make Factor
    | order      = desc,asc
    }}

The first line tells SMW to look for all pages in the Category: Fabric category. The new five lines start with ? and tell it which data to select from those pages (more about that below). The "?# = Name" means "take the page title and refer to it as ?Name". After that, the template tells SMW to called the Template:Ask/Item template for every result (format = template and template = Ask/Item), to pass along the data as named arguments, and to use only page names instead of links (e.g. "Devilstrand" instead of "[[Devilstrand]]").

Thus, the above template call becomes:

   {{Ask/Item|?Name=Hyperweave|?Image=File:Hyperweave.png|?Description=High-tech nano-fibers...|?Note=Top-of-the-shelf, incredibly tough...|?Tags=Template:Textile/Tags}}
   {{Ask/Item|?Name=Devilstrand|?Image=File:Devilstrand.png|?Description=Fabric spun...|?Note=Devilstrand is obtained...|?Tags=Template:Textile/Tags}}

These are then substituted normally again.

(NB: Template:Textile/Tags does not exist yet, so the ?Tags parameter above is empty at the moment. This will change soon.)

Where does the data come from?

SMW know about, say, the description of Devilstrand, because on the Devilstrand page there is a Template:Define template, which executes the following:

  {{#set: Description = {{{description|}}} }}

The {{#set: ... }} parser function is the opposite of {{#ask: ... }}, it tells SMW that the page in question has one or more properties or relations. For the full description, see again the official documentation.

You can browse the data available about a page by using the "Browse Properties" link under "Tools" in the menu on the left side of the screen. You can browse all page/value pairs for a property by visiting its page in the Property: namespace, e.g. Property:Market_Value_Base.