Help:Editing

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
m (updated section, view source tab, restored link to FedoraMain)
(revert Kausdev's translation)
 
(33 intermediate revisions by 13 users not shown)
Line 1: Line 1:
{{admon/important|2008-09-06 Wiki structure rules now in place|[[Help:Wiki_structure]] describes how to structure the wiki, including page naming.}}
+
{{autolang|base=yes}}
 
+
{{admon/note|Additional markup resources|[http://meta.wikimedia.org/wiki/Help:Editing Help:Editing from Mediawiki.org] is a good source for markup help. There is also a handy [http://meta.wikimedia.org/wiki/Help:Reference_card reference card] image.}}
+
  
 
<!-- Useful to know but let's not highlight this anymore; left here in case anyone is desparate.
 
<!-- Useful to know but let's not highlight this anymore; left here in case anyone is desparate.
 
{{admon/tip|Old wiki content available to help in cleanup|The old wiki and the content snapshot at the time of the conversion is available at http://fedoraproject.org/wikiold/.}} -->
 
{{admon/tip|Old wiki content available to help in cleanup|The old wiki and the content snapshot at the time of the conversion is available at http://fedoraproject.org/wikiold/.}} -->
 
+
The Fedora Project Wiki has a very low barrier to entry for editors. (For more about wikis and the Fedora Project Wiki in particular, see the [[Wiki]] page.) However, there can be a small learning curve when beginning to use wiki, and we have a number of guidelines that all editors should follow. This page provides those guidelines and a few tips to help you get going.
<!-- Still somewhat useful, but we need to move on from this attitude; it is no longer clean-up from migration but moving ahead with embracing MediaWiki.
+
{{admon/tip|Wiki migration tasks you may need to do|Read the [[FedoraProject:Wiki migration to-do]] to see if there is anything you need to do for your user or SIG/subProject pages.}} -->
+
 
+
The Fedora Project Wiki has a very low barrier to entry for editors. However, there can be a small learning curve when beginning to use wiki, and we have a number of guidelines that all editors should follow. This page provides those guidelines and a few tips to help you get going.
+
  
 
This document is divided in three parts: gaining edit access, basic wiki editing, and more advanced editing.
 
This document is divided in three parts: gaining edit access, basic wiki editing, and more advanced editing.
Line 19: Line 13:
  
 
# Familiarize yourself with the information on this page and the pages that it links to. Basic guidelines that should be followed throughout the wiki are covered here.  Failure to follow these guidelines creates unnecessary work for other volunteers and may result in revocation of editing privileges.
 
# Familiarize yourself with the information on this page and the pages that it links to. Basic guidelines that should be followed throughout the wiki are covered here.  Failure to follow these guidelines creates unnecessary work for other volunteers and may result in revocation of editing privileges.
# Complete the Contributor License Agreement through the [[Infrastructure/AccountSystem|Fedora Account System]]. Signing the CLA gives the Fedora Project the ability to license your contributions to the wiki under the ''[[Legal/Licenses/OPL| Open Publication License 1.0]] without options''.  This assures that your contributions will remain forever Free for the community to use, modify, and redistribute, just like the Fedora distribution.  See our [[Legal]]  section for more information. Follow the instructions at [[Infrastructure/AccountSystem/CLAHowTo]].
+
# Complete the [[Legal:Fedora_Project_Contributor_Agreement|Fedora Project Contributor Agreement]] through the [[Infrastructure/AccountSystem|Fedora Account System]]. Signing the [[Legal:Fedora_Project_Contributor_Agreement|FPCA]] gives the Fedora Project the ability to license your contributions to the wiki under our [[Legal/Licenses#This_Website|free license]].  This assures that your contributions will remain forever Free for the community to use, modify, and redistribute, just like the Fedora distribution.  See our [[Legal]]  section for more information. Follow the instructions at [[Infrastructure/AccountSystem/CLAHowTo]].
  
{{Admon/note|If you are interested in more general website maintenance, or wish to be part of the Fedora Websites team, please see the [[Websites]] page. | Information on writing new formal Fedora documentation using the wiki is available from [[DocsProject/WritingUsingTheWiki|Writing Wiki Documentation]].}}
+
{{Admon/note|If you are interested in more general website maintenance, or wish to be part of the Fedora Websites team, please see the [[Websites]] page. | Information on writing new formal Fedora documentation using the wiki is available from [[Writing for DocBook using the wiki]].}}
  
== Guidelines and Wiki Etiquette ==
+
== Etiquette guidelines ==
 +
Refer to [[Help:Wiki rules and etiquette]] for some general etiquette guidelines on editing the Fedora wiki.
  
There are a few simple points you should follow as you make changes to the wiki. Below are some examples. In general, be courteous and use common sense.  Defying these guidelines and causing problems are a good way to get your edit privileges revoked.  If you have questions, you can ask on #fedora-websites on [http://freenode.net/ freenode].
+
== Creating pages ==
 
+
The Fedora Project Wiki is large, and so there is a need to maintain a proper hierarchy and organization. The best way to learn about these is to review [[Help:Wiki structure]] and [[Help:Categories]], and then to review the existing layout of the wiki.  Our guidelines will help you name your pages in a way that will help them be more readable, translatable, and easier for search engines to find and promote.
=== Introduce yourself ===
+
 
+
Before you start editing any page, kindly introduce yourself by adding your information to your wiki page. After you have registered your name in the wiki, you automatically have a personal wiki page located at <code><nowiki>http://fedoraproject.org/wiki/User:</nowiki><username></code>, where <code><username></code> is replaced by your Fedora Account System account name. You can also easily get to your wiki page by clicking your username in the top right-hand corner of each page of the wiki.
+
 
+
For examples, take a look at [http://fedoraproject.org/w/index.php?title=Special%3AAllpages&from=&namespace=2 some wiki pages of our contributors].
+
 
+
Make sure you mention at least your email address and, if you are on IRC often, your IRC nick and channels you are often in.
+
 
+
=== Always watch pages that you create or edit ===
+
 
+
It is important that you follow changes to pages you create or edit, so you can coordinate with others working in the wiki content. Wiki editors usually add notes to the pages to convey information to each other as part of working together, and it helps to keep track of these changes.
+
 
+
You can find the '''watch''' link in the tab bar at the top of a page when you are logged in.
+
 
+
=== Be Bold ===
+
 
+
Be '''bold''' while editing changes. Wiki changes are tracked and can be reverted when necessary. This doesn't mean you should be reckless especially when making large changes to key documents.
+
 
+
For more information on being '''bold''', take a look at the [[wikipedia:Wikipedia:Be_bold |be '''bold''' editing guideline on Wikipedia]].
+
 
+
=== Avoid unnecessary edits of pages that discuss legal issues ===
+
 
+
These pages have been carefully written, and the words chosen carefully. When changing these documents, it is usually best to ask for review before applying changes. You can contact the [[Board|Fedora Advisory Board]] for assistance.
+
 
+
=== Do not provide details of forbidden items ===
+
 
+
Do not add any information that violates the law.  Remember that the Fedora Project is an entity in the United States, and is governed by its laws.  Avoid linking to or adding information about software that is not free and open source or that is legally encumbered.  If you think you have a special exception, bring it to the attention of the [[Websites]] team for discussion.  See the [[ForbiddenItems]] page for examples of items that should be avoided.
+
 
+
Bring questions to the [[Websites]]  team for discussion.  If needed, they can get the official word.
+
 
+
=== Be careful when editing key guides or pages ===
+
 
+
Large and important guides, such as the [[Packaging/Guidelines| Packaging Guidelines]] , are generally managed by a specific individual or small group.  It is best to work with them when you feel that changes are needed.
+
 
+
Important pages, like the FedoraMain or [[Distribution/Download|  Download]]  pages, are the first thing that many visitors see.  Changes to such pages should generally be left to experienced contributors.  If you feel that something on such a page should be altered, bring the issue to the [[Websites]]  team for discussion.
+
 
+
=== Do not edit pages just to edit pages ===
+
 
+
Senseless edits should be avoided. Making an alteration to a page just to put your name in the edit log is unacceptable. There are plenty of pages (most of them, in fact) that have real errors that can be corrected. Instead of making pointless edits, such as removing or adding whitespace or changing links from fedoraproject.org to www.fedoraproject.org (the former is preferred), try finding errors in spelling, grammar or punctuation that can be corrected.  Also, when correcting a small error, mark "This is a minor edit" using the appropriate checkbox before you save it.
+
 
+
=== Avoid renaming pages or moving content without coordination ===
+
 
+
Wiki pages are generally referred to and linked to from various other locations. It is important that you coordinate with the appropriate groups before moving content or renaming existing pages. It would be better to avoid doing that without strong rationale. If you wish to discuss moving a particular item, bring your questions to the [[Websites]] team.
+
 
+
=== Deleting Pages ===
+
 
+
Wiki pages that are no longer needed can be tagged for deletion by adding <nowiki>{{Delete|Reason}}</nowiki> to the beginning of the page, this gives Wiki Administrators the ability to ensure that important or archivable content is not lost.
+
 
+
=== Follow the ideals that Fedora holds important ===
+
 
+
For example, try to remain desktop-neutral and user-friendly, especially for non-technical users who are new to Linux and to Fedora. Users may use GNOME, KDE, the console, or some other environment. Try to keep that in mind when writing instructions. Make sure that Fedora's devotion to free and open source technology is also represented properly.
+
 
+
=== Sign your attachments ===
+
 
+
When you attach a file to a wiki page, you should create a detached signature with your GPG keySome file formats, such as RPM packages, support GPG keys, in which case you do not need to create a detached signature -- a signature in the file will be enough.  A detached signature can be attached to the page alongside the original attachment, or can be included in the page itself.
+
 
+
GPG signatures allow others who download your file to verify that it came from you and has not been modified or corrupted.  They do not violate your privacy in any way, they simply allow others to have confidence in the origin of your files.
+
 
+
Images and simple documents are safe to leave without a signature, but there would be no harm in adding one anyway to verify that you were the author.
+
 
+
If you do not have a GPG key or want to learn more, see the [[Cryptography]]  page.
+
 
+
=== Review your changes for errors ===
+
 
+
Whether you are a skilled writer, or your English skills are not strong, invite someone else to review. Well-written documents are important to Fedora's image. Even the best writers are prone to typos or other errors. Take a moment to review your changes to catch small errors. Use the '''Show preview''' button when editing a page to check your syntax.
+
 
+
=== Fedora is a community ===
+
 
+
When writing content, for the wiki or elsewhere, remember that Fedora is a community.  ''We'' operate as one, unified group, moving towards common goals.  ''We'' do not need to distinguish one group or class against another.  For example, there is no need to distinguish between contributors who work for Red Hat and those who do not.  All contributors are part of the same community.  There will be cases where classification is necessary, but it can be avoided otherwise.
+
 
+
=== If you aren't sure about something, feel free to ask ===
+
 
+
Other community members will be happy to assist you. The #fedora-websites channel on [http://freenode.net/ freenode]  is the perfect place to discuss the wiki or other Fedora websites.
+
 
+
{{Anchor|Watch-Your-Pages}}
+
=== Watch your pages, and other ones, too ===
+
 
+
Two details make a Wiki successful as an open content collaboration tool.  First is being able to watch content you are responsible for, to make certain it stays true to its mission.  Second is being able to watch other content develop, grow, and occasionally need your help.
+
 
+
To watch any page on the wiki, after logging in, click the '''watch''' link in the tab bar at the top of a page. It should change to '''unwatch''' after it has finished. If a page has '''unwatch''' at the top, you are already watching that page. You can click '''unwatch''' to unwatch a page.
+
 
+
To receive emails for every edit, go to '''[[Special:Preferences|my preferences]]''' (at the top of the page by your name) and make sure to check the appropriate boxes in the '''User profile''' tab, under '''Email'''.
+
 
+
==== Using Special:Watchlist ====
+
[[Special:Watchlist]] (available by clicking '''my watchlist''' at the top of each page when you are logged in) displays pages you are currently watching. For more information on how to use this special page, please [http://www.mediawiki.org/wiki/Manual:Watchlist the manual page at Mediawiki.org].
+
 
+
We are now maintaining a stand-alone [[Watchlist_How-To]] to help Fedora contributors with specific suggestions and tools.
+
 
+
=== Summarize your changes (aka commit log message) -- this is the rule ===
+
 
+
We all need to be able to quickly glance at a change and know the substance of it.  A full diff is not always available. You must supply a summary of your change (''Summary:'' field when editing). This is akin to a changelog message.  Explain what you did and why, as well as other useful links and details.
+
 
+
If you choose to not put in a summary, it should be the rare exception.  One reason is when doing a minor edit.  In that case, be sure to check ''This is a minor edit'' when saving.
+
  
 
== Editing with Mediawiki ==
 
== Editing with Mediawiki ==
 
+
Refer to [[Help:Wiki syntax and markup]] for basic information on how to write in MediaWiki syntaxIt's really easy, and the wiki makes it easy for you to create a beautiful page with almost no markup at all.
{{admon/note|If you need help with syntax that is not listed here, the [http://www.mediawiki.org/wiki/Help:Contents Mediawiki Help] should contain it.}}
+
 
+
=== Basic Syntax ===
+
{|
+
! What you type !! What it looks like
+
|-
+
| <pre><nowiki>'''bold text'''</nowiki></pre> || '''bold text'''
+
|-
+
| <pre><nowiki>''italics''</nowiki></pre> || ''italics''
+
|-
+
| <pre><nowiki>'''''bold italics'''''</nowiki></pre> || '''''bold italics'''''
+
|-
+
| <pre><nowiki><code>Monospace text</code></nowiki></pre> || <code>Monospace text</code>
+
|}
+
 
+
=== Lists ===
+
{|
+
! What you type !! What it looks like
+
|-
+
| <pre><nowiki>* A list item
+
* Another list item
+
** Oh joy, more list items!</nowiki></pre> ||
+
* A list item
+
* Another list item
+
** Oh joy, more list items!
+
|-
+
| <pre><nowiki># A numbered item
+
# Another numbered item
+
## Sub items
+
## More sub items
+
# Third numbered item</nowiki></pre> ||
+
# A numbered item
+
# Another numbered item
+
## Sub items
+
## More sub items
+
# Third numbered item
+
|-
+
| <pre><nowiki>* An unordered item...
+
*# With a sub-list that is ordered
+
*# More steps
+
* Back to the first list
+
*# Another ordered list
+
*#* With its own sub point</nowiki></pre> ||
+
* An unordered item...
+
*# With a sub-list that is ordered
+
*# More steps
+
* Back to the first list
+
*# Another ordered list
+
*#* With its own sub point
+
|}
+
 
+
{{anchor|Linking}}
+
 
+
=== Links ===
+
{|
+
! What you type !! What it looks like
+
|-
+
| <pre><nowiki>Visit [[DocsProject]] to learn more about
+
Fedora's documentation.</nowiki></pre> || Visit [[DocsProject]] to learn more about Fedora's documentation.
+
|-
+
| <pre><nowiki>Our [[Websites|websites team]] offers many
+
individuals who can help Fedora.</nowiki></pre> || Our [[Websites|websites team]] offers many individuals who can help Fedora.
+
|-
+
| <pre><nowiki>See [[Artwork#Join]] on how to
+
join the Art Team.</nowiki></pre> || See [[Artwork#Join]] on how to join the Art Team.
+
|-
+
| <pre><nowiki>[[The weather in London]] is a
+
page that doesn't exist yet.</nowiki></pre> || [[The weather in London]] is a page that doesn't exist yet.
+
|-
+
| <pre><nowiki>http://fedoraproject.org/</nowiki></pre> || http://fedoraproject.org/
+
|-
+
| <pre><nowiki>Here are some sites:
+
[http://www.deviantart.com]
+
[http://www.flickr.com]</nowiki></pre> || Here are some sites: [http://www.deviantart.com] [http://www.flickr.com]
+
|-
+
| <pre><nowiki>[http://fedoraproject.org Our home page]
+
is full of interesting information.</nowiki></pre> || [http://fedoraproject.org Our home page] is full of interesting information.
+
|-
+
| <pre><nowiki>Use a ':' in the link to link
+
to an [[:Image:Growth_wide.jpg|image]].</nowiki></pre> || Use a ':' in the link to link to an [[:Image:Growth_wide.jpg|image]].
+
|-
+
| <pre><nowiki>The [[:Category:Documentation]] lists all
+
end-user documentation.</nowiki></pre> || The [[:Category:Documentation]] lists all end-user documentation.
+
|-
+
| <pre><nowiki>The [[Category:Documentation]] link puts
+
this page in the listed category; the link
+
appears automatically on the bottom of the
+
page and not inline.</nowiki></pre> || The <nowiki>[[Category:Documentation]]</nowiki> link puts this page in the listed category; the link appears automatically on the bottom of the page and not inline.
+
|}
+
 
+
{{admon/note|There are two ways to use the Category links|Be sure to use the ':' before the word Category when you intend to link to a category page.  Omit the ':' when the page is supposed to be in that category.  Refer to the examples above.}}
+
 
+
=== Tables ===
+
Tables should be used sparingly and only when necessary.
+
 
+
For more advanced table usage, read up on [http://www.mediawiki.org/wiki/Help:Tables Mediawiki.org's page on tables].
+
 
+
{|
+
! What you want !! How to get it
+
|-
+
| Start a table || <pre>{|</pre>
+
|-
+
| Table header || <pre>! Column 1 !! Column 2 !! Column 3</pre>
+
|-
+
| New row || <pre>|-</pre>
+
|-
+
| Table row || <pre>| Cell 1 || Cell 2 || Cell 3</pre>
+
|-
+
| End a table || <pre>|}</pre>
+
|}
+
 
+
=== IRC Logs ===
+
IRC logs can either be surrounded in <code><nowiki><pre></nowiki></code> tags, or converted into MediaWiki pipe-tables with [http://mg.pov.lt/irclog2html/ irclog2html] and [http://ianweller.fedorapeople.org/irclog2html/ Ian's MediaWiki patch for irclog2html].
+
 
+
{{Anchor|Structure_of_a_Wiki_Page}}
+
 
+
== Structure of a Wiki Page ==
+
 
+
This section describes the common structure of a wiki page.  Follow these guidelines for every wiki page.  There are additional rules used for formal Fedora documentation, covered in [[DocsProject/WritingUsingTheWiki]] ; those rules are only required for content written to follow the procedures of the [[DocsProject| Fedora Documentation Project]].  Pages that are templates of standard content that are drawn into other pages may have a different structure.
+
 
+
{{admon/note|Header 1 (h1) deprecated for use in markup|The header 1 is defined by the page title.  When making new or migrating pages, either re-nest or re-structure the page to have ''only'' header 2 and below.}}
+
 
+
* The title of the page is a first-level header.  It is created automatically from the page title.
+
* Sections are created using the equals symbols in pairs:
+
<pre>
+
== Header 2 ==
+
=== Header 3 ===
+
==== Header 4 ====
+
===== Don't do this, 5 levels of nesting means you need a new page or three =====
+
</pre>
+
* The table of contents is automatically created and populated when the page grows big enough.
+
* Anchors to sections are automatically created, with specific symbols used in place of punctuation and spaces:
+
<pre>
+
This page ==> This_page
+
This, that, and the other page ==> This%2C_that%2C_and_the_other_page
+
</pre>
+
 
+
 
+
{{admon/tip|You can use .2C instead of %2C for anchors|The substitute of '.' for '%' works for anchors against a specific section.}}
+
 
+
== Quick Tips ==
+
 
+
These are the basic things that you need to know to edit this Wiki.
+
 
+
{{Admon/note | For more information on drafting documentation on the Wiki, refer to [[DocsProject/WritingUsingTheWiki|  Writing Wiki Documentation]].}}
+
 
+
{{Anchor|Learn_by_Example}}
+
=== Learn by Example ===
+
 
+
Among the better ways to learn how to edit the wiki is reviewing the code of existing pages.  This is very easy to do:
+
 
+
# Find a page whose source you would like to view.
+
# Click on the 'View Source' option.
+
 
+
The wiki will display the plaintext form of that page.  This is particularly valuable for learning some of the clever tricks used by wiki editors ahead of you.  Those 'clever tricks' are valuable, as they allow you to do unique, interesting, and powerful things you might not have thought were possible.  You might try this on pages like [[FedoraMain]].
+
 
+
{{Anchor|Admonitions}}
+
 
+
=== Notes, Tips, and Other Admonitions ===
+
 
+
These are collectively known as admonitions, and [http://docs.fedoraproject.org/documentation-guide/en_US/sn-xml-admon.html are used in DocBook]. To make a paragraph into an admonition, use the special admonition templateA short title and a longer descriptive paragraph are recommended.
+
 
+
{|
+
! '''What you type''' !! '''What you see'''
+
|-
+
||<pre>
+
{{admon/note|A title|Here is more information about
+
this tip, with information that provides more insight
+
into the informative title of the initial paragraph.}}
+
</pre>
+
||{{admon/note|A title|Here is more information about this tip, with information that
+
provides more insight into the informative title of the initial paragraph.}}
+
|}
+
 
+
Indent the initial and second paragraph by one space, to ensure that the box aligns correctly.
+
 
+
These are the standard types of admonition:
+
 
+
{|
+
! '''What you type''' !! '''What you see'''
+
|-
+
||<pre><nowiki>{{admon/note|This is a note|Informational paragraph
+
that tells more about what is going on.}}</nowiki></pre>||{{admon/note|This is a note|Informational paragraph that tells more about what is going on.}}
+
|-
+
||<pre><nowiki>{{admon/tip|This is a tip|Informational paragraph
+
that tells more about what is going on.}}</nowiki></pre>||{{admon/tip|This is a tip|Informational paragraph that tells more about what is going on.}}
+
|-
+
||<pre><nowiki>{{admon/important|This is important|Informational paragraph
+
that tells more about what is going on.}}</nowiki></pre>||{{admon/important|This is important|Informational paragraph that tells more about what is going on.}}
+
|-
+
||<pre><nowiki>{{admon/caution|This is a caution|Informational paragraph
+
that tells more about what is going on.}}</nowiki></pre>||{{admon/caution|This is a caution|Informational paragraph that tells more about what is going on.}}
+
|-
+
||<pre><nowiki>{{admon/warning|This is a warning|Informational paragraph
+
that tells more about what is going on.}}</nowiki></pre>||{{admon/warning|This is a warning|Informational paragraph that tells more about what is going on.}}
+
|}
+
 
+
==== Admonition examples ====
+
 
+
Examples showing context for using these admonitions:
+
 
+
{{admon/note|Cliffs can be very high|[http://en.wikipedia.org/wiki/Cliff Wikipedia can vouch for this].}}
+
{{admon/tip|Standing away from cliff edges is a way to stay safe|For more information, read the <code>cliffs(1)</code> man page.}}
+
{{admon/important|Keep your children away from the cliff edge to your right|Children move around quite a bit and can easily fall off. You should hold their hand.}}
+
{{admon/caution|You are getting near the cliff edge|As mentioned earlier, cliffs can be very high, and it would be bad to fall.}}
+
{{admon/warning|You are about to fall off the cliff|Move away as quickly as possible to avert falling.}}
+
 
+
Refer to the Fedora Documentation Guide for descriptions of the types of admonition: http://docs.fedoraproject.org/documentation-guide/en_US/sn-xml-admon.html
+
 
+
{{Anchor|MarkingTechnicalTerms}}
+
{{Anchor|Marking_Technical_Terms}}
+
 
+
=== Marking Technical Terms ===
+
 
+
Use the ''code'' markup (<code>&lt;code&gt;</code>) to mark the names of applications, files, directories, software packages, user accounts, and other words that have a specific technical meaning. This displays the marked words as <code>monospace</code>.
+
 
+
Use two single-quotes (<code>''</code>) to mark the names of menu items and other elements of the graphical interface. This displays the marked words in ''italic''.
+
 
+
{| border="1" align="center"
+
! Term !! Mark Up !! Formatted example
+
|-
+
| Names of GUI applications || <pre> '''boldface''' </pre> || '''Firefox'''
+
|-
+
| Files, directories || <pre> <code>inline code tags</code> </pre> || <code>/usr/bin/firefox</code>
+
|-
+
| Software packages || <pre> <code>package name</code> </pre> || <code>firefox-1.2.3</code>
+
|-
+
| User accounts || <pre> <code>username</code> </pre> || <code>username</code>
+
|-
+
| Other words that have a specific technical meaning  || <pre> <code>technical term</code> </pre> || ... the class <code>org.fedora.someJava.classname</code> ...
+
|-
+
| Graphical menus and menu items || <pre> ''Menu name'' </pre> || ''Applications > Internet > Firefox Web Browser''
+
|-
+
| Other GUI or WebUI interface element || <pre> ''two single-ticks'' </pre> || ... click the ''Submit'' button ...
+
|-
+
| Inline command and daemons || <pre> <code>command -option</code> <code>daemon</code></pre> || ... run <code>ps -ef | grep httpd</code> to find the PIDs of the running <code>httpd</code> processes.
+
|-
+
| '''Blocks''' of code, configuration files, etc. || <pre> <pre>whitespace preserved< /pre> </pre> || <pre>
+
whitespace
+
    is preservered
+
  here
+
</pre>
+
|-
+
| '''Inline''' pieces of code, configuration files, etc. || <pre> <code>inline whitespace not preserved</code> </pre> || ... Next, modify the variables for <code>set()</code> in <code>/path/to/org/dev108/classname</code> ...
+
|-
+
| First term, glossary term || <pre> ''term'' </pre> || ... '''Firefox''' is an example of a ''graphical user interface'' or ''GUI''.
+
|-
+
| Keystrokes || <pre> '''[Key]''' </pre> || Press the '''[Enter]''' key ...
+
|}
+
 
+
For example:
+
 
+
<pre>
+
The <code>thunderbird</code> package installs the '''Mozilla Thunderbird'''
+
e-mail application. To start '''Thunderbird''', select:
+
  ''Applications > Internet > Thunderbird Email''.
+
</pre>
+
 
+
Which produces:
+
 
+
The <code>thunderbird</code> package installs the '''Mozilla Thunderbird''' e-mail application. To start '''Thunderbird''', select: ''Applications > Internet > Thunderbird Email''.
+
 
+
{{Anchor|Writing_Example_Commands}}
+
 
+
=== Writing Example Commands ===
+
 
+
Example commands are one or more commands set apart from the body of the explanation.  Do not use prompt symbols or any other content that shows machine name, user, directory, etc. (which are details set in the $PS1 environment variable.)
+
 
+
Enclose any example command in <code><nowiki><pre></pre></nowiki></code> tags:
+
 
+
<pre>
+
<pre>
+
su -c "yum install awesome-application"
+
&lt;/pre>
+
 
+
Enter the <code>root</code> password when prompted.
+
</pre>
+
 
+
Which produces:
+
 
+
<pre>
+
su -c "yum install awesome-application"
+
</pre>
+
 
+
Enter the <code>root</code> password when prompted.
+
 
+
{{admon/note|Command examples and root|Many commands require <code>root</code> privileges. The reader should not be logged into their system as <code>root</code>, and so you must specify either <code>su -c</code> or <code>su -</code> when explaining such commands.}}
+
 
+
If the command requires elements to be quoted, nesting should be <code>" '' "</code>, with the single quote marks surrounded by one containing set of double quote marks.  For example:
+
 
+
<pre>su -c "command -o 'Some Text' -file 'More text' foo/bar"
+
</pre>
+
 
+
If you need to have a series of commands or <code>su -c</code> is not responding as expected, have the user switch to <code>root</code> and warn the user to return to a normal user shell afterward.
+
 
+
<pre>su -
+
Password:
+
service food stop
+
cp /etc/foo.d/foo.conf /etc/foo.d/foo.conf.backup
+
vi /etc/foo.d/foo.conf
+
food --test-config
+
...
+
service food start
+
exit
+
</pre>
+
 
+
==== Example command output ====
+
 
+
When the example shows a command as part of showing the output to the screen, you may use a command prompt to clarify commands and output.
+
 
+
<pre>
+
$ su -c "ls -l /root"
+
Password:
+
total 148
+
-rw------- 1 root root  1961 2007-09-21 02:46 anaconda-ks.cfg
+
-rw-r--r-- 1 root root 46725 2007-09-21 02:46 install.log
+
-rw-r--r-- 1 root root  6079 2007-09-21 02:42 install.log.syslog
+
-rw-r--r-- 1 root root  3699 2008-07-28 17:24 scsrun.log
+
-rw-r--r-- 1 root root 45038 2008-01-10 10:21 upgrade.log
+
-rw-r--r-- 1 root root  1317 2008-01-10 10:20 upgrade.log.syslog
+
</pre>
+
 
+
=== Try it Out Yourself ===
+
Try new things in the [[WikiSandBox|  Fedora Wiki Sandbox]] .  It is also a good place to see lots small samples at work.
+
 
+
=== Creating New Pages in the Wiki ===
+
 
+
The Fedora Project Wiki is large, and so there is a need to maintain a proper hierarchy and organization.  The best way to learn about these is to review [[Help:Subpages]]  and [[Help:Categories]], and then to review the existing layout of the wiki.
+
 
+
Redundant names (such as <code>Foo/FooBar/FooBarGrue</code>) should be avoided.  Remember that including 'Fedora' in the page name is redundant.  Major Fedora projects do not need to have 'Project' in their page names, either.  For example, the Fedora Websites Project has its page named 'Websites', not 'FedoraWebsitesProject'.
+
 
+
For the most part, pages should be grouped as subpages by the projects or programs they are part of.  Categories will generally be created for different projects and programs, and should be created sparingly.  Most pages you create should be part of a category, and many should also have appropriate tags.  If you are thinking about creating a new category or tag, please ask the [[Websites]]  team for advice first.
+
 
+
If you have questions, feel free to ask the [[Websites]]  team.
+
 
+
=== Important Pages ===
+
 
+
Key pages, such as Main Page, should be edited sparingly. Changes to such pages should generally be discussed on the mailing lists or on IRC before being applied. Some parts of the wiki may have different permissions. For example, the [[DocsProject]] has a section for the creation of new documentation which is restricted a bit more than the rest of the wiki. In order to gain edit access to such pages, you may have to complete additional steps. You can usually find instructions on those pages.
+
  
 
== Getting Help ==
 
== Getting Help ==
  
If ever you have questions about editing the Fedora Project wiki, or if you need help, please feel free to contact the [[Websites]] team. They have an IRC channel (#fedora-websites on freenode) and a mailing list ([http://www.redhat.com/mailman/listinfo/fedora-websites-list fedora-websites-list]) that are both effective for getting the answers you need.
+
If ever you have questions about editing the Fedora Project wiki, or if you need help, please feel free to contact the [[Websites]] team. They have an [[IRC]] channel called {{fpchat|#fedora-websites}} on freenode.net and a mailing list named {{fplist|websites}} that are both effective for getting the answers you need.
  
 
If you would like to do a lot of editing on the wiki, you should consider [[Websites/Join|joining the Websites team]].
 
If you would like to do a lot of editing on the wiki, you should consider [[Websites/Join|joining the Websites team]].
  
 
[[Category:Documentation]]
 
[[Category:Documentation]]

Latest revision as of 13:04, 2 August 2013

The Fedora Project Wiki has a very low barrier to entry for editors. (For more about wikis and the Fedora Project Wiki in particular, see the Wiki page.) However, there can be a small learning curve when beginning to use wiki, and we have a number of guidelines that all editors should follow. This page provides those guidelines and a few tips to help you get going.

This document is divided in three parts: gaining edit access, basic wiki editing, and more advanced editing.

Contents

[edit] Gaining Edit Access

In order to avoid malicious users defacing the Fedora Project Wiki, we have had to restrict edit access a little. To gain edit access to the wiki, you must follow a few simple steps. Anyone can gain edit access.

  1. Familiarize yourself with the information on this page and the pages that it links to. Basic guidelines that should be followed throughout the wiki are covered here. Failure to follow these guidelines creates unnecessary work for other volunteers and may result in revocation of editing privileges.
  2. Complete the Fedora Project Contributor Agreement through the Fedora Account System. Signing the FPCA gives the Fedora Project the ability to license your contributions to the wiki under our free license. This assures that your contributions will remain forever Free for the community to use, modify, and redistribute, just like the Fedora distribution. See our Legal section for more information. Follow the instructions at Infrastructure/AccountSystem/CLAHowTo.
Note.png
If you are interested in more general website maintenance, or wish to be part of the Fedora Websites team, please see the Websites page.
Information on writing new formal Fedora documentation using the wiki is available from Writing for DocBook using the wiki.

[edit] Etiquette guidelines

Refer to Help:Wiki rules and etiquette for some general etiquette guidelines on editing the Fedora wiki.

[edit] Creating pages

The Fedora Project Wiki is large, and so there is a need to maintain a proper hierarchy and organization. The best way to learn about these is to review Help:Wiki structure and Help:Categories, and then to review the existing layout of the wiki. Our guidelines will help you name your pages in a way that will help them be more readable, translatable, and easier for search engines to find and promote.

[edit] Editing with Mediawiki

Refer to Help:Wiki syntax and markup for basic information on how to write in MediaWiki syntax. It's really easy, and the wiki makes it easy for you to create a beautiful page with almost no markup at all.

[edit] Getting Help

If ever you have questions about editing the Fedora Project wiki, or if you need help, please feel free to contact the Websites team. They have an IRC channel called #fedora-websites[?] on freenode.net and a mailing list named websites that are both effective for getting the answers you need.

If you would like to do a lot of editing on the wiki, you should consider joining the Websites team.