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