Template:Software release/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Created page with "{{Documentation subpage}} {{syntax|<nowiki>{{software release|appid=<game appid>}}</nowiki>}} '''Optional:''' Put <code><nowiki>{{software release|appid=<game appid>|sys=true|...")
 
(Better documentation)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation_subpage}}
{{syntax|<nowiki>{{software release|appid=<game appid>}}</nowiki>}}
{{syntax|<nowiki>{{software release|appid=<software appid>}}</nowiki>}}
'''Optional:'''
'''Optional:'''
Put <code><nowiki>{{software release|appid=<game appid>|sys=true|win=true|mac=true|linux=true|note=<insert text here>}}</nowiki></code> to show all supported systems (Win, Mac, Linux + SteamOS).  
Put <code style="background:{{{bg|{{{background|rgb(0,0,0,.35)}}}}}}; border-radius:3px; color: {{{color|currentcolor}}}; padding:2px 3px; user-select:{{#switch:{{{select}}}|#default=text|1=all|2=none}}"><nowiki>{{software release|appid=<software appid>|sys=true|win=true|mac=true|linux=true|note=<insert text here>}}</nowiki></code> to show all supported systems (Win, Mac, Linux + SteamOS).  
'''Example below:'''
 
== Parameters ==
{| class="standard-table plainlinks"
! Parameters
! Result
|-
| <code style="background:{{{bg|{{{background|rgb(0,0,0,.35)}}}}}}; border-radius:3px; color: {{{color|currentcolor}}}; padding:2px 3px; user-select:{{#switch:{{{select}}}|#default=text|1=all|2=none}}">appid=<software/software appid></code>
| Set the AppID for the "<span style="color: #86BF39">Launch it now</span> or <span style="color: yellow">buy it here</span>" button.
|-
| <code style="background:{{{bg|{{{background|rgb(0,0,0,.35)}}}}}}; border-radius:3px; color: {{{color|currentcolor}}}; padding:2px 3px; user-select:{{#switch:{{{select}}}|#default=text|1=all|2=none}}">sys=true</code> or <code style="background:{{{bg|{{{background|rgb(0,0,0,.35)}}}}}}; border-radius:3px; color: {{{color|currentcolor}}}; padding:2px 3px; user-select:{{#switch:{{{select}}}|#default=text|1=all|2=none}}">show</code>
| Shows "'''Supported Systems:'''"
|-
| <code style="background:{{{bg|{{{background|rgb(0,0,0,.35)}}}}}}; border-radius:3px; color: {{{color|currentcolor}}}; padding:2px 3px; user-select:{{#switch:{{{select}}}|#default=text|1=all|2=none}}">win=true</code>
| Shows "{{windows|4}}"
|-
| <code style="background:{{{bg|{{{background|rgb(0,0,0,.35)}}}}}}; border-radius:3px; color: {{{color|currentcolor}}}; padding:2px 3px; user-select:{{#switch:{{{select}}}|#default=text|1=all|2=none}}">mac=true</code>
| Shows "{{mac|4}}"
|-
| <code style="background:{{{bg|{{{background|rgb(0,0,0,.35)}}}}}}; border-radius:3px; color: {{{color|currentcolor}}}; padding:2px 3px; user-select:{{#switch:{{{select}}}|#default=text|1=all|2=none}}">linux=true</code>
| Shows "{{linux|4}}"
|-
| <code style="background:{{{bg|{{{background|rgb(0,0,0,.35)}}}}}}; border-radius:3px; color: {{{color|currentcolor}}}; padding:2px 3px; user-select:{{#switch:{{{select}}}|#default=text|1=all|2=none}}">note=<insert text here></code>
| Shows notices with custom text.
|-
|}
 
Leaving the <code style="background:{{{bg|{{{background|rgb(0,0,0,.35)}}}}}}; border-radius:3px; color: {{{color|currentcolor}}}; padding:2px 3px; user-select:{{#switch:{{{select}}}|#default=text|1=all|2=none}}"><nowiki>|sys=true|win=true|mac=true|linux=true|note=<insert text here></nowiki></code> omitted will hide the Supported Systems, OS and Notices.
{{ModernWarning|{{code|false}} value are non-functional!, it's need to be added to the template. For a workaround, just remove the (example: {{code|<nowiki>sys=true</nowiki>}}) for now.}}
 
== Example ==
{{software release|appid=1840|sys=true|win=true|mac=true|linux=true|note=This is an example text.}}
{{software release|appid=1840|sys=true|win=true|mac=true|linux=true|note=This is an example text.}}
== See Also ==
=== Game release ===
*[[Template:Game release]] - For paid games.
*[[Template:Game release free]] - For games that are released for free.
=== Mod release ===
*[[Template:Mod release]] - For Mods that are released on Steam.
=== Delisted softwares ===
*[[Template:Game delisted]] - For paid softwares that are delisted on Steam.
*[[Template:Game delisted free]] - For free softwares that are delisted on Steam.
=== Software release ===
*[[Template:Software release]] - You are currently viewing this page.
*[[Template:Software release free]] - Free version of it.
{{Doc/Sandbox other|[[Category:Templates]]}}

Revision as of 06:51, 20 April 2023

Edit-copy.png
This is a documentation subpage for Template:Software release.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Syntax: {{software release|appid=<software appid>}} Optional: Put {{software release|appid=<software appid>|sys=true|win=true|mac=true|linux=true|note=<insert text here>}} to show all supported systems (Win, Mac, Linux + SteamOS).

Parameters

Parameters Result
appid=<software/software appid> Set the AppID for the "Launch it now or buy it here" button.
sys=true or show Shows "Supported Systems:"
win=true Shows "Windows Windows"
mac=true Shows "macOS macOS"
linux=true Shows "Linux Linux"
note=<insert text here> Shows notices with custom text.

Leaving the |sys=true|win=true|mac=true|linux=true|note=<insert text here> omitted will hide the Supported Systems, OS and Notices. Template:ModernWarning

Example

Steam logo - CTRL + F5 or purge if not loading correctly.
This software/tool is available on Steam. Launch it now* or buy it here.
*Only works if Steam has been installed, please install Steam if you haven't already.

Supported Systems for this software: Windows Windows macOS macOS Linux Linux + SteamOS SteamOS

Notice: This is an example text.

See Also

Game release

Mod release

Delisted softwares

Software release

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Template:Software_release/doc&oldid=297963"