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