diff options
Diffstat (limited to 'doc/navigation-core')
-rwxr-xr-x | doc/navigation-core/NavigationCoreAPI.pdf | bin | 0 -> 553634 bytes | |||
-rwxr-xr-x | doc/navigation-core/tools/NavigationCoreAPI-part1.doc | bin | 0 -> 353280 bytes | |||
-rwxr-xr-x | doc/navigation-core/tools/NavigationCoreAPI-part1.pdf | bin | 0 -> 374801 bytes | |||
-rwxr-xr-x | doc/navigation-core/tools/README.txt | 27 | ||||
-rwxr-xr-x | doc/navigation-core/tools/generate-doc.sh | 44 |
5 files changed, 71 insertions, 0 deletions
diff --git a/doc/navigation-core/NavigationCoreAPI.pdf b/doc/navigation-core/NavigationCoreAPI.pdf Binary files differnew file mode 100755 index 0000000..4ede81e --- /dev/null +++ b/doc/navigation-core/NavigationCoreAPI.pdf diff --git a/doc/navigation-core/tools/NavigationCoreAPI-part1.doc b/doc/navigation-core/tools/NavigationCoreAPI-part1.doc Binary files differnew file mode 100755 index 0000000..664125e --- /dev/null +++ b/doc/navigation-core/tools/NavigationCoreAPI-part1.doc diff --git a/doc/navigation-core/tools/NavigationCoreAPI-part1.pdf b/doc/navigation-core/tools/NavigationCoreAPI-part1.pdf Binary files differnew file mode 100755 index 0000000..29eaa2d --- /dev/null +++ b/doc/navigation-core/tools/NavigationCoreAPI-part1.pdf diff --git a/doc/navigation-core/tools/README.txt b/doc/navigation-core/tools/README.txt new file mode 100755 index 0000000..24e2eb2 --- /dev/null +++ b/doc/navigation-core/tools/README.txt @@ -0,0 +1,27 @@ +--------------------------------- +Document Generation +--------------------------------- + +0) +Install the following packages: +sudo apt-get install wkhtmltopdf +sudo apt-get install xsltproc +sudo apt-get install pdftk + +1) +Modify the <component name>API-part1.doc as needed. + +2) +Convert the <component name>API-part1.doc +into a pdf document with the same name. + +3) +Navigate to the directory 'tools'. + +4) +Generate the documentation: +./generate-doc.sh + +A document called <component name>API-part2.pdf will be automatically generated. +The final component documentation (<component name>API.pdf) will be created in +the parent directory. diff --git a/doc/navigation-core/tools/generate-doc.sh b/doc/navigation-core/tools/generate-doc.sh new file mode 100755 index 0000000..80d1709 --- /dev/null +++ b/doc/navigation-core/tools/generate-doc.sh @@ -0,0 +1,44 @@ +#! /bin/bash + +########################################################################### +# @licence app begin@ +# SPDX-License-Identifier: MPL-2.0 +# +# Component Name: GNSSService +# Author: Marco Residori +# +# Copyright (C) 2013, XS Embedded GmbH +# +# License: +# This Source Code Form is subject to the terms of the +# Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with +# this file, You can obtain one at http://mozilla.org/MPL/2.0/. +# +# @licence end@ +########################################################################### + +API_DIR=../../../api/navigation-core +OUTPUT_DIR=.. +OUTPUT_FILE=NavigationCoreAPI.pdf + +INPUT_FILE1=NavigationCoreAPI-part1.pdf +INPUT_FILE2=NavigationCoreAPI-part2.pdf + +#convert xml files into html files +xsltproc -o ./genivi-navigationcore-session.html $API_DIR/introspect.xsl $API_DIR/genivi-navigationcore-session.xml +xsltproc -o ./genivi-navigationcore-configuration.html $API_DIR/introspect.xsl $API_DIR/genivi-navigationcore-configuration.xml +xsltproc -o ./genivi-navigationcore-routing.html $API_DIR/introspect.xsl $API_DIR/genivi-navigationcore-routing.xml +xsltproc -o ./genivi-navigationcore-guidance.html $API_DIR/introspect.xsl $API_DIR/genivi-navigationcore-guidance.xml +xsltproc -o ./genivi-navigationcore-locationinput.html $API_DIR/introspect.xsl $API_DIR/genivi-navigationcore-locationinput.xml +xsltproc -o ./genivi-navigationcore-mapmatchedposition.html $API_DIR/introspect.xsl $API_DIR/genivi-navigationcore-mapmatchedposition.xml +xsltproc -o ./genivi-navigationcore-constants.html $API_DIR/constants.xsl $API_DIR/genivi-navigationcore-constants.xml + +#concatenate html files into a single pdf file +wkhtmltopdf ./genivi-navigationcore-routing.html ./genivi-navigationcore-session.html ./genivi-navigationcore-configuration.html ./genivi-navigationcore-guidance.html ./genivi-navigationcore-mapmatchedposition.html ./genivi-navigationcore-locationinput.html ./genivi-navigationcore-constants.html $INPUT_FILE2 + +#remove temporary html files +rm *.html + +#concatenate pdf files +pdftk $INPUT_FILE1 $INPUT_FILE2 cat output $OUTPUT_DIR/$OUTPUT_FILE + |