132aac686102f2f09903f7b833b5ec93e7fc8645
[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 To insert program source without reformatting in a monospace font, use three curly braces:
62
63 {{{
64   public static void main(String[] args) {
65     out.println("Hello");
66   }
67 }}}
68
69 Just like that.
70
71 == Itemized lists ==
72
73 If you put asterisks (*) at the start of the line
74
75   * you get a 
76   * bulleted
77   * list
78     * which can also be indented
79       * to several levels
80
81 You can also have numbered lists, using the number (#) sign:
82  # first item
83  # second item
84    # first indented item
85    # second indented item
86  # third item
87
88 == Text Styles ==
89
90 To write **bold text**, enclose it in double stars: *////*some word*////*. \\
91 To write //italic text//, enclose it in double slashes: /****/some word/****/. \\
92 To write ##monospace text##, enclose it in double hashes: #****#some word#****#. \\
93 To write __underlined text__, enclose it in double underscores: _****_some word_****_. \\
94 To write ^^superscript text^^, enclose it in double carets: ^****^some word^****^. \\
95 To write ,,subscript text,,, enclose it in double commas: ,****,some word,****,. \\
96 ''Double'' and '''triple''' quotes are also supported for compatiblity with other wikis. \\
97 These keywords are highlighted: FIXME, TODO, DONE.
98
99 TIP: four consecutive stars (*////*////*////*) or slashes (/****/****/****/****) are a good
100 way to escape the syntax. :-)
101
102
103 == Rulers ==
104
105 ---
106 ----
107 -----
108 ------
109
110
111 == Headings ==
112
113 ===Level 2===
114 ====Level 3====
115 =====Level 4=====
116 ======Level 5======
117
118
119 == Tables ==
120
121 ||= Table Heading 1 ||= Table heading 2 ||= Table heading 3||
122 ||  Table cell 4    ||  Table cell 5    || Table cell 6    ||
123 ||  Table cell 7    ||  Table cell 8    || Table cell 9    ||
124
125
126 == Inline HTML ==
127
128 <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;">
129 You can use ##div##, ##span## and ##iframe## elements with any attribute, including
130 <span style="color: green">CSS</span>, of course.
131 </div>
132
133 == Access Control Lists ==
134
135 TODO: document
136
137 == Final Notes ==
138
139 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.