|
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 is the cxxapiref plugin for DITA Open Toolkit. This plugin allows you to build html from DITA specialised cxx XML. |
|
11 After this plugin is installed you can use DITA Open Toolkit as normal or you can use the provided MPDOT tool, which is recommended. |
|
12 |
|
13 Setup |
|
14 ===== |
|
15 Download the DITA Open Toolkit 1.5.1 and the plugin apiref from sourceforge http://sourceforge.net/projects/dita-ot/files/ |
|
16 |
|
17 Uncompress the current package and copy the cxxapiref plugin directory into the %DOT_DIR%\plugins directory and put the python directory at the root of %DOT_DIR%. |
|
18 |
|
19 The file structure should look like this: |
|
20 |
|
21 DITA_OT_1.5.1 |
|
22 +---... |
|
23 +---dtd |
|
24 +---lib |
|
25 +---plugins |
|
26 \---apiref |
|
27 \---cxxapiref <-- added |
|
28 +---python <-- added |
|
29 ..etc |
|
30 |
|
31 |
|
32 Registration of the Specialisations into DITA-OT |
|
33 ================================================ |
|
34 |
|
35 Open a DITA-OT command prompt |
|
36 ----------------------------- |
|
37 Run the startcmd.bat file from the %DOT_DIR% |
|
38 |
|
39 This gives you a shell with the enviroment set up. |
|
40 Try running the DOT demos from this shell: |
|
41 |
|
42 ant all -f build_demo.xml |
|
43 |
|
44 A good build will end with: |
|
45 |
|
46 BUILD SUCCESSFUL |
|
47 Total time: 42 seconds |
|
48 |
|
49 This will populate the %DOT_DIR%\temp and %DOT_DIR%\out directories |
|
50 |
|
51 |
|
52 Run the registration script |
|
53 --------------------------- |
|
54 From the DITA-OT root directory run: |
|
55 ant -f integrator.xml |
|
56 |
|
57 This installs all of the addons plugins in the generic DITA-OT plugins folder. |
|
58 |
|
59 Testing |
|
60 ======= |
|
61 Build the cxx sample: |
|
62 |
|
63 ant -f plugins\cxxapiref\run-ant.xml all |
|
64 |
|
65 Check the output in %DOT_DIR%\plugins\apiref\out\sample |
|
66 |
|
67 Next steps |
|
68 ========== |
|
69 Now that the DITA Open Toolkit is set up, you can run it on your specialised cxx content. Either run DITA Open Toolkit as usual or use the MPDOT tool. |
|
70 Follow the %DOT_DIR%python\doc\Using_MPDOT_to_build_html.txt guide. |
|
71 |