Download LPdoc Manual

Transcript
178
The lpdoc Documentation Generator
A
E
A4 paper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
abstract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
accents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
acceptable modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
appendix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
assertion body syntax . . . . . . . . . . . . . . . . . . . 51, 54, 55
assertions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
author . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
automatic documentation . . . . . . . . . . . . . . . . . . . . . . 111
automatic documentation library . . . . . . . . . . . . . . . 111
avoiding indentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
emacs Ciao mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Emacs, accessing info files . . . . . . . . . . . . . . . . . . . . . .
Emacs, generating manuals from . . . . . . . . . . . . . . . .
Emacs, LPdoc mode. . . . . . . . . . . . . . . . . . . . . . . . . . . .
email address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
email addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
emphasis face . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
encapsulated postscript . . . . . . . . . . . . . . . . . . . . . . . . .
entry assertion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
enumerated list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
escape sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
example of lpdoc use . . . . . . . . . . . . . . . . . . . . . . . . . . .
exit assertion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
36
19
15
15
29
29
27
30
46
26
26
89
46
F
B
bibliographic citations . . . . . . . . . . . . . . . . . . . . . . . . . .
bibliographic entries . . . . . . . . . . . . . . . . . . . . . . . . . . . .
bibliographic entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
bibtex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16,
blank lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
bold face . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
bug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
29
16
29
29
27
27
36
C
calls assertion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43, 44
check assertion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Ciao . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
comment assertion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
comments, machine readable . . . . . . . . . . . . . . . . . . . . 41
comp assertion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
compatibility properties . . . . . . . . . . . . . . . . . . . . . . . . 57
component files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
contents area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
copyright . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
D
date. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
decl assertion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
description list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
document structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
documentation format . . . . . . . . . . . . . . . . . . . . . . . . . 111
documentation strings . . . . . . . . . . . . . . . . . . . . . . . . . . 32
false assertion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
fixed format text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
fixed-width font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
footnote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
formatting commands . . . . . . . . . . . . . . . . . . . . . . . 25,
framed box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
49
27
27
27
41
27
G
generating from Emacs . . . . . . . . . . . . . . . . . . . . . . . . . 15
generating manuals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
H
hard side-effects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
html index page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
I
image file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
images, inserting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
images, scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
including a predicate definition . . . . . . . . . . . . . . . . . .
including an image . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
including code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
including files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
including images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
including or not authors . . . . . . . . . . . . . . . . . . . . . . . .
including or not bug info . . . . . . . . . . . . . . . . . . . . . . .
including or not changelog . . . . . . . . . . . . . . . . . . . . . .
including or not versions, patches. . . . . . . . . . . . . . . .
indentation, avoiding . . . . . . . . . . . . . . . . . . . . . . . . . . .
index pages out of order . . . . . . . . . . . . . . . . . . . . . . . .
30
30
30
30
30
30
30
30
16
16
16
16
27
18