Help:Funtoo Editing Guidelines

Revision as of 02:15, March 16, 2014 by Daniel Robbins (Talk) (<console>)

This guide is meant to serve as a reference for those who are interested in helping improve the Funtoo wiki.


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

kernel options pasted 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:

Displaying Source Code

To display source code, use the <syntaxhighlight> tag, which has the ability to perform syntax highlighting on the source code for easier reading:

<syntaxhighlight lang="python">
import system

This will produce the following output:

import system
Note that the language should be specified in the lang attribute. For a list of supported languages, see this list.

Displaying Files

To display the contents of a file that is not source code, use the </pre> tag. The </pre> tag preserves formatting. Example file contents:

Examples of usage:

<tt> and <code>

To emphasize filenames, commands, and other technical jargon when they appear inline in a paragraph, use the <tt> or <code> option. To use these, follow the example below:

The <tt>/etc/fstab</tt> file is an important one. Another important file is <code>/boot/grub/grub.cfg</code>.

This example produces the following output (notice the difference between the fonts?):
The /etc/fstab file is an important one. Another important file is /boot/grub/grub.cfg.


To display console output, use the <console> tag:

For a root console:

###i## run a command as root


# run a command as root

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.

Examples of usage:

For a non-root console:

$ ##i##run a command as user


$ run a command as user

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

Examples of usage:

Collapsible text

<div class="toccolours mw-collapsible"> some text you might want to fold away because its a huge explanation.</div>

some text you might want to fold away because its a huge explanation.

<div class="toccolours mw-collapsible mw-collapsed">pre collapsed text because it is a huge explanation.</div>

pre collapsed text because it is a huge explanation.


screencasting is an easy method to explain complex tasks. take for instance we chop off the id and insert it into the following syntax to produce a video example.