Difference between revisions of "Template:Fn"

From VideoLAN Wiki
Jump to navigation Jump to search
(Create template to simplify writing Hacker Guide documentation)
 
m (Whitespace)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<!--
 
<!--
-->{{#switch:{{{1}}} {{{2}}}<!--
+
-->{{#switch:{{{1}}}{{{2|}}}<!--
   -->|{{{1}}} {{{2}}} = ;<code>{{{1|function}}}</code>:{{{2|description}}}<!--
+
   -->|{{{1}}}       = '''<code>{{{1|function}}}</code>'''<!--
   -->|{{{1}}}         =<!--
+
   -->|{{{1}}}{{{2}}}<!--
   -->|#default       = '''<code>{{{1|function}}}</code>'''<!--
+
   -->|#default       = ;<code>{{{1|function}}}</code>:{{{2|description}}}<!--
 
  -->}}<noinclude>
 
  -->}}<noinclude>
  
 
== Usage ==
 
== Usage ==
 
To simplify writing [[Hacker Guide]] pages:
 
To simplify writing [[Hacker Guide]] pages:
  <code>{{{{PAGENAME}}|<nowiki>function(args)</nowiki>}}</code>
+
  <code>{{{{PAGENAME}}<nowiki>|name(args)</nowiki>}}</code>
  <code>{{{{PAGENAME}}|<nowiki>function(args)</nowiki>|<nowiki>description</nowiki>}}</code>
+
  <code>{{{{PAGENAME}}<nowiki>|name(args)|description</nowiki>}}</code>
  
 +
== Examples ==
 +
<code>{{{{PAGENAME}}<nowiki>|frob()</nowiki>}}</code>
 +
{{{{PAGENAME}}|frob()}}
 +
<code>{{{{PAGENAME}}<nowiki>|frob(foo&, bar)</nowiki>}}</code>
 +
{{{{PAGENAME}}|frob(foo&, bar)}}
 +
<code>{{{{PAGENAME}}<nowiki>|frob(foo&, bar)|Frobnicate foo with bar method</nowiki>}}</code>
 +
{{{{PAGENAME}}|frob(foo&, bar)|Frobnicate foo with bar method}}
 +
 +
[[Category:Hacker Guide|*]]
 
[[Category:Templates]]
 
[[Category:Templates]]
 
</noinclude>
 
</noinclude>

Latest revision as of 07:37, 17 April 2019

function

Usage

To simplify writing Hacker Guide pages:

{{Fn|name(args)}}
{{Fn|name(args)|description}}

Examples

{{Fn|frob()}}

frob()

{{Fn|frob(foo&, bar)}}

frob(foo&, bar)

{{Fn|frob(foo&, bar)|Frobnicate foo with bar method}}
frob(foo&, bar)
Frobnicate foo with bar method