Help:Wiki syntax and markup

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(Make better bullets)
Line 114: Line 114:
  
 
== Structure of a Wiki Page ==
 
== Structure of a Wiki Page ==
 +
{{Anchor|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.
 
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.

Revision as of 19:30, 18 March 2010

Note.png
If you need help with syntax that is not listed here, the Mediawiki Help should contain it.

Contents

Basic Syntax

What you type What it looks like
'''bold text'''
bold text
''italics''
italics
'''''bold italics'''''
bold italics
<code>Monospace text</code>
Monospace text

Lists

What you type What it looks like
* A list item
* Another list item
** Oh joy, more list items!
  • A list item
  • Another list item
    • Oh joy, more list items!
# A numbered item
# Another numbered item
## Sub items
## More sub items
# Third numbered item
  1. A numbered item
  2. Another numbered item
    1. Sub items
    2. More sub items
  3. Third numbered item
* 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
  • An unordered item...
    1. With a sub-list that is ordered
    2. More steps
  • Back to the first list
    1. Another ordered list
      • With its own sub point

Links

What you type What it looks like
Visit [[DocsProject]] to learn more about
Fedora's documentation.
Visit DocsProject to learn more about Fedora's documentation.
Our [[Websites|websites team]] offers many
individuals who can help Fedora.
Our websites team offers many individuals who can help Fedora.
See [[Artwork#Join]] on how to
join the Art Team.
See Artwork#Join on how to join the Art Team.
[[The weather in London]] is a
page that doesn't exist yet.
The weather in London is a page that doesn't exist yet.
http://fedoraproject.org/
http://fedoraproject.org/
Here are some sites:
[http://www.deviantart.com]
[http://www.flickr.com]
Here are some sites: [1] [2]
[http://fedoraproject.org Our home page]
is full of interesting information.
Our home page is full of interesting information.
Use a ':' in the link to link
to an [[:Image:Growth_wide.jpg|image]].
Use a ':' in the link to link to an image.
The [[:Category:Documentation]] lists all 
end-user documentation.
The Category:Documentation lists all end-user documentation.
The [[Category:Documentation]] link puts
this page in the listed category; the link
appears automatically on the bottom of the
page and not inline.
The [[Category:Documentation]] link puts this page in the listed category; the link appears automatically on the bottom of the page and not inline.
Note.png
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 Mediawiki.org's page on tables.

What you want How to get it
Start a table
{|
Table header
! Column 1 !! Column 2 !! Column 3
Table row
|-
Table data
| Cell 1 || Cell 2 || Cell 3
End a table
|}

IRC Logs

IRC logs can either be surrounded in <pre> tags, or converted into MediaWiki pipe-tables with irclog2html and Ian's MediaWiki patch for irclog2html.

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 Fedora Documentation Project. Pages that are templates of standard content that are drawn into other pages may have a different structure.

Note.png
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:
    == Header 2 ==
    === Header 3 ===
    ==== Header 4 ====
    ===== Don't do this, 5 levels of nesting means you need a new page or three =====
    
  • 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:
    This page ==> This_page
    This, that, and the other page ==> This%2C_that%2C_and_the_other_page
    
Idea.png
You can use .2C instead of %2C for anchors
The substitute of '.' for '%' works for anchors against a specific section.