Add changes from giskard
[wiki.git] / EditingTips
index 470916d17e2f766ec467c51719be8744e164a62f..045579605b3e3adee4c07251074b4ba4740efab8 100644 (file)
@@ -1,32 +1,42 @@
-Note: You should use formatting sparingly, WikiWikiWeb is about content, not look.
-
-Click '''Raw''''''Text''' in the header to see the markup for this page, and try it yourself in PikiSandBox.
-
-==Text Styles==
-
-You can also write ''italics'' and '''bold'''.
-To write italics, enclose the text in double single quotes.
-To write bold, enclose the text in triple single quotes.
+Click **Raw Text** to see the markup for this page, and try it yourself in WikiSandBox.
 
-Leave blank lines between paragraphs.
+---
 
-If you can't figure out what I mean, click EditPage to look at the source for this page.
+Our wiki syntax is deliberately similar to MoinMoin and WikiCreole.
 
+Note: You should use formatting sparingly, WikiWikiWeb is about content, not look.
+See WikiDesignPrinciples.
 
-==Links==
+== Links ==
 
 Names of pages have to LookLikeThis.
 It's called a WikiName.
 If you write a word that LooksLikeThis, it will be automatically turned into a link.
 
-You can use URLs directly: http://www.codewiz.org/ , or you can make descriptive links with [[http://www.codewiz.org/ some anchor text]]. Links to images will appear inline: http://www.w3.org/Icons/valid-css.png
+You can use URLs directly: http://www.codewiz.org/ ,
+or you can make descriptive links with [[http://www.codewiz.org/ | some anchor text]].
+Links to images will appear inline: http://www.w3.org/Icons/valid-css.png
 
+{{GerryStich.jpg|Stich!}}
 
-Anchored links also work with [[FrontPage wiki pages]]
-and [[/index.html local paths]].
+Anchored links also work with [[FrontPage|wiki pages]], [[/index.html | local paths]], and [[non_wiki_words]].
 
+Image links: [[http://www.laptopgiving.org/|GiveOneGetOne.jpg]]
+
+== Macros ==
+
+<<TitleSearch>>
+<<NonexistentMacro | param1 | param2 >>
+
+Included text: <<Include | IncludedPage>>
+
+== Block elements ==
+
+Leave blank lines between paragraphs.
 
-==Block elements==
+You can insert line\\
+breaks\\
+with double backslashes: \****\.
 
 If you indent text
   like this, then it is indented in the output
@@ -50,14 +60,31 @@ To insert program source without reformatting in a monospace font, use three cur
 
 Just like that.
 
-==Rulers==
+
+== Text Styles ==
+
+To write **bold text**, enclose it in double stars: *////*some word*////*. \\
+To write //italic text//, enclose it in double slashes: /****/some word/****/. \\
+To write ##monospace text##, enclose it in double hashes: #****#some word#****#. \\
+To write __underlined text__, enclose it in double underscores: _****_some word_****_. \\
+To write ^^superscript text^^, enclose it in double carets: ^****^some word^****^. \\
+To write ,,subscript text,,, enclose it in double commas: ,****,some word,****,. \\
+''Double'' and '''triple''' quotes are also supported for compatiblity with other wikis. \\
+These keywords are highlighted: FIXME, TODO, DONE.
+
+TIP: four consecutive stars (*////*////*////*) or slashes (/****/****/****/****) are a good
+way to escape the syntax. :-)
+
+
+== Rulers ==
 
 ---
 ----
 -----
 ------
 
-==Headings==
+
+== Headings ==
 
 ===Level 2===
 ====Level 3====
@@ -65,6 +92,24 @@ Just like that.
 ======Level 5======
 
 
-==Final Notes==
+== Tables ==
+
+||= Table Heading 1 ||= Table heading 2 ||= Table heading 3||
+||  Table cell 4    ||  Table cell 5    || Table cell 6    ||
+||  Table cell 7    ||  Table cell 8    || Table cell 9    ||
+
+
+== Inline HTML ==
+
+<div style="align:right; clear:right; font-size:24px; width:20em; max-width:60%; margin:1ex 0ex 1ex 1ex; border:3px outset #969; background-color:#faf; color: #f00; padding:.3em; text-align:center;">
+You can use ##div##, ##span## and ##iframe## elements with any attribute, including
+<span style="color: green">CSS</span>, of course.
+</div>
+
+== Access Control Lists ==
+
+TODO: document
+
+== Final Notes ==
 
-Be aware that PikiPiki does not lock pages during editing, so if you pause for a long time on the edit screen you may overwrite somebody else's changes.
+Be aware that GeekiGeeki does not lock pages during editing, so if you pause for a long time on the edit screen you may overwrite somebody else's changes.