Gentoo Wiki:Article blueprints/Software

From Gentoo Wiki
Jump to:navigation Jump to: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.

After copy-pasting the blueprint, remember to remove the comments that are between the <!-- --> tags. Before copying, it is possible to demo this blueprint by going here.

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!

Common section names can be added to an article where appropriate, even though those section names aren't in this blueprint yet. Take a look at well-formed, preexisting articles to get an idea of how things can be laid out.
{{Stub}} <!-- Mark article as a stub if it is just starting off with little content. -->

{{InfoBox stack
|{{InfoBox project|project_name|header=true}} <!-- remember the "|header=true" parameter in the first section -->
|{{InfoBox homepage|https://homepage/url/}} <!-- use http only if https doesn't work -->
|{{InfoBox odoc|https://official/documentation/project/url/}}
|{{InfoBox package|category/package}}
|{{InfoBox guide|guide_article}}
|{{InfoBox wikipedia|Wikipedia_page_title}}
|{{InfoBox gitweb|Gentoo_gitweb_projectname.git}} <!-- for projects on -->
|{{InfoBox gitweb|https://site/proj/projectname.git/url/|raw=true}}
|{{InfoBox github|project/software_package}}
|{{InfoBox gitlab|proj/repo}}
|{{InfoBox wiki|}}
|{{InfoBox bugs|https://bug/tracker/url/}}
|{{InfoBox manpage|man1/cat.1}}
|{{InfoBox irc|}}
|{{InfoBox blog|proj_blog_url}}
|{{InfoBox ohloh}}
}} <!-- These sections are recommended if possible, but remove unavailable sections. No more than 10 sections can fit in an infobox however.  This order of InfoBox sections can be used for consistency across the wiki. See Special:PrefixIndex?prefix=inf&namespace=10 for all available section templates. -->

<!-- Introductory paragraph goes here. Describe the concept/package/software/tool/utility/etc. here. Put the description sentence in this template: [[Article description::DESCRIPTION]] so it can be used on other pages. Make first mention of subject bold. -->

<!-- i.e. '''Subject''' is [[Article description::what it is, what it does, etc.]] Further information. -->

== Installation ==

=== Kernel ===

<!-- Optional section. Remove if not applicable to software being written about. -->

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

Write menuconfig instructions here.


=== USE flags ===

<!-- Optional section. Remove if not applicable. Some software does not have any USE flags to set. --> 


=== Emerge ===


=== Additional software ===

<!-- Optional section. 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/etc. 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 ===

<!-- Optional section. Provide instructions on starting/stopping and enabling/disabling the software's service. This is only really necessary if the software includes a daemon for certain tasks. -->

==== OpenRC ====

==== runit ====

==== systemd ====

== Usage ==

<!-- Explain how to _use_ the package/software/tool/utility/etc. in this section. -->

=== Invocation ===

<!-- Optional section. Remove this section if not applicable. -->

{{Invocation|cmd --help|output=&lt;pre&gt;
(Paste command help output here.)

== Caveats ==

<!-- Optional section. Add subsections for each caveat. May be moved higher up in the article if contains important info for the later parts of the article. -->

== Tips ==

<!-- Optional section. Add subsections for each tip. -->

== Troubleshooting ==

<!-- Optional section. Add troubleshooting steps for common issues in this section. Separate issues by best describing the error with a new section name. Remove if no common troubleshooting issues are known by the author, another contributor may add it back in later. -->

=== Issue 1 ===

When X happens, Y is how to 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 ===


== See also ==

<!-- Optional section. Link to related Gentoo Wiki articles using bullet points for each link in this section; each link should be local to the Wiki. -->

* {{See also|Article_name}} <!-- This should pull in the text from the [[Article description:: ]] tag in the referenced article. If there is no [[Article description:: ]] it is always good to add one. -->

== External resources ==

<!-- Optional section. Link to external resources (outside the Wiki) using bullet points in this section. It is common to use full sentences that are links here. -->

* [https://_external_website_ Descriptive link name]== References ==

<!-- Optional section. Remove this section if "<ref> </ref>" 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 are littered throughout the main article using the "<ref> </ref>" tags. Don't forget the {{reflist}} tag, which should be the only content of this section. -->


<!-- Category links are listed at the bottom of the article. They effectively end up in the last section of the article, whatever that may be. Do ''not'' use a section heading like "Categories". While all software articles ''could'' appear in [[:Category:Software]], use one of its subcategories whenever possible. -->


See also