README.DOCS 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. This is the README for the Free Pascal documentation.
  2. All documentation is stored here, in LaTeX 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. If you want to produce dos docs, you can do a 'make htm' this will convert
  8. the .html files to .htm files (including all references), suitable for a 8:3
  9. format.
  10. The rest of this document is only interesting if you want to write docs.
  11. Otherwise, you can bail out now.
  12. THE DOCS...
  13. Why LaTeX ?
  14. - because I like a printed copy of the manuals, HTML just isn't good enough
  15. for this.
  16. - I know LaTeX very well :) (mind you : html also !)
  17. - many other reasons.
  18. In order to translate the things to HTML, I use latex2html, since it is the
  19. most powerful and flexible, although sluggish...
  20. For it to be able to use the fpc.sty, I had to write a fpc.perl script
  21. which it loads. The script seems to run fine when used standalone, but in
  22. conjunction with latex2html, I get a out of memory... ??
  23. I'm not familiar with perl, so if someone is, and can fix the thing, please
  24. do. (and let me know :) )
  25. Then how to proceed ?
  26. If you just want to write latex docs, just use fpc.sty. (you don't need
  27. html.sty)
  28. If you want to be able to convert to html, (you need html.sty) the following
  29. fixes the perl-problem :
  30. In the preamble of your document, type :
  31. \usepackage{html}
  32. \latex{\usepackage{fpc}}
  33. \html{\input{fpc-html.tex}}
  34. The fpc-html.tex defines the same commands as fpc.sty, only in a language
  35. that latex2html understands.
  36. fpc.sty.doc describes what fpc.sty does. (one day I'll integrate them using
  37. the doc package, but I need some time for it)
  38. Happy TeXing,
  39. Michael.