Difference between revisions of "Matrix:Description"

From AlsaProject
Jump to: navigation, search
m (Module page (Matrix:Module-*): Typo)
(Module page (Matrix:Module-*): Architecture added; This time with a link to find existing architectures; DONT' FORGET TO ADD THEM TO YOUR MODULE PAGES!)
 
(4 intermediate revisions by one user not shown)
Line 5: Line 5:
 
===Vendor page (Matrix:Vendor-*)===
 
===Vendor page (Matrix:Vendor-*)===
  
Each page must start with including this [[Matrix:VendorBegin|template]] :
+
Each page must start with including the [[Matrix:VendorBegin]] template and end with [[Matrix:VendorEnd]].
 +
'''<nowiki>{{Matrix:VendorBegin}}</nowiki>'''
 +
 +
<nowiki>== Soundcard List for [http://</nowiki>''link.to/vendor_here/'' ''Vendor_here''] ==
 +
 +
<nowiki>{| class="MatrixTable"
 +
! Product
 +
! Chipset(s)
 +
! Driver &amp; Docs
 +
! Tags, Notes
 +
|-
 +
|
 +
{| class="MatrixTableInner"
 +
| [http://</nowiki>''<nowiki>www.vendor.net/card-1a_here/</nowiki>'' ''card-1a_here'']
 +
<nowiki>|-
 +
| [http://</nowiki>''<nowiki>www.vendor.net/card-1b_here/</nowiki>'' ''card-1b_here'']
 +
<nowiki>|-
 +
|}
 +
|
 +
{| class="MatrixTableInner"
 +
| </nowiki>''Card-1_here''
 +
<nowiki>|-
 +
|}
 +
| [[Matrix:Module-</nowiki>''specific_module_here''<nowiki>|Details]]
 +
|  [[Matrix:</nowiki>''Tag-tag_here''|[''tag_here'']]] e.g. ''<nowiki>[[Matrix:Tag-PCI|[PCI]]]</nowiki>''
 +
<nowiki>|-
 +
|
 +
| … </nowiki>''next sound card''
 +
<nowiki>|}</nowiki>
 +
 +
'''<nowiki>{{Matrix:VendorEnd}}</nowiki>'''
  
<nowiki>{{Matrix:VendorBegin}}</nowiki>
+
If you want to create a new vendor page, you may copy&nbsp;&amp; paste the text above (and suit it to your needs) or take a look at already existing [[Matrix:Main#Vendors|vendor pages]].
  
Each page must end with including this [[Matrix:VendorEnd|template]] :
+
===Module page (Matrix:Module-*)===
  
<nowiki>{{Matrix:VendorEnd}}</nowiki>
+
Each module page holds information specific to the described module.
  
===Module page (Matrix:Module-*)===
+
A good layout is to include the TOC (table of contents) statemant right after the [[Special:ALSAPrefixindex/Category:Architecture-|architecture]] categories on top, followed by modules specific information.
 +
The last part '''must be''' the information given by the '''modinfo''' command using the [[Template:Modinfo|Modinfo template]], followed by generic ALSA sound card information using the [[Matrix:Soundcard|Soundcard template]].
 +
Additional links or information that you want to be on the bottom may follow.
  
Include the information given by '''modinfo''' command into [[Template:Modinfo]] parameters:
+
<nowiki>[[Category:Architecture-</nowiki>''arch''<nowiki>]]
  
 +
{| align="right"
 +
| __TOC__
 +
|} </nowiki>
 +
 +
''<nowiki>==Specific information about this ALSA module_here==
 +
 +
… add your specific information_here …
 +
 +
===More information===
 +
 +
… add more of your specific information here …
 +
 +
==Status of developement==
 +
 +
… your ALSA module developement status …
 +
 +
===And so on===
 +
 +
… you have even more to say? …</nowiki>''
 +
 
  <nowiki>{{Modinfo</nowiki>
 
  <nowiki>{{Modinfo</nowiki>
 
  |module=''module name''
 
  |module=''module name''
Line 22: Line 74:
 
  |author=''author''
 
  |author=''author''
 
  |''name of first module param'': ''description of first module param''
 
  |''name of first module param'': ''description of first module param''
  | etc
+
  |
  |''name of tenth module param'': ''description of tenth module param''
+
  |''name of tenth module param'': ''description of last module param''
 
  <nowiki>}}</nowiki>
 
  <nowiki>}}</nowiki>
 +
 +
<nowiki>{{</nowiki>Matrix:Soundcard|name=''full Card Name_here''|module=''module_without_"snd-"_here''<nowiki>}}</nowiki>
 +
<nowiki>*[http://</nowiki>''my.homepage.net/~me/mymodule-additional-notes.html'' ''My additional Notes for snd-mymodule''<nowiki>]</nowiki>
 +
 +
<nowiki>… information that you want to appear on the bottom of the page (what can that be anyway?) …</nowiki>
  
Also link to the [[Matrix:Soundcard|soundcard template]] should be provided:
+
{{Note|The last section of template [[Matrix:Soundcard]] is '''Links''', with generic links and specific links. If you have additional specific links to your module page, add them directly after the template (no empty lines inbetween).}}
  
<nowiki>{{</nowiki>Matrix:Soundcard|name=''full card name here''|module=''module_without_snd_here''<nowiki>}}</nowiki>
+
The ''absolute minimum'' of a module page is to include an [[Special:ALSAPrefixindex/Category:Architecture-|architecture]] category, [[Template:Modinfo]] and [[Matrix:Soundcard]].
  
Note: The last section of template [[Matrix:Soundcard]] is '''Links''', with generic links and specific links. If you have additional specific links to your module page, add them directly after the template.
+
<nowiki>[[Category:Architecture-</nowiki>''arch'']]
 
+
Example:
+
<nowiki>{{Modinfo</nowiki>
 +
|module=''module name''
 +
|description=''description''
 +
|author=''author''
 +
|''name of first module param'': ''description of first module param''
 +
| …
 +
|''name of tenth module param'': ''description of last module param''
 +
<nowiki>}}</nowiki>
 +
 +
<nowiki>{{</nowiki>Matrix:Soundcard|name=''full Card Name_here''|module=''module_without_"snd-"_here''<nowiki>}}</nowiki>
  
<nowiki>{{</nowiki>Matrix:Soundcard|name=''mysoundcard''|module=''mymodule''<nowiki>}}</nowiki>
+
If you are writing a new modules page, you may copy&nbsp;&amp; paste the text above (and suit it to your needs) or take a look at already existing [[Matrix:Main#Drivers|module pages]].
<nowiki>[http://my.homepage.net/~me/mymodule-additional-notes.html</nowiki> My additional Notes for snd-mymodule<nowiki>]</nowiki>
+

Latest revision as of 12:27, 24 January 2008

[edit] Universal Soundcard Description

All pages for the Soundcard Matrix MUST BE stored in the Matrix namespace, so the wiki page name must start with "Matrix:"!

[edit] Vendor page (Matrix:Vendor-*)

Each page must start with including the Matrix:VendorBegin template and end with Matrix:VendorEnd.

{{Matrix:VendorBegin}}

== Soundcard List for [http://link.to/vendor_here/ Vendor_here] ==

{| class="MatrixTable"
! Product
! Chipset(s)
! Driver & Docs
! Tags, Notes
|-
|
{| class="MatrixTableInner"
| [http://www.vendor.net/card-1a_here/ card-1a_here]
|-
| [http://www.vendor.net/card-1b_here/ card-1b_here]
|-
|}
|
{| class="MatrixTableInner"
| Card-1_here
|-
|}
| [[Matrix:Module-specific_module_here|Details]]
|  [[Matrix:Tag-tag_here|[tag_here]]] e.g. [[Matrix:Tag-PCI|[PCI]]]
|-
|
| … next sound card
|}

{{Matrix:VendorEnd}}

If you want to create a new vendor page, you may copy & paste the text above (and suit it to your needs) or take a look at already existing vendor pages.

[edit] Module page (Matrix:Module-*)

Each module page holds information specific to the described module.

A good layout is to include the TOC (table of contents) statemant right after the architecture categories on top, followed by modules specific information. The last part must be the information given by the modinfo command using the Modinfo template, followed by generic ALSA sound card information using the Soundcard template. Additional links or information that you want to be on the bottom may follow.

[[Category:Architecture-arch]]

{| align="right"
| __TOC__
|} 

==Specific information about this ALSA module_here==

… add your specific information_here …

===More information===

… add more of your specific information here …

==Status of developement==

… your ALSA module developement status …

===And so on===

… you have even more to say? …

{{Modinfo
|module=module name
|description=description
|author=author
|name of first module param: description of first module param
| …
|name of tenth module param: description of last module param
}}

{{Matrix:Soundcard|name=full Card Name_here|module=module_without_"snd-"_here}}
*[http://my.homepage.net/~me/mymodule-additional-notes.html My additional Notes for snd-mymodule]

… information that you want to appear on the bottom of the page (what can that be anyway?) …
Note: 

The last section of template Matrix:Soundcard is Links, with generic links and specific links. If you have additional specific links to your module page, add them directly after the template (no empty lines inbetween).


The absolute minimum of a module page is to include an architecture category, Template:Modinfo and Matrix:Soundcard.

[[Category:Architecture-arch]]

{{Modinfo
|module=module name
|description=description
|author=author
|name of first module param: description of first module param
| …
|name of tenth module param: description of last module param
}}

{{Matrix:Soundcard|name=full Card Name_here|module=module_without_"snd-"_here}}

If you are writing a new modules page, you may copy & paste the text above (and suit it to your needs) or take a look at already existing module pages.

Custom Search
Personal tools
Namespaces

Variants
Actions
Navigation
wiki
Toolbox