5963c4a8fc74e96318c20d2238dee36afda3f483
[wiki.git] / EditingTips
1 Click **Raw Text** to see the markup for this page, and try it yourself in WikiSandBox.
2
3 ---
4
5 Our wiki syntax is deliberately similar to MoinMoin and WikiCreole.
6
7 Note: You should use formatting sparingly, WikiWikiWeb is about content, not look.
8 See WikiDesignPrinciples.
9
10 == Links ==
11
12 Names of pages have to LookLikeThis.
13 It's called a WikiName.
14 If you write a word that LooksLikeThis, it will be automatically turned into a link.
15
16 You can use URLs directly: http://www.codewiz.org/ ,
17 or you can make descriptive links with [[http://www.codewiz.org/ | some anchor text]].
18 Links to images will appear inline: http://www.w3.org/Icons/valid-css.png
19
20 Anchored links also work with [[FrontPage|wiki pages]], [[/index.html | local paths]], and [[non_wiki_words]].
21
22 Image links: [[http://www.laptopgiving.org/|GiveOneGetOne.jpg]]
23
24 == Inline media ==
25
26 ==== Images ====
27 {{GerryStich.jpg}}
28
29 ==== Images with thumbnails ====
30 {{GerryStich.jpg|Stich!}}
31
32 ==== Scaled images ====
33 {{GerryStich.jpg|tiny|maxwidth=48}}
34
35
36 ==== Including other wiki pages ====
37 {{IncludedPage}}
38
39 You can also pass arguments to included pages!  It works like a minimal templating system:
40
41 {{TemplatePage | hello=Ciao | world=mondo }}
42
43 ==== Including external resources inline ====
44 {{http://www.codewiz.org/wikigit/geekigeeki.git/blob_plain/HEAD:/geekigeeki.py}}
45
46 == Macros ==
47
48  * Your remote IP: <<CgiVar | REMOTE_ADDR>>
49  * Query string: <<CgiVar | QUERY_STRING>>
50  * <<NonexistentMacro | param1 | param2 >>
51
52 == Block elements ==
53
54 Leave blank lines between paragraphs.
55
56 You can insert line\\
57 breaks\\
58 with double backslashes: \****\.
59
60 If you indent text
61   like this, then it is indented in the output
62     you can have multiple levels of indent
63
64 To insert program source without reformatting in a monospace font, use three curly braces:
65
66 {{{
67   public static void main(String[] args) {
68     out.println("Hello");
69   }
70 }}}
71
72 Just like that.
73
74 == Itemized lists ==
75
76 If you put asterisks (*) at the start of the line
77
78   * you get a 
79   * bulleted
80   * list
81     * which can also be indented
82       * to several levels
83
84 You can also have numbered lists, using the number (#) sign:
85  # first item
86  # second item
87    # first indented item
88    # second indented item
89  # third item
90
91 == Text Styles ==
92
93 To write **bold text**, enclose it in double stars: *////*some word*////*. \\
94 To write //italic text//, enclose it in double slashes: /****/some word/****/. \\
95 To write ##monospace text##, enclose it in double hashes: #****#some word#****#. \\
96 To write __underlined text__, enclose it in double underscores: _****_some word_****_. \\
97 To write ^^superscript text^^, enclose it in double carets: ^****^some word^****^. \\
98 To write ,,subscript text,,, enclose it in double commas: ,****,some word,****,. \\
99 ''Double'' and '''triple''' quotes are also supported for compatiblity with other wikis. \\
100 These keywords are highlighted: FIXME, TODO, DONE.
101
102 TIP: four consecutive stars (*////*////*////*) or slashes (/****/****/****/****) are a good
103 way to escape the syntax. :-)
104
105
106 == Rulers ==
107
108 ---
109 ----
110 -----
111 ------
112
113
114 == Headings ==
115
116 ===Level 2===
117 ====Level 3====
118 =====Level 4=====
119 ======Level 5======
120
121
122 == Tables ==
123
124 ||= Table Heading 1 ||= Table heading 2 ||= Table heading 3||
125 ||  Table cell 4    ||  Table cell 5    || Table cell 6    ||
126 ||  Table cell 7    ||  Table cell 8    || Table cell 9    ||
127
128
129 == Inline HTML ==
130
131 <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;">
132 You can use ##div##, ##span## and ##iframe## elements with any attribute, including
133 <span style="color: green">CSS</span>, of course.
134 </div>
135
136 == Access Control Lists ==
137
138 TODO: document
139
140 == Final Notes ==
141
142 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.