Template:Stormforged Cornerstones/doc - Revision history

76561197969631737: /* View templates */ Added slash-end template

2024-05-05T03:42:39Z

View templates: Added slash-end template

← Older revision		Revision as of 03:42, 5 May 2024
Line 218:		Line 218:
	\|-		\|-
	\| [[Template:StormforgedCornerstonesTable/row]] \|\| Default table row template		\| [[Template:StormforgedCornerstonesTable/row]] \|\| Default table row template
			\|-
			\| [[Template:StormforgedCornerstonesTable/end]] \|\| Table markup closing
	\|-		\|-
	\| [[Template:StormforgedCornerstonesTable/SkipPrices]] \|\| Table header template, but without the prices columns		\| [[Template:StormforgedCornerstonesTable/SkipPrices]] \|\| Table header template, but without the prices columns

76561197969631737: /* List with IDs */ forgot show_id

2024-05-03T02:11:48Z

List with IDs: forgot show_id

← Older revision		Revision as of 02:11, 3 May 2024
Line 195:		Line 195:

	Yields:		Yields:
	{{Stormforged Cornerstones\|name=trade\|description=trade\|display=list}}		{{Stormforged Cornerstones\|name=trade\|description=trade\|display=list\|show_id=show}}

	== Inline Examples ==		== Inline Examples ==

76561197969631737: /* Custom caption */ a couple parameters added accidentally

2024-05-03T02:10:28Z

Custom caption: a couple parameters added accidentally

← Older revision		Revision as of 02:10, 3 May 2024
Line 156:		Line 156:

	Yields:		Yields:
	{{Stormforged Cornerstones\|caption=Every Stormforged Cornerstone in the game~~\|skip_prices=skip\|show_regular=show~~}}		{{Stormforged Cornerstones\|caption=Every Stormforged Cornerstone in the game}}

	== List Examples ==		== List Examples ==

76561197969631737: /* Showing Cornerstone IDs */ swapping parameter

2024-05-03T01:53:24Z

Showing Cornerstone IDs: swapping parameter

← Older revision		Revision as of 01:53, 3 May 2024
Line 127:		Line 127:

	Yields:		Yields:
	{{Stormforged Cornerstones\|id=~~[Altar]~~ Fedora Hat~~, [Altar] Alarm Bells~~\|show_id=show}}		{{Stormforged Cornerstones\|upgrades_from_id=Fedora Hat\|show_id=show}}

	=== Hiding descriptions ===		=== Hiding descriptions ===

76561197969631737: added doc for showing id and hiding description

2024-05-03T01:49:25Z

added doc for showing id and hiding description

← Older revision		Revision as of 01:49, 3 May 2024
Line 5:		Line 5:
	== Parameters ==		== Parameters ==

	All parameters are optional. If no parameters are given, a table of all Stormforged Cornerstones will be displayed.		All parameters are optional. If no parameters are given, a table of all Stormforged Cornerstones will be displayed, showing their icon and name linking to the Cornerstone's page, descriptions, and prices.

	=== Selection and Exclusion ===		=== Selection and Exclusion ===
