Open main menu

Difference between revisions of "Template:PortFeatures"

usage order changed to actual order, added already used invisible buildbot option
m (Add Lastexpress to the list)
(usage order changed to actual order, added already used invisible buildbot option)
Line 29: Line 29:
This template is used to define a port's features, which can later be used/queried in other pages. It additionally shows an infobox with the port's basic information and main features.
This template is used to define a port's features, which can later be used/queried in other pages. It additionally shows an infobox with the port's basic information and main features.


Note that the list of supported engines is not shown in the infobox, but rather in aggregated form on the [[Platforms|platforms]] and [[Platforms/Overview|platforms overview]] pages.
Note that the invisible options and the list of supported engines are not shown in the infobox, but rather in aggregated form on the [[platforms]] and [[Platforms/Overview|platforms overview]] 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>{{</nowiki>PortFeatures|''options''<nowiki>}}</nowiki>
  <nowiki>{{</nowiki>PortFeatures|''options''<nowiki>}}</nowiki>
The available options are:
The available options are:
*Basic information:
*Infobox information:
**'''icon''': name of the icon from the downloads page
**'''name''': the port name
**'''name''': the port name
**'''maintainer''': the backend maintainer
**'''packager''': the port packager
**'''forum''': the ScummVM forum number
**'''backend''': name of the used backend (sdl, ...)
**'''web''': additional webpages
**'''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...
**'''pkgbegin''': beginning of the binary package (before the version number), only if it does not begin with scummvm-
**'''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)
**'''icon''': name of the icon from the downloads page
**'''notes''': brief notes about the port
*Common features:
**'''mp3''': yes/no
**'''mp3''': yes/no
**'''ogg''': yes/no
**'''ogg''': yes/no
**'''flac''': yes/no
**'''flac''': yes/no
**'''uncompressed''': yes/no
**'''uncompressed''': yes/no
**'''web''': additional webpages
**'''maintainer''': the backend maintainer
**'''packager''': the port packager
**'''forum''': the ScummVM forum number
**'''status''': maintained, etc...
**'''firstversion''': first official version
*Invisible options:
**'''backend''': name of the used backend (sdl, ...)
**'''zlib''': yes/no
**'''zlib''': yes/no
**'''plugins''': yes/no
**'''plugins''': yes/no
**'''16bits''': yes/no
**'''16bits''': yes/no
**'''buildbot''': yes/no
**'''notes''': brief notes about the port
*Engines supported:
*Engines supported:
**'''agi''', '''agos''', '''cine''', '''cruise''', '''draci''', '''drascula''', '''gob''', '''groovie''', '''hugo''', '''kyra''', '''lastexpress''', '''lure''', '''m4''', '''made''', '''mohawk''', '''parallaction''', '''queen''', '''saga''', '''sci''', '''scumm''', '''sky''', '''sword1''', '''sword2''', '''sword25''', '''teen''', '''tinsel''', '''toon''', '''touche''', '''tucker''': yes/no
**'''agi''', '''agos''', '''cine''', '''cruise''', '''draci''', '''drascula''', '''gob''', '''groovie''', '''hugo''', '''kyra''', '''lastexpress''', '''lure''', '''m4''', '''made''', '''mohawk''', '''parallaction''', '''queen''', '''saga''', '''sci''', '''scumm''', '''sky''', '''sword1''', '''sword2''', '''sword25''', '''teen''', '''tinsel''', '''toon''', '''touche''', '''tucker''': yes/no
</noinclude>
</noinclude>
736

edits