FPCDocs Tutorial: what changed
Revision 0 to 1. Removed lines have a minus sign; added lines have a plus sign.
Title: FPCDocs Tutorial
| Old | New | Line | |
|---|---|---|---|
| 1 | + | ## Overview | |
| 2 | + | ||
| 3 | + | This tutorial will guide you through getting the latest FreePascal docs sources and generating documentation from it. Please see the official documentation \[3\] for more details. | |
| 4 | + | ||
| 5 | + | November 2011: I'm having trouble generating docs, and finding documentation on it, so I decided to start this page to help me and others. Please feel free to update/add info (and remove this notice when it actually works ;) --BigChimp 05:11, 22 November 2011 (CET) | |
| 6 | + | ||
| 7 | + | ## Prerequisites | |
| 8 | + | ||
| 9 | + | - A working FreePascal environment must be installed (e.g. a stable version from a Debian repository). See \[1\] for more details. | |
| 10 | + | - Having a working Lazarus installed may not hurt | |
| 11 | + | - As the documentation needs FPC source files, you will need the latest source from git. See \[1\] on how to get that. | |
| 12 | + | - The fpcdocs: | |
| 13 | + | ||
| 14 | + | ``` bash | |
| 15 | + | svn co http://svn.freepascal.org/svn/fpcdocs/trunk fpcdocs | |
| 16 | + | ``` | |
| 17 | + | ||
| 18 | + | - Some tex programs: texlive, tex4ht, and dvi2tty if you want to generate plain-text documents (for DOS, mainly). The package names may differ depending on your distribution. The files a4.sty and moveverb.sty. | |
| 19 | + | - Ubuntu 12: | |
| 20 | + | ``` bash | |
| 21 | + | apt-get install tex4ht texlive-binaries texlive-latex-base texlive-latex-recommended texlive-latex-extra | |
| 22 | + | ``` | |
| 23 | + | ||
| 24 | + | ### Assumptions | |
| 25 | + | ||
| 26 | + | I'm assuming you're running on Linux; apparently generating docs on Windows is not supported. Also, this tutorial assumes you have a stable system-wide installation of FPC and Lazarus, and a working SVN version of FPC with proper fpc.cfg. Finally, you have your SVN FPC source and fpcdocs directories set up like this: | |
| 27 | + | ||
| 28 | + | ``` bash | |
| 29 | + | ~/fpc/ | |
| 30 | + | ~/fpc/fpcdocs #contains SVN http://svn.freepascal.org/svn/fpcdocs/trunk | |
| 31 | + | ~/fpc/fpcsrc #contains FPC sources, e.g. http://svn.freepascal.org/svn/fpc/branches/fixes_2_6 | |
| 32 | + | ~/fpc/fpcsrc/compiler/utils/msg2inc.pp #contains FPC msg2inc tool | |
| 33 | + | ``` | |
| 34 | + | ||
| 35 | + | ## Generating documentation | |
| 36 | + | ||
| 37 | + | `make clean`\ | |
| 38 | + | `sh fixdocs.sh` | |
| 39 | + | ||
| 40 | + | write me ;) | |
| 41 | + | ||
| 42 | + | ## References | |
| 43 | + | ||
| 44 | + | - \[1\] [[Installing Lazarus]] | |
| 45 | + | - \[2\] Build FAQ | |
| 46 | + | - \[3\] FPDoc manual | |
| 47 | + | ||
| 48 | + | --- | |
| 49 | + | *From the Free Pascal wiki, page "FPCDocs Tutorial", as it stood on 2023-11-10 after a change by Bart, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* | |
| 50 | + | Category: Help and Docs | |
| 51 | + | Category: Tutorials |