Edit page EditingTips

[wiki.git] / EditingTips

diff --git a/EditingTips b/EditingTips
index b77e9d6e1dbe9c0559f9a047ace85984b7e4c99c..9fc46534de6f0f3c43ad95fa329913dfbc436062 100644 (file)
--- a/EditingTips
+++ b/EditingTips
@@ -1,18 +1,11 @@
-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.

 
 

-This wiki syntax is deliberately similar to MoinMoin and WikiCreole.
-
-== Text Styles ==
+---

 
 

-Leave blank lines between paragraphs.
+Our wiki syntax is deliberately similar to MoinMoin and WikiCreole.

 
 

-To write //italics//, enclose the text in double slashes: /''''''/word/''''''/.  
-To write **bold**, enclose the text in double stars: *''''''*word*''''''*.
-Double and triple quotes are also supported for backwards compatiblity with other wiki's.
-These keywords are highlighted: FIXME, TODO, DONE.  
+Note: You should use formatting sparingly, WikiWikiWeb is about content, not look.
+See WikiDesignPrinciples.

 
 == Links ==
 
 
 == Links ==
 


@@ -26,21 +19,54 @@ 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]].
 
 
 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}}
+
+You can also pass arguments to included pages!  It works like a simple template system:
+
+  {{TemplatePage | hello=Ciao | world=mondo}}
+
+
+==== 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 ==
 
 
 == 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
 
 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:
 
 {{{
 To insert program source without reformatting in a monospace font, use three curly braces:
 
 {{{


@@ -51,6 +77,38 @@ To insert program source without reformatting in a monospace font, use three cur
 
 Just like that.
 
 
 Just like that.
 

+== 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 ==
 
 ---
 == Rulers ==
 
 ---


@@ -69,21 +127,38 @@ Just like that.
 
 == Tables ==
 
 
 == Tables ==
 

-|| Table cell 1 || Table cell 2 || Table cell 3 ||
-|| Table cell 4 || Table cell 5 || Table cell 6 ||
-|| Table cell 7 || Table cell 8 || Table cell 9 ||
-
-TODO: support table headers
+||= 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 ==
 
 
 
 == 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.</div>
+<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 ===

 
 

-== Access Control Lists ==
+{{{
+# acl SomeUser:read,write OtherUser:read All:none
+}}}

 
 

-TODO: document
+Limit read or write access to specific authenticated users

 
 

-== Final Notes ==
+=== Custom cascading style sheets ===
+
+{{{
+# css my_style.css
+}}}

 
 

-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.
+Include a custom CSS before the default ones.