Template:Wiki/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (moved from the "Templates" category (which isn't supposed to contain templates themselves, only categories) to the "Formatting templates" category.)
(not much of a hassle)
 
(21 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Doc/subpage}}
<!-- Please place categories where indicated at the bottom of this page. -->
<!-- Please place categories where indicated at the bottom of this page. -->
== Usage ==
== Description & Usage ==
{{tip|The [[w:help:pipe trick|pipe trick]] makes this template redundant. See also: [[Help:Linking]].}}
{{shortcut|{{t|w}}<br>{{t|wp}}<br> {{t|wikipedia}}}}
This template is a faster way to link to Wikipedia articles. Normally if you want to link to a Wikipedia article such as [[Wikipedia:IMI Desert Eagle|IMI Desert Eagle]], you have to write the entire title twice <code><nowiki>[[Wikipedia:IMI Desert Eagle|IMI Desert Eagle]]</nowiki></code> and it's a hassle. This template skips that step when the displayed text will be the same as the title of the article you are linking to.
{{note|The {{wiki|help:pipe trick|pipe trick}} can also be used, but it will be less clear that the link goes to Wikipedia. See also: [[Help:Linking]].}}
This template is a faster way to link to Wikipedia articles. Normally if you want to link to a Wikipedia article such as {{wiki|IMI Desert Eagle}}, you have to write the entire title twice <code><nowiki>[[w:IMI Desert Eagle|IMI Desert Eagle]]</nowiki></code> and it's a hassle. This template skips that step when the displayed text will be the same as the title of the article you are linking to, and it also adds a handy icon to make it clear to the reader that the link goes to Wikipedia, instead of somewhere internal.


To link to another language page of Wikipedia, use: <code><nowiki>{{Wiki|<lang-prefix>:ARTICLE}}</nowiki></code>, see the example below.
To link to another language page of Wikipedia, use: <code><nowiki>{{Wiki|<lang-prefix>:ARTICLE}}</nowiki></code>, see the example below.
{{note|{{tl2|wikipedia}} redirects to {{tl2|wiki}}, so they're equivalent.}}
{{Note|{{t|wikipedia}} and {{t|w}} redirect to {{t|wiki}}, so they're equivalent.}}


=== Parameters ===
=== Parameters ===
* {{param|1}} - The wikipedia article name to link to.
{| class="standard-table" style="width:100%"
* {{param|2}} - Optional: The display text for the link.
! Parameter
 
! Description
=== Examples ===
! Example
{| style=background:none
! Preview
| {{tlc|wiki|IMI Desert Eagle}} || &rarr; || {{wiki|IMI Desert Eagle}}
|-
| style="text-align:center" | No Parameters
| Creates a link to Wikipedia Home page with language selection.
| style="padding:.2em .5em" | {{CodeBlock|<nowiki>{{wiki}}</nowiki>}}
| style="padding:.2em .5em" | {{Capsule| {{wiki}} }}
|-
| style="text-align:center" | {{Code| {{param}} }}
| Full name of the article on '''Wikipedia'''.
| style="padding:.2em .5em" | {{CodeBlock|<nowiki>{{wiki|Valve Corporation}}</nowiki>}}
| style="padding:.2em .5em" | {{Capsule| {{wiki|Valve Corporation}} }}
|-
| style="text-align:center" | {{Code| {{param|2}} }}
| Alternative name of the link.
| style="padding:.2em .5em" | {{CodeBlock|<nowiki>{{wiki|Valve Corporation|Valve}}</nowiki>}}
                              {{CodeBlock|<nowiki>{{wiki|es:Half-Life 2|HL2 (Spanish Wikipedia)}}</nowiki>}}
| style="padding:.2em .5em" | {{Capsule| {{wiki|Valve Corporation|Valve}} }}
                              {{Capsule| {{wiki|es:Half-Life 2|HL2 (Spanish Wikipedia)}} }}
|-
| style="text-align:center" | {{Code| {{param|section}} }}
| The section to link to (also works with {{param|2}}).
| style="padding:.2em .5em" | {{CodeBlock|<nowiki>{{wiki|Half-Life 2|section=Gameplay}}</nowiki>}}
| style="padding:.2em .5em" | {{Capsule| {{wiki|Half-Life 2|section=Gameplay}} }}
|-
|-
| {{tlc|wiki|IMI Desert Eagle|Deagle}} || &rarr; || {{wiki|IMI Desert Eagle|Deagle}}
| style="text-align:center" | {{Code| {{param|icon}} <br>{{param|text}} }}
| Hide/shows the icon.<br>Values: {{code|show}} (default), {{code|hide}}
| style="padding:.2em .5em" | {{CodeBlock|<nowiki>{{wiki|icon=hide}}</nowiki><br><nowiki>{{wiki|text=hide}}</nowiki>}}
| style="padding:.2em .5em" | {{Capsule| {{wiki|icon=hide}}<br>{{wiki|text=hide}} }}
|-
|-
| {{tlc|wiki|ru:Гейб Ньювелл|Гейб Ньювелл}} || &rarr; || {{wiki|ru:Гейб Ньювелл|Гейб Ньювелл}}
|}
|}


<includeonly>{{sandbox other||
== See also ==
{{External link templates}}
 
<includeonly>{{Sandbox other||
<!-- Categories below this line, please -->
<!-- Categories below this line, please -->
[[Category:Formatting templates]]
[[Category:Formatting templates]]
}}</includeonly>
}}</includeonly>

Latest revision as of 16:55, 16 August 2024

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

Description & Usage

Note.pngNote:The Wikipedia icon pipe trick can also be used, but it will be less clear that the link goes to Wikipedia. See also: Help:Linking.

This template is a faster way to link to Wikipedia articles. Normally if you want to link to a Wikipedia article such as Wikipedia icon IMI Desert Eagle, you have to write the entire title twice [[w:IMI Desert Eagle|IMI Desert Eagle]] and it's a hassle. This template skips that step when the displayed text will be the same as the title of the article you are linking to, and it also adds a handy icon to make it clear to the reader that the link goes to Wikipedia, instead of somewhere internal.

To link to another language page of Wikipedia, use: {{Wiki|<lang-prefix>:ARTICLE}}, see the example below.

Note.pngNote:{{wikipedia}} and {{w}} redirect to {{wiki}}, so they're equivalent.

Parameters

Parameter Description Example Preview
No Parameters Creates a link to Wikipedia Home page with language selection.
{{wiki}}
{{{1}}} Full name of the article on Wikipedia.
{{wiki|Valve Corporation}}
{{{2}}} Alternative name of the link.
{{wiki|Valve Corporation|Valve}}
{{wiki|es:Half-Life 2|HL2 (Spanish Wikipedia)}}
Wikipedia icon Valve
{{{section}}} The section to link to (also works with {{{2}}}).
{{wiki|Half-Life 2|section=Gameplay}}
{{{icon}}}
{{{text}}} 		Hide/shows the icon.
Values: show (default), hide
{{wiki|icon=hide}}
{{wiki|text=hide}}
Wikipedia icon Wikipedia
Wikipedia icon 

See also

Cross-wiki link templates
Template Preview
{{wikipedia}}
{{wiki}}
{{w}}		 Wikipedia icon Wikipedia
{{cow}} Combine overwiki icon.png Combine OverWiki
{{l4dwiki}} Left 4 Dead Wiki Left 4 Dead Wiki
{{pcgw}} Pcgw icon.png PCGamingWiki
{{portalwiki}} Portalwiki icon.png Portal Wiki
{{sboxwiki}} S&box icon.png S&Box Wiki
{{tfwiki}} Tfwiki favicon.png Team Fortress Wiki
{{twhl}} Twhl hammer emote.png TWHL Wiki
{{quakewiki}} Quake1-16px.png Quake Wiki
{{cswiki}} Counter-Strike Wiki Counter-Strike Wiki
Social media link templates
Template Preview
{{bluesky}} Bluesky Bluesky
{{discord}} Discord logo Discord
{{reddit}} Reddit logo Reddit
{{steam community}} Steam Community Steam Community
{{twitch}} Twitch logo Twitch
{{twitter}}
{{x}}		 Logo for X X (Twitter)
{{youtube}} YouTube logo YouTube
Storefront link templates
Template Preview
{{steam store}} Steam Store Steam Store
{{epic}}
{{egs}}		 Epic Games Store Epic Games Store
{{gplay}} Google Play Google Play
{{gog}} GOG.com GOG.com
{{ms store}}
(PC, Xbox One Xbox One, Xbox Series X/S)		 Microsoft Store Microsoft Store
{{xbox store}}
(Xbox 360 Xbox 360)		 Xbox Marketplace Xbox Marketplace
{{nintendo store}} Nintendo Store Nintendo Store
Other link templates
Template Preview
{{steam}} Steam Protocol
{{email}}
{{e}}		 gaben@valvesoftware.com
{{github}} GitHub GitHub
{{gamebanana}} ModDB GameBanana
{{moddb}} ModDB ModDB
{{rtsl}} rtsl RTSL
{{protondb}} ProtonDB ProtonDB
{{steamdb}}
{{sdb}}		 SteamDB SteamDB
{{gdrive}}
{{gd}}		 Google Drive Google Drive
{{fragnet}}
{{fn}}		 Frag-Net Frag-Net

ViewDiscussEdit templatePurge


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