Edit page GeekiGeeki
[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 TODO: one day this will let you pass argument as a templating engine
40
41 ==== Including external resources inline ====
42 {{http://www.codewiz.org/wikigit/geekigeeki.git/blob_plain/HEAD:/geekigeeki.py}}
43
44 == Macros ==
45
46 <<TitleSearch>>
47 <<NonexistentMacro | param1 | param2 >>
48
49 == Block elements ==
50
51 Leave blank lines between paragraphs.
52
53 You can insert line\\
54 breaks\\
55 with double backslashes: \****\.
56
57 If you indent text
58   like this, then it is indented in the output
59     you can have multiple levels of indent
60
61 And if you put asterisks at the start of the line
62
63   * you get a 
64   * bulleted
65   * list
66     * which can also be indented
67       * to several levels
68
69 To insert program source without reformatting in a monospace font, use three curly braces:
70
71 {{{
72   public static void main(String[] args) {
73     out.println("Hello");
74   }
75 }}}
76
77 Just like that.
78
79
80 == Text Styles ==
81
82 To write **bold text**, enclose it in double stars: *////*some word*////*. \\
83 To write //italic text//, enclose it in double slashes: /****/some word/****/. \\
84 To write ##monospace text##, enclose it in double hashes: #****#some word#****#. \\
85 To write __underlined text__, enclose it in double underscores: _****_some word_****_. \\
86 To write ^^superscript text^^, enclose it in double carets: ^****^some word^****^. \\
87 To write ,,subscript text,,, enclose it in double commas: ,****,some word,****,. \\
88 ''Double'' and '''triple''' quotes are also supported for compatiblity with other wikis. \\
89 These keywords are highlighted: FIXME, TODO, DONE.
90
91 TIP: four consecutive stars (*////*////*////*) or slashes (/****/****/****/****) are a good
92 way to escape the syntax. :-)
93
94
95 == Rulers ==
96
97 ---
98 ----
99 -----
100 ------
101
102
103 == Headings ==
104
105 ===Level 2===
106 ====Level 3====
107 =====Level 4=====
108 ======Level 5======
109
110
111 == Tables ==
112
113 ||= Table Heading 1 ||= Table heading 2 ||= Table heading 3||
114 ||  Table cell 4    ||  Table cell 5    || Table cell 6    ||
115 ||  Table cell 7    ||  Table cell 8    || Table cell 9    ||
116
117
118 == Inline HTML ==
119
120 <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;">
121 You can use ##div##, ##span## and ##iframe## elements with any attribute, including
122 <span style="color: green">CSS</span>, of course.
123 </div>
124
125 == Access Control Lists ==
126
127 TODO: document
128
129 == Final Notes ==
130
131 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.