Template:Strings subpage/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Created page with "<noinclude>{{doc|0}}</noinclude> <!-- Please place categories where indicated at the bottom of this page.) --> A panel indicating that this page contains various translatable...")
 
No edit summary
 
(29 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<noinclude>{{doc|0}}</noinclude>
{{Doc/subpage}}
<onlyinclude>
<!-- Please place categories where indicated at the bottom of this page.) -->
<!-- Please place categories where indicated at the bottom of this page.) -->
A panel indicating that this page contains various translatable strings that are used in the template or anywhere else.
== Usage ==
{{Code|<nowiki>{{</nowiki>{{ROOTPAGENAME}}<nowiki>}}</nowiki>|select=1}} → {{ {{ROOTPAGENAME}} }}


<includeonly>{{sandbox other||
A panel indicating that the page it is on contains strings that are used in lieu of complicated #switch parser (or formerly, {{tl2|autolang}}(s)) on the base page.
== Looking for creating a Strings subpage? ==
If you are looking for creating a strings subpage, just create a "{{code|/strings}}" subpage, then paste the following code:
{{Expand|title=See the code|
{{CodeBlock|<nowiki>{{Strings subpage<!-- Don't forget to update once you add new translation to a strings. -->
|number = 1
| en = 1
| de = 1
| eo = 1
| es = 1
| fi = 1
| fr = 1
| ru = 1
| vi = 1
| zh = 1
}}
 
* {{{{PAGENAME}}|Example}}
 
<includeonly><onlyinclude>{{#switch:{{{1}}}<!-- Remember to keep this clean by sorting A-Z, and copy paste the tab space instead of pressing "SPACE" repeatedly. -->
 
| Example = {{#switch: {{language}}
| #default = Example
| de = Beispiel
| eo = Ekzemplo
| es = Ejemplo
| fi = Esimerkki
| fr = Exemple
| ru = Пример
| vi = Ví dụ
| zh = 示例
}}
 
}}</onlyinclude></includeonly>
</nowiki>}}
}}
 
{{Note|(Not required), but when you add a new language, it is recommended to sort the language codes from A to Z.}}
 
== Parameters and Examples ==
{| class="standard-table" width="100%"
! {{Dictionary/common|Param}}
! {{Dictionary/common|Desc}}
! {{Dictionary/common|Example}}
|-
| align="center" | No Parameters
| Places the template.
| {{CodeBlock|margin=5px|<nowiki>{{Strings subpage}}</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|number}}}}
| Number of strings.
| {{CodeBlock|margin=5px|<nowiki>| number = 6</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|<language code>}}}}
| Number of translated strings into the specified language.
| {{CodeBlock|margin=5px|<nowiki>| en = 6</nowiki>}}{{CodeBlock|margin=5px|<nowiki>| eo = 3</nowiki>}}{{CodeBlock|margin=5px|<nowiki>| he = 2</nowiki>}}
|}
 
When creating a new strings subpage, click on the three dots in the top right of the documentation box and click "Strings". This will create a new strings subpage with the proper formatting already applied. Of course, this is not required and you can just create a new one from scratch if you so wish.
</onlyinclude>
{{Doc/Sandbox other|
<!-- Categories below this line, please -->
<!-- Categories below this line, please -->
[[Category:Templates]]
[[Category:Templates]]
}}</includeonly>
}}

Latest revision as of 10:27, 24 January 2025

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


A panel indicating that the page it is on contains strings that are used in lieu of complicated #switch parser (or formerly, {{autolang}}(s)) on the base page.

Looking for creating a Strings subpage?

If you are looking for creating a strings subpage, just create a "/strings" subpage, then paste the following code:

See the code
{{Strings subpage<!-- Don't forget to update once you add new translation to a strings. --> |number = 1 | en = 1 | de = 1 | eo = 1 | es = 1 | fi = 1 | fr = 1 | ru = 1 | vi = 1 | zh = 1 }} * {{{{PAGENAME}}|Example}} <includeonly><onlyinclude>{{#switch:{{{1}}}<!-- Remember to keep this clean by sorting A-Z, and copy paste the tab space instead of pressing "SPACE" repeatedly. --> | Example = {{#switch: {{language}} | #default = Example | de = Beispiel | eo = Ekzemplo | es = Ejemplo | fi = Esimerkki | fr = Exemple | ru = Пример | vi = Ví dụ | zh = 示例 }} }}</onlyinclude></includeonly>
Note.pngNote:(Not required), but when you add a new language, it is recommended to sort the language codes from A to Z.

Parameters and Examples

Parameter Description Example
No Parameters Places the template.
{{Strings subpage}}
{{{number}}} Number of strings.
| number = 6
{{{<language code>}}} Number of translated strings into the specified language.
| en = 6
| eo = 3
| he = 2

When creating a new strings subpage, click on the three dots in the top right of the documentation box and click "Strings". This will create a new strings subpage with the proper formatting already applied. Of course, this is not required and you can just create a new one from scratch if you so wish.