Difference between revisions of "Template:Modinfo"

From AlsaProject
Jump to: navigation, search
(Chapter added)
(update for module=something)
Line 58: Line 58:
 
|}<noinclude>
 
|}<noinclude>
  
==Template:Modinfo==
 
  
 
This template is intended to display the output of
 
This template is intended to display the output of
Line 68: Line 67:
 
==Usage==
 
==Usage==
  
 +
* You need to specify the <tt>module</tt> name.
 
* You need to specify values for <tt>description</tt> and <tt>author</tt>.
 
* You need to specify values for <tt>description</tt> and <tt>author</tt>.
 
* If the license is not the ''GNU General Public License'' (GPL) then you may also specify <tt>license</tt>.
 
* If the license is not the ''GNU General Public License'' (GPL) then you may also specify <tt>license</tt>.
Line 73: Line 73:
  
 
''Example:''
 
''Example:''
  <nowiki>{{Template:Modinfo|description=ALSA module for a sound card|author=Mr. Smith|parm1:on or off|parm2:0 or 1|parm3:debug or not debug, that is the question}}</nowiki>
+
  <nowiki>{{Template:Modinfo|module=generic|description=ALSA module for a sound card|author=Mr. Smith|parm1:on or off|parm2:0 or 1|parm3:debug or not debug, that is the question}}</nowiki>
  
 
''That will give you:''
 
''That will give you:''
{{Template:Modinfo|description=ALSA module for a sound card|author=Mr. Smith|parm1:on or off|parm2:0 or 1|parm3:debug or not debug, that is the question}}
+
{{Template:Modinfo|module=generic|description=ALSA module for a sound card|author=Mr. Smith|parm1:on or off|parm2:0 or 1|parm3:debug or not debug, that is the question}}
  
 
</noinclude>
 
</noinclude>

Revision as of 20:53, 29 July 2007

The module options for snd-{{{module}}}

description:  no desciption included
author:  author unknown
license: GPL
parm: 
parm: 
parm: 
parm: 
parm: 
parm: 
parm: 
parm: 
parm: 
parm: 
parm: 
parm: 
parm: 
parm: 
parm: 


This template is intended to display the output of

modinfo snd-soundcard

in a typewriter style table.

Importaint: 

For the moment there are 15 parameters hard-coded in this template!


Usage

  • You need to specify the module name.
  • You need to specify values for description and author.
  • If the license is not the GNU General Public License (GPL) then you may also specify license.
  • All other parameters are the values for parm, as you get it from the modinfo output.

Example:

{{Template:Modinfo|module=generic|description=ALSA module for a sound card|author=Mr. Smith|parm1:on or off|parm2:0 or 1|parm3:debug or not debug, that is the question}}

That will give you:

The module options for snd-generic

description:  ALSA module for a sound card
author:  Mr. Smith
license: GPL
parm: parm1:on or off
parm: parm2:0 or 1
parm: parm3:debug or not debug, that is the question


Custom Search
Personal tools
Namespaces

Variants
Actions
Navigation
wiki
Toolbox