Difference between revisions of "Template:Howto"

From VideoLAN Wiki
Jump to navigation Jump to search
(Removed feature: {{Howto|silent=yes}} no longer works (should be handled entirely with first unnamed parameter). Manual revert of revision 31711, adapted)
(Copy-edit, humour)
 
Line 9: Line 9:
 
== Usage ==
 
== Usage ==
 
Calling the template currently:
 
Calling the template currently:
# Auto-categorises pages to be members of [[:Category:How To]]
+
# Adds page to [[:Category:How To]]
# 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).
+
# Sorts page under correct title, rather than <code>V</code> for <del>Vendetta</del> <code>VLC HowTo</code>
 
# Displays a message '''(optional)'''
 
# Displays a message '''(optional)'''
#* {{<nowiki />howto|play music with VLC}}) will show <samp>This page describes ''how to play music with VLC''</samp>.
+
#* <code>{{{{PAGENAME}}<nowiki>}}</nowiki></code> no banner
#* {{<nowiki />howto}} will suppress the message altogether—however, the template still auto-categorises and auto-sorts.
+
#* <code>{{{{PAGENAME}}<nowiki>|play music with VLC}}</nowiki></code> banner: <samp>This page describes ''how to play music with VLC''.</samp>
  
 
[[Category:How To|*]]<!-- modifies sortkey -->
 
[[Category:How To|*]]<!-- modifies sortkey -->
 
[[Category:Templates]]
 
[[Category:Templates]]
 
</noinclude>
 
</noinclude>

Latest revision as of 04:03, 9 June 2019

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

Usage

Calling the template currently:

  1. Adds page to Category:How To
  2. Sorts page under correct title, rather than V for Vendetta VLC HowTo
  3. Displays a message (optional)
    • {{Howto}} no banner
    • {{Howto|play music with VLC}} banner: This page describes how to play music with VLC.