Commit Graph

14 Commits

Author SHA1 Message Date
dsiders
59523cede0 Docs: Updates Linux build scripts for CHM and HTML.
* 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.
2024-03-01 21:30:39 +00:00
dsiders
1bf9eac4dc Docs: Updates CHM and HTML build scripts to use fpdoc 3.2.2 and adds log files.
* These changes are temporary.
* fpdoc version 3.3.1-13340-g757f65d0e2 [2023-07-18] has output issues.
2023-07-20 05:37:33 +01:00
dsiders
2f59545512 Docs: build_lcl_docs. Fixes an incompatibility with FPDoc 3.3.x.
* 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.
2022-02-24 06:35:16 +00:00
mattias
f8af491a06 docs: readme 2021-10-30 11:56:47 +02:00
dsiders
1c1fc3a75a Revert "Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500."
This reverts commit 8af9cd0918.
2021-10-29 17:28:13 +01:00
dsiders
3f3887531f Revert "Revert "Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500.""
This reverts commit 8f01e29b24.
2021-10-29 17:19:31 +01:00
dsiders
2380b91fc7 Revert "Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500."
This reverts commit 8af9cd0918.
2021-10-29 17:19:07 +01:00
dsiders
510447e5c2 Revert "Revert "Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500.""
This reverts commit 8f01e29b24.
2021-10-29 17:17:48 +01:00
dsiders
8f01e29b24 Revert "Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500."
This reverts commit 8ac2328b60.
2021-10-29 17:13:27 +01:00
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
mattias
62cd430a5b docs: hints about rtl.xct
git-svn-id: trunk@56017 -
2017-10-10 13:54:04 +00:00
mattias
49eced03ba docs: updated build_html.sh
git-svn-id: trunk@19622 -
2009-04-25 18:23:56 +00:00
vincents
0582d72087 docs: fixed script names in doc building script
git-svn-id: trunk@14966 -
2008-04-25 11:10:51 +00:00
sekelsenmat
95bf12f9c6 Renames the doc building scripts and adds some more scripts for Windows.
git-svn-id: trunk@14962 -
2008-04-25 10:52:13 +00:00