Difference between revisions of "Template:Modinfo"

From AlsaProject
Jump to: navigation, search
m
m (Typo)
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
==The module options for snd-{{{module}}}==
 
{| style="font-family:monospace"
 
{| style="font-family:monospace"
 
| description: 
 
| description: 
| {{{description|''no desciption included''}}}
+
| {{{description|''no description included''}}}
 
|-
 
|-
 
| author: 
 
| author: 
Line 8: Line 9:
 
|license:
 
|license:
 
| {{{license|GPL}}}
 
| {{{license|GPL}}}
{{#if: {{{1|}}} |
+
|
{{!}}-
+
{{#if: {{{1|}}} | {{ModinfoParm|{{{1}}}}} }} {{#if: {{{2|}}} | {{ModinfoParm|{{{2}}}}} }} {{#if: {{{3|}}} | {{ModinfoParm|{{{3}}}}} }} {{#if: {{{4|}}} | {{ModinfoParm|{{{4}}}}} }} {{#if: {{{5|}}} | {{ModinfoParm|{{{5}}}}} }} {{#if: {{{6|}}} | {{ModinfoParm|{{{6}}}}} }} {{#if: {{{7|}}} | {{ModinfoParm|{{{7}}}}} }} {{#if: {{{8|}}} | {{ModinfoParm|{{{8}}}}} }} {{#if: {{{9|}}} | {{ModinfoParm|{{{9}}}}} }} {{#if: {{{10|}}} | {{ModinfoParm|{{{10}}}}} }} {{#if: {{{11|}}} | {{ModinfoParm|{{{11}}}}} }} {{#if: {{{12|}}} | {{ModinfoParm|{{{12}}}}} }} {{#if: {{{13|}}} | {{ModinfoParm|{{{13}}}}} }} {{#if: {{{14|}}} | {{ModinfoParm|{{{14}}}}} }} {{#if: {{{15|}}} | {{ModinfoParm|{{{15}}}}} }} {{#if: {{{16|}}} | {{ModinfoParm|{{{16}}}}} }} {{#if: {{{17|}}} | {{ModinfoParm|{{{17}}}}} }} {{#if: {{{18|}}} | {{ModinfoParm|{{{18}}}}} }} {{#if: {{{19|}}} | {{ModinfoParm|{{{19}}}}} }} {{#if: {{{20|}}} | {{ModinfoParm|{{{20}}}}} }} {{#if: {{{21|}}} | {{ModinfoParm|{{{21}}}}} }} {{#if: {{{22|}}} | {{ModinfoParm|{{{22}}}}} }} {{#if: {{{23|}}} | {{ModinfoParm|{{{23}}}}} }} {{#if: {{{24|}}} | {{ModinfoParm|{{{24}}}}} }} {{#if: {{{25|}}} | {{ModinfoParm|{{{25}}}}} }} {{#if: {{{26|}}} | {{ModinfoParm|{{{26}}}}} }} {{#if: {{{27|}}} | {{ModinfoParm|{{{27}}}}} }} {{#if: {{{28|}}} | {{ModinfoParm|{{{28}}}}} }} {{#if: {{{29|}}} | {{ModinfoParm|{{{29}}}}} }} {{#if: {{{30|}}} | {{ModinfoParm|{{{30}}}}} }}
{{!}} parm: 
+
{{!}} {{{1}}}
+
|}}
+
 
|}<noinclude>
 
|}<noinclude>
 +
 +
 +
----
  
 
This template is intended to display the output of
 
This template is intended to display the output of
 
  <nowiki>modinfo snd-</nowiki>''soundcard''
 
  <nowiki>modinfo snd-</nowiki>''soundcard''
 
in a typewriter style table.
 
in a typewriter style table.
 +
 +
{{Note|For the moment there are '''30''' parameters hard-coded in this template. <br /> You may change it to add support for more parameters.}}
  
 
==Usage==
 
==Usage==
  
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>. All other parameters are the values for parm, as you get it from the <tt>modinfo</tt> output.
+
* You ''need to'' specify the module name: <br /> <tt>module=</tt>
 +
* You ''need to'' give a description and specify the author(s): <br /> <tt>description=</tt> <br /> <tt>author=</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.
  
  <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>
+
''Example:''
 +
  <nowiki>{{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}}
+
{{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>

Latest revision as of 15:03, 5 October 2007

[edit] The module options for snd-{{{module}}}

description:  no description 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 it to add support for more parameters.


[edit] 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:

[edit] 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