Difference between pages "Welcome" and "Help:Funtoo Editing Guidelines"

(Difference between pages)
 
(Adding documentation on slideshows)
 
Line 1: Line 1:
<div class="container"><div class="row"><div class="col-xs-12 col-md-8 col-lg-8">
+
'''Thanks for your potential interest in contribution the the Funtoo wiki!'''
{{Slideshow}}
+
__NOTOC__
Want to submit a screenshot? [http://forums.funtoo.org/index.php?/topic/180-screenshots/ See here.]
+
== Types of Edits ==
</div><div class="col-xs-12 col-md-4 col-lg-4">
+
'''Funtoo Linux''' is a Linux-based operating system that is a variant of [http://www.gentoo.org Gentoo Linux]. Funtoo Linux is:
+
* ...'''fun!''' Our priority is to create a ''great, supportive and responsive'' user community.
+
* ...'''user-centric and collaborative'''. Everyone is considered a '''user''' of Funtoo, first and foremost. You don't need any special privileges to collaborate with us.
+
* ...'''production-oriented''': Our goal is to have Funtoo be useful for ''real-world tasks''. We use Funtoo to do stuff, like host our infrastructure. It needs to work.__NOTOC__
+
* ...'''creative''': We seek creative, elegant and maintainable solutions to problems of all kinds.
+
  
'''View the [[Funtoo Linux FAQ]] for answers to common questions.'''
+
Before we get started, let's review what changes are okay to make, and what changes are not okay:
  
{{#ask: [[Category:People]] [[Gravatar MD5::+]]
+
{{TableStart}}
| limit=22
+
<tr class="active"><th>Type of Change</th><th>Okay?</th></tr>
| order=random
+
<tr><td>Grammar/spelling fixes</td><td>Yes</td></tr>
| format=template
+
<tr><td>New wiki content</td><td>Yes</td></tr>
| template=GravatarDisplay
+
<tr><td>New package information</td><td>Yes</td></tr>
| link=none
+
<tr><td>Adding to existing article</td><td>Maybe -- see below</td></tr>
| searchlabel=
+
<tr><td>Adding missing/incomplete information</td><td>Yes</td></tr>
 +
<tr><td>Making corrections</td><td>Yes</td></tr>
 +
<tr class="danger"><td>Adding work-arounds to problems experienced</td><td>No - open bug first on [http://bugs.funtoo.org bug tracker].</td></tr>
 +
{{TableEnd}}
 +
 
 +
{{fancyimportant|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 {{CreateAccount}} 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.
 +
* This wiki uses the [http://www.mediawiki.org/wiki/Extension:Approved_Revs ApprovedRevs Extension], which means that any changes you make to a page will need to be approved by an Editor before they are displayed. Editors can visit the [[Special:ApprovedRevs]] page to approve edits made on pages (click "Pages whose approved revision is not their latest" or "Unapproved pages".)
 +
* Until your edits are approved, you can continue to edit the page and your changes will be displayed in the page's History -- click "History" under the "Actions" menu to view the page's history. You will see that the approved version of a page has a star next to it.
 +
* 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 [[:Category:Ebuilds|Ebuild pages]] for which you are an author. It's generally a good idea to do this.
 +
 
 +
{{fancytip|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:
 +
 
 +
{{fancynote| ugh!}}
 +
 
 +
...instead of this:
 +
 
 +
{{fancynote|This looks much better!}}
 +
 
 +
== Page and Section Capitalization ==
 +
 
 +
In general, capitalize all words in page names and section heading except:
 +
* Articles: a, an, the
 +
* Coordinating Conjunctions: and, but, or, for, nor, etc.
 +
* Prepositions (fewer than five letters): on, at, to, from, by, etc.
 +
 
 +
== Document Hierarchy ==
 +
 
 +
Use section headings to create a document hierarchy for your page. These will define the table of contents that appears at the top of the wiki page. Create chapters, sections and sub-sections as follows:
 +
 
 +
<pre>= Page Title =
 +
 
 +
== Chapter Title ==
 +
 
 +
=== Section Title ===
 +
 
 +
==== SubSection Title ====
 +
 
 +
</pre>
 +
 
 +
== Links ==
 +
 
 +
Internal links to other wiki pages can be specified as <tt><nowiki>[[pagename]]</nowiki></tt>. To specify an alternate name for the link, use <tt><nowiki>[[pagename|my link name]]</nowiki></tt>.
 +
 
 +
For external links, use <tt><nowiki>[http://funtoo.org my link]</nowiki></tt> 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
 +
 
 +
# 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><nowiki><blockquote></nowiki></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>
 +
 
 +
== Literal Text and HTML Symbols ==
 +
 
 +
Here is wikitext for the section above, which I am displaying by placing the literal wikitext between a &#60;pre&#62; and &#60;/pre&#62; tag. If you want to disable wikitext processing for an inline span of text, use &#60;nowiki&#62; and &#60;/nowiki&#62;. If you want to print out a tag literally, use &amp;#60; and &amp;#62; (In the wikitext, I used &amp;amp;#60; and &amp;amp;#62 to display these!)
 +
 
 +
<pre>
 +
* 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><nowiki><blockquote></nowiki></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>
 +
</pre>
 +
 
 +
== Linking to Packages ==
 +
 
 +
To link to a package page, use the <code>Package</code> template:
 +
 
 +
<pre><nowiki>
 +
{{Package|sys-apps/portage}}
 +
</nowiki></pre>
 +
 
 +
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:
 +
 
 +
{{Package|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):
 +
 
 +
{{Package|sys-foo/undocumented-ebuild}}
 +
 
 +
== Tables ==
 +
 
 +
Instead of using traditional MediaWiki table wikitext, use the following format:
 +
 
 +
<pre>
 +
{{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}}
 +
</pre>
 +
 
 +
This wil render as follows:
 +
 
 +
{{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}}
 +
 
 +
{{fancytip|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 <code>tr</code> (rows) and <code>td/th</code> elements to color them as desired:
 +
 
 +
{{TableStart}}
 +
<tr class="active"><td>Class Name</td></tr>
 +
<tr class="success"><td>success</td></tr>
 +
<tr class="info"><td>info</td></tr>
 +
<tr class="warning"><td>warning</td></tr>
 +
<tr class="active"><td>active</td></tr>
 +
<tr class="danger"><td>danger</td></tr>
 +
{{TableEnd}}
 +
 
 +
== Displaying Source Code ==
 +
 
 +
To display source code, use the <tt>&#60;syntaxhighlight&#62;</tt> tag, which has the ability to perform syntax highlighting on the source code for easier reading:
 +
<pre>
 +
<syntaxhighlight lang="python">
 +
import system
 +
</syntaxhighlight>
 +
</pre>
 +
 
 +
This will produce the following output:
 +
 
 +
<syntaxhighlight lang="python">
 +
import system
 +
</syntaxhighlight>
 +
 
 +
Alternatively, if you need a caption, use can use the file template, specifying a <tt>lang=</tt> parameter:
 +
 
 +
<pre>
 +
{{file|name=foobar|lang=python|desc=foobarosity|body=
 +
import system
 
}}
 
}}
 +
</pre>
  
Join us - {{CreateAccount}}, and then add yourself to our [[Usermap]]!
+
This will produce:
</div>
+
 
</div><div class="row">
+
{{file|name=foobar|lang=python|desc=foobarosity|body=
<div class="col-xs-12 col-md-4 col-lg-4">
+
import system
== Resources ==
+
}}
 +
 
 +
{{fancyimportant|If you need to display the pipe ("{{!}}") character within the body of a file template, replace each "{{!}}" with <nowiki>{{!}}</nowiki> -- otherwise your file contents will not display properly. This is necessary because <nowiki>{{file}}</nowiki> is a template and the "{{!}}" character is used as a delimiter for arguments to the template.}}
 +
 
 +
Note that the language should be specified in the <tt>lang</tt> attribute. For a list of supported languages, see [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Supported_languages this list].
 +
 
 +
== 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 <tt>&#60;pre&#62;</tt> tags, or use the new [[Template:File|file template]]. The file template is used like so:
 +
 
 +
<pre>
 +
{{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
 +
}}
 +
</pre>
 +
 
 +
This will produce:
 +
 
 +
{{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
 +
}}
 +
 
 +
== Console ==
 +
To display console output, use the <tt>&#60;console&#62;</tt> tag:
 +
 
 +
For a root console:
 +
<pre>
 +
<console>
 +
###i## run a command as root
 +
</console>
 +
</pre>
 +
Produces:
 +
<console>
 +
###i## run a command as root
 +
</console>
 +
 
 +
For a non-root console:
 +
<pre>
 +
<console>
 +
$ ##i##run a command as user
 +
</console>
 +
</pre>
 +
Produces:
 +
<console>
 +
$ ##i##run a command as user
 +
</console>
  
 
{{fancyimportant|1=
 
{{fancyimportant|1=
[[Support Funtoo]] to help our project grow! '''Donate $15 per month and get a free [[Funtoo Hosting|Funtoo Virtual Container]].'''}}
+
Note that we use a <tt>#</tt> prompt for <tt>root</tt> and a <tt>$</tt> prompt to denote a non-root user.}}
  
'''Our resources:''' -- also see the <code>Go</code> menu:
+
{{Fancyimportant|The <tt>##i##</tt> 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.}}
* '''{{CreateAccount}}''' ([[Funtoo Authentication FAQ|Auth FAQ]])
+
* '''[http://forums.funtoo.org forums.funtoo.org]''' - our new forums!
+
* '''[http://bugs.funtoo.org bugs.funtoo.org]''', our bug tracker ([[Reporting Bugs|Instructions]]).
+
* [http://larrythecow.org larrythecow.org], Gentoo blog service.
+
* [http://kernel-seeds.org kernel-seeds.org], kernel build help.
+
* [http://git.funtoo.org git.funtoo.org], our cgit repository browser.
+
* '''[[Support Funtoo]]''' to help our project grow.
+
* '''[[Funtoo Hosting|Get a Funtoo Virtual Container]]'''.
+
</div><div class="col-sm-12 col-xs-12 col-md-4 col-lg-4">
+
== Getting Started ==
+
  
We encourage you to '''[[Funtoo Linux Installation|install Funtoo Linux]]''', and get involved in our user community. Get to know fellow Funtoo Linux users on our '''[http://forums.funtoo.org forums]'''. If you have any improvements or find any bugs in Funtoo Linux, you are strongly encouraged to report them on our '''[http://bugs.funtoo.org bug tracker]'''. We take all bugs seriously, and all work performed on Funtoo Linux is tracked on our bug tracker, for purposes of transparency.
+
If you need to end highlighting of user input prior to the end of a line, use <code>##!i##</code> to mark the end of the highlighted area.
  
Funtoo Linux has a very active [http://en.wikipedia.org/wiki/IRC IRC] community on Freenode, in the <code>#funtoo</code> channel, and you are encouraged to hang out online with us.
+
The following special character sequences are also available:
 +
* <code>##g##</code> - Green
 +
* <code>##y##</code> - Yellow
 +
* <code>##bl##</code> - Blue
 +
* <code>##r##</code> - Red
 +
* <code>##b##</code> - Bold
  
== Expand the wiki! ==
+
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 <code>##!(colorcode)##</code> option to turn color off prior to end of line.
  
The [[:Help:Funtoo_Editing_Guidelines | How to 'wiki']] will help get you started on wiki editing. Have a look at [[Requested-Documents]] and [[:Category:Needs_Updates | pages that need to be updated.]]  
+
Here is an example of its use:<console>
 +
# ##i##bluetoothctl
 +
[##g##NEW##!g##] Controller 00:02:72:C9:62:65 antec [default]
 +
##bl##[bluetooth]##!bl###power on
 +
Changing power on succeeded
 +
##bl##[bluetooth]##!bl### ##i##agent on
 +
Agent registered
 +
##bl##[bluetooth]##!bl### ##i##scan on
 +
Discovery started
 +
##bl##[bluetooth]##!bl### ##i##devices
 +
Device 00:1F:20:3D:1E:75 Logitech K760
 +
##bl##[bluetooth]##!bl### ##i##pair 00:1F:20:3D:1E:75
 +
Attempting to pair with 00:1F:20:3D:1E:75
 +
[##y##CHG##!y##] Device 00:1F:20:3D:1E:75 Connected: yes
 +
##r##[agent]##!r## Passkey: 454358
 +
##r##[agent]##!r## Passkey: ##i##4##!i##54358
 +
##r##[agent]##!r## Passkey: ##i##45##!i##4358
 +
##r##[agent]##!r## Passkey: ##i##454##!i##358
 +
##r##[agent]##!r## Passkey: ##i##4543##!i##58
 +
##r##[agent]##!r## Passkey: ##i##45435##!i##8
 +
##r##[agent]##!r## Passkey: ##i##454358##!i##
 +
[##y##CHG##!y##] Device 00:1F:20:3D:1E:75 Paired: yes
 +
Pairing successful
 +
[##y##CHG##!y##] Device 00:1F:20:3D:1E:75 Connected: no
 +
##bl##[bluetooth]##!bl### ##i##connect 00:1F:20:3D:1E:75
 +
Attempting to connect to 00:1F:20:3D:1E:75
 +
[##y##CHG##!y##] Device 00:1F:20:3D:1E:75 Connected: yes
 +
Connection successful
 +
##bl##[bluetooth]##!bl### ##i##quit
 +
[##r##DEL##!r##] Controller 00:02:72:C9:62:65 antec [default]
 +
#
 +
</console>
  
See [[:Category:Ebuilds|Ebuilds]] for a list of all ebuild pages, and [[Adding an Ebuild to the Wiki]] for information on how to add one.
+
== Informational Messages ==
 +
Notes, warnings, tips, and important templates can be used for informational messages that need to be offset from the regular text flow:
  
'''Ebuild pages recently updated:''' {{#ask: [[Category:Ebuilds]]
+
<pre>{{note|this is a note}}</pre>
| order=descending
+
{{note|this is a note}}
| sort=Modification date
+
 
| format=list
+
<pre>{{important|this is important}}</pre>
| limit=10
+
{{important|this is important}}
| searchlabel=more...
+
 
 +
<pre>{{warning|this is a warning}}</pre>
 +
{{warning|this is a warning}}
 +
 
 +
<pre>{{tip|this is a tip}}</pre>
 +
{{ftip|this is a tip}}
 +
 
 +
Note that these templates used to be called <code>fancynote</code>, <code>fancytip</code>, 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 <tt>kernelop</tt> template. To use the <tt>kernelop</tt> template, create an entry similar to the following example:
 +
<pre>
 +
{{kernelop|title=foo,bar|desc=
 +
kernel options pasted from "make menuconfig"
 +
}}
 +
</pre>
 +
 
 +
{{fancynote|Kernelop is colored blue to slightly resemble the blueish background from <tt>make menuconfig</tt>.}}
 +
 
 +
Adding this entry will give you the following output:
 +
{{kernelop|title=foo,bar|desc=
 +
kernel options
 
}}
 
}}
</div><div class="col-sm-12 col-xs-12 col-md-4 col-lg-4">
 
== Distinctives ==
 
  
Funtoo Linux packages are installed from source code, automatically, thanks to the [http://en.wikipedia.org/wiki/Portage_(software) Portage ports system], inspired by the FreeBSD ports system, but written in Python and with full advanced package management functionality. Funtoo Linux is a meta-distribution, which means it is built (fully automatically) with the functionality and optimizations that ''you'' want, not what some distro maintainer thought was best for you.
+
Here's a more concrete example:
 +
{{kernelop|title=File systems|desc=
 +
<M> Second extended fs support         
 +
[ ]   Ext2 extended attributes         
 +
[ ]  Ext2 execute in place support   
 +
<M> Ext3 journalling file system support
 +
}}
  
We use [http://en.wikipedia.org/wiki/Git_(software) Git] for all our development, and we also use Git to deliver our ports tree to you.
+
Examples of usage:
 +
* [[Package:AMD Catalyst Video Drivers]]
 +
* [[Package:ACPI Daemon]]
 +
* [[Microcode]]
  
In contrast to Gentoo Linux, we offer a number of innovations, including our extensive use of git, [[Funtoo 1.0 Profile|our profile system]], [[Package:Boot-Update|boot-update]] boot management tool, our incredibly flexible [[Funtoo Linux Networking|template-based networking scripts]], [[Metro Quick Start Tutorial|Metro]] distribution build system, support of Debian, RHEL and other kernels, [[Creating_Python-related_Ebuilds|enhanced Python support]], Portage mini-manifests, user-centric distribution model, and a large number of community infrastructure improvements.
+
== Discussion Pages ==
  
== Project Structure ==
+
In MediaWiki, every "regular" wiki page has a corresponding "Talk" or "Discussion" page which has a page name prefixed by "Talk:" -- you can get to this page by going to the "Action" menu, and then choosing the "Discussion" menu item. These talk pages are typically used to discuss the edits that are going on in the "main" wiki page. The problem with talk pages is that they are kind of a pain to use. However, we have a way to fix that. If you want to enable a DISQUS-based mini-forum on a talk page, insert the following wikitext on the Talk page:
  
Funtoo Linux is led by [http://en.wikipedia.org/wiki/Daniel_Robbins_(computer_programmer) Daniel Robbins], the creator and former Chief Architect of [http://en.wikipedia.org/wiki/Gentoo_Linux Gentoo Linux], who serves as benevolent dictator for life (BDFL) of the project.
+
<pre>
 +
{{DISQUS}}
 +
</pre>
  
'''Learn more about Funtoo Linux's [[staff]] and [[Funtoo Linux Vision|development vision]].'''
+
...and presto! You will now have DISQUS-powered mini-forums to discuss whatever you want about your wiki page.
</div></div></div>
+
  
__NOTITLE__
+
== Marking Pages as Needing Updates ==
__NOEDITSECTION__
+
 
 +
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 [[:Category:Needs Updates|Needs Updates Category]] so we can identify pages that need updating:
 +
 
 +
<pre>
 +
{{PageNeedsUpdates}}
 +
{{SectionNeedsUpdates}}
 +
</pre>
 +
 
 +
 
 +
Examples of usage:
 +
* [[UEFI Install Guide]]
 +
* [[Package:MediaWiki]]
 +
* [[Clang]]
 +
 
 +
== Inline Code ==
 +
 
 +
To emphasize filenames, commands, and other technical jargon when they appear inline in a paragraph, use the <tt>&#60;code&#62;</tt> element. Follow the example below:
 +
 
 +
<pre>
 +
The <code>/etc/fstab</code> file is an important one. Another important file is <code>/boot/grub/grub.cfg</code>.
 +
</pre>
 +
 
 +
This example produces the following output:
 +
 
 +
The <code>/etc/fstab</code> file is an important one. Another important file is <code>/boot/grub/grub.cfg</code>.
 +
 
 +
{{fancyimportant|1=
 +
The &#60;tt&#62; tag has been deprecated for the purpose of tagging inline code, to conform with HTML5.}}
 +
 
 +
 
 +
== Slideshow ==
 +
 
 +
Any page has the capability of displaying a slideshow. Adding a slideshow to a page involves three steps:
 +
 
 +
# Upload Images
 +
# Define Slides
 +
# Add Slideshow to page
 +
 
 +
=== Upload Images ===
 +
 
 +
To upload images, head to [[Special:Upload]] and upload a file. It is highly recommended to upload JPEG format images in high resolution -- MediaWiki will handle scaling JPEG automatically, saving bandwidth, but does not do this for PNG. 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" for the '''Destination Filename'''.
 +
 
 +
=== Define Slides ===
 +
 
 +
Once images have been uploaded, you must define slides. To define slides on a page, you enter special semantic information about the slide on the page that it will be displayed, in the following format:
 +
 
 +
<pre><nowiki>
 
{{#subobject:|slideIndex=0|slideCaption=
 
{{#subobject:|slideIndex=0|slideCaption=
== [[User:Drobbins|drobbins]] ==
+
== Wikitext Here ==
 +
This is a fantastic slide!
 +
|slideImage=File:Fruit.jpg|slideLink=PageName}}
 +
</nowiki></pre>
 +
 
 +
Here are some important instructions regarding defining slides:
 +
 
 +
* <code>slideIndex</code> must be 0 for the first slide, 1 for the second slide, etc. Numbers must be unique and incrementing from zero, and not doing this will result in slideshow display errors (but can be easily fixed by correcting the wikitext.)
 +
* <code>slideCaption=</code> can contain wikitext, such as headings and links. The best way to enter <code>slideCaption</code> is as above -- type a literal <code>slideCaption=</code>, followed by enter, then specify your wikitext, and terminate the caption by a single pipe character on the following line. Pipe characters are used to separate arguments from each other.
 +
* Specify your image name in the <code>slideImage</code> field. Your slideImage will have a name of <code>File:myname.jpg</code>, where <code>myname.jpg</code> is the '''Destination Filename''' you used when uploading the image.
 +
* An optional parameter called <code>slideLink=</code> can be provided to allow the image to be clickable and link to another wiki page. If it is omitted, then the image will not be clickable.
 +
 
 +
=== Add Slideshow to Page ===
 +
 
 +
Once the slides have been added to the page, you can add the following text to your page at the point you'd like the slideshow to appear:
 +
<pre>
 +
{{Slideshow}}
 +
</pre>
 +
 
 +
== YouTube Videos (Screencasts, etc.) ==
  
[[GNOME First Steps|GNOME 3.12]]
+
Screencasting is an easy method to explain complex tasks. Take for instance <code>youtu.be/5KDei5mBfSg</code> and chop off the id and insert it into the following syntax to produce a video example.
([[Funtoo_Linux_FAQ#Do_you_support_systemd.3F|without systemd]], because that's how we roll.)
+
  
Note: Badgers optional.
+
<pre>{{#widget:YouTube16x9|id=5KDei5mBfSg}}</pre>
|slideImage=File:gnome3122.jpg|slideLink=GNOME First Steps}}
+
{{#widget:YouTube16x9|id=5KDei5mBfSg}}
{{#subobject:|slideIndex=1|slideCaption=
+
== [[User:Anak1n|anak1n]] ==
+
  
flux box
+
{{tip|The sample video above explains how to create your own screencasts under Funtoo Linux.}}
|slideImage=File:fluxbox-09.02.14.jpg}}
+
{{#subobject:|slideIndex=2|slideCaption=
+
== spectromas ==
+
  
[[Package:Awesome_(Window_Manager)|Awesome WM]]
+
Most YouTube videos are in 16x9 format and should use the <code>YouTube16x9</code> widget. There is also a <code>YouTube4x3</code> widget for videos with a 4x3 aspect ratio.
|slideImage=File:awesome.jpg|slideLink=Package:Awesome (Window Manager)}}
+
{{note|These YouTube widgets have been updated to be mobile-friendly.}}
{{#subobject:|slideIndex=3|slideCaption=
+
== [[User:Anak1n|anak1n]] ==
+
  
KDE
+
[[Category:Wiki Development]]
|slideImage=File:anak1n-kde.jpg}}
+

Revision as of 16:55, October 17, 2014

Thanks for your potential interest in contribution 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 ChangeOkay?
Grammar/spelling fixesYes
New wiki contentYes
New package informationYes
Adding to existing articleMaybe -- see below
Adding missing/incomplete informationYes
Making correctionsYes
Adding work-arounds to problems experiencedNo - 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.
  • This wiki uses the ApprovedRevs Extension, which means that any changes you make to a page will need to be approved by an Editor before they are displayed. Editors can visit the Special:ApprovedRevs page to approve edits made on pages (click "Pages whose approved revision is not their latest" or "Unapproved pages".)
  • Until your edits are approved, you can continue to edit the page and your changes will be displayed in the page's History -- click "History" under the "Actions" menu to view the page's history. You will see that the approved version of a page has a star next to it.
  • 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!

Page and Section Capitalization

In general, capitalize all words in page names and section heading except:

  • Articles: a, an, the
  • Coordinating Conjunctions: and, but, or, for, nor, etc.
  • Prepositions (fewer than five letters): on, at, to, from, by, etc.

Document Hierarchy

Use section headings to create a document hierarchy for your page. These will define the table of contents that appears at the top of the wiki page. Create chapters, sections and sub-sections as follows:

= Page Title =

== Chapter Title ==

=== Section Title ===

==== SubSection Title ====

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.

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:

Portage (Funtoo)

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

sys-foo/undocumented-ebuild (package not on wiki - please add)

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 wil render as follows:

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

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

Alternatively, if you need a caption, use can use the file template, specifying a lang= parameter:

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

This will produce:

foobar: foobarosity (python source code)
import system

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.

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

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> tag:

For a root console:

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

Produces:

# run a command as root

For a non-root console:

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

Produces:

$ 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:
# bluetoothctl 
[NEW] Controller 00:02:72:C9:62:65 antec [default]
[bluetooth]#power on
Changing power on succeeded
[bluetooth]# agent on
Agent registered
[bluetooth]# scan on
Discovery started
[bluetooth]# devices
Device 00:1F:20:3D:1E:75 Logitech K760
[bluetooth]# 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
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[CHG] Device 00:1F:20:3D:1E:75 Paired: yes
Pairing successful
[CHG] Device 00:1F:20:3D:1E:75 Connected: no
[bluetooth]# 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
[bluetooth]# quit
[DEL] Controller 00:02:72:C9:62:65 antec [default]
#

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

Template:Ftip

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:

Discussion Pages

In MediaWiki, every "regular" wiki page has a corresponding "Talk" or "Discussion" page which has a page name prefixed by "Talk:" -- you can get to this page by going to the "Action" menu, and then choosing the "Discussion" menu item. These talk pages are typically used to discuss the edits that are going on in the "main" wiki page. The problem with talk pages is that they are kind of a pain to use. However, we have a way to fix that. If you want to enable a DISQUS-based mini-forum on a talk page, insert the following wikitext on the Talk page:

{{DISQUS}}

...and presto! You will now have DISQUS-powered mini-forums to discuss whatever you want about your wiki page.

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:

Inline Code

To emphasize filenames, commands, and other technical jargon when they appear inline in a paragraph, use the <code> element. Follow the example below:

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

This example produces the following output:

The /etc/fstab file is an important one. Another important file is /boot/grub/grub.cfg.

Important

The <tt> tag has been deprecated for the purpose of tagging inline code, to conform with HTML5.


Slideshow

Any page has the capability of displaying a slideshow. Adding a slideshow to a page involves three steps:

  1. Upload Images
  2. Define Slides
  3. Add Slideshow to page

Upload Images

To upload images, head to Special:Upload and upload a file. It is highly recommended to upload JPEG format images in high resolution -- MediaWiki will handle scaling JPEG automatically, saving bandwidth, but does not do this for PNG. 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" for the Destination Filename.

Define Slides

Once images have been uploaded, you must define slides. To define slides on a page, you enter special semantic information about the slide on the page that it will be displayed, in the following format:

{{#subobject:|slideIndex=0|slideCaption=
== Wikitext Here ==
This is a fantastic slide!
|slideImage=File:Fruit.jpg|slideLink=PageName}}

Here are some important instructions regarding defining slides:

  • slideIndex must be 0 for the first slide, 1 for the second slide, etc. Numbers must be unique and incrementing from zero, and not doing this will result in slideshow display errors (but can be easily fixed by correcting the wikitext.)
  • slideCaption= can contain wikitext, such as headings and links. The best way to enter slideCaption is as above -- type a literal slideCaption=, followed by enter, then specify your wikitext, and terminate the caption by a single pipe character on the following line. Pipe characters are used to separate arguments from each other.
  • Specify your image name in the slideImage field. Your slideImage will have a name of File:myname.jpg, where myname.jpg is the Destination Filename you used when uploading the image.
  • An optional parameter called slideLink= can be provided to allow the image to be clickable and link to another wiki page. If it is omitted, then the image will not be clickable.

Add Slideshow to Page

Once the slides have been added to the page, you can add the following text to your page at the point you'd like the slideshow to appear:

{{Slideshow}}

YouTube Videos (Screencasts, etc.)

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

{{#widget:YouTube16x9|id=5KDei5mBfSg}}

Tip

The sample video above explains how to create your own screencasts under Funtoo Linux.

Most YouTube videos are in 16x9 format and should use the YouTube16x9 widget. There is also a YouTube4x3 widget for videos with a 4x3 aspect ratio.

Note

These YouTube widgets have been updated to be mobile-friendly.