wiki/Help.page

---
format: DocBook
...

<sect1 id="navigating">
  <title>Navigating</title>
  <para>
    The most natural way of navigating is by clicking wiki links that
    connect one page with another. The <quote>Front page</quote> link in
    the navigation bar will always take you to the Front Page of the
    wiki. The <quote>All pages</quote> 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
    <quote>gremlins</quote>, type that and not <quote>gremlin</quote>.
    The <quote>go</quote> box will take you directly to the page you
    type.
  </para>
</sect1>
<sect1 id="creating-and-modifying-pages">
  <title>Creating and modifying pages</title>
  <sect2 id="registering-for-an-account">
    <title>Registering for an account</title>
    <para>
      In order to modify pages, you’ll need to be logged in. To register
      for an account, just click the <quote>register</quote> 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 <quote>login</quote> button. While you are logged in,
      these buttons are replaced by a <quote>logout so-and-so</quote>
      button, which you should click to log out when you are finished.
    </para>
    <para>
      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.
    </para>
  </sect2>
  <sect2 id="editing-a-page">
    <title>Editing a page</title>
    <para>
      To edit a page, just click the <quote>edit</quote> button at the
      bottom right corner of the page.
    </para>
    <para>
      You can click <quote>Preview</quote> at any time to see how your
      changes will look. Nothing is saved until you press
      <quote>Save.</quote>
    </para>
    <para>
      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.
    </para>
  </sect2>
  <sect2 id="page-metadata">
    <title>Page metadata</title>
    <para>
      Pages may optionally begin with a metadata block. Here is an
      example:
    </para>
    <programlisting>
---
format: latex+lhs
categories: haskell math
toc: no
title: Haskell and
  Category Theory
...

\section{Why Category Theory?}
</programlisting>
    <para>
      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 <quote>title</quote> example above.) The
      metadata block must begin with a line <literal>---</literal> and
      end with a line <literal>...</literal> optionally followed by one
      or more blank lines.
    </para>
    <para>
      Currently the following keys are supported:
    </para>
    <variablelist spacing="compact">
      <varlistentry>
        <term>
          format
        </term>
        <listitem>
          <para>
            Overrides the default page type as specified in the
            configuration file. Possible values are
            <literal>markdown</literal>, <literal>rst</literal>,
            <literal>latex</literal>, <literal>html</literal>,
            <literal>markdown+lhs</literal>, <literal>rst+lhs</literal>,
            <literal>latex+lhs</literal>. (Capitalization is ignored, so
            you can also use <literal>LaTeX</literal>,
            <literal>HTML</literal>, etc.) The <literal>+lhs</literal>
            variants indicate that the page is to be interpreted as
            literate Haskell. If this field is missing, the default page
            type will be used.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          categories
        </term>
        <listitem>
          <para>
            A space or comma separated list of categories to which the
            page belongs.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          toc
        </term>
        <listitem>
          <para>
            Overrides default setting for table-of-contents in the
            configuration file. Values can be <literal>yes</literal>,
            <literal>no</literal>, <literal>true</literal>, or
            <literal>false</literal> (capitalization is ignored).
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          title
        </term>
        <listitem>
          <para>
            By default the displayed page title is the page name. This
            metadata element overrides that default.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
  <sect2 id="creating-a-new-page">
    <title>Creating a new page</title>
    <para>
      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.
    </para>
  </sect2>
  <sect2 id="reverting-to-an-earlier-version">
    <title>Reverting to an earlier version</title>
    <para>
      If you click the <quote>history</quote> 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 <quote>revert</quote> button
      at the bottom of the page, then <quote>Save</quote>.
    </para>
  </sect2>
  <sect2 id="deleting-a-page">
    <title>Deleting a page</title>
    <para>
      The <quote>delete</quote> 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
      <quote>activity</quote> button on the top of the page.
    </para>
  </sect2>
</sect1>
<sect1 id="uploading-files">
  <title>Uploading files</title>
  <para>
    To upload a file–a picture, a PDF, or some other resource–click the
    <quote>upload</quote> 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).
  </para>
  <para>
    Often you may leave <quote>Name on wiki</quote> 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
    <emphasis>must</emphasis> include a file extension (e.g.
    <literal>.pdf</literal>).
  </para>
  <para>
    If you are providing a new version of a file that already exists on
    the wiki, check the box <quote>Overwrite existing file.</quote>
    Otherwise, leave it unchecked.
  </para>
  <para>
    To link to an uploaded file, just use its name in a regular wiki
    link. For example, if you uploaded a picture
    <literal>fido.jpg</literal>, you can insert the picture into a
    (markdown-formatted) page as follows:
    <literal>![fido](fido.jpg)</literal>. If you uploaded a PDF
    <literal>projection.pdf</literal>, you can insert a link to it
    using: <literal>[projection](projection.pdf)</literal>.
  </para>
</sect1>

<sect1 id="markdown">
<title>
Markdown
</title>
<para>
<programlisting>
This wiki's pages are written in
&lt;ulink url=&quot;http://johnmacfarlane.net/pandoc&quot;&gt;pandoc&lt;/ulink&gt;'s
extended form of
&lt;ulink url=&quot;http://daringfireball.net/projects/markdown&quot;&gt;markdown&lt;/ulink&gt;.
If you're not familiar with markdown, you should start by looking at
the
&lt;ulink url=&quot;http://daringfireball.net/projects/markdown/basics&quot;&gt;markdown
&amp;quot;basics&amp;quot; page&lt;/ulink&gt; and the
&lt;ulink url=&quot;http://daringfireball.net/projects/markdown/syntax&quot;&gt;markdown
syntax description&lt;/ulink&gt;. Consult the
&lt;ulink url=&quot;http://johnmacfarlane.net/pandoc/README.html&quot;&gt;pandoc
User's Guide&lt;/ulink&gt; for information about pandoc's syntax for
footnotes, tables, description lists, and other elements not present
in standard markdown.
</programlisting>
</para>
<para>
<programlisting>
Markdown is pretty intuitive, since it is based on email
conventions. Here are some examples to get you started:
</programlisting>
</para>
<table>
<tr>
<td>
<literal><emphasis>emphasized text</emphasis></literal>
</td>
<td>
<emphasis>emphasized text</emphasis>
</td>
</tr>
<tr>
<td>
<literal><emphasis role="strong">strong emphasis</emphasis></literal>
</td>
<td>
<emphasis role="strong">strong emphasis</emphasis>
</td>
</tr>
<tr>
<td>
<literal><literal>literal text</literal></literal>
</td>
<td>
<literal>literal text</literal>
</td>
</tr>
<tr>
<td>
<literal>*escaped special characters*</literal>
</td>
<td>
<emphasis>escaped special characters</emphasis>
</td>
</tr>
<tr>
<td>
<literal><ulink url="http://google.com">external link</ulink></literal>
</td>
<td>
<ulink url="http://google.com">external link</ulink>
</td>
</tr>
<tr>
<td>
<literal><inlinemediaobject>
  <imageobject>
    <imagedata fileref="/img/icons/folder.png" />
  </imageobject>
</inlinemediaobject></literal>
</td>
<td>
<inlinemediaobject> <imageobject>
<imagedata fileref="/img/icons/folder.png" /> </imageobject>
</inlinemediaobject>
</td>
</tr>
<tr>
<td>
Wikilink: <literal><ulink url="">Front Page</ulink></literal>
</td>
<td>
Wikilink: <ulink url="">Front Page</ulink>
</td>
</tr>
<tr>
<td>
<literal>H<subscript>2</subscript>O</literal>
</td>
<td>
H<subscript>2</subscript>O
</td>
</tr>
<tr>
<td>
<literal>10<superscript>100</superscript></literal>
</td>
<td>
10<superscript>100</superscript>
</td>
</tr>
<tr>
<td>
<literal><emphasis role="strikethrough">strikeout</emphasis></literal>
</td>
<td>
<emphasis role="strikethrough">strikeout</emphasis>
</td>
</tr>
<tr>
<td>
<literal>$x = \frac{{ - b \pm \sqrt {b^2 - 4ac} }}{{2a}}$</literal>
</td>
<td>
$x = \frac{{ - b \pm \sqrt {b^2 - 4ac} }}{{2a}}$<footnote>
<para>
<programlisting>
  If this looks like code, it's because jsMath is not installed on
  your system. Contact your administrator to request it.
&lt;/para&gt;
</programlisting>
</footnote>
</td>
</tr>
<tr>
<td>
<literal>A simple footnote.<footnote>
  <para>
    Or is it so simple?
  </para>
</footnote></literal>
</td>
<td>
A simple footnote.<footnote>
<para>
<programlisting>
  Or is it so simple?
&lt;/para&gt;
</programlisting>
</footnote>
</td>
</tr>
<tr>
<td>
<pre>
  > an indented paragraph,
  > usually used for quotations
  </pre>
</td>
<td>
<blockquote>
<programlisting>
&lt;para&gt;
  an indented paragraph, usually used for quotations
&lt;/para&gt;
</programlisting>
</blockquote>
</td>
<tr>
<td>
<pre>
      #!/bin/sh -e
      # code, indented four spaces
      echo "Hello world"
  </pre>
</td>
<td>
<programlisting>
<sect1 id="binsh--e">
  <title>!/bin/sh -e</title>
  <para>
  </para>
</sect1>
<sect1 id="code-indented-four-spaces">
  <title>code, indented four spaces</title>
  echo <quote>Hello world</quote>
  </programlisting>
  </td>
  </tr>
  <tr>
  <td>
  <pre>
    * 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
    </pre>
  </td>
  <td>
  <itemizedlist spacing="compact">
  <programlisting>
&lt;listitem&gt;
  &lt;para&gt;
    a bulleted list
  &lt;/para&gt;
&lt;/listitem&gt;
&lt;listitem&gt;
  &lt;para&gt;
    second item
  &lt;/para&gt;
  &lt;itemizedlist spacing=&quot;compact&quot;&gt;
    &lt;listitem&gt;
      &lt;para&gt;
        sublist
      &lt;/para&gt;
    &lt;/listitem&gt;
    &lt;listitem&gt;
      &lt;para&gt;
        and more
      &lt;/para&gt;
    &lt;/listitem&gt;
  &lt;/itemizedlist&gt;
&lt;/listitem&gt;
&lt;listitem&gt;
  &lt;para&gt;
    back to main list
  &lt;/para&gt;
  &lt;orderedlist numeration=&quot;arabic&quot; spacing=&quot;compact&quot;&gt;
    &lt;listitem&gt;
      &lt;para&gt;
        this item has an ordered
      &lt;/para&gt;
    &lt;/listitem&gt;
    &lt;listitem&gt;
      &lt;para&gt;
        sublist
      &lt;/para&gt;
      &lt;orderedlist numeration=&quot;loweralpha&quot; spacing=&quot;compact&quot;&gt;
        &lt;listitem&gt;
          &lt;para&gt;
            you can also use letters
          &lt;/para&gt;
        &lt;/listitem&gt;
        &lt;listitem&gt;
          &lt;para&gt;
            another item
          &lt;/para&gt;
        &lt;/listitem&gt;
      &lt;/orderedlist&gt;
    &lt;/listitem&gt;
  &lt;/orderedlist&gt;
&lt;/listitem&gt;
</programlisting>
  </itemizedlist>
  </td>
  </tr>
  <tr>
  <td>
  <pre>
    Fruit        Quantity
    --------  -----------
    apples         30,200
    oranges         1,998
    pears              42

    Table:  Our fruit inventory
    </pre>
  </td>
  <td>
  <table>
  <programlisting>
