[Started using gitit Robin Green **20090126035812 Ignore-this: 1c74d6ee456ace1ca3650f3fc8deda74 ] addfile ./Front\32\Page.page addfile ./Help.page hunk ./Front\32\Page.page 1 +# Welcome to Gitit! + +Gitit is a [Wiki] written in [Haskell]. [HAppS] is used for the web +server and session state. Pages and uploaded files are stored in a [git] +repository and may be modified either by using git's command-line tools +or through the wiki's web interface. [Pandoc]'s extended version of +[markdown] is used as a markup language. Gitit can be configured to +display TeX math and highlighted source code. + +You can edit this page by double-clicking on it, or by clicking on the +"edit" tab at the top of the screen. + +You can make a link to another wiki page like this: +`[French Cheeses]()`. +This will produce a link like this: [French Cheeses](). Note that +the names of wiki pages need not be in CamelCase, and they may contain +spaces. Wiki pages may be organized into directories. Use the +slash ("/") character between directories and page names or +subdirectories: `[Wines/Pinot Noir]()`. + +To create a new wiki page, just create a link to it and follow +the link. + +Help is always available through the "Help" link in the sidebar. + +[Wiki]: http://en.wikipedia.org/wiki/Wiki +[git]: http://git.or.cz/ +[HAppS]: http://happs.org +[Haskell]: http://www.haskell.org/ +[pandoc]: http://johnmacfarlane.net/pandoc/ +[markdown]: http://daringfireball.net/projects/markdown/ + hunk ./Help.page 1 +# Navigating + +The most natural way of navigating is by clicking wiki links that +connect one page with another. The "front" button on the top navigation +bar will always take you to the Front Page of the wiki. The "index" +button 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". + +# 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](/stylesheets/folder.png)`![folder](/stylesheets/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)`. + +# 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 double-click it, or 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. + +## 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 markdown link. +For example, if you uploaded a picture `fido.jpg`, you can insert the +picture into a page using the markdown: `![fido](fido.jpg)`. +If you uploaded a PDF `projection.pdf`, you can insert a link to it +using: `[projection](projection.pdf)`. +