Template:Executable name/doc: Difference between revisions
imported>Margotbean category |
imported>Margotbean m Text replacement - "==Usage==" to "==Use==" |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 2: | Line 2: | ||
This template formats an executable file's name & icon for consistency in documentation pages. | This template formats an executable file's name & icon for consistency in documentation pages. | ||
== | ==Use== | ||
The template can be used by placing <code><nowiki>{{</nowiki>executable name|''executable name without file extension''|''wiki icon name''<nowiki>}}</nowiki></code> on the page. For example: | The template can be used by placing <code><nowiki>{{</nowiki>executable name|''executable name without file extension''|''wiki icon name''<nowiki>}}</nowiki></code> on the page. If the icon field is omitted, it'll be auto-populated if the name is ''Stardew Valley'', ''StardewValley'', or ''StardewModdingAPI''. | ||
For example: | |||
{| class="wikitable" | {| class="wikitable" | ||
| Line 13: | Line 15: | ||
| {{executable name|Stardew Valley|Stardew Valley executable icon.png}} | | {{executable name|Stardew Valley|Stardew Valley executable icon.png}} | ||
|- | |- | ||
| <pre>{{executable name|StardewModdingAPI| | | <pre>{{executable name|Stardew Valley}}</pre> | ||
| {{executable name| | | {{executable name|Stardew Valley}} | ||
|- | |||
| <pre>{{executable name|StardewModdingAPI}}</pre> | |||
| {{executable name|StardewModdingAPI}} | |||
|} | |||
You can also set a different executable file extension: | |||
{| class="wikitable" | |||
|- | |||
! code | |||
! result | |||
|- | |||
| <pre>{{executable name|install on Windows|extension=bat}}</pre> | |||
| {{executable name|install on Windows|extension=bat}} | |||
|} | |} | ||
<includeonly>{{Addlanglinks}}[[Category:Modding templates]]</includeonly> | <includeonly>{{Addlanglinks}}[[Category:Modding templates]]</includeonly> | ||
<noinclude>[[Category:Template documentation]]</noinclude> | <noinclude>[[Category:Template documentation]]</noinclude> | ||
Latest revision as of 21:01, 8 January 2023
Description
This template formats an executable file's name & icon for consistency in documentation pages.
Use
The template can be used by placing {{executable name|executable name without file extension|wiki icon name}} on the page. If the icon field is omitted, it'll be auto-populated if the name is Stardew Valley, StardewValley, or StardewModdingAPI.
For example:
| code | result |
|---|---|
{{executable name|Stardew Valley|Stardew Valley executable icon.png}}
|
|
{{executable name|Stardew Valley}}
|
|
{{executable name|StardewModdingAPI}}
|
|
You can also set a different executable file extension:
| code | result |
|---|---|
{{executable name|install on Windows|extension=bat}}
|
install on Windows.bat
|