Help.page (9252B)
1 --- 2 format: Markdown 3 ... 4 5 # Navigating 6 7 The most natural way of navigating is by clicking wiki links that 8 connect one page with another. The "Front page" link in the navigation 9 bar will always take you to the Front Page of the wiki. The "All pages" 10 link will take you to a list of all pages on the wiki (organized into 11 folders if directories are used). Alternatively, you can search using 12 the search box. Note that the search is set to look for whole words, so 13 if you are looking for "gremlins", type that and not "gremlin". 14 The "go" box will take you directly to the page you type. 15 16 # Creating and modifying pages 17 18 ## Registering for an account 19 20 In order to modify pages, you'll need to be logged in. To register 21 for an account, just click the "register" button in the bar on top 22 of the screen. You'll be asked to choose a username and a password, 23 which you can use to log in in the future by clicking the "login" 24 button. While you are logged in, these buttons are replaced by 25 a "logout so-and-so" button, which you should click to log out 26 when you are finished. 27 28 Note that logins are persistent through session cookies, so if you 29 don't log out, you'll still be logged in when you return to the 30 wiki from the same browser in the future. 31 32 ## Editing a page 33 34 To edit a page, just click the "edit" button at the bottom right corner 35 of the page. 36 37 You can click "Preview" at any time to see how your changes will look. 38 Nothing is saved until you press "Save." 39 40 Note that you must provide a description of your changes. This is to 41 make it easier for others to see how a wiki page has been changed. 42 43 ## Page metadata 44 45 Pages may optionally begin with a metadata block. Here is an example: 46 47 --- 48 format: latex+lhs 49 categories: haskell math 50 toc: no 51 title: Haskell and 52 Category Theory 53 ... 54 55 \section{Why Category Theory?} 56 57 The metadata block consists of a list of key-value pairs, each on a 58 separate line. If needed, the value can be continued on one or more 59 additional line, which must begin with a space. (This is illustrated by 60 the "title" example above.) The metadata block must begin with a line 61 `---` and end with a line `...` optionally followed by one or more blank 62 lines. 63 64 Currently the following keys are supported: 65 66 format 67 : Overrides the default page type as specified in the configuration file. 68 Possible values are `markdown`, `rst`, `latex`, `html`, `markdown+lhs`, 69 `rst+lhs`, `latex+lhs`. (Capitalization is ignored, so you can also 70 use `LaTeX`, `HTML`, etc.) The `+lhs` variants indicate that the page 71 is to be interpreted as literate Haskell. If this field is missing, 72 the default page type will be used. 73 74 categories 75 : A space or comma separated list of categories to which the page belongs. 76 77 toc 78 : Overrides default setting for table-of-contents in the configuration file. 79 Values can be `yes`, `no`, `true`, or `false` (capitalization is ignored). 80 81 title 82 : By default the displayed page title is the page name. This metadata element 83 overrides that default. 84 85 ## Creating a new page 86 87 To create a new page, just create a wiki link that links to it, and 88 click the link. If the page does not exist, you will be editing it 89 immediately. 90 91 ## Reverting to an earlier version 92 93 If you click the "history" button at the bottom of the page, you will 94 get a record of previous versions of the page. You can see the differences 95 between two versions by dragging one onto the other; additions will be 96 highlighted in yellow, and deletions will be crossed out with a horizontal 97 line. Clicking on the description of changes will take you to the page 98 as it existed after those changes. To revert the page to the revision 99 you're currently looking at, just click the "revert" button at the bottom 100 of the page, then "Save". 101 102 ## Deleting a page 103 104 The "delete" button at the bottom of the page will delete a page. Note 105 that deleted pages can be recovered, since a record of them will still be 106 accessible via the "activity" button on the top of the page. 107 108 # Uploading files 109 110 To upload a file--a picture, a PDF, or some other resource--click the 111 "upload" button in the navigation bar. You will be prompted to select 112 the file to upload. As with edits, you will be asked to provide a 113 description of the resource (or of the change, if you are overwriting 114 an existing file). 115 116 Often you may leave "Name on wiki" blank, since the existing name of the 117 file will be used by default. If that isn't desired, supply a name. 118 Note that uploaded files *must* include a file extension (e.g. `.pdf`). 119 120 If you are providing a new version of a file that already exists on the 121 wiki, check the box "Overwrite existing file." Otherwise, leave it 122 unchecked. 123 124 To link to an uploaded file, just use its name in a regular wiki link. 125 For example, if you uploaded a picture `fido.jpg`, you can insert the 126 picture into a (markdown-formatted) page as follows: ``. 127 If you uploaded a PDF `projection.pdf`, you can insert a link to it 128 using: `[projection](projection.pdf)`. 129 130 131 132 # Markdown 133 134 This wiki's pages are written in [pandoc]'s extended form of [markdown]. 135 If you're not familiar with markdown, you should start by looking 136 at the [markdown "basics" page] and the [markdown syntax description]. 137 Consult the [pandoc User's Guide] for information about pandoc's syntax 138 for footnotes, tables, description lists, and other elements not present 139 in standard markdown. 140 141 [pandoc]: http://pandoc.org 142 [pandoc User's Guide]: http://pandoc.org/README.html 143 [markdown]: http://daringfireball.net/projects/markdown 144 [markdown "basics" page]: http://daringfireball.net/projects/markdown/basics 145 [markdown syntax description]: http://daringfireball.net/projects/markdown/syntax 146 147 Markdown is pretty intuitive, since it is based on email conventions. 148 Here are some examples to get you started: 149 150 <table> 151 <tr> 152 <td>`*emphasized text*`</td> 153 <td>*emphasized text*</td> 154 </tr> 155 <tr> 156 <td>`**strong emphasis**`</td> 157 <td>**strong emphasis**</td> 158 </tr> 159 <tr> 160 <td>`` `literal text` ``</td> 161 <td>`literal text`</td> 162 </tr> 163 <tr> 164 <td>`\*escaped special characters\*`</td> 165 <td>\*escaped special characters\*</td> 166 </tr> 167 <tr> 168 <td>`[external link](http://google.com)`</td> 169 <td>[external link](http://google.com)</td> 170 </tr> 171 <tr> 172 <td>``</td> 173 <td></td> 174 </tr> 175 <tr> 176 <td>Wikilink: `[Front Page]()`</td> 177 <td>Wikilink: [Front Page]()</td> 178 </tr> 179 <tr> 180 <td>`H~2~O`</td> 181 <td>H~2~O</td> 182 </tr> 183 <tr> 184 <td>`10^100^`</td> 185 <td>10^100^</td> 186 </tr> 187 <tr> 188 <td>`~~strikeout~~`</td> 189 <td>~~strikeout~~</td> 190 </tr> 191 <tr> 192 <td> 193 `$x = \frac{{ - b \pm \sqrt {b^2 - 4ac} }}{{2a}}$` 194 </td> 195 <td> 196 $x = \frac{{ - b \pm \sqrt {b^2 - 4ac} }}{{2a}}$^[If this looks like 197 code, it's because jsMath is 198 not installed on your system. Contact your administrator to request it.] 199 </td> 200 </tr> 201 <tr> 202 <td> 203 `A simple footnote.^[Or is it so simple?]` 204 </td> 205 <td> 206 A simple footnote.^[Or is it so simple?] 207 </td> 208 </tr> 209 <tr> 210 <td> 211 <pre> 212 > an indented paragraph, 213 > usually used for quotations 214 </pre> 215 </td> 216 <td> 217 218 > an indented paragraph, 219 > usually used for quotations 220 221 </td> 222 <tr> 223 <td> 224 <pre> 225 #!/bin/sh -e 226 # code, indented four spaces 227 echo "Hello world" 228 </pre> 229 </td> 230 <td> 231 232 #!/bin/sh -e 233 # code, indented four spaces 234 echo "Hello world" 235 236 </td> 237 </tr> 238 <tr> 239 <td> 240 <pre> 241 * a bulleted list 242 * second item 243 - sublist 244 - and more 245 * back to main list 246 1. this item has an ordered 247 2. sublist 248 a) you can also use letters 249 b) another item 250 </pre> 251 </td> 252 <td> 253 254 * a bulleted list 255 * second item 256 - sublist 257 - and more 258 * back to main list 259 1. this item has an ordered 260 2. sublist 261 a) you can also use letters 262 b) another item 263 264 </td> 265 </tr> 266 <tr> 267 <td> 268 <pre> 269 Fruit Quantity 270 -------- ----------- 271 apples 30,200 272 oranges 1,998 273 pears 42 274 275 Table: Our fruit inventory 276 </pre> 277 </td> 278 <td> 279 280 Fruit Quantity 281 -------- ----------- 282 apples 30,200 283 oranges 1,998 284 pears 42 285 286 Table: Our fruit inventory 287 288 </td> 289 </tr> 290 </table> 291 292 For headings, prefix a line with one or more `#` signs: one for a major heading, 293 two for a subheading, three for a subsubheading. Be sure to leave space before 294 and after the heading. 295 296 # Markdown 297 298 Text... 299 300 ## Some examples... 301 302 Text... 303 304 ## Wiki links 305 306 Links to other wiki pages are formed this way: `[Page Name]()`. 307 (Gitit converts markdown links with empty targets into wikilinks.) 308 309 To link to a wiki page using something else as the link text: 310 `[something else](Page Name)`. 311 312 Note that page names may contain spaces and some special characters. 313 They need not be CamelCase. CamelCase words are *not* automatically 314 converted to wiki links. 315 316 Wiki pages may be organized into directories. So, if you have 317 several pages on wine, you may wish to organize them like so: 318 319 Wine/Pinot Noir 320 Wine/Burgundy 321 Wine/Cabernet Sauvignon 322 323 Note that a wiki link `[Burgundy]()` that occurs inside the `Wine` 324 directory will link to `Wine/Burgundy`, and not to `Burgundy`. 325 To link to a top-level page called `Burgundy`, you'd have to use 326 `[Burgundy](/Burgundy)`. 327 328 To link to a directory listing for a subdirectory, use a trailing 329 slash: `[Wine/]()` will link to a listing of the `Wine` subdirectory.