Important note: This Wiki page is edited by participants of the EOWG. It does not necessarily represent consensus and it may have incorrect information or information that is not supported by other Working Group participants, WAI, or W3C. It may also have some very useful information.


Wiki Instructions

From Education & Outreach
Revision as of 13:18, 27 April 2012 by Dboudrea (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

{@@dboudreau - Maybe add some links to other wiki syntax elements referenced elsewhere that people may need like table syntax. But for the sake of conciseness, not necessarily add it all in this page.}

{@@dboudreau - Also, add general instructions for best practices using the wiki, like providing summary of changes and checking the "minor edit" or "watch this page" checkboxes at the bottom of the editor view.}

Getting started

This cheatsheet has been developed to help the EOWG participants get a better grasp of the syntax required to contribute to this wiki.

It also suggests working habits we could all adopt to ensure consistency between our different interventions. Most of the information presented in this section comes from the "official" Wikipedia Cheatsheet and has been reproduced here for your comfort.

During the april 13th EO teleconfence call, it was agreed amongst participants that for general content editing purposes, EO members should use valid HTML instead of wiki syntax when developing content in this platform. However, if for some reason the use of valid HTML is difficult, the following syntax should be used to enbla to production of content.

In order to get a better control over the different sections of a document, it was agreed that section headings should be tagged with wiki syntax and not regular <hn> elements (so the document ends up being separated in sub-sections).

Editor/contributor comments syntax

Whenever a contributor needs to leave a comment in a document instead of directly modifying it, the following syntax should be used in order to ensure consistency between all commenting contributors.

{@@editorName - Comment that goes on, and on, and on, and on...}

Wiki syntax

Section headings

Note1: Do not use level 1 headings in your documents as the level 1 heading is reserved for the page's title.

Note2: A Table of Contents will automatically be generated when four headings are added to an article.

DESCRIPTION YOU TYPE YOU GET
Level 2 Section headings ==Level 2==

Level 2

Level 3 Section headings ===Level 3===

Level 3

Level 4 Section headings ====Level 4====

Level 4

Level 5 Section headings =====Level 5=====
Level 5
Level 6 Section headings ======Level 6======
Level 6

Presentation styles

DESCRIPTION YOU TYPE YOU GET
Italic text ''italic'' italic
Bold text '''bold''' bold
Bold and Italic '''''bold and italic''''' bold and italic

Images

DESCRIPTION YOU TYPE YOU GET
Show an image [[File:Wiki.png|thumb|alt=text|Caption]]
Size an image [[File:Wiki.png|thumb|60px|alt=text|Caption]]

Hyperlinks

DESCRIPTION YOU TYPE YOU GET
Link to another wiki page [[Name of page]]
[[Name of page|Text to display]]
Name of page
Text to display
Link to internal heading [[#Heading name]]
[[#Heading name2|Name2]]
#Heading name
Name2

Lists

DESCRIPTION YOU TYPE YOU GET
Bulleted lists * One
* Two
** Two point one
* Three
  • One
  • Two
    • Two point one
  • Three
Numbered lists # One
# Two
## Two point one
# Three
  1. One
  2. Two
    1. Two point one
  3. Three