Line 32:		Line 32:

	{\| class="wikitable"		{\| class="wikitable"
	! Parameter !! Description		! Parameter !! Default !! Description
			\|-
			\| caption \|\| "Stormforged Cornerstones" \|\| If you want to override the default caption for the table, you can specify it here.
			\|-
			\| skip_prices \|\| not skipped\|\| Use <code>skip_prices=skip</code> if you want a table with fewer columns that only lists the icons, names, and their descriptions--without their prices at the Forsaken Altar. This breaks from the naming convention of the other parameters because the template logic is different.
	\|-		\|-
	\| ~~caption~~ \|\| If you want to ~~override~~ the ~~default caption for~~ the ~~table~~, ~~you can specify it here~~.		\| show_id \|\| hidden \|\| Use <code>show_id=show</code> if you want to '''show''' a first column in the table that shows the id of the Cornerstone. (In list or inline display, the id is shown in parentheses.)
	\|-		\|-
	\| ~~skip_prices~~ \|\| Use <code>~~skip_prices~~=~~skip~~</code> if you want a table ~~with fewer columns that only lists~~ the ~~icons, names, and their~~ descriptions~~--without their prices at the Forsaken Altar~~.		\| show_description \|\| shown \|\| Use <code>show_description=no</code> if you want to '''hide''' the description column from the table. (In list or inline display, the descriptions are never shown.)
	\|-		\|-
	\| show_regular \|\| Use <code>show_regular=show</code> if you want to ~~add~~ a last column to the table that shows the regular version that each Cornerstone is upgraded from, if any.		\| show_regular \|\| hidden \|\| Use <code>show_regular=show</code> if you want to '''show''' a last column in the table that shows the regular version that each Cornerstone is upgraded from, if any. (In list or inline display, the regular versions are never shown.)
	\|-		\|-
	\| display \|\| For use when including these Cornerstones inside other tables or within paragraphs, the '''display''' parameter condenses the output to just the links to the pages on each Cornerstone:		\| display \|\| a table \|\| For use when including these Cornerstones inside other tables or within paragraphs, the '''display''' parameter condenses the output to just the links to the pages on each Cornerstone:
	* Use <code>display=list</code> to convert the table layout into a basic list~~. Only the standard~~ links ~~will show,~~ and ~~with small~~ icons.		* Use <code>display=list</code> to convert the table layout into a basic list with simple links and no icons.
	* Use <code>display=inline</code> to convert the table into an inline list of links, ~~without~~ icons.		* Use <code>display=inline</code> to convert the table into an inline list of links, also with no icons.
	\|-		\|-
	\| list_type \|\| When displaying as a list instead of a table, you can specify <code>list_type=number</code> to show the list as a numbered list instead ~~of the default, <code>list_type=bullet</code>~~.		\| list_type \|\| bullet \|\| When displaying as a list instead of a table, you can specify <code>list_type=number</code> to show the list as a numbered list instead.
	\|}		\|}

