Difference between revisions of "Template:PortFeatures"

From ScummVM :: Wiki
Jump to navigation Jump to search
m (Document the 16bits feature)
 
(20 intermediate revisions by 8 users not shown)
Line 4: Line 4:
 
|- valign="top"
 
|- valign="top"
 
|style="padding:5px;"| '''Latest Released Version'''
 
|style="padding:5px;"| '''Latest Released Version'''
| {{IsEmpty|{{{version|}}} | empty=<i>None</i> | noempty=[http://prdownloads.sourceforge.net/scummvm/{{{pkgbegin|scummvm-}}}{{{version}}}{{{pkgend}}}?download {{{version}}}]}}
+
| {{IsEmpty|{{{version|}}} | empty=<i>None</i> | noempty=[http://www.scummvm.org/frs/scummvm/{{{version}}}/{{{pkgbegin|scummvm-}}}{{{version}}}{{{pkgend}}} {{{version}}}]}}
 
|- valign="top"
 
|- valign="top"
 
|style="padding:5px;"| '''Supported Audio Options'''
 
|style="padding:5px;"| '''Supported Audio Options'''
Line 22: Line 22:
 
|- valign="top"
 
|- valign="top"
 
|style="padding:5px;"| '''Status'''
 
|style="padding:5px;"| '''Status'''
| {{{status|<i>Unknown</i>}}}
+
| {{{status|<i>Unknown</i>}}}{{#ifeq:{{{status}}}|Unmaintained|[[Category:Unmaintained Platforms]]}}
 
|- valign="top"
 
|- valign="top"
 
|style="padding:5px;"| '''First Official Version'''
 
|style="padding:5px;"| '''First Official Version'''
| {{IsEmpty|{{{firstversion}}}|empty=<i>None</i>|noempty=[http://prdownloads.sourceforge.net/scummvm/{{{pkgbegin|scummvm-}}}{{{firstversion}}}{{{pkgend}}}?download {{{firstversion}}}]}}
+
| {{IsEmpty|{{{firstversion}}}|empty=<i>None</i>|noempty=[https://www.scummvm.org/frs/scummvm/{{{firstversion}}}/{{{pkgbegin|scummvm-}}}{{{firstversion}}}{{{pkgend}}} {{{firstversion}}}]}}
 
|}[[Category:Platforms|{{{name}}} Port]]{{#ifeq:{{{version}}}|{{StableVersion}}||[[Category:Outdated Ports|{{{name}}} Port]]}}</includeonly><noinclude>
 
|}[[Category:Platforms|{{{name}}} Port]]{{#ifeq:{{{version}}}|{{StableVersion}}||[[Category:Outdated Ports|{{{name}}} Port]]}}</includeonly><noinclude>
 
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''', '''kyra''', '''lure''', '''m4''', '''made''', '''parallaction''', '''queen''', '''saga''', '''sci''', '''scumm''', '''sky''', '''sword1''', '''sword2''', '''teenagent''', '''tinsel''', '''touche''', '''tucker''': yes/no
+
**'''agi''', '''agos''', '''avalanche''', '''cge''', '''cine''', '''composer''', '''cruise''', '''draci''', '''drascula''', '''dreamweb''', '''fullpipe''', '''gob''', '''groovie''', '''hopkins''', '''hugo''', '''kyra''', '''lastexpress''', '''lure''', '''made''', '''mohawk''', '''mortevielle''', '''neverhood''', '''parallaction''', '''pegasus''', '''queen''', '''saga''', '''sci''', '''scumm''', '''sky''', '''sword1''', '''sword2''', '''sword25''', '''teenagent''', '''testbed''', '''tinsel''', '''toltecs''', '''tony''', '''toon''', '''touche''', '''tsage''', '''tucker''', '''wintermute''', '''zvision''': yes/no
 +
 
 +
== Automatic Categorization ==
 +
 
 +
In order to reduce the workload of Wiki editors and ensure that the Wiki is up to date, the following categories are automatically applied:
 +
 
 +
* [[:Category:Unmaintained Platforms]]: if the ''status'' is "Unmaintained".
 +
* [[:Category:Outdated Ports]]: if the ''version'' does not match the value of [[:Template:StableVersion]].
 +
 
 +
[[Category:Information templates]]
 
</noinclude>
 
</noinclude>

Latest revision as of 18:12, 14 June 2020

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 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 pages.

Usage

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

{{PortFeatures|options}}

The available options are:

  • Infobox information:
    • icon: name of the icon from the downloads page
    • name: the port name
    • version: last released version (usually {{StableVersion}} if the port is up to date with ScummVM)
    • pkgbegin: beginning of the binary package (before the version number), only if it does not begin with scummvm-
    • pkgend: end of the binary package (after the version number)
    • mp3: yes/no
    • ogg: yes/no
    • flac: 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
    • plugins: yes/no
    • 16bits: yes/no
    • buildbot: yes/no
    • notes: brief notes about the port
  • Engines supported:
    • agi, agos, avalanche, cge, cine, composer, cruise, draci, drascula, dreamweb, fullpipe, gob, groovie, hopkins, hugo, kyra, lastexpress, lure, made, mohawk, mortevielle, neverhood, parallaction, pegasus, queen, saga, sci, scumm, sky, sword1, sword2, sword25, teenagent, testbed, tinsel, toltecs, tony, toon, touche, tsage, tucker, wintermute, zvision: yes/no

Automatic Categorization

In order to reduce the workload of Wiki editors and ensure that the Wiki is up to date, the following categories are automatically applied: