Difference between revisions of "Template:Protocol"

From VideoLAN Wiki
Jump to navigation Jump to search
(Added parameter: optional specification of "mod" like Template:Mux)
(I documented the final options)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<!--
 
<!--
 
-->{{top box
 
-->{{top box
−
|id={{{id|??}}}
+
|id={{{1|??}}}
 
|text=<!--
 
|text=<!--
−
Line 1: -->VLC uses this [[protocol]] (or [[access module]]) to read data from a device or network. {{{info|}}}<!--
+
Line 1:               -->VLC uses this [[protocol]] (or [[access module]]) to read data from a device or network.{{#if:{{{info|}}}|&#32;Additional information: '''{{{info}}}'''}}<!--
−
Line 2: --><br />{{#if:{{{id|}}}<!--
+
Line 2: (conditional) -->{{#if:{{{mod|{{lc:{{{1|}}}}}}}}|<br />This protocol is handled by the '''{{docmod|{{{mod|{{lc:{{{1}}}}}}}}}}''' [[module]].}}
−
                -->|The [[module]] name to use at the [[command line]] is '''{{docmod|{{{mod|{{{id}}}}}}}}'''<!--
 
−
                -->{{#if:{{{altid|}}}<!--
 
−
                  -->|, but you can also use '''{{{altid}}}'''<!--
 
−
                    -->{{#if:{{{altid2|}}}<!--
 
−
                      -->|, or '''{{{altid2}}}'''<!--
 
−
                      -->{{#if:{{{altid3|}}}<!--
 
−
                        -->|, or '''{{{altid3}}}'''<!--
 
−
                      -->}}<!--
 
−
                    -->}}<!--
 
−
                -->}}.<!--
 
−
                -->|The [[module]] name to use at the [[command line]] is unknown.<!--
 
−
              -->}}
 
 
|bgcol=#ffe0e0
 
|bgcol=#ffe0e0
 
|brcol=#e0c0c0<!--
 
|brcol=#e0c0c0<!--
−
-->}}<includeonly> [[Category:Protocols]] </includeonly><noinclude>
+
-->}}<includeonly>{{#ifeq:{{{nocat|n}}}|y| |[[Category:Protocols]]}}</includeonly><noinclude>
  
 
==Usage==
 
==Usage==
−
  <nowiki>{{protocol |id= |info= |altid= |altid2= |altid3= |mod= }}</nowiki>
+
  <nowiki>{{protocol |<protocol> |info= |mod= }}</nowiki>
 +
The purpose of the template is to visually inform readers that VLC supports the protocol and through which module.<br />
 +
The page will be added automatically to [[:Category:Protocols]].
  
−
It will add it to [[:Category:Protocols]]
+
Parameters:
 +
* (unnamed) (required): the text in the small box, defaults to <samp>'''??'''</samp>
 +
* <code>'''<nowiki>|info=</nowiki>'''</code> (optional) extra text
 +
* <code>'''<nowiki>|mod=</nowiki>'''</code> (optional) link to a particular module while displaying the {{Tag|protocol}} given
  
−
Info is for extra text in the box.
+
Enter the protocol name as-is. If the name differs other than casing supply the module name with <code>'''<nowiki>|mod=</nowiki>'''</code>
−
 
 
−
<code>mod</code> will link to a particular module while displaying the <code>id</code> given. Use this when <code>altid</code> would not make sense.
 
  
 
==Examples==
 
==Examples==
−
Example, [[http]]
+
For [[HTTP]] the casing difference between ''[[HTTP]]'' and ''{{docmod|http}}'' is not a problem:
−
  <nowiki>{{protocol|id=http|altid=https}}</nowiki>
+
<code>{{{{PAGENAME}}<nowiki>|HTTP</nowiki>}}</code>
 +
{{{{PAGENAME}}|HTTP|nocat=y}}
 +
For [[RTSP]], the protocol is handled by the {{docmod|live}} module:
 +
  <code>{{{{PAGENAME}}<nowiki>|RTSP</nowiki>|mod=live}}</code>
 +
{{{{PAGENAME}}|RTSP|mod=live|nocat=y}}
 +
To say something for [[Dummy]]:
 +
<code>{{{{PAGENAME}}<nowiki>|Dummy</nowiki>|info=Fakes codec input, but is no longer used.}}</code>
 +
{{{{PAGENAME}}|Dummy|info=Fakes codec input, but is no longer used.|nocat=y}}
  
 
==See also==
 
==See also==

Latest revision as of 09:03, 19 April 2019

??
 VLC uses this protocol (or access module) to read data from a device or network.

Usage

{{protocol |<protocol> |info= |mod= }}

The purpose of the template is to visually inform readers that VLC supports the protocol and through which module.
The page will be added automatically to Category:Protocols.

Parameters:

  • (unnamed) (required): the text in the small box, defaults to ??
  • |info= (optional) extra text
  • |mod= (optional) link to a particular module while displaying the <protocol> given

Enter the protocol name as-is. If the name differs other than casing supply the module name with |mod=

Examples

For HTTP the casing difference between HTTP and http is not a problem: 

{{Protocol|HTTP}}
HTTP
 VLC uses this protocol (or access module) to read data from a device or network.
This protocol is handled by the http module.

For RTSP, the protocol is handled by the live module: 

{{Protocol|RTSP|mod=live}}
RTSP
 VLC uses this protocol (or access module) to read data from a device or network.
This protocol is handled by the live module.

To say something for Dummy: 

{{Protocol|Dummy|info=Fakes codec input, but is no longer used.}}
Dummy
 VLC uses this protocol (or access module) to read data from a device or network. Additional information: Fakes codec input, but is no longer used.
This protocol is handled by the dummy module.

See also

Retrieved from "https://wiki.videolan.org/index.php?title=Template:Protocol&oldid=61041"