diff --git a/docs/html/build_chm.sh b/docs/html/build_chm.sh index d4175a1d7c..3d7c544694 100755 --- a/docs/html/build_chm.sh +++ b/docs/html/build_chm.sh @@ -1,12 +1,10 @@ #!/bin/bash -# # Builds Lazarus documentation for LCL and LazUtils in CHM format. # Requires a $(LazarusDir)/docs/chm directory which contains rtl.xct and fcl.xct. # Process fails if either the directory or the files are missing. # Process creates ./lcl and ./lazutils subdirectories for CHM output. -# Update the content in locallclfooter.xml if needed before starting the script. -# +# UPDATE THE CONTENT IN LOCALLCLFOOTER.XML IF NEEDED BEFORE STARTING THE SCRIPT. # Path to the fpdoc program # The trunk (main) version of fpdoc is recommended. @@ -17,14 +15,22 @@ fpdocpath="../../../fpc331/fpc/bin/x86_64-win64" # rebuild if needed #../../lazbuild build_lcl_docs.lpi -# build chm output without footers -./build_lcl_docs --outfmt=chm --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc +# build chm output WITHOUT footers +#./build_lcl_docs --outfmt=chm --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc 2>&1 | tee -a ./build_chm.log + +# build chm output with date in footer +# DOES NOT WORK IN FPDOC 3.3.1 AS OF 2024-03-01 (AV) +#./build_lcl_docs --outfmt=chm --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc --arg "--footer-date" 2>&1 | tee -a ./build_chm.log # For FPDoc 3.2.X: build chm output with footers in locallclfooter.xml -#./build_lcl_docs --outfmt=chm --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc --footer=locallclfooter.xml +# update the content in locallclfooter.xml if needed before starting the script. +#./build_lcl_docs --outfmt=chm --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc --footer=locallclfooter.xml 2>&1 | tee -a ./build_chm.log # For FPDoc 3.3.X: build chm output with footers in locallclfooter.xml -#./build_lcl_docs --outfmt=chm --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc --footer=@locallclfooter.xml +# update the content in locallclfooter.xml if needed before starting the script. +#./build_lcl_docs --outfmt=chm --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc --footer=@locallclfooter.xml 2>&1 | tee -a ./build_chm.log -# For FPDoc 3.3.X: build chm output with footer text -#./build_lcl_docs --outfmt=chm --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc --footer="(c) Copyright 2022. All rights reserved." +# For FPDoc 3.3.X ONLY: build chm output with footer text +# update the text in ftr before starting the script +ftr="Version 3.4 (YYYY-MM-DD)" +./build_lcl_docs --outfmt=chm --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc --footer="$ftr" 2>&1 | tee -a ./build_chm.log diff --git a/docs/html/build_html.sh b/docs/html/build_html.sh index 95d102e899..8a0f8db175 100755 --- a/docs/html/build_html.sh +++ b/docs/html/build_html.sh @@ -1,12 +1,10 @@ #!/bin/bash -# -# Builds Lazarus documentaiton for LCL and LazUtils in HTML format. +# Builds Lazarus documentaiton for LCL and LazUtils in HTML format. # Requires a $(LazarusDir)/docs/chm directory which contains rtl.xct and fcl.xct. # Process fails if either the directory or the files are missing. # Process creates ./lcl and ./lazutils subdirectories for HTML output. # Update the content in locallclfooter.xml if needed before starting the script. -# # Path to the fpdoc program # The trunk (main) version of fpdoc is recommended. @@ -18,13 +16,21 @@ fpdocpath="../../../fpc331/fpc/bin/x86_64-win64" #../../lazbuild build_lcl_docs.lpi # build html output without footers -./build_lcl_docs --outfmt=html --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc +#./build_lcl_docs --outfmt=html --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc 2>&1 | tee -a ./build_html.log + +# build chm output with date in footer +# DOES NOT WORK IN FPDOC 3.3.1 AS OF 2024-03-01 (AV) +#./build_lcl_docs --outfmt=html --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc --arg="--footer-date" 2>&1 | tee -a ./build_html.log # For FPDoc 3.2.X: build html output with footers in locallclfooter.xml -#./build_lcl_docs --outfmt=html --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc --footer=locallclfooter.xml +# update the content in locallclfooter.xml if needed before starting the script. +#./build_lcl_docs --outfmt=html --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc --footer=locallclfooter.xml 2>&1 | tee -a ./build_html.log # For FPDoc 3.3.X: build html output with footers in locallclfooter.xml -#./build_lcl_docs --outfmt=html --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc --footer=@locallclfooter.xml +# update the content in locallclfooter.xml if needed before starting the script. +./build_lcl_docs --outfmt=html --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc --footer=@locallclfooter.xml 2>&1 | tee -a ./build_html.log -# For FPDoc 3.3.X: build html output with footer text -#./build_lcl_docs --outfmt=html --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc --footer="(c) Copyright 2022. All rights reserved." +# For FPDoc 3.3.X ONLY: build html output with footer text +# update the text in ftr before starting the script +ftr="Version 3.4 (YYYY-MM-DD)" +#./build_lcl_docs --outfmt=html --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc --footer="$ftr" 2>&1 | tee -a ./build_html.log