Line 114:		Line 118:
	Yields:		Yields:
	{{Stormforged Cornerstones\|name=trade\|description=trade\|skip_prices=skip}}		{{Stormforged Cornerstones\|name=trade\|description=trade\|skip_prices=skip}}

			=== Showing Cornerstone IDs ===

			<pre>{{Stormforged Cornerstones
			\|upgrades_from_id=Fedora Hat
			\|show_id=show
			}}</pre>

			Yields:
			{{Stormforged Cornerstones\|id=[Altar] Fedora Hat, [Altar] Alarm Bells\|show_id=show}}

			=== Hiding descriptions ===

			<pre>{{Stormforged Cornerstones
			\|upgrades_from_id=Fedora Hat
			\|show_description=no
			}}</pre>

			Yields:
			{{Stormforged Cornerstones\|upgrades_from_id=Fedora Hat\|show_description=no}}

	=== Showing regular versions ===		=== Showing regular versions ===

	~~Compare the following table with the one above.~~

	<pre>{{Stormforged Cornerstones		<pre>{{Stormforged Cornerstones
Line 162:		Line 184:
	Yields:		Yields:
	{{Stormforged Cornerstones\|name=trade\|description=trade\|display=list\|list_type=number}}		{{Stormforged Cornerstones\|name=trade\|description=trade\|display=list\|list_type=number}}

			=== List with IDs ===

			<pre>{{Stormforged Cornerstones
			\|name=trade
			\|description=trade
			\|display=list
			\|show_id=show
			}}</pre>

			Yields:
			{{Stormforged Cornerstones\|name=trade\|description=trade\|display=list}}

	== Inline Examples ==		== Inline Examples ==
Line 169:		Line 203:
	Yields the following, shown in the middle of a paragraph to highlight its usefulness. When you have a settlement profiting significantly from trading, consider investing in {{Stormforged Cornerstones\|name=trade\|description=trade\|display=inline}} Stormforged Cornerstones. If you can spare the cost, they can save your settlement!		Yields the following, shown in the middle of a paragraph to highlight its usefulness. When you have a settlement profiting significantly from trading, consider investing in {{Stormforged Cornerstones\|name=trade\|description=trade\|display=inline}} Stormforged Cornerstones. If you can spare the cost, they can save your settlement!

	<pre>{{Stormforged Cornerstones\|upgrades_from_id=Alarm Bells\|display=inline}}</pre>		<pre>{{Stormforged Cornerstones\|upgrades_from_id=Alarm Bells\|display=inline\|show_id=show}}</pre>

	Yields the ability to write a reminder that you can upgrade {{pl\|id=Alarm Bells\|icon_size=none}} to {{Stormforged Cornerstones\|upgrades_from_id=Alarm Bells\|display=inline}}, while only having to look up one ID!		Yields the ability to write a reminder that you can upgrade {{pl\|id=Alarm Bells\|icon_size=none}} to {{Stormforged Cornerstones\|upgrades_from_id=Alarm Bells\|display=inline\|show_id=show}}, while only having to look up one ID!

	== View templates ==		== View templates ==

76561197969631737: Added template list to the bottom

2024-05-02T22:03:57Z

Added template list to the bottom

← Older revision		Revision as of 22:03, 2 May 2024
Line 172:		Line 172:

	Yields the ability to write a reminder that you can upgrade {{pl\|id=Alarm Bells\|icon_size=none}} to {{Stormforged Cornerstones\|upgrades_from_id=Alarm Bells\|display=inline}}, while only having to look up one ID!		Yields the ability to write a reminder that you can upgrade {{pl\|id=Alarm Bells\|icon_size=none}} to {{Stormforged Cornerstones\|upgrades_from_id=Alarm Bells\|display=inline}}, while only having to look up one ID!

			== View templates ==

			This functionality is accomplished through the [[Wiki_data_model]]. This ''Template:Stormforged Cornerstones'' calls the controller module, which in turn interfaces with the data model modules. The view is handled entirely by these additional templates:

			{\|class=wikitable
			\|+ Related templates
			! Template !! Purpose
			\|-
			\| [[Template:StormforgedCornerstonesTable]] \|\| Primary, default table header template
			\|-
			\| [[Template:StormforgedCornerstonesTable/row]] \|\| Default table row template
			\|-
			\| [[Template:StormforgedCornerstonesTable/SkipPrices]] \|\| Table header template, but without the prices columns
			\|-
			\|white-space="nowrap"\| [[Template:StormforgedCornerstonesTable/row/SkipPrices]] \|\| Table row template, but without the prices columns
			\|-
			\| [[Template:StormforgedCornerstonesList/item]] \|\| List version row template (there is no list header template)
			\|}

76561197969631737: Updated to reflect list of ids not just individuals

2024-05-02T22:00:00Z

Updated to reflect list of ids not just individuals

← Older revision		Revision as of 22:00, 2 May 2024
Line 16:		Line 16:
	! Parameter !! Description		! Parameter !! Description
	\|-		\|-
	\| id \|\| ~~The~~ Stormforged ~~Cornerstone with this id will be selected to display in the table~~. ~~If there is a match~~, adds one Cornerstone ~~with that id~~ to the table~~, since ids are unique~~.		\| id \|\| A list of IDs of Stormforged Cornerstones, separated by commas. Since IDs are unique, each matched ID adds exactly one Cornerstone to the table. Will not throw an error if an ID is invalid.
	\|-		\|-
	\| name \|\| Searches names for this string, and adds Cornerstones with any part of their names matching that string to the table.		\| name \|\| Searches names for this string, and adds Cornerstones with any part of their names matching that string to the table.
Line 24:		Line 24:
	\| upgrades_from_id \|\| The regular Cornerstone with this id may be upgraded into a Stormforged Cornerstone, which will be selected to display in the table. If there is a match, adds one Stormforged Cornerstone (not the regular version) with that id to the table, since ids are unique.		\| upgrades_from_id \|\| The regular Cornerstone with this id may be upgraded into a Stormforged Cornerstone, which will be selected to display in the table. If there is a match, adds one Stormforged Cornerstone (not the regular version) with that id to the table, since ids are unique.
	\|-		\|-
	\| exclude \|\| A list of ~~ids~~, separated by commas, that will be excluded from the ~~data~~. 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.
	\|}		\|}

Line 62:		Line 62:
	== Table Examples ==		== Table Examples ==

	=== ~~Showing one Cornerstone~~ by ~~its ID~~ ===		=== Selecting Cornerstones by their IDs ===

	<pre>{{Stormforged Cornerstones		<pre>{{Stormforged Cornerstones
Line 70:		Line 70:
	Yields:		Yields:
	{{Stormforged Cornerstones\|id=[Altar] Fedora Hat}}		{{Stormforged Cornerstones\|id=[Altar] Fedora Hat}}


			<pre>{{Stormforged Cornerstones
			\|id=[Altar] Fedora Hat, [Altar] Alarm Bells
			}}</pre>

			Yields:
			{{Stormforged Cornerstones\|id=[Altar] Fedora Hat, [Altar] Alarm Bells}}

	=== Selecting by upgrade ===		=== Selecting by upgrade ===

76561197969631737: /* Inline Example */ Updated examples

2024-05-02T02:50:27Z

Inline Example: Updated examples

← Older revision		Revision as of 02:50, 2 May 2024
Line 155:		Line 155:
	{{Stormforged Cornerstones\|name=trade\|description=trade\|display=list\|list_type=number}}		{{Stormforged Cornerstones\|name=trade\|description=trade\|display=list\|list_type=number}}

	== Inline ~~Example~~ ==		== Inline Examples ==

	<pre>{{Stormforged Cornerstones		<pre>{{Stormforged Cornerstones\|name=trade\|description=trade\|display=inline}}</pre>
	\|name=trade
	\|description=trade
	\|display=inline
	}}</pre>

	Yields the following, shown in the middle of a paragraph to highlight its usefulness. When you have a settlement profiting significantly from trading, consider investing in {{Stormforged Cornerstones\|name=trade\|description=trade\|display=inline}} Stormforged Cornerstones.		Yields the following, shown in the middle of a paragraph to highlight its usefulness. When you have a settlement profiting significantly from trading, consider investing in {{Stormforged Cornerstones\|name=trade\|description=trade\|display=inline}} Stormforged Cornerstones. If you can spare the cost, they can save your settlement!

			<pre>{{Stormforged Cornerstones\|upgrades_from_id=Alarm Bells\|display=inline}}</pre>

			Yields the ability to write a reminder that you can upgrade {{pl\|id=Alarm Bells\|icon_size=none}} to {{Stormforged Cornerstones\|upgrades_from_id=Alarm Bells\|display=inline}}, while only having to look up one ID!

76561197969631737: Added examples for list and inline display

2024-05-02T02:46:53Z

Added examples for list and inline display

@@ Line 1: / Line 1: @@
 == Overview ==
-Displays data about all Stormforged Cornerstones or a subset of them based on search parameters and exclusions. It is not possible to include regular (non-Stormforged) Cornerstones in the results.
+Displays data about all Stormforged Cornerstones or a subset of them based on search parameters and exclusions. There are a few ways the data can be displayed. It is not possible to include regular (non-Stormforged) Cornerstones in the results.
 == Parameters ==
@@ Line 39: / Line 39: @@
 |-
 | show_regular || Use <code>show_regular=show</code> if you want to add a last column to the table that shows the regular version that each Cornerstone is upgraded from, if any.
 |}
@@ Line 45: / Line 51: @@
 === No results from search ===
-If you specify parameters intending to select or search for terms, sometimes there is no result. This can be because you misspelled an id, asked for a search term that was not present in any name or description, or excluded every item that was found. In this situation, the template will instead render a plain-text message that nothing was found.
+If you specify parameters intending to select or search for terms, sometimes there is no result. This can be because you misspelled an id, asked for a search term that was not present in any name or description, or excluded every item that was found. In this situation, the template will instead render a plain-text message that nothing was found. (This is the error output regardless of any display overrides.)
 <pre>{{Stormforged Cornerstones
@@ Line 54: / Line 60: @@
 {{Stormforged Cornerstones|id=There is no ID like this}}
-== Examples ==
+== Table Examples ==
 === Showing one Cornerstone by its ID ===
@@ Line 121: / Line 127: @@
 Yields:
 {{Stormforged Cornerstones|caption=Every Stormforged Cornerstone in the game|skip_prices=skip|show_regular=show}}

76561197969631737: Added parameters for showing and selecting by regular versions.

2024-05-02T01:23:25Z

Added parameters for showing and selecting by regular versions.

← Older revision		Revision as of 01:23, 2 May 2024
Line 9:		Line 9:
	=== Selection and Exclusion ===		=== Selection and Exclusion ===

	You may combine the first ~~three~~ parameters to return more Cornerstones. The result will be the union of your selections, without duplicates. Then use <code>exclude</code> to remove any Cornerstones that are unrelated to your purposes with their ids.		You may combine the first four parameters to return more Cornerstones. The result will be the union of your selections, without duplicates. Then use <code>exclude</code> to remove any Cornerstones that are unrelated to your purposes with their ids.

	Remember that ids are not visible in the game, so you may need to look them up.		Remember that ids are not visible in the game, so you may need to look them up.
Line 16:		Line 16:
	! Parameter !! Description		! Parameter !! Description
	\|-		\|-
	\| id \|\| The Stormforged Cornerstone with this id will be selected to display in the table. If there is a match, adds ~~the~~ one Cornerstone with that id to the table, since ~~they~~ are unique.		\| id \|\| The Stormforged Cornerstone with this id will be selected to display in the table. If there is a match, adds one Cornerstone with that id to the table, since ids are unique.
	\|-		\|-
	\| name \|\| Searches names for this string, and adds Cornerstones with any part of their names matching that string to the table.		\| name \|\| Searches names for this string, and adds Cornerstones with any part of their names matching that string to the table.
	\|-		\|-
	\| description\|\| Searches descriptions for this string, and adds Cornerstones with any part of their descriptions matching that string to the table.		\| description \|\| Searches descriptions for this string, and adds Cornerstones with any part of their descriptions matching that string to the table.
			\|-
			\| upgrades_from_id \|\| The regular Cornerstone with this id may be upgraded into a Stormforged Cornerstone, which will be selected to display in the table. If there is a match, adds one Stormforged Cornerstone (not the regular version) with that id to the table, since ids are unique.
	\|-		\|-
	\| exclude \|\| A list of ids, separated by commas, that will be excluded from the data. Will not throw an error if an ID is invalid.		\| exclude \|\| A list of ids, separated by commas, that will be excluded from the data. Will not throw an error if an ID is invalid.
Line 35:		Line 37:
	\|-		\|-
	\| skip_prices \|\| Use <code>skip_prices=skip</code> if you want a table with fewer columns that only lists the icons, names, and their descriptions--without their prices at the Forsaken Altar.		\| skip_prices \|\| Use <code>skip_prices=skip</code> if you want a table with fewer columns that only lists the icons, names, and their descriptions--without their prices at the Forsaken Altar.
			\|-
			\| show_regular \|\| Use <code>show_regular=show</code> if you want to add a last column to the table that shows the regular version that each Cornerstone is upgraded from, if any.
	\|}		\|}

Line 43:		Line 47:
	If you specify parameters intending to select or search for terms, sometimes there is no result. This can be because you misspelled an id, asked for a search term that was not present in any name or description, or excluded every item that was found. In this situation, the template will instead render a plain-text message that nothing was found.		If you specify parameters intending to select or search for terms, sometimes there is no result. This can be because you misspelled an id, asked for a search term that was not present in any name or description, or excluded every item that was found. In this situation, the template will instead render a plain-text message that nothing was found.

	<pre>{{Stormforged Cornerstones\|id=There is no ID like this}}</pre>		<pre>{{Stormforged Cornerstones
			\|id=There is no ID like this
			}}</pre>

	Yields:		Yields:
Line 58:		Line 64:
	Yields:		Yields:
	{{Stormforged Cornerstones\|id=[Altar] Fedora Hat}}		{{Stormforged Cornerstones\|id=[Altar] Fedora Hat}}

			=== Selecting by upgrade ===

			Note that the regular versions must be shown to see them in the table. Selecting by the upgrade does not automatically show the extra column in the table.

			<pre>{{Stormforged Cornerstones
			\|upgrades_from_id=Fedora Hat
			}}</pre>

			Yields:
			{{Stormforged Cornerstones\|upgrades_from_id=Fedora Hat}}

	=== Searching names and descriptions ===		=== Searching names and descriptions ===
Line 83:		Line 100:
	Yields:		Yields:
	{{Stormforged Cornerstones\|name=trade\|description=trade\|skip_prices=skip}}		{{Stormforged Cornerstones\|name=trade\|description=trade\|skip_prices=skip}}

			=== Showing regular versions ===

			Compare the following table with the one above.

			<pre>{{Stormforged Cornerstones
			\|upgrades_from_id=Fedora Hat
			\|show_regular=show
			}}</pre>

			Yields:
			{{Stormforged Cornerstones\|upgrades_from_id=Fedora Hat\|show_regular=show}}

	=== Custom caption ===		=== Custom caption ===
Line 91:		Line 120:

	Yields:		Yields:
	{{Stormforged Cornerstones\|caption=Every Stormforged Cornerstone in the game}}		{{Stormforged Cornerstones\|caption=Every Stormforged Cornerstone in the game\|skip_prices=skip\|show_regular=show}}