Difference between revisions of "Template:Modinfo"

From AlsaProject
Jump to: navigation, search
(Usage: "Template:Modinfo" replaced with "Modinfo" (without "Template:"))
Line 22: Line 22:
 
==Usage==
 
==Usage==
  
* You need to specify the <tt>module</tt> name.
+
* You ''need to'' specify the module name: <br /> <tt>module=</tt>
* You need to specify values for <tt>description</tt> and <tt>author</tt>.
+
* You ''need to'' give a description and specify the author(s): <br /> <tt>description=</tt> <br /> <tt>author=</tt>
* If the license is not the ''GNU General Public License'' (GPL) then you may also specify <tt>license</tt>.
+
* You ''may'' specify the license if it is not the ''GNU General Public License'' (GPL): <br /> <tt>license=</tt>
 
* All other parameters are the values for parm, as you get it from the <tt>modinfo</tt> output.
 
* All other parameters are the values for parm, as you get it from the <tt>modinfo</tt> output.
  
 
''Example:''
 
''Example:''
  <nowiki>{{Template:Modinfo
+
  <nowiki>{{Modinfo
 
|module=generic
 
|module=generic
 
|description=ALSA module for a sound card
 
|description=ALSA module for a sound card
Line 38: Line 38:
  
 
''That will give you:''
 
''That will give you:''
{{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}}
+
{{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 10:27, 17 August 2007

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

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


This template is intended to display the output of

modinfo snd-soundcard

in a typewriter style table.

Note: 

For the moment there are 30 parameters hard-coded in this template! You may change this template to add support for more parameters.


Usage

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

Example:

{{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