Difference between revisions of "Template:Protocol"

From VideoLAN Wiki
Jump to navigation Jump to search
m (Accept first unnamed parameter as alias to id. This will not make sense yet)
(No page uses parameter "id". Removing)
Line 1: Line 1:
 
<!--
 
<!--
 
-->{{top box
 
-->{{top box
|id={{{1|{{{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. {{{info|}}}<!--
Line 2: --><br />{{#if:{{{1|{{{id|}}}}}}<!--
+
Line 2: --><br />{{#if:{{{1|}}}<!--
                 -->|The [[module]] name to use at the [[command line]] is '''{{docmod|{{{mod|{{lc:{{{1|{{{id}}}}}}}}}}}}}'''<!--
+
                 -->|The [[module]] name to use at the [[command line]] is '''{{docmod|{{{mod|{{lc:{{{1|}}}}}}}}}}'''<!--
 
                 -->{{#if:{{{altid|}}}<!--
 
                 -->{{#if:{{{altid|}}}<!--
 
                   -->|, but you can also use '''{{{altid}}}'''<!--
 
                   -->|, but you can also use '''{{{altid}}}'''<!--
Line 25: Line 25:
  
 
==Usage==
 
==Usage==
  <nowiki>{{protocol |id= |info= |altid= |altid2= |altid3= |altid4= |mod= }}</nowiki>
+
  <nowiki>{{protocol |<protocol> |info= |altid= |altid2= |altid3= |altid4= |mod= }}</nowiki>
  
 
It will add it to [[:Category:Protocols]]  
 
It will add it to [[:Category:Protocols]]  
Line 31: Line 31:
 
Info is for extra text in the box.
 
Info is for extra text in the box.
  
<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.
+
<code>mod</code> will link to a particular module while displaying the {{Tag|protocol}} given. Use this when <code>altid</code> would not make sense.
  
 
==Examples==
 
==Examples==
 
Example, [[http]]
 
Example, [[http]]
  <nowiki>{{protocol|id=http|altid=https}}</nowiki>
+
  <nowiki>{{protocol|HTTP|altid=https}}</nowiki>
  
 
==See also==
 
==See also==

Revision as of 04:40, 19 April 2019

??
VLC uses this protocol (or access module) to read data from a device or network.
The module name to use at the command line is unknown.

Usage

{{protocol |<protocol> |info= |altid= |altid2= |altid3= |altid4= |mod= }}

It will add it to Category:Protocols

Info is for extra text in the box.

mod will link to a particular module while displaying the <protocol> given. Use this when altid would not make sense.

Examples

Example, http

{{protocol|HTTP|altid=https}}

See also