Template:Infobox package/doc

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(Linked to Template:Infobox package directly, removing the need for a "See also")
(Renamed "url" fields to "website")
Line 23: Line 23:
 
| package_removed = [[Fedora 13]]
 
| package_removed = [[Fedora 13]]
  
| url = http://yum.baseurl.org/
+
| website = http://yum.baseurl.org/
 
| bug_tracker = http://yum.baseurl.org/report
 
| bug_tracker = http://yum.baseurl.org/report
 
| mailing_list = http://lists.baseurl.org/mailman/listinfo/yum
 
| mailing_list = http://lists.baseurl.org/mailman/listinfo/yum
Line 32: Line 32:
 
| name = Fictional Package Manager
 
| name = Fictional Package Manager
 
| package_name = fictional
 
| package_name = fictional
| url = http://yum.baseurl.org/
+
| website = http://yum.baseurl.org/
 
| added = [[Fedora 13]]
 
| added = [[Fedora 13]]
 
}}
 
}}

Revision as of 07:13, 28 June 2010

Template:Infobox package is used to describe packages in Fedora. Only the package_name tag is required, but contributors are encouraged to add as much information as possible.

Contents

Fields

This template has conventions regarding how some fields should be specified. To ensure the quality of the Fedora Project wiki, these conventions should be followed whenever possible.

package_maintainer should specify a link to the package owner. The package owner can be found using the Fedora Package Database. Ideally, the maintainer's user page on the Fedora Project wiki should be used. If the maintainer does not have a user page, this field should should point to the maintainer's account details on the Fedora Accounts System, such as https://admin.fedoraproject.org/accounts/user/view/dafrito. Do not link to the maintainer's personal homepage or email address.

package_name should specify the official package name, in the form that would be provided to yum. The package name should not be capitalized unless the capitalization is required. The package name should never contain links or miscellaneous information.

name should contain the human-readable name of the packaged application, program, or library. Always prefer the official or formal name given or used by upstream.

If upstream does not provide or have a formal name, convert the package name to a title: capitalize each word appropriately, convert dashes and underscores to spaces, and omit articles such as "a" or "the" unless they're included in the name, and expand abbreviations. These rules should be broken if a more recognizable or natural name can be formed, but do not include extraneous information that is not part of the title: prefer Firefox over "Firefox web browser".

Version-specific information such as version numbers, code-names, and build suffixes (RC, beta, alpha, etc.) should usually not be included unless there is a need to be specific. This may be necessary if there are currently multiple, packaged versions of the same application, or if there is a fork.

Examples

Full-fledged example

Fictional Package Manager
Echo-package-48px.png

RPM package fictional
Maintainer Aaron Faanes
Added in Fedora 12
Removed in Fedora 13

Website http://yum.baseurl.org/
Upstream bugs http://yum.baseurl.org/report
Mailing list http://lists.baseurl.org/mailman/listinfo/yum
IRC #yum on irc.freenode.net

BugsBodhiKoji

Basic example

Fictional Package Manager
Echo-package-48px.png

RPM package fictional
Website http://yum.baseurl.org/

BugsBodhiKoji

Minimum example

Infobox package/doc
Echo-package-48px.png

RPM package fictional

BugsBodhiKoji