Difference between revisions of "Template:Howto"

From VideoLAN Wiki
Jump to navigation Jump to search
(Transition to parameter "silent" for suppressing the box)
(→‎Usage: it's more awkward code-wise, but {{howto|silent=yes}} seems clearer than {{howto}}...)
Line 10: Line 10:
 
# 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)'''
#* If the first unnamed parameter is specified (e.g. {{<nowiki />howto|do something}}) a message will be shown similar to the above.  
+
#* {{<nowiki />howto|do something}}) will show a message will be shown similar to the above.  
#* Alternately, ''not'' passing anything to the first parameter (e.g. {{<nowiki />howto}}) suppresses the message altogether—however, the template still auto-categorises and auto-sorts.
+
#* {{<nowiki />howto|silent=yes}} will suppress the message altogether—however, the template still auto-categorises and auto-sorts.
  
 
{{DEFAULTCATEGORYSORT:*}}
 
{{DEFAULTCATEGORYSORT:*}}
 
[[Category:Templates]]
 
[[Category:Templates]]
 
</noinclude>
 
</noinclude>

Revision as of 12:48, 17 November 2016

This page describes how to {{{1}}}. 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|do something}}) will show a message will be shown similar to the above.
    • {{howto|silent=yes}} will suppress the message altogether—however, the template still auto-categorises and auto-sorts.