(Changed some of our example data to appear more bogus) |
(Added a bit of policy regarding package_name, name, and package_maintainer) |
||
| Line 1: | Line 1: | ||
<noinclude>{{for|this template|Template:Infobox package}}</noinclude> | <noinclude>{{for|this template|Template:Infobox package}}</noinclude> | ||
== Full-fledged example == | |||
'''Template:Infobox package''' is used to describe [[package]]s in [[Fedora]]. Only the <code>package_name</code> tag is required, but contributors are encouraged to add as much information as possible. | |||
== 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 maintainer|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 === | |||
{{Infobox package | {{Infobox package | ||
| name = Fictional Package Manager | | name = Fictional Package Manager | ||
| Line 13: | Line 30: | ||
| irc = [irc://irc.freenode.net/#yum #yum] on [http://www.freenode.net irc.freenode.net] | | irc = [irc://irc.freenode.net/#yum #yum] on [http://www.freenode.net irc.freenode.net] | ||
}} | }} | ||
== Basic example == | === Basic example === | ||
{{Infobox package | {{Infobox package | ||
| name = Fictional Package Manager | | name = Fictional Package Manager | ||
| Line 20: | Line 37: | ||
| added = [[Fedora 13]] | | added = [[Fedora 13]] | ||
}} | }} | ||
== | === Minimum example === | ||
{{Infobox package | {{Infobox package | ||
| package_name = fictional | | package_name = fictional | ||
}} | }} | ||
Revision as of 23:43, 27 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.
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 | |
| |
| RPM package | fictional
|
| Maintainer | Aaron Faanes |
| Added in | Fedora 12 |
| Removed in | Fedora 13 |
| Upstream bugs | http://yum.baseurl.org/report |
| Mailing list | http://lists.baseurl.org/mailman/listinfo/yum |
| IRC | #yum on irc.freenode.net |
| Bugs • Bodhi • Koji | |
Basic example
| Fictional Package Manager | |
|
| |
| RPM package | fictional
|
| Bugs • Bodhi • Koji | |
Minimum example
| Infobox package/doc | |
|
| |
| RPM package | fictional
|
| Bugs • Bodhi • Koji | |