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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
This is the README for the Free Pascal documentation.
All documentation is stored here, in LaTeX format and in fpdoc format.
it uses special style files (fpc*.sty) which are also in the directory.
Available Options
-----------------
To see a list of all available "target" output formats, run the following
command:
$ make help
do a 'make dvi' to produce the dvi format of the docs.
a 'make html' will produce the html version (using tex4ht).
a 'make ps' will produce PostScript documents.
a 'make pdf' will produce PDF (Portable Document Format) documents.
a 'make txt' will produce plain text documents.
If you only want the html reference documentation (fpdoc format), type
$ make rtl.chk
$ make fcl.chk
The html target output format has some variations as well. The two
commands above will generate the standard html output in sub-directories.
Two variations are both html output, but in a single file format.
CHM - Compressed HTML Help
--------------------------
When the HTMLFMT environment variable is set to "chm", make html (fpdoc)
will compress the html files to .chm files. The environment variable
CSSFILE can be used to override the style file (.css).
A complete release building script "fixdocs.sh" is added that should
build the .chms on *nix, provided a recent FPC is installed (not just fpdoc,
needs 2.4.0/2.5.1 fcl-xml too).
Note that the script does not do a great job cleaning yet, so if you have
odd problems, try to manually cleanup the fpcdocs/ checkout first.
IPF - OS/2 Information Presentation Facility
--------------------------------------------
When the HTMLFMT environment variable is set to "ipf", make html (fpdoc)
will generate a single .ipf file that contains all the documentation. This
.ipf file can then be compiled with the IPFC compiler (external tool) to
generate the final .INF help file.
$ make rtl.chk HTMLFMT=ipf FPCSRCDIR=/path/to/fpc/source
General Settings
----------------
The reference documentation and the list of compiler messages are
created from the FPC sources. For this to work correctly, the
documentation should be in the same directory as the rest of the
FPC source tree.
Meaning a directory layout as
/FPC/compiler
/rtl
/packages
/docs
or, alternatively, the directory structure as created when checking out
the build SVN-repository:
/FPC/fpcsrc/compiler
/rtl
/packages
/fpcdocs
If you have the sources in another location, you can specify their
location through the FPCSRCDIR makefile variable, e.g like in:
$ make html FPCSRCDIR=/path/to/fpc/sources
or an example of generating HTML reference documentation only:
$ make rtl.chk fcl.chk FPCSRCDIR=/path/to/fpc/sources
If you want to produce dos docs, you can do a 'make htm' this will convert
the .html files to .htm files (including all references), suitable for a 8:3
format.
The rest of this document is only interesting if you want to write docs.
Otherwise, you can bail out now.
THE DOCS...
Why LaTeX ?
-----------
- because I like a printed copy of the manuals, HTML just isn't good enough
for this.
- I know LaTeX very well :) (mind you : html also !)
- It converts to many other formats.
- many other reasons.
In order to translate the user manuals to HTML, I use tex4ht.
Why fpdoc ?
-----------
- Because it always creates up-to-date documentation.
- The documentation is separate from the units contrary to many other
documentation tools which require comments in the sources, which makes
the source unreadable.
- It's written in FPC.
Then how to proceed ?
---------------------
If you just want to write general latex docs, just use fpc.sty.
fpc.sty.doc describes what fpc.sty does. (one day I'll integrate them using
the doc package, but I need some time for it)
If you want to document units, use fpdoc. It is documented fairly complete,
and you can have a look at the many .xml units for examples on how to use
it.
Happy TeXing,
Michael.
|
