注意：

The Funtoo Linux project has transitioned to "Hobby Mode" and this wiki is now read-only.

Difference between revisions of "Help:Funtoo Editing Guidelines"

From Funtoo
Jump to navigation Jump to search
m (Protected "Help:Funtoo Editing Guidelines": BDFL sets the editing guidelines ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
m (remove IRC reference)
 
(115 intermediate revisions by the same user not shown)
Line 1: Line 1:
This guide is meant to serve as a reference for those who are interested in helping improve the Funtoo Wiki.
{{Subpages|Basics,Images,Headings,Inline Code,Tables,Page Tools,Tips and Warnings,Source Code,Text Files,ConsoleOutput,Packages,Kernel,Translations,User Pages}}


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 click the "Create" button in the upper right.


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.
'''Thanks for your interest in contributing to the Funtoo Wiki!'''  


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".)
Before we get started, it's a good idea to review what kinds of changes to the wiki
we're looking for, and what kind of changes we're not looking for.


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.
Most of the time it's good to document stuff. But because we want Funtoo Linux to be as seamless an experience as possible, sometimes the best approach is to use IRC or forums for support, or file a bug on our bug tracker. See the table below for the types of wiki edits we consider to be OK:


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.
{{TableStart}}
 
<tr class="active"><th>Type of Edit</th><th>OK?</th></tr>
{{fancytip|The following sections document how to use wikitext and Funtoo templates on the Funtoo wiki.}}
<tr><td>Grammar/spelling fixes</td><td>Yes</td></tr>
 
<tr><td>New wiki content</td><td>Yes</td></tr>
= Paragraphs =
<tr><td>New package information</td><td>Yes</td></tr>
 
<tr><td>Adding to existing article</td><td>Yes</td></tr>
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.
<tr><td>Adding missing/incomplete information</td><td>Yes</td></tr>
 
<tr><td>Making corrections</td><td>Yes</td></tr>
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:
<tr class="danger"><td>Adding workarounds to problems experienced, esp. install issues</td><td>Maybe not - try forums or Discord/Telegram first, and possibly open bug first on [https://bugs.funtoo.org bug tracker].</td></tr>
 
{{TableEnd}}
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 a 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
}}
 
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>
 
{{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.}}
 
Examples of usage:
* [[Rootfs over encrypted lvm]]
* [[Boot-Update]]
* [[Fonts]]
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=
Note that we use a <tt>#</tt> prompt for <tt>root</tt> and a <tt>$</tt> prompt to denote a non-root user.}}
 
Examples of usage:
* [[Zope HOWTO]]
* [[Benchmarking]]
 
== Fancy Notes ==
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 />
{{fancyimportant|this is a fancy important}}<br />
 
<pre>{{fancywarning|this is a fancy warning}}</pre><br />
{{fancywarning|this is a fancy warning}}<br />
 
<pre>{{fancytip|this is a fancy tip}}</pre><br />
{{fancytip|this is a fancy tip}}<br />
 
== 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
}}
 
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
}}
 
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 [[: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]]
 
== &#60;tt&#62; and &#60;code&#62; ==
To emphasize filenames, commands, and other technical jargon when they appear inline in a paragraph, use the  <tt>&#60;tt&#62;</tt> or <tt>&#60;code&#62;</tt> option. To use these, follow the example below:
<pre>
The <tt>/etc/fstab</tt> file is an important one. Another important file is <code>/boot/grub/grub.cfg</code>.
</pre>
 
This example produces the following output (notice the difference between the fonts?): <br> The <tt>/etc/fstab</tt> file is an important one. Another important file is <code>/boot/grub/grub.cfg</code>.
 
== Collapsible text ==
 
<pre><div class="toccolours mw-collapsible"> some text you might want to fold away because its a huge explanation.</div></pre><br />
 
<div class="toccolours mw-collapsible"> some text you might want to fold away because its a huge explanation.</div><br />
 
<pre><div class="toccolours mw-collapsible mw-collapsed">pre collapsed text because it is a huge explanation.</div></pre><br />
 
<div class="toccolours mw-collapsible mw-collapsed">pre collapsed text because it is a huge explanation.</div>
 
== 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.<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}}


The basic concept is this -- some complications should simply ''be fixed in Funtoo'' rather than documented for users as ugly workarounds. So be aware
of types of issues that may fall into this category and take appropriate action such as [https://bugs.funtoo.org filing a bug]. We want the Funtoo experience to be as straightforward as possible, especially for new users. Now that that's out of the way, please browse the '''subpage links at the top of the page''' to familiarize yourself with Funtoo editing guidelines -- and have fun!
[[Category:Wiki Development]]
[[Category:Wiki Development]]
[[Category:Official Documentation]]

Latest revision as of 03:53, November 13, 2021

Subpages:
Basics
Images
Headings
Inline Code
Tables
Page Tools
Tips and Warnings
Source Code
Text Files
ConsoleOutput
Packages
Kernel
Translations
User Pages


Thanks for your interest in contributing to the Funtoo Wiki!

Before we get started, it's a good idea to review what kinds of changes to the wiki we're looking for, and what kind of changes we're not looking for.

Most of the time it's good to document stuff. But because we want Funtoo Linux to be as seamless an experience as possible, sometimes the best approach is to use IRC or forums for support, or file a bug on our bug tracker. See the table below for the types of wiki edits we consider to be OK:

Type of EditOK?
Grammar/spelling fixesYes
New wiki contentYes
New package informationYes
Adding to existing articleYes
Adding missing/incomplete informationYes
Making correctionsYes
Adding workarounds to problems experienced, esp. install issuesMaybe not - try forums or Discord/Telegram first, and possibly open bug first on bug tracker.

The basic concept is this -- some complications should simply be fixed in Funtoo rather than documented for users as ugly workarounds. So be aware of types of issues that may fall into this category and take appropriate action such as filing a bug. We want the Funtoo experience to be as straightforward as possible, especially for new users. Now that that's out of the way, please browse the subpage links at the top of the page to familiarize yourself with Funtoo editing guidelines -- and have fun!

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