Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "ETrice/Development/BuildingDocumentation"
< ETrice | Development
(MikTex added) |
|||
| Line 10: | Line 10: | ||
Prerequisites of the build are | Prerequisites of the build are | ||
| + | * a MikTex installation which can be obtained from [http://miktex.org/ the MikTex web site] | ||
| + | ** make sure that the htlatex binary is found on the path (it is located in %MIKTEX_HOME%\miktex\bin) | ||
* a LaTex Ant task which can be obtained from [http://www.java2s.com/Code/Jar/a/Downloadantlatex0091jar.htm the Java2s web page] | * a LaTex Ant task which can be obtained from [http://www.java2s.com/Code/Jar/a/Downloadantlatex0091jar.htm the Java2s web page] | ||
* the Xslt engine saxon9he as a Jar archive available from [http://sourceforge.net/projects/saxon/files/Saxon-HE/9.4/SaxonHE9-4-0-7J.zip/download the Saxon download page] | * the Xslt engine saxon9he as a Jar archive available from [http://sourceforge.net/projects/saxon/files/Saxon-HE/9.4/SaxonHE9-4-0-7J.zip/download the Saxon download page] | ||
Revision as of 05:59, 12 April 2013
Building the eTrice Documentation
The eTrice documentation is LaTex based. The sources are contained in the doc folder. The main document is etrice-doc.tex. All documents included therein will constitute the contents of the documentation.
The Ant script build.xml builds from the Tex sources
- a PDF manual
- HTML pages
- the Eclipse help table of contents
Prerequisites of the build are
- a MikTex installation which can be obtained from the MikTex web site
- make sure that the htlatex binary is found on the path (it is located in %MIKTEX_HOME%\miktex\bin)
- a LaTex Ant task which can be obtained from the Java2s web page
- the Xslt engine saxon9he as a Jar archive available from the Saxon download page
Note: The LaTex Ant task can be defined also directly inside Eclipse: Preferences > Ant > Runtime > Tasks. Before doing so you will have to add the classpath to the ant_latex jar in the corresponding tab (under Global Entries).