===================================
Using RSTPages and ReStructuredText
===================================

Anyone can help, regardless of your skill level.  
We need raw content, so if you can type some text, we can use your help.  
If you can edit what someone else has typed and make it look pretty, great!  
If you want to help code the underlying mechanics, we need that too.

You'll need an account on this website, and you should subscribe to the 
pycon-organizers mailing list.  `Click here for instructions. </2008/helping/>`_


.. contents:: :local:


Editing Pages
=============

Creating Pages
--------------
**To create a page**, enter the new URL in your browser.  
You'll see a "404: Page not found" message and a "Create Page" button.
Click the button and add text.
Each page should begin with a document title, like this::

    ===============
    Page Title Here
    ===============

The lines of "=" (equals signs) above & below the title must be the same length,
at least as long as the title text.

Links
-----

**To add links**, either insert the URL (``http://`` etc.) directly,
or use this syntax::

    `display text <URL>`_

The URL may be relative to the page you're editing (``subpage/``, ``../sibling/``), 
absolute on the site (``/2008/.../``), or fully qualified (``http://...``).


ReStructuredText
----------------
For instructions on reStructuredText_, the markup used for these pages,
please see one or more of the links below: 

* `reStructuredText Cheat Sheet`__ (text
  only; 1 page for syntax, 1 page directive & role reference)

  __ http://docutils.sf.net/docs/user/rst/cheatsheet.txt

* `Quick reStructuredText`__ (user reference)

  __ http://docutils.sf.net/docs/user/rst/quickref.html

* `A ReStructuredText Primer (HTML)`__ (or `text source`__)

  __ http://docutils.sf.net/docs/user/rst/quickstart.html
  __ http://docutils.sf.net/docs/user/rst/quickstart.txt

* `reStructuredText Markup Specification`__ (detailed reference)

  __ http://docutils.sf.net/docs/ref/rst/restructuredtext.html



RSS Feeds
=========

RSS2 feeds are available for the "Recent Changes" page and for the history 
lists of individual pages. The RSS link is the same as the page URL with '?feed=rss2'
appended (e.g. `</recent/?feed=rss2>`_, `</?feed=rss2>`_).


.. _reStructuredText: http://docutils.sf.net/rst.html