Difference between revisions of "Template:Howto"

From VideoLAN Wiki
Jump to navigation Jump to search
m (Code-correct (see Wikipedia:HiddenStructure) but ugly)
(Removed feature: {{Howto|silent=yes}} no longer works (should be handled entirely with first unnamed parameter). Manual revert of revision 31711, adapted)
Line 1: Line 1:
{{#switch:{{{silent}}}
+
{{#if:{{{1<includeonly>|</includeonly>}}}
   |yes
+
   | {{{!}} class="widebox center cellpadding-3px" style="border-spacing:2px;"
  |y        =
+
     {{!}}style="text-align: left;"{{!}}This page describes ''how to {{lcfirst:{{{1<noinclude>|do something</noinclude>}}}}}''.
  |#default =
 
  {{{!}} class="widebox center cellpadding-3px" style="border-spacing:2px;"
 
     {{!}}style="text-align: left;"{{!}}This page describes ''how to {{lcfirst:{{{1}}}}}''.
 
 
     {{!}}class="nowrap" style="text-align: right;"{{!}}[[VLC HowTo{{!}}Other "how to" pages]]
 
     {{!}}class="nowrap" style="text-align: right;"{{!}}[[VLC HowTo{{!}}Other "how to" pages]]
  {{!}}}
+
    {{!}}}
 
}}
 
}}
 
{{#switch:{{{nosort}}}|yes|y = |#default = <includeonly>{{DEFAULTSORT:{{#titleparts:{{FULLPAGENAME}}|1|2}}|noerror}}</includeonly>}}
 
{{#switch:{{{nosort}}}|yes|y = |#default = <includeonly>{{DEFAULTSORT:{{#titleparts:{{FULLPAGENAME}}|1|2}}|noerror}}</includeonly>}}
Line 15: Line 12:
 
# Corrects the sortkey: telling the system that [[VLC HowTo/Adjust audio delay]] ought to be filed as "'''A'''djust audio delay" (A) and not "'''V'''LC HowTo/Adjust audio delay" (V).
 
# Corrects the sortkey: telling the system that [[VLC HowTo/Adjust audio delay]] ought to be filed as "'''A'''djust audio delay" (A) and not "'''V'''LC HowTo/Adjust audio delay" (V).
 
# Displays a message '''(optional)'''
 
# Displays a message '''(optional)'''
#* {{<nowiki />howto|do something}}) will show a message will be shown similar to the above.  
+
#* {{<nowiki />howto|play music with VLC}}) will show <samp>This page describes ''how to play music with VLC''</samp>.
#* {{<nowiki />howto|silent=yes}} will suppress the message altogether—however, the template still auto-categorises and auto-sorts.
+
#* {{<nowiki />howto}} will suppress the message altogether—however, the template still auto-categorises and auto-sorts.
  
 
[[Category:How To|*]]<!-- modifies sortkey -->
 
[[Category:How To|*]]<!-- modifies sortkey -->
 
[[Category:Templates]]
 
[[Category:Templates]]
 
</noinclude>
 
</noinclude>

Revision as of 03:52, 9 June 2019

This page describes how to do something. Other "how to" pages

Usage

Calling the template currently:

  1. Auto-categorises pages to be members of Category:How To
  2. Corrects the sortkey: telling the system that VLC HowTo/Adjust audio delay ought to be filed as "Adjust audio delay" (A) and not "VLC HowTo/Adjust audio delay" (V).
  3. Displays a message (optional)
    • {{howto|play music with VLC}}) will show This page describes how to play music with VLC.
    • {{howto}} will suppress the message altogether—however, the template still auto-categorises and auto-sorts.