Edit page IncludedPage

[wiki.git] / EditingTips

diff --git a/EditingTips b/EditingTips
index 3313fed105304503d1862f67ed23e81abc91fd85..b7c53b5d2202f106f33b45c9dde062c1afd176b4 100644 (file)
--- a/EditingTips
+++ b/EditingTips
@@ -1,45 +1,67 @@
+Click **Raw Text** to see the markup for this page, and try it yourself in WikiSandBox.
+
+---
+
+Our wiki syntax is deliberately similar to MoinMoin and WikiCreole.
+

 Note: You should use formatting sparingly, WikiWikiWeb is about content, not look.
 Note: You should use formatting sparingly, WikiWikiWeb is about content, not look.

+See WikiDesignPrinciples.
+
+== Links ==

 
 

-Click Edit''''''Text in the header to see the markup for this page, and try it yourself in PikiSandBox.
+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.

 
 

-==Text Styles==
+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 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.
+Anchored links also work with [[FrontPage|wiki pages]], [[/index.html | local paths]], and [[non_wiki_words]].

 
 

-Leave blank lines between paragraphs.
+Image links: [[http://www.laptopgiving.org/|GiveOneGetOne.jpg]]

 
 

-If you can't figure out what I mean, click EditPage to look at the source for this page.
+== Inline media ==

 
 

+==== Images ====
+{{GerryStich.jpg}}

 
 

-==Links==
+==== Images with thumbnails ====
+{{GerryStich.jpg|Stich!}}

 
 

-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.
+==== Scaled images ====
+{{GerryStich.jpg|tiny|maxwidth=48}}

 
 

-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

 
 

+==== Including 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 template engine:

 
 

+{{IncludedPage | hello=Ciao }}

 
 

-==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
 
 
 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:
 
 {{{


@@ -50,14 +72,47 @@ To insert program source without reformatting in a monospace font, use three cur
 
 Just like that.
 
 
 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====
 
 ===Level 2===
 ====Level 3====


@@ -65,6 +120,24 @@ Just like that.
 ======Level 5======
 
 
 ======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.