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

From Funtoo
(Difference between pages)
Jump to navigation Jump to search
 
 
Line 1: Line 1:
This guide is meant to serve as a reference for those who are interested in helping improve the Funtoo Wiki.
<div class="container"><div class="row"><div class="col-xs-12 col-sm-8">
__TOC__
{{Slideshow}}
First, to perform edits on the wiki, you must {{CreateAccount}} and log in.
</div><div class="col-xs-12 col-sm-4">
== Welcome to Funtoo Linux ==
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.


{{fancynote|A new wiki capability has been added, called ''annotations'', which allows you to make in-line comments to wiki text. To create or view annotations, click the '''View annotations''' tab. Hover over any yellow highlighted text to view an annotation (there is one for the first sentence of this page), or select text with your mouse and use the widget that appears to add your own annotation. Note that annotations are wiped when the page is edited.}}
'''View the [[Funtoo Linux FAQ]] for answers to common questions.'''
 
</div><div class="col-sm-12 col-sm-4">
You can create a new page by navigating to http://www.funtoo.org/New_Page_Name. Underscores are the equivalent of spaces. Then click the "Create" button in the upper right.
== Resources ==
 
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 "View History" in the upper right 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 in the upper right once you have logged in. This will bring you to your "User" page. Then click "Create with Form" 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
 
== 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 Heirarchy ==
 
Use section headings to create a document heirarchy 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>
 
== 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>
 
This will produce:
 
{{file|name=foobar|lang=python|desc=foobarosity|body=
import system
}}
 
{{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=
Note that we use a <tt>#</tt> prompt for <tt>root</tt> and a <tt>$</tt> prompt to denote a non-root user.}}
[[Support Funtoo]] to help our project grow! '''Donate $15 per month and get a free [[Funtoo Hosting|Funtoo Virtual Container]].'''}}


