Edit page EditingTips
[wiki.git] / EditingTips
index 5d24572d66b74ced8fa8c9fc1bfc2fbd6faa48d6..9fc46534de6f0f3c43ad95fa329913dfbc436062 100644 (file)
@@ -19,7 +19,41 @@ 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]].
 
-Image links: [[http://www.laptopgiving.org/ | GiveOneGetOne.jpg]]
+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 ==
 
@@ -33,14 +67,6 @@ 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:
 
 {{{
@@ -51,12 +77,31 @@ To insert program source without reformatting in a monospace font, use three cur
 
 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 the text in double stars: *////*some word*////*. \\
-To write //italic text//, enclose the text in double slashes: /****/some word/****/. \\
-To write ##monospace text##, enclose the text in double hashes: #****#some word#****#. \\
+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.
 
@@ -94,10 +139,26 @@ You can use ##div##, ##span## and ##iframe## elements with any attribute, includ
 <span style="color: green">CSS</span>, of course.
 </div>
 
-== Access Control Lists ==
+== Pragmas ==
+
+Wiki pages can provide special commands in their header, in the form:
 
-TODO: document
+{{{
+# &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 ===
 
-== Final Notes ==
+{{{
+# 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.