Help:Funtoo Editing Guidelines

Description:

This page documents the editing guidelines for the Funtoo Wiki.

Authors:

Daniel Robbins

Subpages:

Headings

Thanks for your interest in contributing to the the Funtoo wiki!

Types of Edits

Before we get started, let's review what changes are okay to make, and what changes are not okay:

Type of Change	Okay?
Grammar/spelling fixes	Yes
New wiki content	Yes
New package information	Yes
Adding to existing article	Maybe -- see below
Adding missing/incomplete information	Yes
Making corrections	Yes
Adding work-arounds to problems experienced	No - open bug first on bug tracker.

   Important

Note that if you experience some problem with Funtoo Linux, during installation or otherwise, the proper course of action is to not add a work-around to our documentation, but to open a bug on our bug tracker. This is important because the problem you experienced may be a legitimate bug and the solution may be to fix the bug rather than add a work-around to our documentation. We may end up fixing a bug, making a documentation fix, or possibly both.

Basics

Here is a list of basic wiki information that you will need to know to get started:

• First, to perform edits on the wiki, you must Create a Funtoo account and log in.
• You can create a new page by navigating to http://www.funtoo.org/New_Page_Name. Underscores are the equivalent of spaces. Then select "Create" under the "Actions" menu.
• Whether creating a new page or editing an existing page by clicking "Edit", you will be presented with Web-based text editor that allows you to modify the wikitext of the page. The wikitext is rendered to produce the document you see when you view the page normally.
• Another fun thing you can do is click on your name under the "Account" menu once you have logged in. This will bring you to your "User" page. Then click "Create with Form" unde the "Actions" menu and enter your geographic and other information. This will allow you to be displayed on our Usermap and will also allow your full name to be displayed on Ebuild pages for which you are an author. It's generally a good idea to do this.

   Tip

The following sections document how to use wikitext and Funtoo templates on the Funtoo wiki.

Paragraphs

To create a new paragraph, insert a blank line between two lines of text. If a blank line doesn't exist between two lines of wikitext, they will be combined into a single flowing paragraph.

If you leave leading whitespace at the beginning of a line, MediaWiki will render it as pre-formatted text. Beware of this. Here's an example:

foobar

This can rear its ugly head when specifying template parameters, so you will get this:

   Note

ugh!

...instead of this:

   Note

This looks much better!

   Note

By default, Table of Contents is disabled on the Funtoo wiki. If you would like to enable the TOC, you can place a __TOC__ on a blank line where you'd like the Table of Contents to appear, or place __FORCETOC__ on a blank line anywhere in the wikitext to force the TOC to appear at the top of the page.

Links

Internal links to other wiki pages can be specified as [[pagename]]. To specify an alternate name for the link, use [[pagename|my link name]].

