README.DOCS 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. This is the README for the Free Pascal documentation.
  2. All documentation is stored here, in LaTeX format and in fpdoc format.
  3. it uses special style files (fpc*.sty) which are also in the directory.
  4. do a 'make dvi' to produce the dvi format of the docs.
  5. a 'make html' will produce the html version (using latex2html).
  6. a 'make ps' will produce PostScript documents.
  7. a 'make pdf' will produce PDF (Portable Document Format) documents.
  8. a 'make txt' will produce plain text documents.
  9. If you want to produce dos docs, you can do a 'make htm' this will convert
  10. the .html files to .htm files (including all references), suitable for a 8:3
  11. format.
  12. The rest of this document is only interesting if you want to write docs.
  13. Otherwise, you can bail out now.
  14. THE DOCS...
  15. Why LaTeX ?
  16. - because I like a printed copy of the manuals, HTML just isn't good enough
  17. for this.
  18. - I know LaTeX very well :) (mind you : html also !)
  19. - It converts to many other formats.
  20. - many other reasons.
  21. In order to translate the things to HTML, I use latex2html, since it is the
  22. most powerful and flexible, although sluggish...
  23. Why fpdoc ?
  24. - Because it always creates up-to-date documentation.
  25. - The documentation is separate from the units contrary to many other
  26. documentation tools which require comments in the sources, which makes
  27. the source unreadable.
  28. - It's written in FPC.
  29. Then how to proceed ?
  30. If you just want to write general latex docs, just use fpc.sty.
  31. fpc.sty.doc describes what fpc.sty does. (one day I'll integrate them using
  32. the doc package, but I need some time for it)
  33. If you want to document units, use fpdoc. It is documented fairly complete,
  34. and you can have a look at the many .xml units for examples on how to use
  35. it.
  36. Happy TeXing,
  37. Michael.