Template:Recipe/doc - Revision history

76561197969631737: amending example for product and ingredient combo; removing note at the top

2024-10-31T21:27:24Z

amending example for product and ingredient combo; removing note at the top

← Older revision		Revision as of 21:27, 31 October 2024
Line 1:		Line 1:
	{{c\|{{ColorRed}}\|Important template author note: Writing this doc revealed a few edge cases that are not being handled correctly--nothing major, just edge cases. I will fix these as soon as I can. In the meantime, the documentation is correct for how things ''will'' be, once the template is fixed.}}

	== Overview ==		== Overview ==

Line 62:		Line 60:
	<pre>{{Recipe\|product=Meat\|ingredient=Plant Fiber}}</pre>		<pre>{{Recipe\|product=Meat\|ingredient=Plant Fiber}}</pre>
	<pre>{{Recipe\|product=Meat}}</pre>		<pre>{{Recipe\|product=Meat}}</pre>
	Specifying both the product and ingredient is redundant in most cases. Only when products can be gathered or produced in industry buildings will the results be different:		Specifying both the product and ingredient is redundant in most cases. Only when products can be both (a) gathered and (b) produced in industry buildings will the results be different. There is currently no way to match only recipes with empty ingredients except by making separate boxes for separate buildings.
	{{Recipe\|product=Meat\|ingredient=Plant Fiber}}		{{Recipe\|product=Meat\|ingredient=Plant Fiber}}

76561197969631737: Revised doc for this version

2024-10-31T04:03:58Z

Revised doc for this version

Show changes

76561197969631737: Created to move documentation to a subpage

2024-10-31T03:24:43Z

Created to move documentation to a subpage

Show changes

76561197969631737: no longer needed

2023-02-13T17:36:28Z

no longer needed

← Older revision		Revision as of 17:36, 13 February 2023
Line 1:		Line 1:
	This template calls <code>renderRecipe</code> in '''Module:RenderRecipe''' to get recipes for a product and/or a building. This will generate a new wikitable full of content from the game: buildings, stars of efficiency, ingredients, and products.

	This template standardizes the display of recipes throughout this wiki and greatly simplifies the amount of writing that is necessary when adding new content pages, especially for resources and buildings.


	~~== Usage ==~~

	The table will contain exactly one recipe if the template is given both a product and building. The table will (usually) contain more than one row if the template is given either a product or a building. If nothing is provided, for example <code><nowiki>{{Recipe}}</nowiki></code>, an error will appear instead.

	~~Here are ways to call the template, as they would be written in the article calling the template:~~

	~~{\| class="wikitable"~~
	~~! Argument !! Examples !! Expected outcome~~
	\|-
	~~\| None~~
	~~\| <code><nowiki>{{Recipe}}</nowiki></code>~~
	~~\| An error~~
	\|-
	~~\| Product and building~~
	~~\| style="white-space: nowrap" \| <code><nowiki>{{Recipe\|Crystalized Dew\|Brickyard}}</nowiki></code> <br> <code><nowiki>{{Recipe\|product=Crystalized Dew\|building=Brickyard}}</nowiki></code>~~
	~~\| A table with one row.~~
	\|-
	~~\| Product only~~
	~~\| style="white-space: nowrap" \| <code><nowiki>{{Recipe\|Pie}}</nowiki></code> <br> <code><nowiki>{{Recipe\|product=Pie}}</nowiki></code>~~
	~~\| A table with several rows, one for each building in which '''Pie''' can be produced.~~
	\|-
	~~\| Building only~~
	~~\| style="white-space: nowrap" \| <code><nowiki>{{Recipe\|\|Scribe}}</nowiki></code> ''(note the double pipe)'' <br> <code><nowiki>{{Recipe\|building=Scribe}}</nowiki></code>~~
	~~\| A table with several rows, one for each product that can be produced in the '''Scribe.'''~~
	\|}


	~~== Examples ==~~

	~~The following are generated by calling the template, as shown in the examples in the table above.~~

	~~<code><nowiki>{{Recipe}}</nowiki></code> yields:~~

	~~{{Recipe}}~~


	~~<code><nowiki>{{Recipe\|Crystalized Dew\|Brickyard}}</nowiki></code> yields:~~

	~~{{Recipe\|Crystalized Dew\|Brickyard}}~~


	~~<code><nowiki>{{Recipe\|Pie}}</nowiki></code> yields:~~

	~~{{Recipe\|Pie}}~~


	~~<code><nowiki>{{Recipe\|\|Scribe}}</nowiki></code> yields:~~

	~~{{Recipe\|\|Scribe}}~~

76561197969631737: separated the documentation page

2023-02-12T23:19:46Z

separated the documentation page

New page

This template calls <code>renderRecipe</code> in '''Module:RenderRecipe''' to get recipes for a product and/or a building. This will generate a new wikitable full of content from the game: buildings, stars of efficiency, ingredients, and products.

This template standardizes the display of recipes throughout this wiki and greatly simplifies the amount of writing that is necessary when adding new content pages, especially for resources and buildings.

== Usage ==

The table will contain exactly one recipe if the template is given both a product and building. The table will (usually) contain more than one row if the template is given either a product or a building. If nothing is provided, for example <code><nowiki>{{Recipe}}</nowiki></code>, an error will appear instead.

Here are ways to call the template, as they would be written in the article calling the template:

{| class="wikitable"
! Argument !! Examples !! Expected outcome
|-
| None
| <code><nowiki>{{Recipe}}</nowiki></code>
| An error
|-
| Product and building
| style="white-space: nowrap" | <code><nowiki>{{Recipe|Crystalized Dew|Brickyard}}</nowiki></code> <br> <code><nowiki>{{Recipe|product=Crystalized Dew|building=Brickyard}}</nowiki></code>
| A table with one row.
|-
| Product only
| style="white-space: nowrap" | <code><nowiki>{{Recipe|Pie}}</nowiki></code> <br> <code><nowiki>{{Recipe|product=Pie}}</nowiki></code>
| A table with several rows, one for each building in which '''Pie''' can be produced.
|-
| Building only
| style="white-space: nowrap" | <code><nowiki>{{Recipe||Scribe}}</nowiki></code> ''(note the double pipe)'' <br> <code><nowiki>{{Recipe|building=Scribe}}</nowiki></code>
| A table with several rows, one for each product that can be produced in the '''Scribe.'''
|}

== Examples ==

The following are generated by calling the template, as shown in the examples in the table above.

<code><nowiki>{{Recipe}}</nowiki></code> yields:

{{Recipe}}

<code><nowiki>{{Recipe|Crystalized Dew|Brickyard}}</nowiki></code> yields:

{{Recipe|Crystalized Dew|Brickyard}}

<code><nowiki>{{Recipe|Pie}}</nowiki></code> yields:

{{Recipe|Pie}}

<code><nowiki>{{Recipe||Scribe}}</nowiki></code> yields:

{{Recipe||Scribe}}