Difference between revisions of "Template:PortFeatures"

From ScummVM :: Wiki
Jump to navigation Jump to search
(Documented the rest of options)
m
 
(54 intermediate revisions by 11 users not shown)
Line 1: Line 1:
<includeonly>{{Switch|switch={{{switch}}}|default={{{default}}}<!--
<includeonly>{| style="border: 1px solid #6666ff; margin: 0px; padding: 0px; width: 270px; align=right; margin: 3px; float: right;" cellspacing=0
| align="center" colspan=2 style="background-color: #f0f0ff;" | {{PortIcon|{{{icon|}}}}} '''''{{{name}}} Port'''''
|-
|- valign="top"
|style="padding:5px;"| '''Latest Released Version'''
| {{IsEmpty|{{{version|}}} | empty=<i>None</i> | noempty=[https://downloads.scummvm.org/frs/scummvm/{{{version}}}/{{{pkgbegin|scummvm-}}}{{{version}}}{{{pkgend}}} {{{version}}}]}}
|- valign="top"
|style="padding:5px;"| '''Supported Audio Options'''
| {{#switch:{{#explode:{{{mp3|no}}}| }}|yes=MP3,|no=}} {{#switch:{{#explode:{{{ogg|no}}}| }}|yes=OGG,|no=}} {{#switch:{{#explode:{{{flac|no}}}| }}|yes=FLAC,|no=}} {{#switch:{{#explode:{{{uncompressed|no}}}| }}|yes=Uncompressed|no=}}
|- valign="top"
|style="padding:5px;"| '''Additional Webpage(s)'''
| {{{web|<i>None</i>}}}
|- valign="top"
|style="padding:5px;"| '''Maintainer(s)'''
| {{{maintainer|<i>None</i>}}}
|- valign="top"
|style="padding:5px;"| '''Packager(s)'''
| {{{packager|<i>None</i>}}}
|- valign="top"
|style="padding:5px;"| '''Forum'''
| {{IsEmpty|{{{forum}}}|empty=<i>None</i>|noempty=[https://forums.scummvm.org/viewforum.php?f={{{forum}}} Port Forum]}}
|- valign="top"
|style="padding:5px;"| '''Status'''
| {{{status|<i>Unknown</i>}}}{{#ifeq:{{{status}}}|Unmaintained|[[Category:Unmaintained Platforms]]}}
|- valign="top"
|style="padding:5px;"| '''First Official Version'''
| {{IsEmpty|{{{firstversion}}}|empty=<i>None</i>|noempty=[https://downloads.scummvm.org/frs/scummvm/{{{firstversion}}}/{{{pkgbegin|scummvm-}}}{{{firstversion}}}{{{pkgend}}} {{{firstversion}}}]}}
|}[[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.


Basic information:
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.
-->|name={{{name}}}<!--
-->|maintainer={{{maintainer}}}<!--
-->|forum={{{forum}}}<!--
-->|backend={{{backend}}}<!--
-->|web={{{web}}}<!--
-->|firstversion={{{firstversion}}}<!--
-->|version={{{version}}}<!--
-->|status={{{status}}}<!--
 
Common features:
-->|mp3={{{mp3|no}}}<!--
-->|ogg={{{ogg|no}}}<!--
-->|flac={{{flac|no}}}<!--
-->|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|wip}}}<!--
-->|parallaction={{{parallaction|?}}}<!--
-->|queen={{{queen|?}}}<!--
-->|saga={{{saga|?}}}<!--
-->|sci={{{sci|wip}}}<!--
-->|scumm={{{scumm|?}}}<!--
-->|sky={{{sky|?}}}<!--
-->|sword1={{{sword1|?}}}<!--
-->|sword2={{{sword2|?}}}<!--
-->|tinsel={{{tinsel|wip}}}<!--
-->|touche={{{touche|?}}}<!--
-->|tucker={{{tucker|?}}}<!--
-->}}</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><includeonly>{{PortFeatures|switch={{{switch}}}|default={{{default}}}</nowiki>
  <nowiki>{{</nowiki>PortFeatures|''options''<nowiki>}}</nowiki>
ADD OPTIONS HERE
<nowiki>}}</includeonly><noinclude></nowiki>
WRITE THE REST OF THE PAGE HERE
<nowiki></noinclude></nowiki>
The available options are:
The available options are:
*Basic information:
*Infobox information:
**name: the port name
**'''icon''': name of the icon from the downloads page
**maintainer: the port maintainer
**'''name''': the port name
**forum: the ScummVM forum number
**'''version''': last released version (usually <nowiki>{{StableVersion}}</nowiki> if the port is up to date with ScummVM)
**backend: type of backend used (SDL, Custom, ...)
**'''pkgbegin''': beginning of the binary package (before the version number), only if it does not begin with scummvm-
**web: additional webpages
**'''pkgend''': end of the binary package (after the version number)
**firstversion: first official version
**'''mp3''': yes/no
**version: last released version (usually <nowiki>{{StableVersion}}</nowiki> if the port is up to date with ScummVM)
**'''ogg''': yes/no
**status: maintained, etc...
**'''flac''': yes/no
*Common features:
**'''uncompressed''': yes/no
**mp3: yes/no
**'''web''': additional webpages
**ogg: yes/no
**'''maintainer''': the backend maintainer
**flac: yes/no
**'''packager''': the port packager
**zlib: yes/no
**'''forum''': the ScummVM forum number
**plugins: yes/no
**'''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:
*Engines supported:
**agi, agos, etc...: 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 13:25, 2 March 2023

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:

Retrieved from "https://wiki.scummvm.org/index.php?title=Template:PortFeatures&oldid=35908"