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