Difference between revisions of "Template:Howto"

From VideoLAN Wiki
Jump to navigation Jump to search
m (add proper documentation)
(Transition to parameter "silent" for suppressing the box)
Line 1: Line 1:
<includeonly>{{#if:{{{1|}}}|</includeonly>{{{!}} cellspacing="2" cellpadding="3" class="widebox"
+
<includeonly>{{#if:{{{silent|}}}||</includeonly>{{{!}} cellspacing="2" cellpadding="3" class="widebox"
 
{{!}}align="left"{{!}}This page describes ''how to {{lcfirst:{{{1}}}}}''.
 
{{!}}align="left"{{!}}This page describes ''how to {{lcfirst:{{{1}}}}}''.
 
{{!}}align="right"{{!}}<span style="white-space:nowrap;">[[VLC HowTo{{!}}Other "how to" pages]]</span>
 
{{!}}align="right"{{!}}<span style="white-space:nowrap;">[[VLC HowTo{{!}}Other "how to" pages]]</span>
{{!}}}<includeonly>|}}</includeonly>
+
{{!}}}<includeonly>}}</includeonly>
 
{{#if: {{{nosort|}}} |  |<includeonly>{{DEFAULTSORT:{{#titleparts:{{FULLPAGENAME}}|1|2}}}}</includeonly>|noerror}}
 
{{#if: {{{nosort|}}} |  |<includeonly>{{DEFAULTSORT:{{#titleparts:{{FULLPAGENAME}}|1|2}}}}</includeonly>|noerror}}
 
{{ #if: {{{nocat|}}} |  | [[Category:How To]] }}<noinclude>
 
{{ #if: {{{nocat|}}} |  | [[Category:How To]] }}<noinclude>

Revision as of 12:44, 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)
    • If the first unnamed parameter is specified (e.g. {{howto|do something}}) a message will be shown similar to the above.
    • Alternately, not passing anything to the first parameter (e.g. {{howto}}) suppresses the message altogether—however, the template still auto-categorises and auto-sorts.