Difference between revisions of "Template:PortFeatures"

From ScummVM :: Wiki
Jump to navigation Jump to search
m (Add the uncompressed audio option)
(Remove all the black magic required to retrieve individual attributes without DPL, and updated the documentation)
Line 1: Line 1:
<includeonly>{{IsEmpty|{{Switch|switch={{{switch}}}<!--
<includeonly></includeonly><noinclude>
 
This is a dummy template used to define a port's features, which can later be used/queried in other pages.
Basic information:
-->|name={{{name}}}<!--
-->|maintainer={{{maintainer|}}}<!--
-->|forum={{{forum|}}}<!--
-->|backend={{{backend|}}}<!--
-->|web={{{web|}}}<!--
-->|firstversion={{{firstversion|}}}<!--
-->|version={{{version|}}}<!--
-->|status={{{status|}}}<!--
-->|pkgbegin={{{pkgbegin|scummvm-}}}<!--
-->|pkgend={{{pkgend|}}}<!--
 
Common features:
-->|mp3={{{mp3|no}}}<!--
-->|ogg={{{ogg|no}}}<!--
-->|flac={{{flac|no}}}<!--
-->|uncompressed={{{uncompressed|yes}}}<!--
-->|zlib={{{zlib|no}}}<!--
-->|plugins={{{plugins|no}}}<!--
 
Supported engines:
-->|agi={{{agi|?}}}<!--
-->|agos={{{agos|?}}}<!--
-->|cine={{{cine|?}}}<!--
-->|cruise={{{cruise|?}}}<!--
-->|drascula={{{drascula|?}}}<!--
-->|gob={{{gob|?}}}<!--
-->|groovie={{{groovie|?}}}<!--
-->|igor={{{igor|wip}}}<!--
-->|kyra={{{kyra|?}}}<!--
-->|lure={{{lure|?}}}<!--
-->|m4={{{m4|wip}}}<!--
-->|made={{{made|?}}}<!--
-->|parallaction={{{parallaction|?}}}<!--
-->|queen={{{queen|?}}}<!--
-->|saga={{{saga|?}}}<!--
-->|sci={{{sci|wip}}}<!--
-->|scumm={{{scumm|?}}}<!--
-->|sky={{{sky|?}}}<!--
-->|sword1={{{sword1|?}}}<!--
-->|sword2={{{sword2|?}}}<!--
-->|teen={{{teen|wip}}}<!--
-->|tinsel={{{tinsel|?}}}<!--
-->|touche={{{touche|?}}}<!--
-->|tucker={{{tucker|?}}}<!--
-->}}|empty={{{default|}}}}}</includeonly><noinclude>
Use this template to define a port's features, which can later be included in several pages.
=Usage=
=Usage=
To write the port features, copy this to your port's page:
To write the port features, copy this to your port's page:
  <nowiki>&lt;includeonly&gt;{{PortFeatures|switch={{{switch}}}|default={{{default|}}}</nowiki>
  <nowiki>{{</nowiki>PortFeatures|''options''<nowiki>}}</nowiki>
ADD OPTIONS HERE
<nowiki>}}&lt;/includeonly&gt;&lt;noinclude&gt;</nowiki>
WRITE THE REST OF THE PAGE HERE
<nowiki>&lt;/noinclude&gt;</nowiki>
The available options are:
The available options are:
*Basic information:
*Basic information:
**name: the port name
**'''name''': the port name
**maintainer: the port maintainer
**'''maintainer''': the port maintainer
**forum: the ScummVM forum number
**'''forum''': the ScummVM forum number
**backend: type of backend used (SDL, Custom, ...)
**'''backend''': name of the used backend (sdl, ...)
**web: additional webpages
**'''web''': additional webpages
**firstversion: first official version
**'''firstversion''': first official version
**version: last released version (usually <nowiki>{{StableVersion}}</nowiki> if the port is up to date with ScummVM)
**'''version''': last released version (usually <nowiki>{{StableVersion}}</nowiki> if the port is up to date with ScummVM)
**status: maintained, etc...
**'''status''': maintained, etc...
**pkgbegin: beginning of the binary package (before the version number)
**'''pkgbegin''': beginning of the binary package (before the version number)
**pkgend: end of the binary package (after the version number)
**'''pkgend''': end of the binary package (after the version number)
*Common features:
*Common features:
**mp3: yes/no
**'''mp3''': yes/no
**ogg: yes/no
**'''ogg''': yes/no
**flac: yes/no
**'''flac''': yes/no
**zlib: yes/no
**'''uncompressed''': yes/no
**plugins: yes/no
**'''zlib''': yes/no
**'''plugins''': yes/no
*Engines supported:
*Engines supported:
**agi, agos, etc...: yes/no
**'''agi''', '''agos''', '''cine''', '''cruise''', '''drascula''', '''gob''', '''groovie''', '''igor''', '''kyra''', '''lure''', '''m4''', '''made''', '''parallaction''', '''queen''', '''saga''', '''sci''', '''scumm''', '''sky''', '''sword1''', '''sword2''', '''teen, '''tinsel''', '''touche''', '''tucker''': yes/no
</noinclude>
</noinclude>

Revision as of 19:14, 22 September 2009

This is a dummy template used to define a port's features, which can later be used/queried in other pages.

Usage

To write the port features, copy this to your port's page:

{{PortFeatures|options}}

The available options are:

  • Basic information:
    • name: the port name
    • maintainer: the port maintainer
    • forum: the ScummVM forum number
    • backend: name of the used backend (sdl, ...)
    • web: additional webpages
    • firstversion: first official version
    • version: last released version (usually {{StableVersion}} if the port is up to date with ScummVM)
    • status: maintained, etc...
    • pkgbegin: beginning of the binary package (before the version number)
    • pkgend: end of the binary package (after the version number)
  • Common features:
    • mp3: yes/no
    • ogg: yes/no
    • flac: yes/no
    • uncompressed: yes/no
    • zlib: yes/no
    • plugins: yes/no
  • Engines supported:
    • agi, agos, cine, cruise, drascula, gob, groovie, igor, kyra, lure, m4, made, parallaction, queen, saga, sci, scumm, sky, sword1, sword2, teen, tinsel, touche, tucker: yes/no