Difference between revisions of "VideoLAN Wiki:List of templates"

From VideoLAN Wiki
Jump to navigation Jump to search
m (→‎Formatting: Update documentation for Template:Clear)
 
(7 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
== Formatting ==
 
== Formatting ==
 
{| class="wikitable"
 
{| class="wikitable"
−
! Name !! Description
+
! scope="col" | Name !! scope="col" | Description
 
|-
 
|-
 
| {{tl|Clear}} || If there are elements (e.g. wikipedia box) to the left or right of the page, this will place text under those, rather than beside it. Accepts one optional argument (''left'' or ''right'') to clear a single side.
 
| {{tl|Clear}} || If there are elements (e.g. wikipedia box) to the left or right of the page, this will place text under those, rather than beside it. Accepts one optional argument (''left'' or ''right'') to clear a single side.
Line 14: Line 14:
 
== Interwiki links ==
 
== Interwiki links ==
 
{| class="wikitable"
 
{| class="wikitable"
−
! Name !! Description
+
! scope="col" | Name !! scope="col" | Description
 
|-
 
|-
 
| {{tl|Mmwiki}} || Box to [[Multimedia Wiki]]
 
| {{tl|Mmwiki}} || Box to [[Multimedia Wiki]]
Line 29: Line 29:
 
== Links to VLC project ==
 
== Links to VLC project ==
 
{| class="wikitable"
 
{| class="wikitable"
−
! Name !! Description
+
! scope="col" | Name !! scope="col" | Description
 
|-
 
|-
 
| {{tl|Bug}} || Link to a bug
 
| {{tl|Bug}} || Link to a bug
Line 39: Line 39:
 
| {{tl|Forum}} || Link to forum thread
 
| {{tl|Forum}} || Link to forum thread
 
|-
 
|-
−
| {{tl|File}} || Link to source code
+
| {{tl|VLCSourceFile}} || Link to source code file
 
|-
 
|-
−
| {{tl|VLCSourceFile}} || Same as {{tl|File}} but does not add a leading bullet
+
| {{tl|File}} || Link to source code file and add a bullet
 +
|-
 +
| {{tl|VLCSourceFolder}} || Link to source code folder
 +
|-
 +
| {{tl|Commit}} || Link to commit
 +
|-
 +
| {{tl|Commitdiff}} || Link to commit with diff
 
|}
 
|}
  
 
== Maintenance ==
 
== Maintenance ==
 
{| class="wikitable"
 
{| class="wikitable"
−
! Name !! Description
+
! scope="col" | Name !! scope="col" | Description
 
|-
 
|-
 
| {{tl|Check}} || Adds <sup>[Please check]</sup> and adds to [[:Category:Pages to check]]
 
| {{tl|Check}} || Adds <sup>[Please check]</sup> and adds to [[:Category:Pages to check]]
Line 56: Line 62:
 
| {{tl|Historical}} || Tags obsolete pages as being for historical purposes only.
 
| {{tl|Historical}} || Tags obsolete pages as being for historical purposes only.
 
|-
 
|-
−
| {{tl|Outdated}} || Tags outdated pages and adds to [[:Category:Outdated pages]] or [[:Category:Important outdated pages]]
+
| {{tl|Outdated}} || Tags outdated pages and adds to [[:Category:Outdated pages]]
 
|-
 
|-
 
| {{tl|Merge}} || Request for a page merge.
 
| {{tl|Merge}} || Request for a page merge.
 
|-
 
|-
 
| {{tl|Stub}} || Is a stub. Adds to [[:Category:Stubs]]
 
| {{tl|Stub}} || Is a stub. Adds to [[:Category:Stubs]]
 +
|-
 +
| {{tl|Compat}} || Is a compatibility stub. Adds to [[:Category:CompatStub]]
 +
|-
 +
| {{tl|Image requested}} || Tags page and adds to [[:Category:Requested images]]
 
|}
 
|}
  
 
== Page type banners ==
 
== Page type banners ==
 
{| class="wikitable"
 
{| class="wikitable"
−
! Name !! Description
+
! scope="col" | Name !! scope="col" | Description
 
|-
 
|-
−
| {{tl|Documentation}} || Marks as being from the official documentation
+
| {{tl|Documentation footer}} || Marks as being from the official documentation
 
|-
 
|-
 
| {{tl|VSG}} || Marks as part of the [[VLC Support Guide]] pages
 
| {{tl|VSG}} || Marks as part of the [[VLC Support Guide]] pages
Line 87: Line 97:
  
 
== Yes and no ==
 
== Yes and no ==
−
; Test status
+
=== Test status ===
 
{| class="wikitable"
 
{| class="wikitable"
−
! Name !! Description
+
! scope="col" | Name !! scope="col" | Description
 
|-
 
|-
 
| {{tl|Yes}} || {{yes}}
 
| {{tl|Yes}} || {{yes}}
 
|-
 
|-
 
| {{tl|No}} || {{no}}
 
| {{tl|No}} || {{no}}
 +
|-
 +
| {{tl|ARC}} || {{ARC}}
 +
|-
 +
| {{tl|n/a}} || {{n/a}}
 
|-  
 
|-  
 
| {{tl|Ok}} || {{ok}}
 
| {{tl|Ok}} || {{ok}}
Line 106: Line 120:
 
|}
 
|}
  
−
; Needed
+
=== Needed ===
 
{| class="wikitable"
 
{| class="wikitable"
−
! Name !! Description
+
! scope="col" | Name !! scope="col" | Description
 
|-
 
|-
 
| {{tl|Needed}} || {{needed}}
 
| {{tl|Needed}} || {{needed}}
Line 117: Line 131:
 
== Modules ==
 
== Modules ==
 
{| class="wikitable"
 
{| class="wikitable"
−
! Name !! Description
+
! scope="col" | Name !! scope="col" | Description
 
|-
 
|-
 
| {{tl|Module}} || Module info box
 
| {{tl|Module}} || Module info box
Line 126: Line 140:
 
== Other ==
 
== Other ==
 
{| class="wikitable"
 
{| class="wikitable"
−
! Name !! Description
+
! scope="col" | Name !! scope="col" | Description
 
|-
 
|-
 
| {{tl|Navbox}} || The classic navigational box used to create navigational aids in the wiki.
 
| {{tl|Navbox}} || The classic navigational box used to create navigational aids in the wiki.
Line 135: Line 149:
 
|-
 
|-
 
| {{tl|Tl}} || For templates, does the groovy {{tl|tl}} thing.
 
| {{tl|Tl}} || For templates, does the groovy {{tl|tl}} thing.
−
|-
 
−
| {{tl|Unsupported}} || Not compatible box
 
 
|-
 
|-
 
| {{tl|VLC}} || Expands to {{VLC}}.
 
| {{tl|VLC}} || Expands to {{VLC}}.
Line 148: Line 160:
 
| {{tl|Done}} || Expands to the text {{done}}
 
| {{tl|Done}} || Expands to the text {{done}}
 
|-
 
|-
−
| {{tl|%}} || Expands to {{%}} for use at the start of console stuff
+
| {{tl|Prompt}} || Flexible template that displays console prompts
 +
|-
 +
| {{tl|$}} || Expands to {{$}}. Quicker to type than <code><nowiki>{{Prompt|$}}</nowiki></code>
 +
|-
 +
| {{tl|%}} || Expands to {{%}}. Quicker to type than <code><nowiki>{{Prompt|%}}</nowiki></code>
 
|-
 
|-
 
| {{tl|!}} || Expands to the vertical bar for use inside templates
 
| {{tl|!}} || Expands to the vertical bar for use inside templates

Latest revision as of 05:17, 31 May 2019

See also: Help:Templates, Category:Templates, Sandbox (testing) area, and Full list of templates

Formatting

Name Description
{{Clear}} If there are elements (e.g. wikipedia box) to the left or right of the page, this will place text under those, rather than beside it. Accepts one optional argument (left or right) to clear a single side.
{{Lowercase}} If the initial letter of article title should be lowercase (e.g. libdvbpsi) add this to the top of the article.
{{Anchoring space}} Adds space for anchoring along with the associated message "This space is left blank to make anchoring work correctly".

Interwiki links

Name Description
{{Mmwiki}} Box to Multimedia Wiki
{{Website}} Box to official website
{{Wikipedia}} Box to Wikipedia:
{{Xiph}} Box to Xiph Wiki
{{Open}} Marks free open source projects

Links to VLC project

Name Description
{{Bug}} Link to a bug
{{Doc}} Link to documentation
{{Faqlink}} Link to FAQs Does not work anymore - videolan.org/doc is down
{{Forum}} Link to forum thread
{{VLCSourceFile}} Link to source code file
{{File}} Link to source code file and add a bullet
{{VLCSourceFolder}} Link to source code folder
{{Commit}} Link to commit
{{Commitdiff}} Link to commit with diff

Maintenance

Name Description
{{Check}} Adds [Please check] and adds to Category:Pages to check
{{Dead link}} Adds [dead link] and adds to Category:Pages with broken links
{{Delete}} Places a page in Category:Delete for deletion.
{{Historical}} Tags obsolete pages as being for historical purposes only.
{{Outdated}} Tags outdated pages and adds to Category:Outdated pages
{{Merge}} Request for a page merge.
{{Stub}} Is a stub. Adds to Category:Stubs
{{Compat}} Is a compatibility stub. Adds to Category:CompatStub
{{Image requested}} Tags page and adds to Category:Requested images

Page type banners

Name Description
{{Documentation footer}} Marks as being from the official documentation
{{VSG}} Marks as part of the VLC Support Guide pages
{{Howto}} Marks as part of the how to pages
{{Mux}} Marks as a container.
{{Codec audio}} Marks as an audio codec.
{{Codec video}} Marks as a video codec.
{{Protocol}} Marks as an access module (http, cdda, etc).
{{Top box}} A box with a square and a bit for text, used for {{mux}}, etc.
{{example code}} Page is example code

Yes and no

Test status

Name Description
{{Yes}} Yes
{{No}} No
{{ARC}} ARC
{{n/a}} n/a
{{Ok}} Ok / Upgradable
{{Partial}} Partial
{{Middle}} Middle
{{Untested}} untested ???
{{Up-to-date}} Up-to-date

Needed

Name Description
{{Needed}} X
{{UnNeeded}} -

Modules

Name Description
{{Module}} Module info box
{{Option}} Module option

Other

Name Description
{{Navbox}} The classic navigational box used to create navigational aids in the wiki.
{{Languages}} Navigation box for translations of this wiki. Please read the associated documentation before using!
{{Compat}} Asks for compatibility information, e.g. for hardware.
{{Tl}} For templates, does the groovy {{tl}} thing.
{{VLC}} Expands to VLC media player.
{{VLC icon}} Expands to the VLC icon LargeVLC.png.
{{VLC:latest version}} Expands to VLC latest version. Currently 3.0.12
{{Checkmark}} Expands to a checkmark Yes
{{Done}} Expands to the text Yes Done
{{Prompt}} Flexible template that displays console prompts
{{$}} Expands to $. Quicker to type than {{Prompt|$}}
{{%}} Expands to %. Quicker to type than {{Prompt|%}}
{{!}} Expands to the vertical bar for use inside templates
{{GPL notice}} GPL notice ("Permission is granted to...")
{{CVE}} Link to a CVE.
{{US-CERT}} Link to a US-CERT Vulnerability Notice.
{{VideoLAN-SA}} Link to a VideoLAN Security Advisory.
{{-*}} Expands to →
Retrieved from "https://wiki.videolan.org/index.php?title=VideoLAN_Wiki:List_of_templates&oldid=61666"