Help:Funtoo Editing Guidelines

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

document hierarchy structure

The above top-level section was inserted using:

= document hierarchy structure =

document hierarchy sub structure

Sub-sections can be created as follows, or use these as your main sections:

== document hierarchy sub structure ==

this is the primary structure most pages, talk pages will use instead of main heading example above. some pages will call for main heading.

document hierarchy sub sub structure

Now, we can create third-level sections:

=== document hierarchy sub sub structure ===

document hierarchy sub sub sub structure

==== document hierarchy sub structure ====

to implement pipe | in documents, wrap with brackets.

{{!}}

   Important

below template is not instated yet

to use equals signs with out conflicting with document structure wrap with brackets.

{{=}}

= http://en.wikipedia.org/wiki/Template:%3D

<console>

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

For a root console:

<console>
###i## run a command as root
</console>

Produces:

root # run a command as root

   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.

Examples of usage:

• Rootfs over encrypted lvm
• Boot-Update
• Fonts

For a non-root console:

<console>
$ ##i##run a command as user
</console>

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.

Examples of usage:

• Zope HOWTO
• Benchmarking

or a more concise syntax

Fancy Notes

notes, warnings, tips, and important templates will help bring emphasis to articles drawn up.

{{fancynote|this is a fancy note}}

   Note

this is a fancy note

{{fancyimportant|this is a fancy important}}

   Important

this is a fancy important

{{fancywarning|this is a fancy warning}}

   Warning

this is a fancy warning

{{fancytip|this is a fancy tip}}

   Tip

this is a fancy tip

bridge returns will help you edit articles also <br /> starts a new line

bridge returns will help you edit articles also
starts a new line

{{Kernelop}}

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:

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

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

links

internal:

[[pagename]]

pagename

internal with text:

[[pagename|some text]]

some text

external:

[http://funtoo.org/ http://funtoo.org/]

http://funtoo.org/

external with text:

[http://funtoo.org/ this is some text]

this is some text

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
</syntaxhighlight>

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:

foo
bar
oni

Examples of usage:

• UEFI Install Guide
• Package:MediaWiki
• Clang

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

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

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

{{#widget:YouTube|id=5KDei5mBfSg|width=320|height=180}}

standard:

{{#widget:YouTube|id=5KDei5mBfSg|width=700|height=420}}