&lt;title&gt;
  Our fruit inventory
&lt;/title&gt;
&lt;tgroup cols=&quot;2&quot;&gt;
  &lt;colspec align=&quot;left&quot; /&gt;
  &lt;colspec align=&quot;right&quot; /&gt;
  &lt;thead&gt;
    &lt;row&gt;
      &lt;entry&gt;
        Fruit
      &lt;/entry&gt;
      &lt;entry&gt;
        Quantity
      &lt;/entry&gt;
    &lt;/row&gt;
  &lt;/thead&gt;
  &lt;tbody&gt;
    &lt;row&gt;
      &lt;entry&gt;
        apples
      &lt;/entry&gt;
      &lt;entry&gt;
        30,200
      &lt;/entry&gt;
    &lt;/row&gt;
    &lt;row&gt;
      &lt;entry&gt;
        oranges
      &lt;/entry&gt;
      &lt;entry&gt;
        1,998
      &lt;/entry&gt;
    &lt;/row&gt;
    &lt;row&gt;
      &lt;entry&gt;
        pears
      &lt;/entry&gt;
      &lt;entry&gt;
        42
      &lt;/entry&gt;
    &lt;/row&gt;
  &lt;/tbody&gt;
&lt;/tgroup&gt;
</programlisting>
  </table>
  </td>
  </tr>
  </table>
  <para>
  <programlisting>
For headings, prefix a line with one or more &lt;literal&gt;#&lt;/literal&gt;
signs: one for a major heading, two for a subheading, three for a
subsubheading. Be sure to leave space before and after the heading.
</programlisting>
  </para>
  <programlisting>
</sect1>
<sect1 id="markdown">
  <title>Markdown</title>
  <para>
    Text…
  </para>
  <sect2 id="some-examples">
    <title>Some examples…</title>
    Text…
    </programlisting>
    <sect2 id="wiki-links">
    <title>
    Wiki links
    </title>
    <programlisting>
&lt;para&gt;
  Links to other wiki pages are formed this way:
  &lt;literal&gt;[Page Name]()&lt;/literal&gt;. (Gitit converts markdown links
  with empty targets into wikilinks.)
&lt;/para&gt;
&lt;para&gt;
  To link to a wiki page using something else as the link text:
  &lt;literal&gt;[something else](Page Name)&lt;/literal&gt;.
&lt;/para&gt;
&lt;para&gt;
  Note that page names may contain spaces and some special
  characters. They need not be CamelCase. CamelCase words are
  &lt;emphasis&gt;not&lt;/emphasis&gt; automatically converted to wiki links.
&lt;/para&gt;
&lt;para&gt;
  Wiki pages may be organized into directories. So, if you have
  several pages on wine, you may wish to organize them like so:
&lt;/para&gt;
&lt;programlisting&gt;
</programlisting>
    Wine/Pinot Noir Wine/Burgundy Wine/Cabernet Sauvignon
    </programlisting>
    <programlisting>
&lt;para&gt;
  Note that a wiki link &lt;literal&gt;[Burgundy]()&lt;/literal&gt; that occurs
  inside the &lt;literal&gt;Wine&lt;/literal&gt; directory will link to
  &lt;literal&gt;Wine/Burgundy&lt;/literal&gt;, and not to
  &lt;literal&gt;Burgundy&lt;/literal&gt;. To link to a top-level page called
  &lt;literal&gt;Burgundy&lt;/literal&gt;, you'd have to use
  &lt;literal&gt;[Burgundy](/Burgundy)&lt;/literal&gt;.
&lt;/para&gt;
&lt;para&gt;
  To link to a directory listing for a subdirectory, use a trailing
  slash: &lt;literal&gt;[Wine/]()&lt;/literal&gt; will link to a listing of the
  &lt;literal&gt;Wine&lt;/literal&gt; subdirectory.
&lt;/para&gt;
</programlisting>
    <para>
      </sect2> </sect1>
    </para>
  </sect2>
</sect1>