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
|
"""Test of gendoc.
Chapter 1
Ok, this is chapter one. First, we start of by testing *emphisized words*,
**bold words** and some quotations: 'We can bury her, burn her or dump her'.
Hopefully, it understands bullet lists as well:
- Bullet one
- Bullet two
- Bullet three
Bullet lists comes in different shapes:
* Bullets as stars (of course you won't see these variations if
you are looking at this in your favourite Grail browser).
* Here's another star bullet (bullet lists must use consistent
bullets).
The last variation on this theme is:
o Oooh, this is beautiful
o ooops, do yoo loko thos?
Chapter 2
Now, here is something spectacular. Gendoc supports nested lists,
and numbered lists!
* This is an outer bullet
o This is an inner bullet
- This is an even innier bullet
- This is as inny as above bullet
o This is not as inny as above, but certainly innier than the first
* Back to the least inny bullet
1. Yes, that's right. I am number one.
2. I'm not far behind
a. I should be the first in the second numbered bullet
b. I should be the last in the second numbered bullet
3. Last but not least (actually most, 3 > 2 > 1)
Chapter 3
Another new feature is definition lists:
rows -- is a string like "20%,*,20%" stating the number and widths of
rows defined for the frames. Widths for each row can be expressed in
integer (absolute pixels), percentage (of overall browser window or
containing frame), or asterisk(*) to indicate an auto-resized remainder
width.
cols -- is a string of the same format as above except applied to column
widths. There should not be both a rows and cols attribute in the same
Frameset tag.
frame_warning -- optional flag is available to indicate if a <NOFRAMES>
statement should be included with the Frameset to alert browsers without
frame support. Default is 1 (yes).
onLoad -- is a string of script code, which is executed when the frameset
is loaded
onUnload -- is a string of script code, which is executed when the frameset
is unloaded
Definitions
word -- definition
word -- definition
o Nested lists needs a blank line inbetween.
- This is an even innier bullet
- This is as inny as above bullet
o This is not as inny as above, but certainly innier than the first
o Unnested lists don't need blanks (but can have)
o Look, no blank line!
Links
Links are written within double quotes: "Python home page".
To be interpreted as a link, you must put a link definition
at the end of the doc string.
Example:
$ cp gendoc_test.py /tmp
$ gendoc -i -f HTMLg /tmp/gendoc_test.py
.. "Python home page" http://www.python.org
"""
|
