Difference between revisions of "Template:Protocol"

From VideoLAN Wiki
Jump to navigation Jump to search
m (Insert space)
(Remove all the altids and usage instructions. The purpose of the module is to identify the protocol and direct the reader to the appropriate module page. altids are for modules, not protocols)
Line 3: Line 3:
 
|id={{{1|??}}}
 
|id={{{1|??}}}
 
|text=<!--
 
|text=<!--
Line 1:              -->VLC uses this [[protocol]] (or [[access module]]) to read data from a device or network{{#if:{{{mod|{{lc:{{{1|}}}}}}}}|&#32;with '''<code>{{{mod|{{lc:{{{1}}}}}}}}<nowiki>://</nowiki></code>'''}}. {{{info|}}}<!--
+
Line 1:              -->VLC uses this [[protocol]] (or [[access module]]) to read data from a device or network. {{{info|}}}<!--
Line 2: (conditional) -->{{#if:{{{mod|{{lc:{{{1|}}}}}}}}|<br />This protocol is handled by '''{{docmod|{{{mod|{{lc:{{{1}}}}}}}}}}''' [[module]].}}{{#if:{{{altid|}}}<!--
+
Line 2: (conditional) -->{{#if:{{{mod|{{lc:{{{1|}}}}}}}}|<br />This protocol is handled by the '''{{docmod|{{{mod|{{lc:{{{1}}}}}}}}}}''' [[module]].}}
                        -->|&#32;Valid shortcuts for this module at the [[command line]] include '''{{{altid}}}'''<!--
 
                        -->{{#if:{{{altid2|}}}<!--
 
                          -->|, but you can also use '''{{{altid2}}}'''<!--
 
                            -->{{#if:{{{altid3|}}}<!--
 
                              -->|, or '''{{{altid3}}}'''<!--
 
                              -->{{#if:{{{altid4|}}}<!--
 
                                -->|, or '''{{{altid4}}}'''<!--
 
                              -->}}<!--
 
                            -->}}<!--
 
                        -->}}.<!--
 
                      -->}}
 
 
|bgcol=#ffe0e0
 
|bgcol=#ffe0e0
 
|brcol=#e0c0c0<!--
 
|brcol=#e0c0c0<!--
Line 21: Line 10:
  
 
==Usage==
 
==Usage==
  <nowiki>{{protocol |<protocol> |info= |altid= |altid2= |altid3= |altid4= |mod= }}</nowiki>
+
  <nowiki>{{protocol |<protocol> |info= |mod= }}</nowiki>
  
 
It will add it to [[:Category:Protocols]]  
 
It will add it to [[:Category:Protocols]]  
Line 27: Line 16:
 
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 {{Tag|protocol}} 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.
  
 
==Examples==
 
==Examples==
 
Example, [[http]]
 
Example, [[http]]
  <nowiki>{{protocol|HTTP|altid=https}}</nowiki>
+
  <nowiki>{{protocol|HTTP}}</nowiki>
  
 
==See also==
 
==See also==

Revision as of 06:03, 19 April 2019

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

Usage

{{protocol |<protocol> |info=  |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.

Examples

Example, http

{{protocol|HTTP}}

See also