Gentoo Wiki:Article Blueprints/Core system

From Gentoo Wiki
Jump to: navigation, search

The following is a semi-structured, rough core system article blueprint users can copy and paste to create new core system articles. In general, it follows the Wiki guidelines (please 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 Core system article blueprint by going here.
Important
Not every core system 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 <Core_system_title> article. Show it some love by improving it!

{{Stub}}
{{InfoBox stack
|{{InfoBox homepage|http://url/to/homepage|header=true}}
|{{InfoBox wikipedia|TitleOnTheWikipedia}}
|{{InfoBox ohloh}}
}}

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

__TOC__

== Installation ==

=== Kernel ===

(Optional section. Remove if not applicable.)

{{KernelBox|Title=Enabled support for <Core_system_title>|1=

Show Kernel feature instructions here.

}}

=== USE flags ===

(Optional section. Remove if no USE flags exist or not applicable to the article.)

{{USEflag|package=category/package|desc=Optional USE flags for {{Package|category/package}}:
|useflag1
|useflag2
|useflag3
}}

=== Emerge ===

{{Emerge|category/package}}

== Configuration ==

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

== 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.

== 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:Core system]]