For external links, use [http://funtoo.org my link] to specify a URL. If you want the URL to appear in the wikitext, you can specify it without brackets: http://forums.funtoo.org.

Lists

MediaWiki supports a number of list formats:

• Unordered List
• Unordered Item 2
  • Unordered sub-item

1. Ordered List
2. Ordered Item 2
   1. Ordered sub-item

Term

This is called a "definition list". It is used when defining various terms.

   Note

Please use Tables instead of definition lists when possible. They are easier to read.

If you need to quote a portion of text from another site, use <blockquote> as follows:

Wikipedia (ˌwɪkɨˈpiːdiə/ or wɪkiˈpiːdiə/ wik-i-pee-dee-ə) is a collaboratively edited, multilingual, free-access, free content Internet encyclopedia that is supported and hosted by the non-profit Wikimedia Foundation. Volunteers worldwide collaboratively write Wikipedia's 30 million articles in 287 languages, including over 4.5 million in the English Wikipedia. Anyone who can access the site can edit almost any of its articles, which on the Internet comprise[4] the largest and most popular general reference work.[5][6][7][8][9] In February 2014, The New York Times reported that Wikipedia is ranked fifth globally among all websites stating, "With 18 billion page views and nearly 500 million unique visitors a month..., Wikipedia trails just Yahoo, Facebook, Microsoft and Google, the largest with 1.2 billion unique visitors."[10]

Literal Text and HTML Symbols

Here is wikitext for the section above, which I am displaying by placing the literal wikitext between a <pre> and </pre> tag. If you want to disable wikitext processing for an inline span of text, use <nowiki> and </nowiki>. If you want to print out a tag literally, use &#60; and &#62; (In the wikitext, I used &amp;#60; and &amp;#62 to display these!)

* Unordered List
* Unordered Item 2
** Unordered sub-item

# Ordered List
# Ordered Item 2
## Ordered sub-item

;Term: This is called a "definition list". It is used when defining various terms.

If you need to quote a portion of text from another site, use <tt><blockquote></tt> as follows:

<blockquote>
Wikipedia (ˌwɪkɨˈpiːdiə/ or wɪkiˈpiːdiə/ wik-i-pee-dee-ə) is a collaboratively edited, multilingual, free-access, 
free content Internet encyclopedia that is supported and hosted by the non-profit Wikimedia Foundation. Volunteers
worldwide collaboratively write Wikipedia's 30 million articles in 287 languages, including over 4.5 million in the 
English Wikipedia. Anyone who can access the site can edit almost any of its articles, which on the Internet 
comprise[4] the largest and most popular general reference work.[5][6][7][8][9] In February 2014, The New York 
Times reported that Wikipedia is ranked fifth globally among all websites stating, "With 18 billion page views 
and nearly 500 million unique visitors a month..., Wikipedia trails just Yahoo, Facebook, Microsoft and Google, 
the largest with 1.2 billion unique visitors."[10]
</blockquote>

Linking to Packages

To link to a package page, use the Package template:

{{Package|sys-apps/portage}}

This template will create a link to the official wiki page for sys-apps/portage, and render using the official "English" page name, as follows:

sys-apps/portage

If you specify a yet-to-be-documented ebuild, it will render like this (which is okay -- it will encourage people to document it):

No results

Tables

Instead of using traditional MediaWiki table wikitext, use the following format:

{{TableStart}}
<tr class="info"><th>Header 1</th><th>Header 2</th></tr>
<tr><td>Value 1</td><td>Value 2</td></tr>
<tr><td>Value 3</td><td>Value 4</td></tr>
{{TableEnd}}

This will render as follows:

Header 1	Header 2
Value 1	Value 2
Value 3	Value 4

Some helper macros are now available which make it easier to define two and three-column tables. Use 2Col for normal two-column row, 2ColHead for 2-column header, and 3Col for 3-column row and 3ColHead for 3-column header:

{{TableStart}}
{{2ColHead|Sub-Profile|Description}}
{{2Col|{{c|arch}}|One arch profile is enabled, at build time, and is not changed. This defines CPU architecture-specific settings.}}
{{2Col|{{c|subarch}}|One subarch profile is typically enabled at build time, and defines the CPU optimizations in use.}}
{{2Col|{{c|build}}|One build profile is enabled, at build time, and is generally not changed. It defines the type of build, such as {{c|current}} or {{c|stable}}, and associated settings.}}
{{2Col|{{c|flavor}}|One flavor is enabled per system, and can be changed by the user. This defines the general use of the system, such as {{c|minimal}}, {{c|core}}, {{c|workstation}} or {{c|desktop}}}}
{{2Col|{{c|mix-ins}}|Zero or more mix-ins can be enabled that enable settings specific to a particular subset of features, such as {{c|gnome}}, {{c|kde}}, {{c|media}}, {{c|mate}}, {{c|X}}, {{c|hardened}}.}}
{{TableEnd}}

Which renders as follows:

Sub-Profile	Description
arch	One arch profile is enabled, at build time, and is not changed. This defines CPU architecture-specific settings.
subarch	One subarch profile is typically enabled at build time, and defines the CPU optimizations in use.
build	One build profile is enabled, at build time, and is generally not changed. It defines the type of build, such as current or stable, and associated settings.
flavor	One flavor is enabled per system, and can be changed by the user. This defines the general use of the system, such as minimal, core, workstation or desktop
mix-ins	Zero or more mix-ins can be enabled that enable settings specific to a particular subset of features, such as gnome, kde, media, mate, X, hardened.

   Tip

This table syntax has an added benefit of creating a responsive table that renders properly on mobile devices.

It is possible to use the following CSS classes with tr (rows) and td/th elements to color them as desired:

Class Name

success

info

warning

active

danger

Displaying Source Code

To display source code, use can use the file template, specifying a lang= parameter:

{{file|name=foobar|lang=python|desc=foobarosity|body=
import system
}}

This will produce:

   foobar (python source code) - foobarosity

import system

The parameters name (filename), lang (language for syntax highlighting) and desc (Description, appearing as a caption) are optional. For a list of supported languages, see this list.

   Important

If you need to display the pipe ("|") character within the body of a file template, replace each "|" with {{!}} -- otherwise your file contents will not display properly. This is necessary because {{file}} is a template and the "|" character is used as a delimiter for arguments to the template.

Displaying Text File Contents

For displaying the contents of non-programming language text files (like config files), you have two options. You can enclose your lines within <pre> tags, or use the new file template. The file template is used like so:

{{file|name=/etc/foo.conf|desc=My foo.conf file|body=
# /etc/host.conf:
# $Header: /var/cvsroot/gentoo/src/patchsets/glibc/extra/etc/host.conf,v 1.1 2006/09/29
}}

This will produce:

   /etc/foo.conf - My foo.conf file

# /etc/host.conf:
# $Header: /var/cvsroot/gentoo/src/patchsets/glibc/extra/etc/host.conf,v 1.1 2006/09/29

Console

To display console output, use the {{console}} template:

For a root console:

{{console|body=
###i## run a command as root
}}

Produces:

root # run a command as root

For a non-root console:

{{console|body=
$ ##i##run a command as user
}}

Produces:

user $ run a command as user

   Important

Note that we use a # prompt for root and a $ prompt to denote a non-root user.

   Important

The ##i## text tags the rest of the line as being user input ("i" is for "input"). It is then highlighted in a noticeable color so it stands out from text that is not typed in by the user.

If you need to end highlighting of user input prior to the end of a line, use ##!i## to mark the end of the highlighted area.

The following special character sequences are also available:

• ##g## - Green
• ##y## - Yellow
• ##bl## - Blue
• ##r## - Red
• ##b## - Bold

Please use the above coloring options sparingly. It is sometimes nice to use them to get wiki console output to match the colors that are displayed on a Linux console. Also note that for every color above, there is a matching ##!(colorcode)## option to turn color off prior to end of line.

Here is an example of its use:

root # bluetoothctl 
[NEW] Controller 00:02:72:C9:62:65 antec [default]
root ##bl##[bluetooth]##!bl### power on
Changing power on succeeded
root ##bl##[bluetooth]##!bl### agent on
Agent registered
root ##bl##[bluetooth]##!bl### scan on
Discovery started
root ##bl##[bluetooth]##!bl### devices
Device 00:1F:20:3D:1E:75 Logitech K760
root ##bl##[bluetooth]##!bl### pair 00:1F:20:3D:1E:75
Attempting to pair with 00:1F:20:3D:1E:75
[CHG] Device 00:1F:20:3D:1E:75 Connected: yes
root ##r##[agent]##!r## Passkey: 454358
root ##r##[agent]##!r## Passkey: 454358
root ##r##[agent]##!r## Passkey: 454358
root ##r##[agent]##!r## Passkey: 454358
root ##r##[agent]##!r## Passkey: 454358
root ##r##[agent]##!r## Passkey: 454358
root ##r##[agent]##!r## Passkey: 454358
[CHG] Device 00:1F:20:3D:1E:75 Paired: yes
Pairing successful
[CHG] Device 00:1F:20:3D:1E:75 Connected: no
root ##bl##[bluetooth]##!bl### connect 00:1F:20:3D:1E:75
Attempting to connect to 00:1F:20:3D:1E:75
[CHG] Device 00:1F:20:3D:1E:75 Connected: yes
Connection successful
root ##bl##[bluetooth]##!bl### quit
[DEL] Controller 00:02:72:C9:62:65 antec [default]
root #

Informational Messages

Notes, warnings, tips, and important templates can be used for informational messages that need to be offset from the regular text flow:

{{note|this is a note}}

   Note

this is a note

{{important|this is important}}

   Important

this is important

{{warning|this is a warning}}

   Warning

this is a warning

{{tip|this is a tip}}

   Tip

this is a tip

Note that these templates used to be called fancynote, fancytip, etc. The "fancy" names have been deprecated but will still be supported for the forseeable future.

Kernelop

To display kernel configuration options, we encourage you to use the kernelop template. To use the kernelop template, create an entry similar to the following example:

{{kernelop|title=foo,bar|desc=
kernel options pasted from "make menuconfig"
}} 

   Note

Kernelop is colored blue to slightly resemble the blueish background from make menuconfig.

Adding this entry will give you the following output: Under foo-->bar:

kernel options

Here's a more concrete example: Under File systems:

<M> Second extended fs support          
[ ]   Ext2 extended attributes          
[ ]   Ext2 execute in place support     
<M> Ext3 journalling file system support

Examples of usage:

• Package:AMD Catalyst Video Drivers
• Package:ACPI Daemon
• Microcode

Marking Pages as Needing Updates

If you find outdated wiki content, but you don't have the time or ability to update it, add one of the following templates to the wikitext of the page. This will add the page to the Needs Updates Category so we can identify pages that need updating:

{{PageNeedsUpdates}}
{{SectionNeedsUpdates}}

Examples of usage:

• UEFI Install Guide
• Package:MediaWiki
• Clang

Inline Code

To emphasize commands, and other technical jargon when they appear inline in a paragraph, use the {{c}} template. When referencing files, use the {{f}} template.

The {{f|/etc/fstab}} file is an important one. Another important file is {{f|/boot/grub/grub.cfg}}. The {{c|emerge}} command is really nifty.

This example produces the following output:

The /etc/fstab file is an important one. Another important file is /boot/grub/grub.cfg. The emerge command is really nifty.

   Important

The <tt> tag has been deprecated for the purpose of tagging inline code, to conform with HTML5, and the previous use of the <code> tag is discouraged. It is more maintainable to use the {{c}} template.

Translations

We are starting to use the official MediaWiki Translate extension for translating page contents. I recommend focusing primarily on the Install Guide for translation, and only moving on to other things once the Install Guide translation is 100% complete.

Section-by-Section Install Guide Translation

To translate the Install Guide, start with the section-by-section format and choose "Translate this page", and work through it a section at a time.

Also note that you can go to [1] to translate special user interface text we use like "Chapter", "Install Guide", "Tip", "Important", etc.

Navigation Buttons

The section-by-section Install Guide has a blue navigation section which is used to navigate to the previous or next section. Here's how it works for translated pages. If you are on a translated section, and you want to go to the "next" section, and a translated section for the next section exists, then the link will point to the next translated page. But, if the translated version of the next page doesn't exist, then you will get linked to the English version of the section. Once you are in an English version of the section, you have been "de-railed" into the English document and the navigation will not "jump back" into your translated sections. But this allows users who are using your incomplete translated documentation to at least start reading the translated version, and click through to the end of the documentation without having any missing pages.

Once all sections exist in the translated language, then the "next" and "prev" links will stay in your translated sections, and the user will only go back to English if they select the English translation from the languages area.

All-in-One (One Page) Install Guide

Once the section-by-section Install Guide is translated, it is possible to create a copy of The contents of the all-in-one-page Installation Guide -- click here to view it and click "Edit". Create your copy at "Install/languagecode" and paste the contents. Update minor things like the title but the calls to translated_subpage can remain the same.

Next, good pages to translate are the ZFS, BTRFS and other pages in the Category:Official Documentation category. If you need more pages to translate, you can send me an email (either direct, or even better, go to User:Drobbins and then in the left-hand "Tools" section you will see an option to "Email this User" which you can use to send me a notification inside MediaWiki. I will then mark new pages for translation.

Upload Images

To upload images, head to Special:Upload and upload a file. Make sure that all images you upload have the same dimensions. When you upload, make note of the Destination Filename field -- this is the name that the upload will use when you reference it in your slide. It is recommended that you choose a simple descriptive name ending in ".jpg" or ".png" for the Destination Filename.