Gentoo Wiki:Article Blueprints/Software

From Gentoo Wiki
Jump to: navigation, search

The following is a semi-structured, rough software article blueprint users can copy and paste to create new software articles. In general, it follows the Wiki guidelines (review if necessary). Be sure to substitute category/package below with the category/package being used. Be aware some information provided in the blueprint may not be needed; it is always easier to delete unneeded content than to type out new content.

  • Before copying it is possible to demo the Software article blueprint by going here.
Important
Not every software article will fit into the outline of this blueprint; it is simply a rough framework to assist in article creation. Modify as needed!

Suggestion for the article's Summary field: Initial creation of the <Software_title> article. Show it some love by improving it!

{{Stub}}
{{InfoBox stack
|{{InfoBox homepage|http://url/to/homepage|header=true}}
|{{InfoBox package|category/package}}
|{{InfoBox wikipedia|SoftwareTitleOnTheWikipedia}}
|{{InfoBox github|Project/SoftwarePackage}}
|{{InfoBox ohloh}}
}}

(Introductory paragraph goes here. Describe the concept/package/software/tool/utility here.)

__TOC__

== Installation ==

=== Kernel ===

(Optional section. Remove if not applicable.)

{{KernelBox|title=Enable support for <Software_title>|1=

Write menuconfig instructions here.

}}

=== USE flags ===

(Optional section. Remove if not applicable.)

{{USEflag|package=category/package}}

=== Emerge ===

{{Emerge|category/package}}

=== Additional software ===

(Explain software that can be paired or used with the main software package described in this article. This could be anything from a small plugin to a complete integration.)

== Configuration ==

(Explain how to configure the package/software/tool/utility in this section.)

=== Environment variables ===

* <var>VAR1</var>
* <var>VAR2</var>

=== Files ===

* {{Path|/etc/global_file_example}} - Global (system wide) configuration file.
* {{Path|~/.local_file_example}} - Local (per user) configuration file.

=== Service ===

(Provide instructions on starting/stopping and enabling/disabling the software's service. This is only really necessary if it if the software includes a daemon for certain tasks.)

==== OpenRC ====

==== runit ====

==== systemd ====

== Usage ==

(Explain how to use the package/software/tool/utility in this section.)

=== Invocation ===

(Remove this section if not applicable.)

== Troubleshooting ==

(Troubleshoot issues in this section. Separate issues by best describing the error with a new section name. Remove if no issues are known.)

=== Issue 1 ===

When X happens, Y is how you fix it.

== Removal ==

(Explain how to properly remove the software. If this section needs more than an 'emerge -C' command each step should be explained in detail so that no trace of the software remains on the system.)

=== Unmerge ===

{{Unmerge|category/package}}

== See also ==

* [[Article_name]] - (Link to related Gentoo Wiki articles using bullet points for each link in this section; each link should be local to the Wiki. Use a dash to separate the link from a reason why the link was decided upon.)

== External resources ==

* (Link to external resources (outside the Wiki) using bullet points in this section. It is common for the information in this section to full sentences that are links.)

== References ==

(Optional section. Remove this section if references are not used. This section is used to cite factual information. This information is found outside the Gentoo Wiki and used to back up truth claims. The actual references themselves still be littered throughout the main article.)

{{reflist}}

[[Category:Software]]

See also