|
1 License |
|
2 ======= |
|
3 Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. |
|
4 This component and the accompanying materials are made available under the terms of the License |
|
5 "Eclipse Public License v1.0" which accompanies this distribution, |
|
6 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
7 |
|
8 Introduction |
|
9 ============ |
|
10 This document explains how to use mpdot.exe on converted cxx specialisation xml to create html. |
|
11 |
|
12 MPDOT.exe runs the DITA Open Toolkit for each cxx specialisation reference component in parallel. This decreases the time it |
|
13 takes to build a large amount of reference xml documentation and also reduces the likelihood of java out of memory issues. |
|
14 |
|
15 Prerequisites |
|
16 ============= |
|
17 This supplied version of the DITA Open Toolkit is based onDITA-OT version 1.5.1. It contains the specialised cxxapiref plugin |
|
18 DITA-OT1.5.1/plugins/cxxapiref and some specific python scripts. |
|
19 |
|
20 To use this modified version of DITA Open Toolkit unzip it to a location on your build machine and follow the instructions below. |
|
21 |
|
22 You should have already installed and run ORB and orb_process_cxx.bat on your content and as a result have a directory |
|
23 with all the cxx reference and maps within it. This directory can be found here: |
|
24 %EPOCROOT%epoc32\release\doxygen\dita |
|
25 |
|
26 This directory should contain a set of files including maps and reference documents. Maps are named .ditamap |
|
27 and reference documents .xml. All the files should have been renamed with a global unique id (GUID) and there should |
|
28 be a file named GUID-445218BA-A6BF-334B-9337-5DCBD993AEB3.ditamap. This file is the main ditamap and this is passed to |
|
29 the mpdot.exe for processing. |
|
30 |
|
31 If you do not have these files see the README.txt document in ORB for instructions. |
|
32 |
|
33 Building html with mpdot |
|
34 ======================== |
|
35 Open a command prompt with startcmd.bat in the DITA-OT1.5.1 installation. This sets the required environment variables and opens |
|
36 a command prompt. |
|
37 |
|
38 envoke mpdot.exe with the path to the ditamap you wish to build and the path of the output directory. |
|
39 If the output directory does not already exist then create it first. |
|
40 |
|
41 mpdot.exe <DITA map> <output directory> |
|
42 |
|
43 For example: |
|
44 python\dist\mpdot.exe "C:\epoc32\release\doxygen\dita\GUID-445218BA-A6BF-334B-9337-5DCBD993AEB3.ditamap" "C:\epoc32\release\mpdot_out" |
|
45 |
|
46 Other options |
|
47 ============= |
|
48 These options can also be passed to mpdot.exe. |
|
49 * -j 0 This option detects and uses maximum processors on the build machine. |
|
50 * dita.preprocess.reloadstylesheet=true This option reduces the amount of memory the java virtual machine uses and so will reduce |
|
51 the likelihood of memory errors. |
|
52 * transtype=xhtml This is the output type that DITA Open Toolkit will produce. Check DITA Open Toolkit help |
|
53 for other options. |
|
54 For example: |
|
55 python\dist\mpdot.exe -j 0 "C:\epoc32\release\doxygen\dita\GUID-445218BA-A6BF-334B-9337-5DCBD993AEB3.ditamap" "C:\epoc32\release\mpdot_out" transtype=xhtml dita.preprocess.reloadstylesheet=true |
|
56 |
|
57 Output |
|
58 ====== |
|
59 In the output directory you will find these directories: |
|
60 |
|
61 Directory tree Description |
|
62 -------------- ----------- |
|
63 +---dot_comp Contains all components individually built in their own directories. The name of the ditamap built by DOT is in the name of the folder. |
|
64 +---dot_src All component files and their maps and the main ditamap |
|
65 +---dot_toc Contains the main toc only. |
|
66 +---dot_toc_tmp Temporary directory |
|
67 |