Edit page EditingTips
[wiki.git] / EditingTips
index 2b7ac6e38ab3bfe763908ecd53bfb54bf54b448c..9fc46534de6f0f3c43ad95fa329913dfbc436062 100644 (file)
@@ -1,43 +1,72 @@
-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 WikiSandBox.
+Click **Raw Text** to see the markup for this page, and try it yourself in WikiSandBox.
 
-==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.
+---
 
-Leave blank lines between paragraphs.
+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
+
+Anchored links also work with [[FrontPage|wiki pages]], [[/index.html | local paths]], and [[non_wiki_words]].
+
+If you link to a directory, GeekiGeeki will automatically generate an index for it: [[sys/macros]]
+
+Image links: [[http://www.laptopgiving.org/|GiveOneGetOne.jpg]]
+
+== Inline media ==
+
+==== Images ====
+{{GerryStich.jpg}}
+
+==== Images with thumbnails ====
+{{GerryStich.jpg|Stich!}}
+
+==== Scaled images ====
+{{GerryStich.jpg|tiny|maxwidth=48}}
+
+
+==== Including other wiki pages ====
+
+Use the same syntax to embed wiki pages inside other wiki pages:
 
+  {{IncludedPage}}
 
-Anchored links also work with [[FrontPage wiki pages]]
-and [[/index.html local paths]].
+You can also pass arguments to included pages!  It works like a simple template system:
 
+  {{TemplatePage | hello=Ciao | world=mondo}}
 
-==Block elements==
+
+==== Including external resources inline ====
+{{http://www.codewiz.org/wikigit/geekigeeki.git/blob_plain/HEAD:/geekigeeki.py}}
+
+== Macros ==
+
+ * Your remote IP: <<CgiVar | REMOTE_ADDR>>
+ * Query string: <<CgiVar | QUERY_STRING>>
+ * <<NonexistentMacro | param1 | param2 >>
+
+== Block elements ==
+
+Leave blank lines between paragraphs.
+
+You can insert line\\
+breaks\\
+with double backslashes: \****\.
 
 If you indent text
   like this, then it is indented in the output
     you can have multiple levels of indent
 
-And if you put asterisks at the start of the line
-
-  * you get a 
-  * bulleted
-  * list
-    * which can also be indented
-      * to several levels
-
 To insert program source without reformatting in a monospace font, use three curly braces:
 
 {{{
@@ -48,14 +77,47 @@ To insert program source without reformatting in a monospace font, use three cur
 
 Just like that.
 
-==Rulers==
+== Itemized lists ==
+
+If you put asterisks (*) at the start of the line
+
+  * you get a 
+  * bulleted
+  * list
+    * which can also be indented
+      * to several levels
+
+You can also have numbered lists, using the number (#) sign:
+ # first item
+ # second item
+   # first indented item
+   # second indented item
+ # third item
+
+== 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====
@@ -63,6 +125,40 @@ 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>
+
+== Pragmas ==
+
+Wiki pages can provide special commands in their header, in the form:
+
+{{{
+# &lt;keyword&gt; &lt;values&gt;
+}}}
+
+=== Access Control Lists ===
+
+{{{
+# acl SomeUser:read,write OtherUser:read All:none
+}}}
+
+Limit read or write access to specific authenticated users
+
+=== Custom cascading style sheets ===
+
+{{{
+# css my_style.css
+}}}
 
-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.
+Include a custom CSS before the default ones.