Edit page blog/2010/03
[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 You can Link to URLs by enclosing them in double square brackets: [[http://www.codewiz.org/]],
13 or you can make descriptive links with [[http://www.codewiz.org/ | some anchor text]].
14
15 Anchored links also work with [[FrontPage|wiki pages]], [[/index.html | local paths]], and [[non_wiki_words]].
16
17 If you link to a directory, GeekiGeeki will automatically generate an index for it: [[sys/macros]]
18
19 Image links: [[http://www.laptopgiving.org/|GiveOneGetOne.jpg]]
20
21 == Inline media ==
22
23 ==== Images ====
24 {{GerryStich.jpg}}
25
26 ==== Images with thumbnails ====
27 {{GerryStich.jpg|Stich!}}
28
29 ==== Scaled images ====
30 {{GerryStich.jpg|tiny|maxwidth=48}}
31
32
33 ==== Including other wiki pages ====
34
35 Use the same syntax to embed wiki pages inside other wiki pages:
36
37   {{IncludedPage}}
38
39 You can also pass arguments to included pages!  It works like a simple template system:
40
41   {{TemplatePage | hello=Ciao | world=mondo}}
42
43
44 ==== Including external resources inline ====
45 {{http://www.codewiz.org/wikigit/geekigeeki.git/blob_plain/HEAD:/geekigeeki.py}}
46
47 == Macros ==
48
49  * Your remote IP: <<CgiVar | REMOTE_ADDR>>
50  * Query string: <<CgiVar | QUERY_STRING>>
51  * <<NonexistentMacro | param1 | param2 >>
52
53 == Block elements ==
54
55 Leave blank lines between paragraphs.
56
57 You can insert line\\
58 breaks\\
59 with double backslashes: \****\.
60
61 If you indent text
62   like this, then it is indented in the output
63     you can have multiple levels of indent
64
65 To insert program source without reformatting in a monospace font, use three curly braces:
66
67 {{{
68   public static void main(String[] args) {
69     out.println("Hello");
70   }
71 }}}
72
73 Just like that.
74
75 == Itemized lists ==
76
77 If you put asterisks (*) at the start of the line
78
79   * you get a 
80   * bulleted
81   * list
82     * which can also be indented
83       * to several levels
84
85 You can also have numbered lists, using the number (#) sign:
86  # first item
87  # second item
88    # first indented item
89    # second indented item
90  # third item
91
92 == Text Styles ==
93
94 To write **bold text**, enclose it in double stars: *////*some word*////*. \\
95 To write //italic text//, enclose it in double slashes: /****/some word/****/. \\
96 To write ##monospace text##, enclose it in double hashes: #****#some word#****#. \\
97 To write __underlined text__, enclose it in double underscores: _****_some word_****_. \\
98 To write ^^superscript text^^, enclose it in double carets: ^****^some word^****^. \\
99 To write ,,subscript text,,, enclose it in double commas: ,****,some word,****,. \\
100 ''Double'' and '''triple''' quotes are also supported for compatiblity with other wikis. \\
101 These keywords are highlighted: FIXME, TODO, DONE.
102
103 TIP: four consecutive stars (*////*////*////*) or slashes (/****/****/****/****) are a good
104 way to escape the syntax. :-)
105
106
107 == Rulers ==
108
109 ---
110 ----
111 -----
112 ------
113
114
115 == Headings ==
116
117 ===Level 2===
118 ====Level 3====
119 =====Level 4=====
120 ======Level 5======
121
122
123 == Tables ==
124
125 ||= Table Heading 1 ||= Table heading 2 ||= Table heading 3||
126 ||  Table cell 4    ||  Table cell 5    || Table cell 6    ||
127 ||  Table cell 7    ||  Table cell 8    || Table cell 9    ||
128
129
130 == Inline HTML ==
131
132 <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;">
133 You can use ##div##, ##span## and ##iframe## elements with any attribute, including
134 <span style="color: green">CSS</span>, of course.
135 </div>
136
137 == Pragmas ==
138
139 Wiki pages can specify special-purpose commands in their header.  In the form:
140
141 {{{
142 # &lt;keyword&gt; &lt;values&gt;
143 }}}
144
145 === Access Control Lists ===
146
147 {{{
148 # acl SomeUser:read,write OtherUser:read All:none
149 }}}
150
151 Limit read or write access to specific authenticated users
152
153 === Custom cascading style sheets ===
154
155 {{{
156 # css my_style.css
157 }}}
158
159 Include a user-specified custom CSS before the default one(s).