{{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.}}
Our community has a number of excellent resources for communication and collaboration:
* '''{{CreateAccount}}''' to log in to the wiki, forums and bug tracker. See [[Funtoo Authentication FAQ]].
* '''[http://forums.funtoo.org forums.funtoo.org]''' - our new forums!
* [https://groups.google.com/forum/#!forum/funtoo-dev funtoo-dev] mailing list
* '''[http://bugs.funtoo.org bugs.funtoo.org]''', our bug tracker ([[Reporting Bugs|Instructions]]).
* [http://larrythecow.org larrythecow.org], our Gentoo blog aggregation service.
* [http://kernel-seeds.org kernel-seeds.org], resources for building your kernel from scratch.
* [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 ==


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


The following special character sequences are also available:
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.
* <code>##g##</code> - Green
</div><div class="col-sm-12 col-xs-12 col-md-4 col-lg-4">
* <code>##y##</code> - Yellow
== Project Structure ==
* <code>##bl##</code> - Blue
* <code>##r##</code> - Red
* <code>##b##</code> - 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 <code>##!(colorcode)##</code> option to turn color off prior to end of line.
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. Our organizational structure consists of BDFL and a small number of support staff, as well as members of our user community who are involved in improving Funtoo Linux. Development efforts are driven by the BDFL as well as our users, and efforts are under way to implement various mechanisms to allow supporters of Funtoo Linux to chart the future direction of the project.


Here is an example of its use:<console>
'''Learn more about Funtoo Linux's [[staff]] and [[Funtoo Linux Vision|development vision]].'''
# ##i##bluetoothctl
</div><div class="col-sm-12 col-xs-12 col-md-4 col-lg-4">
[##g##NEW##!g##] Controller 00:02:72:C9:62:65 antec [default]
== Distinctives ==
##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>


== Fancy Notes ==
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.
notes, warnings, tips, and important templates will help bring emphasis to articles drawn up.
<pre>{{fancynote|this is a fancy note}}</pre><br />
{{fancynote|this is a fancy note}}<br />


<pre>{{fancyimportant|this is a fancy important}}</pre><br />
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.
{{fancyimportant|this is a fancy important}}<br />


<pre>{{fancywarning|this is a fancy warning}}</pre><br />
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.
{{fancywarning|this is a fancy warning}}<br />
</div><div class="col-xs-12">
== Help Document Ebuilds! ==


<pre>{{fancytip|this is a fancy tip}}</pre><br />
We need help adding documentation for ebuilds to our wiki. See below for a list of pages:
{{fancytip|this is a fancy tip}}<br />


== Kernelop ==
This page lists all ebuilds with pages on the Funtoo Linux wiki.
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>.}}
{{#ask:[[Category:Ebuilds]] [[CatPkg::+]]
 
|?CatPkg=
Adding this entry will give you the following output:
|?Repository=
{{kernelop|title=foo,bar|desc=
|?Summary=
kernel options
|format=listwidget
|link=all
|headers=show
|searchlabel=… further results
|class=sortable wikitable smwtable
|limit=9999
}}
}}


Here's a more concrete example:
'''Add an Ebuild page:''' (see [[Adding an Ebuild to the Wiki]] for instructions)
{{kernelop|title=File systems|desc=
<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 ==
{{#forminput:form=Ebuild|size=|default value=|button text=Add Package|autocomplete on namespace=Package|remote autocompletion|placeholder=Descriptive name|query string=namespace=Package}}


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:
== Help Document! ==


<pre>
The [[:Help:Funtoo_Editing_Guidelines | How to 'wiki']] sidebar link has several formatting examples.  Have a look at [[Requested-Documents]] and [[:Category:Needs_Updates | pages that need to be updated.]]  Please search the wiki before creating pages to ensure that you are not duplicating efforts.
{{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.}}


== Screencasting ==
</div></div></div>
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.<br />
tiny:
<pre>{{#widget:YouTube|id=5KDei5mBfSg|width=320|height=180}}</pre>
standard:
<pre>{{#widget:YouTube|id=5KDei5mBfSg|width=700|height=420}}</pre>
{{#widget:YouTube|id=5KDei5mBfSg|width=700|height=420}}


[[Category:Wiki Development]]
__NOTITLE__
__NOEDITSECTION__
{{#subobject:|slideIndex=0|slideCaption=|slideImage=/slideshow/13972219722_aa48a588c1_c.jpg}}
{{#subobject:|slideIndex=1|slideCaption=|slideImage=/slideshow/14409383560_8a19a9b3d9_c.jpg}}

Revision as of 03:57, September 21, 2014

Welcome to Funtoo Linux

Funtoo Linux is a Linux-based operating system that is a variant of 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.
  • ...creative: We seek creative, elegant and maintainable solutions to problems of all kinds.

View the Funtoo Linux FAQ for answers to common questions.

Resources

   Important

Support Funtoo to help our project grow! Donate $15 per month and get a free Funtoo Virtual Container.

Our community has a number of excellent resources for communication and collaboration:

Getting Started

We encourage you to install Funtoo Linux, and get involved in our user community. Get to know fellow Funtoo Linux users on our forums. If you have any improvements or find any bugs in Funtoo Linux, you are strongly encouraged to report them on our bug tracker. We take all bugs seriously, and all work performed on Funtoo Linux is tracked on our bug tracker, for purposes of transparency.

Funtoo Linux has a very active IRC community on Freenode, in the #funtoo channel, and you are encouraged to hang out online with us.

Project Structure

Funtoo Linux is led by Daniel Robbins, the creator and former Chief Architect of Gentoo Linux, who serves as benevolent dictator for life (BDFL) of the project. Our organizational structure consists of BDFL and a small number of support staff, as well as members of our user community who are involved in improving Funtoo Linux. Development efforts are driven by the BDFL as well as our users, and efforts are under way to implement various mechanisms to allow supporters of Funtoo Linux to chart the future direction of the project.

Learn more about Funtoo Linux's staff and development vision.

Distinctives

Funtoo Linux packages are installed from source code, automatically, thanks to the 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.

We use Git for all our development, and we also use Git to deliver our ports tree to you.

In contrast to Gentoo Linux, we offer a number of innovations, including our extensive use of git, our profile system, boot-update boot management tool, our incredibly flexible template-based networking scripts, Metro distribution build system, support of Debian, RHEL and other kernels, enhanced Python support, Portage mini-manifests, user-centric distribution model, and a large number of community infrastructure improvements.

Help Document Ebuilds!

We need help adding documentation for ebuilds to our wiki. See below for a list of pages:

This page lists all ebuilds with pages on the Funtoo Linux wiki.

{{#ask: CatPkg::+ |?CatPkg= |?Repository= |?Summary= |format=listwidget |link=all |headers=show |searchlabel=… further results |class=sortable wikitable smwtable |limit=9999 }}

Add an Ebuild page: (see Adding an Ebuild to the Wiki for instructions)


Help Document!

The How to 'wiki' sidebar link has several formatting examples. Have a look at Requested-Documents and pages that need to be updated. Please search the wiki before creating pages to ensure that you are not duplicating efforts.


{{#subobject:|slideIndex=0|slideCaption=|slideImage=/slideshow/13972219722_aa48a588c1_c.jpg}} {{#subobject:|slideIndex=1|slideCaption=|slideImage=/slideshow/14409383560_8a19a9b3d9_c.jpg}}

Retrieved from "https://www.funtoo.org/index.php?title=Help:Funtoo_Editing_Guidelines&oldid=5601"