paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-10 18:08:17 +02:00
Code Issues Packages Projects Releases Wiki Activity
f5bb0f7081
lazarus/docs/html
History
dsiders 8af9cd0918 Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500. 
Modified files:

* docs/html/build_lcl_docs.lpi
*  docs/html/build_lcl_docs.lpr
Adds TFPDocRun.ChmTitle property for CHM title and text in the LHelp TOC navigation tree.
Sets the footer file for each of the output formats generated in the program. Allows CHM to have links to the online HTML version, while HTML does not.
Modifies logic used to generate links to external topics. Causes LazUtils (the smaller of the two outputs) to be created twice.

* docs/html/build_chm.bat
* docs/html/build_chm.sh
Adds logic to generate distinct footer files for CHM vs HTML. Footer files include document title, version information, and generation date.

* docs/html/build_html.bat
* docs/html/build_html.sh
Copies custom CSS file to the output directory.

* docs/html/chmlazutilsfooter.xml
* docs/html/chmlclfooter.xml
* docs/html/locallazutilsfooter.xml
* docs/html/locallclfooter.xml
Standardized footer files for CHM and HTML output formats. A separate footer file is used for LCL and LazUtils for each of the output formats.

* docs/html/fpdoc.css
Adds font family fallbacks for common default fonts on various platforms.
Modifies layout and borders for definition lists (DL, DT, DD tags). Removes the border around DL.
Adds style rules for tags, classes used in file footers.
2021-10-28 02:55:57 +01:00
..
build_chm.bat Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500. 2021-10-28 02:55:57 +01:00
build_chm.sh Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500. 2021-10-28 02:55:57 +01:00
build_html.bat Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500. 2021-10-28 02:55:57 +01:00
build_html.sh Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500. 2021-10-28 02:55:57 +01:00
build_lcl_chm.sh debian: fix group writable permissions 2017-05-19 08:45:30 +00:00
build_lcl_docs.lpi Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500. 2021-10-28 02:55:57 +01:00
build_lcl_docs.lpr Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500. 2021-10-28 02:55:57 +01:00
chmlazutilsfooter.xml Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500. 2021-10-28 02:55:57 +01:00
chmlclfooter.xml Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500. 2021-10-28 02:55:57 +01:00
fpdoc.css Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500. 2021-10-28 02:55:57 +01:00
localfclfooter.xml
locallazutilsfooter.xml Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500. 2021-10-28 02:55:57 +01:00
locallclfooter.xml Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500. 2021-10-28 02:55:57 +01:00
localrtlfooter.xml
Makefile
README.txt docs: readme: add footer 2019-04-13 11:16:24 +00:00

README.txt 

HTML documentation of Lazarus
=============================

This directory contains the tools to create the HTML and CHM documentation for
Lazarus. The documentation is stored in fpdoc format in the docs/xml/ directory.

For UNIXes:

The script build_html.sh will automatically create the whole HTML
documentation.
Build build_lcl_docs.lpi
../../lazbuild build_lcl_docs.lpi

./build_lcl_docs --fpdoc /path/to/fpc/trunk/utils/fpdoc/fpdoc --fpcdocs=../chm --outfmt chm --footer locallclfooter.xml

For Windows:

Build the project build_lcl_docs.lpi, fix the PATH in the build_html.bat batch
script to your local installation and then run the script, or run
build_lcl_docs.exe directly.