Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
swdev:howto:create_and_use_html_help_.chm_files [2010/07/08 14:11]
smayr
swdev:howto:create_and_use_html_help_.chm_files [2020/05/08 17:18] (current)
ajdavis [Setup Doxygen]
Line 7: Line 7:
 ===Setup Doxygen=== ===Setup Doxygen===
 * [[http://www.microsoft.com/downloads/details.aspx?familyid=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en|Download the HTML Help Compiler from Microsoft]]  and install it to ''C:\Program Files\HTMLHelp''. * [[http://www.microsoft.com/downloads/details.aspx?familyid=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en|Download the HTML Help Compiler from Microsoft]]  and install it to ''C:\Program Files\HTMLHelp''.
-* Download Doxygen files from http://www.doxygen.org and install them. +Make sure ezfit5/UserDoc/proj.cfg HHC_LOCATION property is set to the correct location. 
-* Download pas2dox from http://pas2dox.sourceforge.net +* <del>Download Doxygen files from http://www.doxygen.org and install them.</del> 
-* Copy pas2dox executable into the same folder where doxygen was installed (by default ''C:\Program Files\doxygen\bin'').+<del>Download pas2dox from http://pas2dox.sourceforge.net</del> 
 +<del>Copy pas2dox executable into the same folder where doxygen was installed (by default ''C:\Program Files\doxygen\bin'').</del>
 * Verify that the following preprocessor setting is enabled in the doxygen configuration file (for example, proj.cfg) used in a Delphi/Pascal project: * Verify that the following preprocessor setting is enabled in the doxygen configuration file (for example, proj.cfg) used in a Delphi/Pascal project:
 <code delphi> <code delphi>
Line 16: Line 17:
 ... ...
 </code> </code>
 +
 ===Doxygen Configuration=== ===Doxygen Configuration===
 * Generate a configuration file (such as proj.cfg) by calling doxygen with the -g option:  * Generate a configuration file (such as proj.cfg) by calling doxygen with the -g option: 
Line 122: Line 124:
   * Ghostscript (http://sourceforge.net/projects/ghostscript)   * Ghostscript (http://sourceforge.net/projects/ghostscript)
   * MiKTeX (http://www.miktex.org)   * MiKTeX (http://www.miktex.org)
 +
 +Create default Makefile (here it is called ''LatexMakefile''):
 +<code dos>
 +all: clean refman.dvi
 +
 +ps: refman.ps
 +
 +pdf: refman.pdf
 +
 +ps_2on1: refman_2on1.ps
 +
 +pdf_2on1: refman_2on1.pdf
 +
 +refman.ps: refman.dvi
 + C:\apps\miktex\miktex\bin\dvips -o refman.ps refman.dvi
 +
 +refman.pdf: refman.ps
 + "C:\Program Files\gs\gs8.71\bin\gswin32c" -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=refman.pdf -c save pop -f refman.ps
 +
 +refman.dvi: refman.tex doxygen.sty
 + echo "Running latex..."
 + C:\apps\miktex\miktex\bin\latex refman.tex
 + echo "Running makeindex..."
 + C:\apps\miktex\miktex\bin\makeindex refman.idx
 + echo "Rerunning latex...."
 + C:\apps\miktex\miktex\bin\latex refman.tex
 +
 +refman_2on1.ps: refman.ps
 + C:\apps\miktex\miktex\bin\psnup -2 refman.ps >refman_2on1.ps
 +
 +refman_2on1.pdf: refman_2on1.ps
 + "C:\Program Files\gs\gs8.71\bin\gswin32c" -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=refman_2on1.pdf -c save pop -f refman_2on1.ps
 +
 +clean:
 + del -f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out *.pdf
 +</code>
  
 Run a batch file: Run a batch file:
-<code>+<code dos>
 REM ---------------------------------------------------------- REM ----------------------------------------------------------
 REM script: make.bat REM script: make.bat
 +REM date  : 2006 jun
 +REM programmer: Siegwart Mayr
 REM Description: REM Description:
 REM Make HTML, CHM, and PDF versions of the documentation REM Make HTML, CHM, and PDF versions of the documentation
Line 142: Line 182:
 doxygen proj.cfg doxygen proj.cfg
  
-rem @echo --- create PDF document version ---+@echo --- create PDF document version ---
 copy /Y LatexMakefile latex\Makefile  copy /Y LatexMakefile latex\Makefile 
 @cd latex @cd latex
-make all + 
-make ps +REM --- Create PDF using Makefile (Optional) --- 
-make pdf +REM make all 
-make ps_2on1 +REM make ps 
-make pdf_2on1+REM make pdf 
 +REM make ps_2on1 
 +REM make pdf_2on1 
 + 
 +REM --- Creating PDF using commands directly --- 
 +@echo "Running latex..." 
 +C:\apps\miktex\miktex\bin\latex refman.tex 
 +@echo "Running makeindex..." 
 +C:\apps\miktex\miktex\bin\makeindex refman.idx 
 +@echo "Rerunning latex...." 
 +C:\apps\miktex\miktex\bin\latex refman.tex 
 +@echo "Creating PDF from latex...." 
 +C:\apps\miktex\miktex\bin\pdflatex refman.tex 
 +C:\apps\miktex\miktex\bin\dvips -o refman.ps refman.dvi 
 +"C:\Program Files\gs\gs8.71\bin\gswin32c.exe" -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=refman.pdf -c save pop -f refman.ps     
 @cd .. @cd ..
  
Line 156: Line 211:
 start html\UserDoc.CHM start html\UserDoc.CHM
 start latex\refman.pdf start latex\refman.pdf
-start latex\refman_2on1.pdf+rem start latex\refman_2on1.pdf 
 + 
 +@pause
  
 </code> </code>
Line 282: Line 339:
 #include ctxhelp #include ctxhelp
 </code> </code>
 +
  
 * Create a batch file to add the context information: * Create a batch file to add the context information: