Template:Perks/doc - Revision history

76561198157077871: /* Selection, Filtering, and Exclusion */

2025-02-28T00:30:36Z

Selection, Filtering, and Exclusion

← Older revision		Revision as of 00:30, 28 February 2025
Line 37:		Line 37:
	* <code>Relic</code> (from Glade Events)		* <code>Relic</code> (from Glade Events)
	* <code>Trader</code>		* <code>Trader</code>
			* <code>Decoration</code>
			* <code>Port</code> (from Strider Port expeditions)
			* <code>Racial</code> (from Hearthkeeper bonuses)
			* <code>Institution</code> (from Service Buildings)
			* <code>Biome</code>
	\|-		\|-
	\| exclude \|\| A list of IDs, separated by commas, that will be excluded from the display. Will not throw an error if an ID is invalid.		\| exclude \|\| A list of IDs, separated by commas, that will be excluded from the display. Will not throw an error if an ID is invalid.

76561198002628672: /* Selection, Filtering, and Exclusion */

2025-02-19T22:23:19Z

Selection, Filtering, and Exclusion

← Older revision		Revision as of 22:23, 19 February 2025
Line 11:		Line 11:
	You may combine the first three parameters to return more Perks. The result will be the union of your selections, without duplicates. Then use <code>exclude</code> to remove any Perks that are unrelated to your purposes with their IDs or filter by rarity or source.		You may combine the first three parameters to return more Perks. The result will be the union of your selections, without duplicates. Then use <code>exclude</code> to remove any Perks that are unrelated to your purposes with their IDs or filter by rarity or source.

	Remember that IDs are not visible ~~int he~~ game, so you may need to look them up first.		Remember that IDs are not visible in the game, so you may need to look them up first.

	{\|class="wikitable"		{\|class="wikitable"

76561197969631737: /* Inline examples = */ fixing typo in heading

2024-10-10T03:42:54Z

Inline examples =: fixing typo in heading

← Older revision		Revision as of 03:42, 10 October 2024
Line 333:		Line 333:
	{{Perks\|id=Accidental Barrels\|name=barrel\|display=list\|show_id=show}}		{{Perks\|id=Accidental Barrels\|name=barrel\|display=list\|show_id=show}}

	== Inline examples ===		== Inline examples ==

	<pre>{{Perks\|id=Accidental Barrels\|display=inline}}</pre>		<pre>{{Perks\|id=Accidental Barrels\|display=inline}}</pre>

76561197969631737: added category

2024-10-02T04:03:43Z

added category

← Older revision		Revision as of 04:03, 2 October 2024
Line 365:		Line 365:
	\| [[Template:PerksCornerstonesList/item]] \|\| List version row template (there is no list header template)		\| [[Template:PerksCornerstonesList/item]] \|\| List version row template (there is no list header template)
	\|}		\|}

			[[Category:Lua-based templates]]

76561197969631737: /* View templates */ Updating documentation to reflect the change in the view implementation

2024-06-24T01:34:42Z

View templates: Updating documentation to reflect the change in the view implementation

