Difference between revisions of "Template:Executable name/doc"

From Stardew Valley Wiki
Jump to navigation Jump to search
(create page)
 
m (Text replacement - "==Usage==" to "==Use==")
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
==Description==
 
==Description==
−
This template formats a file's name & icon for consistency in documentation pages.
+
This template formats an executable file's name & icon for consistency in documentation pages.
  
−
==Usage==
+
==Use==
−
The template can be used by placing <code><nowiki>{{</nowiki>file name|''file name''|''icon image 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 10: Line 12:
 
! result
 
! result
 
|-
 
|-
−
| <pre>{{file name|Stardew Valley.exe|Stardew Valley executable icon.png}}</pre>
+
| <pre>{{executable name|Stardew Valley|Stardew Valley executable icon.png}}</pre>
−
| {{file name|Stardew Valley.exe|Stardew Valley executable icon.png}}
+
| {{executable name|Stardew Valley|Stardew Valley executable icon.png}}
 +
|-
 +
| <pre>{{executable name|Stardew Valley}}</pre>
 +
| {{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>{{file name|Stardew Valley.exe}}</pre>
+
| <pre>{{executable name|install on Windows|extension=bat}}</pre>
−
| {{file name|Stardew Valley.exe}}
+
| {{executable name|install on Windows|extension=bat}}
 
|}
 
|}
  
−
<includeonly>{{Addlanglinks}}[[Category:Formatting 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}}
 Stardew Valley executable icon.png Stardew Valley.exe 
{{executable name|Stardew Valley}}
 Stardew Valley executable icon.png Stardew Valley.exe 
{{executable name|StardewModdingAPI}}
 SMAPI mascot.png StardewModdingAPI.exe

You can also set a different executable file extension:

code result 
{{executable name|install on Windows|extension=bat}}
 install on Windows.bat
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Template:Executable_name/doc&oldid=145193"