Debian Codegraph @

doc/html/quickstartguide/concepts/about_toolkitroles.html

raw
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xml:lang="en-us" lang="en-us">
5 <head>
6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
7 <meta name="copyright" content="(C) Copyright 2005"/>
8 <meta name="DC.rights.owner" content="(C) Copyright 2005"/>
9 <meta name="DC.Type" content="concept"/>
10 <meta name="DC.Title" content="About DITA-OT Toolkit Roles"/>
11 <meta name="abstract" content="Descriptions of the following user roles for the toolkit: CSS Customizers, Build Scripters, and potentially End Users of third-party authoring tools."/>
12 <meta name="description" content="Descriptions of the following user roles for the toolkit: CSS Customizers, Build Scripters, and potentially End Users of third-party authoring tools."/>
13 <meta name="DC.Relation" scheme="URI" content="../../quickstartguide/chapters/chapter1.html"/>
14 <meta name="DC.Format" content="XHTML"/>
15 <meta name="DC.Identifier" content="about_toolkitroles"/>
16 <link rel="stylesheet" type="text/css" href="../../css/commonltr.css"/>
17 <title>About DITA-OT Toolkit Roles</title>
18 </head>
19 <body id="about_toolkitroles">
20
21
22 <h1 class="title topictitle1">About DITA-OT Toolkit Roles</h1>
23
24
25 <div class="body conbody"><p class="shortdesc">Descriptions of the following user roles for the toolkit: CSS Customizers, Build Scripters, and potentially End Users of third-party authoring tools.</p>
26
27 <div class="p">If you don't know what a build script is, or whether your authoring tool should or does use DITA OpenToolkit, you may be reading the right document in the
28 in the DITA-OT documentation suite. User Roles are a useful way to present and approach the documentation, enabling the reader to bypass information that is not relevant to
29 the specific task she is performing when this document is read. The followige roles are addressed in this guide:
30 <ul class="ul">
31 <li class="li">CSS Stylesheet Customizers</li>
32
33 <li class="li">Ant Build Scripters</li>
34
35 <li class="li">Online Help developers</li>
36
37 </ul>
38
39 </div>
40
41 <p class="p">
42 Many readers may be unaware of the toolkit's presence, but it is the "engine" of whatever writing tool you use to write and maintain XML-based, DITA-compliant content.
43 CSS Stylesheet Customizers read this guide when they are unable to specify custom stylesheets, or <samp class="ph codeph">.css</samp> files from their third-party authoring application.
44 Build Scripters consult this guide when the toolkit is unable to process an Ant build script. The Quick Start Guide features an up-to-date tables of all supported parameters
45 for both Ant and the Java command line interface, useful information if your documentation is generated automatically as part of an automated daily build. As my first manager
46 warned me long, long ago, 'The howling hordes descend when the build breaks'.
47 </p>
48
49 <p class="p">
50 If you need to fix a broken build, time is of the essence. If you know how to edit CSS stylesheessor run Ant build scripts, then read on.
51 If you don't recognize CSS and Ant, you're likely an End User and you should refer to your third-party documentation. If like the author, you also enjoy hacking with your tools
52 this is definitely the guide for you. Although the Quick StartGguide currently provides more information for build scripters than css customizers, revisions will describe the use
53 of XSLT and the new plugin architecture for this audience. When your third-party authoring tool breaks down, this guide is the mechanic's manual you didn't know you had. If you're
54 unafraid of a command line and willing to "get your hands dirty" under the hood, an up-to-date, and maintained table of Ant build properties can be the difference between a broken
55 build and a bad day or a gently purring build in a background <samp class="ph codeph">chron</samp> chron job that never demands attention. If the build has already broken by the time you read this, your may be the "build hero" who magically "fixes" the build
56 which no one cares about, except that it is usually only then that the fire-breathing IT dragon returns to it's cave and everyone can relax again until the next "emergency".
57 </p>
58
59 </div>
60
61 <div class="related-links">
62 <div class="familylinks">
63 <div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../../quickstartguide/chapters/chapter1.html" title="Understanding the role of DITA Open Toolkit and Ant for technical writers.">Introduction to the DITA Open Toolkit and Ant</a></div>
64 </div>
65 </div>
66
67 </body>
68 </html>