← Older revision		Revision as of 01:34, 24 June 2024
Line 343:		Line 343:
	You can also show the ID of the Perk alongside the link, like {{Perks\|id=Accidental Barrels\|display=inline\|show_id=show}}, if your readers need to see it too.		You can also show the ID of the Perk alongside the link, like {{Perks\|id=Accidental Barrels\|display=inline\|show_id=show}}, if your readers need to see it too.

	== View ~~templates~~ ==		== View ==

	The functionality of the '''Perks''' template is accomplished through the [[Wiki data model]]. This '''Template:Perks''' calls the controller module, which in turn interfaces with the data model module. The view is ~~handled entirely~~ by ~~these additional templates~~:		The functionality of the '''Perks''' template is accomplished through the [[Wiki data model]]. This '''Template:Perks''' calls the controller module, which in turn interfaces with the data model module. It also interfaces with the view module for the table or calls a template to display the list version.

			Only the last, List/item, is called from the controller. All others are still here in the off chance they may be useful to an author for manually creating tables of perks. However, it is strongly recommended to learn how to use [[Template:Perks]] instead. The table version of the view is accomplished with [[Module:PerksView]], which cannot be invoked directly, but is invoked by [[Module:PerksController]].

	{\|class=wikitable		{\|class=wikitable

76561197969631737: /* Selecting Perks by their IDs */ Adding exclude example

2024-05-10T20:14:10Z

Selecting Perks by their IDs: Adding exclude example

@@ Line 120: / Line 120: @@
 Yields:
 {{Perks|id=Amber for Trader Visit, Trader Interval +25, Trading Packs}}
 === Searching names and descriptions ===

76561197969631737: /* Selecting Perks by their IDs */ showing incorrect case still works.

2024-05-10T19:02:32Z

Selecting Perks by their IDs: showing incorrect case still works.

← Older revision		Revision as of 19:02, 10 May 2024
Line 95:		Line 95:

	=== Selecting Perks by their IDs ===		=== Selecting Perks by their IDs ===

			IDs to select are normalized, so you do not need to worry about case. Spelling, spacing, and punctuation must all be correct, however.

			<pre>{{Perks
			\|id=accidental barrels
			}}</pre>

			Is the same as the following:

	<pre>{{Perks		<pre>{{Perks
Line 101:		Line 109:

	Yields:		Yields:
	{{Perks\|id=~~Accidental Barrels~~}}		{{Perks\|id=accidental barrels}}

76561197969631737: Added doc for new search parameter shortcut for name= and description=

2024-05-09T01:44:17Z

Added doc for new search parameter shortcut for name= and description=

← Older revision		Revision as of 01:44, 9 May 2024
Line 21:		Line 21:
	\|-		\|-
	\| description \|\| A list of terms to search for in descriptions. Adds all Perks with any part of their descriptions matching that string to the table.		\| description \|\| A list of terms to search for in descriptions. Adds all Perks with any part of their descriptions matching that string to the table.
			\|-
			\| search \|\| A shortcut parameter for the previous two. <code>search=criteria</code> is the same as <code>name=criteria\|description=criteria</code>. Using this parameter does not prevent you from or override searching by name or description too, but it kind of defeats the purpose.
	\|-		\|-
	\| rarity \|\| Filters any Perks found by the first search parameters by the specified rarity. Does not throw an error if you misspell the term; here are the correct options:		\| rarity \|\| Filters any Perks found by the first search parameters by the specified rarity. Does not throw an error if you misspell the term; here are the correct options:
Line 113:		Line 115:
	=== Searching names and descriptions ===		=== Searching names and descriptions ===

	The following example shows searching the same term in both name and description, but you could search different things in each field or use only one and not the other.		The following example shows searching the same term in both name and description, but you could search different things in each field or use only one and not the other. As a shorthand, when you want to search for the same thing in both name and description, you can use the '''search''' parameter instead.

	<pre>{{Perks		<pre>{{Perks
	\|name=blightrot cyst		\|name=blightrot cyst
	\|description=blightrot cyst		\|description=blightrot cyst
			}}</pre>

			Note this is the same as this:
			<pre>{{Perks
			\|search=blightrot cyst
	}}</pre>		}}</pre>

76561197969631737: /* Searching names and descriptions */ Added list example

2024-05-08T21:34:07Z

Searching names and descriptions: Added list example

← Older revision		Revision as of 21:34, 8 May 2024
Line 123:		Line 123:
	{{Perks\|name=blightrot cyst\|description=blightrot cyst}}		{{Perks\|name=blightrot cyst\|description=blightrot cyst}}


			Similar to selecting IDs, You can also search for multiple terms in names and descriptions by separating additional terms with commas. This allows you to combine Perks into one table that otherwise seem unrelated, and may be easier than selecting all of their IDs.

			The results are combined so the number of results increases, like with an '''or''' boolean operation, and this cannot be changed.

			<pre>{{Perks
			\|name=mist,ashes
			}}</pre>

			Yields:
			{{Perks\|name=mist,ashes}}

	=== Filtering by rarity or source ===		=== Filtering by rarity or source ===

76561197969631737: /* Selection, Filtering, and Exclusion */ now describes list of names and descriptions

2024-05-08T21:24:37Z

Selection, Filtering, and Exclusion: now describes list of names and descriptions

← Older revision		Revision as of 21:24, 8 May 2024
Line 18:		Line 18:
	\| id \|\| A list of IDs of Perks, Cornerstones, and effects, separated by commas. Since IDs are unique, each matched ID adds exactly one Perk to the table. Will not throw an error if an ID is invalid.		\| id \|\| A list of IDs of Perks, Cornerstones, and effects, separated by commas. Since IDs are unique, each matched ID adds exactly one Perk to the table. Will not throw an error if an ID is invalid.
	\|-		\|-
	\| name \|\| ~~Searches~~ names ~~for this string, and adds~~ Perks with any part of their names matching ~~that string~~ to the table.		\| name \|\| A list of terms to search for in names. Adds all Perks with any part of their names matching those terms to the table.
	\|-		\|-
	\| description \|\| ~~Searches~~ descriptions ~~for this string, and adds~~ Perks with any part of their descriptions matching that string to the table.		\| description \|\| A list of terms to search for in descriptions. Adds all Perks with any part of their descriptions matching that string to the table.
	\|-		\|-
	\| rarity \|\| Filters any Perks found by the first search parameters by the specified rarity. Does not throw an error if you misspell the term; here are the correct options:		\| rarity \|\| Filters any Perks found by the first search parameters by the specified rarity. Does not throw an error if you misspell the term; here are the correct options: