* Use FPDoc 3.3.1 by default.
* Adds log file output to all variations of the command line.
* Comments on use of --footer-date argument. FPDoc 3.3.1 raises an AV as of 2024-03-01.
* Adds comments about content that needs to be updated before running the scripts.
* Changes the default content in the --footer text variant.
* Sets the default font size to 12pt instead of 14px. 14px is approximately 7
lines per inch at 96dpi, and too small. It's like the fine print in a legal
contract. 12pt is 6 lines per inch and a more reasonable default size.
* Adds missing semicolon separators at the end of css style attributes.
* Depends on 5e581ce9, 2f595455, b0d263f1.
* LazUtils was never built with external links to LCL (See Also and source declarations) because lcl.xct could not be imported. The file does not exist when LazUtils is built.
To solve this problem, the output format for LazUtils is built twice. It is the smaller of the two packages. Building LazUtils twice ensures that the "chicken or the egg" problem with inter-file links is avoided.
* Build LazUtils WITHOUT any external links (faster).
* Build LCL with links to RTL, FCL, LazUtils.
* Build LazUtils with links to RTL, FCL, LCL.
* FPDoc 3.3.X changed the syntax for the --footer argument. It uses an ''@' prefix for file names and treats anythine else as text for the footer.. build_lcl_docs did not handle that syntax. Since we do not know which version of FPDoc will be used, we must handle both.
* Accepts --footer=filename.ext for 3.2.X.
* Accepts --footer=@filename.ext for 3.3.X.
* Accepts --footer="Your text here" for 3.3.X.
* File name expansion and validation occurs in the setter for TFPDocRun.FooterFilename.
* Modifies README.txt and all of the script files (.bat, .sh) to document requirements and usage.
* No default footer file is assumed. Allows output formats to be generated without footers when the --footer option is omitted.
* Removes unused unit LazUtilities from uses clause.
* Renames TFPDocRun.CreateOuputDir to TFPDocRun.CreateOutputDir.
* Fixes strings used in exception and logging messages.
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.
