~thomir-deactivatedaccount/sloecode/error-style

« back to all changes in this revision

Viewing changes to help_pages/test/test.rst

  • Committer: Thomi Richards
  • Date: 2011-01-13 22:17:38 UTC
  • mfrom: (32.1.5 help)
  • Revision ID: thomir@gmail.com-20110113221738-tex9bxnz9nvrnixi
Basic help system in place.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
Test Help Page
 
3
--------------
 
4
 
 
5
This is a test help page. The idea is for me to write some garbage text to
 
6
demonstrate the various features of the reST syntax. That thing up at the top
 
7
of the page is a first-level heading. It's first-level simply because it's the
 
8
first heading style we used within the document. This is a paragraph.
 
9
 
 
10
 * This should be a bullet point.
 
11
   Text within bullet points must be left-aligned in order to stay on the same
 
12
   bullet point. Luckily, vim (and emacs too, I'm sure) recognises the .rst
 
13
   file extension and handles this for you. Yay!
 
14
 
 
15
 * This is a second bullet point. It requires a blank line..
 
16
 
 
17
   * This is a sub-point of the first one.
 
18
 
 
19
That's bullet points done. You can also do ordered (or numbered) lists too:
 
20
 
 
21
 1. Point one.
 
22
 
 
23
 2. Point two.
 
24
 
 
25
   2.1. Point two - point- one.
 
26
 
 
27
 
 
28
Second Heading
 
29
==============
 
30
 
 
31
This is another paragraph. See how the heading above is a lvl-2 heading? That's
 
32
because I used a different style for the heading underline. You can use
 
33
whatever ASCII character you want as an underline. Once you define the heading
 
34
heirarchy styles, you need to continue them.
 
35
 
 
36
----
 
37
 
 
38
You can also have transition markers. Will we need them? Maybe not.
 
39
 
 
40
Glossary
 
41
++++++++
 
42
 
 
43
Here are some terms and their meanings.
 
44
 
 
45
bzr
 
46
    A shortened version of 'bazaar'.
 
47
 
 
48
bazaar
 
49
    A distributed version control system, made by canonical.
 
50
 
 
51
More Stuff
 
52
==========
 
53
 
 
54
We can mark stuff as a literal block of code, either by indenting it...
 
55
 
 
56
::
 
57
 
 
58
    This is a literal block. Nothing in here will be used as markup. Not even
 
59
    special characters like *this*.
 
60
 
 
61
Or by using a quote character like this::
 
62
 
 
63
>Yet another literal paragraph. This one looks like email formatting, and is
 
64
>perhaps a bit more explicit.
 
65
 
 
66
In either case, you need double-colon characters right before it.
 
67
 
 
68
Images
 
69
++++++
 
70
 
 
71
You can add images easily. Images MUST be in PNG format (simply because our
 
72
make target only accepts PNG images - this is by design). Here's an example:
 
73
 
 
74
.. image:: eric_settings.png
 
75
    :alt: A test Image
 
76
    :scale: 10 %
 
77
    :align: center
 
 
b'\\ No newline at end of file'