diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/build.xml b/hadocs/dita-ot/trunk/src/gettingstarted/build.xml new file mode 100644 index 00000000..52cf2494 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/build.xml @@ -0,0 +1,83 @@ + + + + + + + + + + + + + + + + + + + + This sample file uses a simple CSS file to create a new, more colorful look and feel for generatedXHTML files. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/gettingstarted.ditamap b/hadocs/dita-ot/trunk/src/gettingstarted/gettingstarted.ditamap new file mode 100644 index 00000000..64c2dfc2 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/gettingstarted.ditamap @@ -0,0 +1,125 @@ + + + + + + + + + + + HAWEBS信息技术股份有限公司 + + + DITA 入门 + + + + HAWEBS DITA OT + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_c_overview_of_the_dita_open_toolkit.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_c_overview_of_the_dita_open_toolkit.dita new file mode 100644 index 00000000..271b41c1 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_c_overview_of_the_dita_open_toolkit.dita @@ -0,0 +1,15 @@ + + + + +Overview of the DITA Open Toolkit +The DITA Open Toolkit is a reference implementation of +the OASIS DITA standard. The Toolkit transforms DITA content (maps +and topics) into deliverable formats, including XHTML, Eclipse Help, +HTML Help, JavaHelp, and PDF. + +

+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_c_prerequisite_software.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_c_prerequisite_software.dita new file mode 100644 index 00000000..a64c198b --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_c_prerequisite_software.dita @@ -0,0 +1,28 @@ + + + + +Prerequisite software +The DITA Open Toolkit can be installed on either Windows +or SUSE Linux. It requires a JDK. + +

The DITA Toolkit has been tested with the following applications:

+ +
Java Development Kit (JDK)
+
    +
  • IBM JDK 1.5,
    • +
  • SUN JDK 1.5
    • +
+ +
Operating systems
+
    +
  • Microsoft Windows XP
    • +
  • SUSE Linux Enterprise Server (SLES) 10
    • +
+

+

Ant 1.7.1 and Saxon 6.5 are included in the full package +of the DITA Toolkit.

+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_c_whats_new_in_dita_ot_15.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_c_whats_new_in_dita_ot_15.dita new file mode 100644 index 00000000..2527424b --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_c_whats_new_in_dita_ot_15.dita @@ -0,0 +1,87 @@ + + + + + + + DITA Open Toolkit, version 1.5 的新特性 + 新特性，DITA OT + +
+ +
新的通用处理参数
+
DITA OT 1.5 包含有下面新的 ANT 处理参数： + + + + + + + + +
+ + +
新的 XHTML 转换参数
+
DITA OT 1.5 包含有下面新的供 XHTML 转换输出的 ANT 参数： + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
New parameters for PDF transformations
+
DITA OT 1.5 contains the following new parameters for PDF transformations: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_ditabase_conref.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_ditabase_conref.dita new file mode 100644 index 00000000..cf68d1f6 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_ditabase_conref.dita @@ -0,0 +1,614 @@ + + + + + + + +Reuse file +Contains elements that are reused in the documentation +for the DITA Open Toolkit + + +Concept + + + +Reference + +
Ant parametersHere are existing +resources about the DITA OT parameters:
    +
    • +
    • +
The valid values are yes and no. The default value is no. + +args.artlbl +An optional parameter that specifies whether +the path and name of the image file are displayed in brackets after +the image. + +args.breadcrumbs +An optional parameter that specifies +whether bread crumb links are generated in the output. + +args.copycss +An optional parameter that specifies whether +to copy the user-specified CSS file to the output directory. (The +default DITA Open Toolkit files, commonltr.css or commonrtl.css, +are automatically copied to the output directory.) When used in conjunction +with the args.csspath parameter, all CSS files +are copied to the specified subdirectory. + +args.css +An optional parameter that specifies a user-supplied +CSS file. By default, the HTML references either commonltr.css or commonrtl.css. +When you specify an additional CSS file using the args.css parameter, +that CSS file also is referenced in the <head> of the HTML page. +Use this parameter to locate the CSS file on the build system. The +following values are valid:
    +
  • A fully qualified file name.
    • +
  • A file name. For this to work, you must also issue the args.cssroot parameter.
    • +
  • A relative path and file name. For this to work, you must also +issue the args.cssroot parameter.
    • +
 + +args.csspath +An optional parameter that specifies the +path of the @href attribute for the <link> element in the HTML +output. This can be useful if you want all the CSS files to be located +in a subdirectory of the output directory, or if you want to refer +to a CSS file located on a Web server. Valid values are one of the +following:
    +
  • A local relative path. Use / as the path +separator; do not append a path separator to the end of the value.
    • +
  • An absolute path that begins with http:// or https://.
    • +
The default value is no path. + +args.cssroot +An optional parameter that specifies the +root directory of a user-specified CSS file. If this parameter is +set, the value of the args.css parameter must +be a file path relative to args.cssroot. + +args.debug +An optional parameter that specifies whether +the log contains extra debugging information. + +args.dita.locale +An optional parameter that specifies +the locale that is used to sort the <indexterm> elements. The valid +values are specified in the string.xml file +that is located in the DITAOT\xsl\common directory, +where DITAOT is the directory where the DITA Open +Toolkit is installed. By default, the value of the first occurrence +of the @xml-lang attribute found in the DITA source is used. If no +@xml-lang attribute is found, en-us is used. + +args.draft +An optional parameter that specifies whether +draft comments and the content of <required-cleanup> elements are +rendered in output. + +args.eclipse.provider +An optional parameter that specifies +the value of providerName in the plugin.properties file. +The default value is DITA. + +args.eclipse.version +An optional parameter that specifies +the version of the Eclipse help. The default value is 1.0.Does +the default value need to be updated?Here +are some messages from the Yahoo! list that are pertinent:
    +
    • +
    • +
    • +
 + +args.eclipsecontent.toc +An optional parameter that specifies +XXX. The default value is the name of the DITA map.Content +from existing documentation or release notes:
    +
  • "the root file name of the output Eclipse content provider toc +file in eclipsecontent transformation."
    • +
  • The original parameter "args.eclipse.toc" in "Ant tasks and script" +was separated to "args.eclipsehelp.toc" for DITA-to-Eclipse help transformation, +and "args.eclipsecontent.toc" for DITA-to-dynamic Eclipse content +transformation. See for more information.
    • +
  • Additional notes that apply to Release 1.1.2 as well: http://tech.groups.yahoo.com/group/dita-users/message/120
    • +
 +Does this parameter also apply to the dita2eclipsehelp +transformation? + +args.eclipsehelp.toc +An optional parameter that specifies +the root name of the Eclipse table of contents (TOC) file. The default +value is the root name of the DITA map. + +arg.figurelink.style +An optional parameter that specifies how cross references to figures +are rendered. The valid values are figure and title. The default value +is figure. + +args.fo.img.ext +An optional parameter that specifies the +extension for image files. The valid values are jpg and gif. If no +value is specified, the image files are used as-is.. + What values are valid? + +args.fo.output.rel.links +An optional parameter that specifies +whether related linked are rendered in output. + +args.fo.userconfig +An optional parameter that specifies +the user configuration file for Apache Formatting Objects Processor +(FOP). + +args.ftr +An optional parameter that specifies the fully +qualified name of a file that contains an XHTML fragment. The fragment +is written before the </body> element in the XHTML output. The +HTML fragment must have a single root element, such as <div>. + +args.gen.default.meta +An optional parameter that specifies +whether to "generate extra metadata that targets parental control +scanners (meta elements with name="security" and name="Robots')." + +args.gen.task.lbl +An optional parameter that specifies +whether to generate locale-based headings for <section> elements +in task topics. + +args.hdf +An optional parameter that specifies the fully +qualified name of a file that contains an XHTML fragment. The fragment, +often JavaScript, is written in the <head> element in the XHTML +output. The HTML fragment must have a single root element, such as <div>. +Since a <div> element is not valid in the <head> element, it +is not included in the XHTML output. + +args.hdr +An optional parameter that specifies the fully +qualified name of a file that contains an XHTML fragment. The fragment +is written after the <body> element in the XHTML output. The HTML +fragment must have a single root element, such as <div>. + +args.hide.parent.link +An optional parameter that specifies +whether to hide the links to parent topics in the rendered XHTML. + +args.htmlhelp.includefile +An optional parameter that specifies +XXX.
    +
  • Content from original documentation: "the file that need to be +included by the HTMLHelp output"
    • +
  • Information from Deborah Picket: "there's an args.htmlhelp.includefile +argument for the dita2htmlhelp target, which can get an extra #include +line into the [FILES] section." This refers to the [FILES] section +of the generated HHP file, before hhc.exe gets called. See
    • +
  • More info about actually doing this:
    • +
 + +args.indexshow +An optional parameter that specifies whether +the content of in-line <indexterm> elements is displayed in the +body of the text. The content of <indexterm> elements located in +the <prolog> are not displayed. + +args.input +An optional parameter that specifies the name +and path of the input file. This parameter is case sensitive. + This parameter must be +provided if dita.input and and dita.input.dirname are +not provided. + +args.javahelp.map +An optional parameter that specifies +the root name of the JavaHelp map file. The default value is the root +name of the DITA map file. + +args.javahelp.toc +An optional parameter that specifies +the root name of the JavaHelp table of contents (TOC) file. The default +value is the root name of the DITA map file. + +args.logdir +An optional parameter that specifies the directory +where the generated log files are written. The default value is the +output directory.If you run an aggregated +target, for example, the all target that is used by the DITA Open +Toolkit demos, the following behavior occurs:
    +
  • If the value of args.logdir is the same for +all transformations, the directory specified by the args.logdir parameter +is used.
    • +
  • If the value of args.logdir varies among +the transformations, but the transformations share a common output +directory, the generated log files are written to the common output +directory.
    • +
  • If the values of both args.logdir and output.dir vary +among the transformations, the generated log files are written to +the basedir directory.
    • +
 + +args.outext +An optional parameter that specifies the extension +for the XHTML files that are generated. Valid values are any text +strings, although htm or html is required by current Web browsers. +The default value is html. + +args.tablelink.style +An optional parameter that specifies how cross references to tables +are rendered. The valid values are number and title. The default value +is number. + +args.xhtml.classattr +An optional parameter that specifies +whether to include information about DITA class ancestry within the +generated XHTML elements. + +args.xsl +An optional parameter that specifies the XSL +file. The default value depends on the transformation type:
+
docbook
+
dita2docbook.xsl
+ +
eclipsehelp
+
dita2xhtml.xsl
+ +
htmlhelp
+
dita2html.xsl
+ +
javahelp
+
dita2html.xsl
+ +
pdf
+
dita2fo-shell.xsl
+ +
wordrtf
+
dita2rtf.xsl
+ +
xhtml
+
dita2xhtml.xsl
+
 + + +
    +
  • docbook
    • +
  • eclipsecontent
    • +
  • eclipsehelp
    • +
  • htmlhelp
    • +
  • javahelp
    • +
  • pdf
    • +
  • troff
    • +
  • wordrtf
    • +
  • xhtml
    • +
 + +basedir +An optional parameter that specifies the +directory where the Ant processing begins. If a relative path is used, basedir is +set relative to the current directory. If not specified, the default +value is the current directory.Is this also equivalent +to directory where the Ant script is located? + +clean.temp +An optional parameter that specifies whether +the temp directory is erased after each build. The valid values are +yes and no. The default value is yes. + +dita.dir +An optional parameter that specifies the absolute +path of directory where the DITA Open Toolkit is installed. The default +value is the current directory. + +dita.extname +An optional parameter that specifies the +file extension of the files that are written to the temp directory. +The valid values are dita, .dita, xml, and .xml. The default value +is xml. + +generate.copy.outer +An optional parameter that specifies +how the DITA Open Toolkit processes files that are neither in the +same directory as the DITA map nor in a subdirectory of the directory +that contains the DITA map. The following values are valid:
+
1
+
Only files that are in the same directory as the DITA map or in +a subdirectory of the DITA map are generated.
+ +
2
+
All files are generated, including files that are written to a +directory outside of the output directory.
+ +
3
+
The directories are adjusted so that all files are generated within +the output directory.
+
The default value is 1.Is this really +about how files are processed or is it always about the output directory? +Has the default value changed over releases?The +following messages on dita-users contain information:
    +
  • http://tech.groups.yahoo.com/group/dita-users/message/7505
    • +
  • http://tech.groups.yahoo.com/group/dita-users/message/7499
    • +
for more information + +dita.input +An optional parameter that specifies the name +of the input file. It must be used in conjunction with the dita.input.dirname parameter. This +is deprecated in favor of the args.input parameter. + +dita.input.dirname +An optional parameter that specifies +the directory that contains the input file. It must be used in conjunction +with the dita.input parameter.This is deprecated +in favor of the args.input parameter. + +dita.input.valfile +An optional parameter that specifies +name and relative path of the DITAVAL file. + +dita.temp.dir +An optional parameter that specifies the +directory where the temporary files are written. The default value +is temp. + +onlytopic.in.map +An optional parameter that specifies +whether DITA topics that are not referenced in DITA map files are +generated. Examples of files not referenced in a DITA map file are +topics that are referenced only from <xref> or <link> elements +within a DITA file. Valid values are true and false. The default value +is false.Here is information that Robert Anderson provided +on 8 October 2009: "this could be useful when your topics refer directly +to topics in other plug-ins, but you do not want to build those other +topics. By default, anything referenced by an <xref> will be built; +it is not part of the navigation, and is only findable if you go through +the topic that referenced it." + +outer.control +An optional parameter that specifies how +the DITA Open Toolkit responds if files would be generated outside +of the output directory. The following values are valid:
+
fail
+
The transformation does not run if files would be generated outside +of the output directory.
+ +
quiet
+
The transformation runs, but a warning is logged.
+
+
warn
+
The transformation runs; no warning or error is generated.
+
Described by Deborah Pickett "as designed +to work around the specific issue of allowing Eclipse infocenter plugins +to refer to each other". Circa June 2008. See for more information.Robert +Anderson commented on 8 October 2009 that we should ask Steven about +this; are the explanations for quiet and warn reversed? + +output.dir +A required parameter that specifies the directory +where the DITA Open Toolkit writes the output. + +validate +An optional parameter that specifies whether +the input files are validated. The valid values are true and false. +The default value is true. + +/xhtmltoc:args.xhtml.toc +An optional parameter that specifies the +name of the table of contents (TOC) file for the XHTML transformation. +The default value is index. + + + +args.bookmark.style +Description needed + +artworkPrefixUrl +Description needed + +customization.dir +Description needed + +disableRelatedLinks +Description needed + +document.locale +Description needed + +file.protocol.prefix +Description needed + +pdf.formatter +Description needed + +publish.required.cleanup +Description needed +
+
Parameters used for the Java command-line interface + +/artlbl:args.artlbl + + +/basedir:basedir + + +/cleantemp:clean.temp + + +/copycss:args.copycss + + +/css:args.css + + +/csspath:args.csspath + + +/cssroot:args.cssroot + + +/ditadir:dita.dir + + +/ditaext:dita.extname + + +/ditalocale:args.dita.locale + + +/draft:args.draft + + +/eclipsecontenttoc:args.eclipsecontent.toc + + +/eclipsehelptoc:args.eclipsehelp.toc + + +/filter:dita.input.valfile + + +/foimgext:args.fo.img.ext + + +/fooutputrellinks:args.fo.output.rel.links + + +/fouserconfig:args.fo.userconfig + + +/ftr:args.ftr + + +/generateouter:generate.copy.outer + + +-h or -help +An optional parameter that displays help for the Java command-line +interface. + +/hdr:args.hdr + + +/hdf:args.hdf + +This option requires an absolute path. + +/htmlhelpincludefile:args.htmlhelp.includefile + + +/i:args.input + + +/id:dita.input.dirname + + +/if:dita.input + + +/indexshow:args.indexshow + + +/javahelpmap:args.javahelp.map + + +/javahelptoc:args.javahelp.toc + + +/logdir:args.logdir + + +/onlytopicinmap:onlytopic.in.map + + +/outdir:output.dir + + +/outercontrol:outer.control + + +/outext:args.outext + + +/provider:args.eclipse.provider + + +/tempdir:dita.temp.dir + + +/transtype:transtype +A required parameter that specifies the type of transformation. +The following values are valid:
    +
  • +
 + +/validate:validate + + +-version +An optional parameter that displays the version of the DITA Open +Toolkit. + +/xhtmltoc:args.xhtml.toc + + +/xsl:args.xsl + +
+ + + +Task + + +Run either the startcmd.bat or startcmd.sh file. + + + + + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_ant_targets.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_ant_targets.dita new file mode 100644 index 00000000..a6b59096 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_ant_targets.dita @@ -0,0 +1,11 @@ + + + + + +Ant targets +You can use the Ant targets to transform DITA to several +different output formats. + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2docbook.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2docbook.dita new file mode 100644 index 00000000..32615ce3 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2docbook.dita @@ -0,0 +1,57 @@ + + + + + + +dita2docbook +Use the dita2docbook target to generate DocBook. + +
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2eclipsecontent.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2eclipsecontent.dita new file mode 100644 index 00000000..84a95ad6 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2eclipsecontent.dita @@ -0,0 +1,25 @@ + + + + + + +dita2eclipsecontent +Put your short description here; used for first paragraph +and abstract. + +
Parameters + + +
    +
  • Do the parameters that apply to the dita2eclipsehelp transformation +also apply here?
    • +
  • What does this transformation do? Original documentation stated +"Transforms a DITA topic or DITA map into Eclipse help plugin for +Eclipse dynamic content provider based on xhtml".
    • +
+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2eclipsehelp.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2eclipsehelp.dita new file mode 100644 index 00000000..68755d5b --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2eclipsehelp.dita @@ -0,0 +1,176 @@ + + + + + +dita2eclipsehelp +Use the dita2eclipsehelp target to generate Eclipse help. + +Kristen James Eberlein + + + +
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2htmlhelp.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2htmlhelp.dita new file mode 100644 index 00000000..d1a960b2 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2htmlhelp.dita @@ -0,0 +1,165 @@ + + + + + + +dita2htmlhelp +Use the dita2htmlhelp target to generate HTML help. + +
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2javahelp.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2javahelp.dita new file mode 100644 index 00000000..65208b3a --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2javahelp.dita @@ -0,0 +1,173 @@ + + + + + + +dita2javahelp +Use the dita2javahelp target to generate JavaHelp. + +Kristen James Eberlein + + + +
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2pdf.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2pdf.dita new file mode 100644 index 00000000..e3296986 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2pdf.dita @@ -0,0 +1,102 @@ + + + + + + +dita2pdf +Use the dita2pdf target to generate a Portable Document +Format (PDF) file. + +Kristen James Eberlein + + + +
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2troff.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2troff.dita new file mode 100644 index 00000000..26bdd551 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2troff.dita @@ -0,0 +1,15 @@ + + + + + + +dita2troff +Use this target to generate TROFF. + +
Parameters
+ + + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2wordrtf.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2wordrtf.dita new file mode 100644 index 00000000..87f7b754 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2wordrtf.dita @@ -0,0 +1,82 @@ + + + + + + +dita2wordrtf +Use the dita2wordrtf target to generate Rich Text Format +(RTF). + +
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2xhtml.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2xhtml.dita new file mode 100644 index 00000000..30d7d99a --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_dita2xhtml.dita @@ -0,0 +1,168 @@ + + + + + +dita2xhtml +Use the dita2xhtml target to generate XHTML. + +Kristen James Eberlein + + + +
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +args.xhtml.toc +An optional parameter that specifies the root name of the Table +of Contents (TOC) file. The default value is index. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_docbook.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_docbook.dita new file mode 100644 index 00000000..ab293191 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_docbook.dita @@ -0,0 +1,52 @@ + + + + + + +docbook +Use the /transtype:docbook parameter +to generate DocBook from the Java command-line interface + +
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_eclipsecontent.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_eclipsecontent.dita new file mode 100644 index 00000000..29d1071a --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_eclipsecontent.dita @@ -0,0 +1,10 @@ + + + + +eclipsecontent +Short description needed + + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_eclipsehelp.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_eclipsehelp.dita new file mode 100644 index 00000000..874dd4af --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_eclipsehelp.dita @@ -0,0 +1,118 @@ + + + + + +eclipsehelp +Use the /transtype:eclipsehelp parameter +to generate Eclipse Help from the Java command-line interface + +
Parameters +/artlbl:args.artlbl + + +/basedir:basedir + + +/cleantemp:clean.temp + + +/copycss:args.copycss + + +/css:args.css + + +/csspath:args.csspath + + +/cssroot:args.cssroot + + +/ditadir:dita.dir + + +/ditaext:dita.extname + + +/ditalocale:args.dita.locale + + +/draft:args.draft + + +/filter:dita.input.valfile + + +/ftr:args.ftr + + +/generateouter:generate.copy.outer + + +-h or -help +An optional parameter that displays help for the Java command-line +interface. + +/hdr:args.hdr + + +/hdf:args.hdf + +This option requires an absolute path. + +/i:args.input + + +/id:dita.input.dirname + + +/if:dita.input + + +/indexshow:args.indexshow + + +/logdir:args.logdir + + +/onlytopicinmap:onlytopic.in.map + + +/outdir:output.dir + + +/outercontrol:outer.control + + +/outext:args.outext + + +/provider:args.eclipse.provider + + +/tempdir:dita.temp.dir + + +/transtype:transtype +A required parameter that specifies the type of transformation. +The following values are valid:
    +
  • +
 + +/validate:validate + + +-version +An optional parameter that displays the version of the DITA Open +Toolkit. + +/xsl:args.xsl + +
+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_htmlhelp.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_htmlhelp.dita new file mode 100644 index 00000000..5aaff8fb --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_htmlhelp.dita @@ -0,0 +1,158 @@ + + + + + + +htmlhelp +Use the /transtype:htmlhelp parameter +to generate HTML Help from the Java command-line interface + +
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_java_command-line_parameters.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_java_command-line_parameters.dita new file mode 100644 index 00000000..d8d42f2b --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_java_command-line_parameters.dita @@ -0,0 +1,13 @@ + + + + + + +Java command-line parameters +You can use the Java command-line interface to transform +DITA to several different output formats + + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_javahelp.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_javahelp.dita new file mode 100644 index 00000000..f5531a9d --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_javahelp.dita @@ -0,0 +1,157 @@ + + + + + +javahelp +Use the /transtype:javahelp parameter +to generate JavaHelp from the Java command-line interface + +
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_pdf.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_pdf.dita new file mode 100644 index 00000000..ce3fafee --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_pdf.dita @@ -0,0 +1,158 @@ + + + + + +pdf +Use the /transtype:pdf parameter to +generate a Portable Document Formal (PDF) file from the +Java command-line interface + +
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_reference.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_reference.dita new file mode 100644 index 00000000..9f88698b --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_reference.dita @@ -0,0 +1,15 @@ + + + + + +Reference +This section contains reference information that is organized +to help you locate facts quickly. + +Kristen James Eberlein + + + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_troff.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_troff.dita new file mode 100644 index 00000000..6cbbd8be --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_troff.dita @@ -0,0 +1,157 @@ + + + + + +troff +Use the /transtype:troff parameter +to generate TROFF from the Java command-line interface + +
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_wordrtf.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_wordrtf.dita new file mode 100644 index 00000000..1a5e6594 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_wordrtf.dita @@ -0,0 +1,158 @@ + + + + + +wordrtf +Use the /transtype:wordrtf parameter +to generate Rich Text Formal (RTF) from the Java command-line +interface + +
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_xhtml.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_xhtml.dita new file mode 100644 index 00000000..0c0269fa --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_xhtml.dita @@ -0,0 +1,157 @@ + + + + + +xhtml +Use the /transtype:xhtml parameter to +generate XHTML from the Java command-line interface + +
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_xslt_parameters.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_xslt_parameters.dita new file mode 100644 index 00000000..2ec34724 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_r_xslt_parameters.dita @@ -0,0 +1,107 @@ + + + + + + +XSLT parameters +If you are writing XSLT overrides or creating plug-ins +that modify the default values for the Ant parameters, you need to +know the XSLT parameters that correspond to the Ant parameters + +
+ + + +Ant parameters +XSLT parameters + + + + + +ARTLBL + + + +BREADCRUMBS + + + +CSSPATH + + + +DBG + + + +DRAFT + + + +FIGURELINK + + + +FTR + + + +genDefMeta + + + +GENERATE-TASK-LABELS + + + +HDF + + + +HDR + + + +NOPARENTLINK + + + +INDEXSHOW + + + +OUTEXT + + + +TABLELINK + + + +PRESERVE-DITA-CLASS + + + +
+ + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_downloading_and_installing_the_dita_open_toolkit_on_linux.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_downloading_and_installing_the_dita_open_toolkit_on_linux.dita new file mode 100644 index 00000000..58118979 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_downloading_and_installing_the_dita_open_toolkit_on_linux.dita @@ -0,0 +1,10 @@ + + + + +Downloading and installing the DITA Open Toolkit +Put your short description here; used for first paragraph +and abstract. + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_downloading_and_installing_the_dita_open_toolkit_on_mac_os.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_downloading_and_installing_the_dita_open_toolkit_on_mac_os.dita new file mode 100644 index 00000000..9d0ec728 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_downloading_and_installing_the_dita_open_toolkit_on_mac_os.dita @@ -0,0 +1,11 @@ + + + + + +Downloading and installing the DITA Open Toolkit on Mac OS + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_downloading_and_installing_the_dita_open_toolkit_on_windows.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_downloading_and_installing_the_dita_open_toolkit_on_windows.dita new file mode 100644 index 00000000..e5e5ad3e --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_downloading_and_installing_the_dita_open_toolkit_on_windows.dita @@ -0,0 +1,11 @@ + + + + + +Downloading and installing the DITA Open Toolkit on Windows + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_generating_output.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_generating_output.dita new file mode 100644 index 00000000..d2f6a15a --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_generating_output.dita @@ -0,0 +1,18 @@ + + + + + +Generating output with your DITA files<?Pub Caret?> +After you have installed the DITA Open Toolkit and run +the samples, you might want to use the Toolkit with your own DITA +files. You either can use an Ant file or the Java command-line interface +to run the transformations. + +Kristen James Eberlein + + + + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_generating_output_using_ant.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_generating_output_using_ant.dita new file mode 100644 index 00000000..cbd5eea6 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_generating_output_using_ant.dita @@ -0,0 +1,29 @@ + + + + + +Generating output using Ant +You can use Ant scripts to call the XSLT scripts and provide parameters for the transformations. + +Kristen James Eberlein + + + + +Create a Ant script that contains targets for the output that you want to build. + +From the command prompt, type the following string and press Enter:ant -f build_file targetwhere
    +
  • -l log_file is a optional parameter that will log the X to log_file. By default, the X is displayed in the command-prompt window.
    • +
  • -f build_file is an optional parameter that specifies the Ant script. If you do not issue this parameter, Ant looks for a build.xml file in the current directory.
    • +
  • target is the name of the Ant target that you want to run.
    • +
 + + + +Apache Ant 1.7.1 manual +This is the documentation for Ant 1.7.1. In the navigation pane, click Ant TasksCore Tasks to view information about Ant tasks and their parameters. + + + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_generating_output_using_the_java_command-line_interface.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_generating_output_using_the_java_command-line_interface.dita new file mode 100644 index 00000000..7d1b7357 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_generating_output_using_the_java_command-line_interface.dita @@ -0,0 +1,36 @@ + + + + + +Generating output using the Java command-line interface +If you are not familiar with Ant, you can use the command +line to perform the transformations. The DITA Open Toolkit creates +a properties file (property.temp) that contains +the information that you provided at the command line and then passes +the property file to Ant. The properties file is saved in the args.logdir directory. + +Kristen James Eberlein + + + + + + +From the command prompt, type the following string and +press Enter:java -jar lib/dost.jar /i:input_file /outdir:output_directory /transtype:transformation [options]where
    +
  • input_file is the name of the DITA file or +DITA map that is the input for the transformation.
    • +
  • output_directory is the directory where the +DITA Open Toolkit writes the output of the transformation.
    • +
  • transformation is one of the following options:
      +
    • +
    • +
  • [options] are optional parameters.
    • +
 + + + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing.dita new file mode 100644 index 00000000..42619840 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing.dita @@ -0,0 +1,10 @@ + + + + + +Installing +Short description needed + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_a_jdk_on_linux.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_a_jdk_on_linux.dita new file mode 100644 index 00000000..e9c35e56 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_a_jdk_on_linux.dita @@ -0,0 +1,10 @@ + + + + +Installing a JDK +Put your short description here; used for first paragraph +and abstract. + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_a_jdk_on_mac_os.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_a_jdk_on_mac_os.dita new file mode 100644 index 00000000..92a64f90 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_a_jdk_on_mac_os.dita @@ -0,0 +1,10 @@ + + + + + +Installing a JDK on Mac OS +Short description needed + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_a_jdk_on_windows.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_a_jdk_on_windows.dita new file mode 100644 index 00000000..99085ac2 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_a_jdk_on_windows.dita @@ -0,0 +1,9 @@ + + + + + +Installing a JDK on Windows + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_html_help_workshop.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_html_help_workshop.dita new file mode 100644 index 00000000..b9a69bd3 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_html_help_workshop.dita @@ -0,0 +1,9 @@ + + + + + +Installing HTML Help Workshop + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_javahelp.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_javahelp.dita new file mode 100644 index 00000000..99dcb526 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_javahelp.dita @@ -0,0 +1,9 @@ + + + + + +Installing JavaHelp + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_optional_applications.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_optional_applications.dita new file mode 100644 index 00000000..92158e6d --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_optional_applications.dita @@ -0,0 +1,9 @@ + + + + + +Installing optional applications + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_the_dita_open_toolkit_on_linux.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_the_dita_open_toolkit_on_linux.dita new file mode 100644 index 00000000..5f872a02 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_the_dita_open_toolkit_on_linux.dita @@ -0,0 +1,10 @@ + + + + +Installing the DITA Open Toolkit on Linux +Put your short description here; used for first paragraph +and abstract. + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_the_dita_open_toolkit_on_mac_os.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_the_dita_open_toolkit_on_mac_os.dita new file mode 100644 index 00000000..0600588b --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_the_dita_open_toolkit_on_mac_os.dita @@ -0,0 +1,10 @@ + + + + + +Installing the DITA Open Toolkit on Mac OS + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_the_dita_open_toolkit_on_windows.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_the_dita_open_toolkit_on_windows.dita new file mode 100644 index 00000000..7b55c082 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_installing_the_dita_open_toolkit_on_windows.dita @@ -0,0 +1,10 @@ + + + + + +Installing the DITA Open Toolkit on Windows + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_migrating_html_to_dita.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_migrating_html_to_dita.dita new file mode 100644 index 00000000..4b49d40f --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_migrating_html_to_dita.dita @@ -0,0 +1,40 @@ + + + + + + +Migrating HTML to DITA +You can use the DITA Open Toolkit to migrate +HTML to DITA. The migration tools are located in the demo\h2d directory. +The tools are updated version of the tools created by Robert D. Anderson +and published on developerWorks in 2005.The "Related information" +section contains links to the original developerWorks articles, which +contain detailed information about these tools and how +to extend them. + +Kristen James Eberlein + + + +Migrating HTML to DITA, Part 1: Simple +steps to move from HTML to DITA +This is the first developerWorks article. The first of two parts, +this article explains how to get a quick start with DITA using HTML +topics that are already available. It shows you how to use the provided +XSLT transform to do the migration and examines what is needed to +ensure quality results. + +Migrating HTML to DITA, Part 2: Extend +the migration for more robust results +This is the second developerWorks article. In Part 2 of this +two-part series on how to quickly migrate HTML topics to DITA, the +author explains the details of migration and shows you how to override +parts of this process for ideal results. + + + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_migrating_html_to_dita_using_ant.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_migrating_html_to_dita_using_ant.dita new file mode 100644 index 00000000..096dab0d --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_migrating_html_to_dita_using_ant.dita @@ -0,0 +1,54 @@ + + + + + + +Migrating HTML to DITA using Ant +You can use ANT to migrate HTML files to DITA. + +Kristen James Eberlein + + + + + +Change to the DITAOT\demo\h2d directory, +where DITAOT is the root directory of the DITA +Open Toolkit installation. +Run the following command:ant -f build.xml [options]where +options are the following parameters: +-Dargs.input=input +Specifies the location of the HTMl files to be transformed. The input variable +can be either a file name or directory. The default value is the current +directory. + +-Dargs.output=output +Specifies the directory where the DITA files are written. The +default value is the current directory. + +-Dargs.infotype=type +Specifies the type of DITA file. The type variable +takes the following values: concept, reference, task, or topic. The +default value is topic. + +-Dargs.dita.ext=file_extension +Specifies the extension for the generated files. The file_extension variable +takes the following values: dita or xml. The default value is dita. + +-Dargs.lang=language +Specifies the language attribute for the generated files. The language variable +takes the values specified in the string.xml file +located in the DITAOT\xsl\common directory, +where DITAOT is the root directory of the DITA +Open Toolkit installation. The default value is en-us. + +-Dargs.xsl=XSL_file +Specifies the XSL file used by the transformation. + + + + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_preparing_html_files_for_migration_to_dita.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_preparing_html_files_for_migration_to_dita.dita new file mode 100644 index 00000000..ef6b02f1 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_preparing_html_files_for_migration_to_dita.dita @@ -0,0 +1,34 @@ + + + + + + +Preparing HTML files for migration to DITA +Before you can use the migration tool to transform HTML +files to DITA, you might need to prepare the HTML files. The migration +tool works only with valid XHTML files. + +Kristen James Eberlein + + + + +Rework the HTML files to separate concept, task, and reference +material into separate files. +Run a utility such as HTML Tidy to ensure that the files +are valid XHTML files. +Remove any nested sections from the XHMTL files. Each XHMTL +file must contain only a single section. + + + +HTML Tidy +HTML Tidy is an open source application that you can use to +check HTML files for tagging errors. + + + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_running_the_dita_open_toolkit_samples.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_running_the_dita_open_toolkit_samples.dita new file mode 100644 index 00000000..860e10ca --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_running_the_dita_open_toolkit_samples.dita @@ -0,0 +1,10 @@ + + + + + +Running the DITA Open Toolkit samples + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_verifying_the_installation_on_linux.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_verifying_the_installation_on_linux.dita new file mode 100644 index 00000000..a15294b9 --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_verifying_the_installation_on_linux.dita @@ -0,0 +1,10 @@ + + + + +Verifying the installation +Put your short description here; used for first paragraph +and abstract. + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_verifying_the_installation_on_mac_os.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_verifying_the_installation_on_mac_os.dita new file mode 100644 index 00000000..79994e6c --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_verifying_the_installation_on_mac_os.dita @@ -0,0 +1,9 @@ + + + + + +Verifying the installation on Mac OS + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_verifying_the_installation_on_windows.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_verifying_the_installation_on_windows.dita new file mode 100644 index 00000000..42b9453e --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/ditaot_t_verifying_the_installation_on_windows.dita @@ -0,0 +1,10 @@ + + + + + +Verifying the installation on Windows + + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/info/apachelicense.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/info/apachelicense.dita new file mode 100644 index 00000000..0b61360c --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/info/apachelicense.dita @@ -0,0 +1,266 @@ + + + + + + Apache 许可证 + + + + + Apachelicense + + + + +
+ Apache许可证，版本2.0 + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, + reproduction, and distribution as defined by Sections 1 through + 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized + by the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under + common control with that entity. For the purposes of this + definition, "control" means (i) the power, direct or indirect, + to cause the direction or management of such entity, whether by + contract or otherwise, or (ii) ownership of fifty percent (50%) + or more of the outstanding shares, or (iii) beneficial ownership + of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making + modifications, including but not limited to software source code, + documentation source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or + Object form, that is based on (or derived from) the Work and + for which the editorial revisions, annotations, elaborations, + or other modifications represent, as a whole, an original work + of authorship. For the purposes of this License, Derivative + Works shall not include works that remain separable from, or + merely link (or bind by name) to the interfaces of, the Work + and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or + additions to that Work or Derivative Works thereof, that is + intentionally submitted to Licensor for inclusion in the Work + by the copyright owner or by an individual or Legal Entity + authorized to submit on behalf of the copyright owner. For the + purposes of this definition, + "submitted" means any form of electronic, verbal, or written + communication sent to the Licensor or its representatives, + including but not limited to communication on electronic mailing + lists, source code control systems, and issue tracking systems + that are managed by, or on behalf of, the Licensor for the + purpose of discussing and improving the Work, but excluding + communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a + Contribution." + + "Contributor" shall mean Licensor and any individual or Legal + Entity on behalf of whom a Contribution has been received by + Licensor and subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions + of this License, each Contributor hereby grants to You a + perpetual, worldwide, non-exclusive, no-charge, royalty-free, + irrevocable copyright license to reproduce, prepare Derivative + Works of, publicly display, publicly perform, sublicense, and + distribute the Work and such Derivative Works in Source or + Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have + made, use, offer to sell, sell, import, and otherwise transfer + the Work, where such license applies only to those patent claims + licensable by such Contributor that are necessarily infringed by + their Contribution(s) alone or by combination of their + Contribution(s) with the Work to which such Contribution(s) was + submitted. If You institute patent litigation against any entity + (including a cross-claim or counterclaim in a lawsuit) alleging + that the Work or a Contribution incorporated within the Work + constitutes direct or contributory patent infringement, then any + patent licenses granted to You under this License for that Work + shall terminate as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute + must include a readable copy of the attribution notices + contained within such NOTICE file, excluding those notices + that do not pertain to any part of the Derivative Works, in + at least one of the following places: within a NOTICE text + file distributed as part of the Derivative Works; within the + Source form or documentation, if provided along with the + Derivative Works; or, within a display generated by the + Derivative Works, if and wherever such third-party notices + normally appear. The contents of the NOTICE file are for + informational purposes only and do not modify the License. + You may add Your own attribution notices within Derivative + Works that You distribute, alongside or as an addendum to + the NOTICE text from the Work, provided that such additional + attribution notices cannot be construed as modifying the + License. + + You may add Your own copyright statement to Your modifications + and may provide additional or different license terms and + conditions for use, reproduction, or distribution of Your + modifications, or for any such Derivative Works as a whole, + provided Your use, reproduction, and distribution of the Work + otherwise complies with the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state + otherwise, any Contribution intentionally submitted for + inclusion in the Work by You to the Licensor shall be under the + terms and conditions of this License, without any additional + terms or conditions. Notwithstanding the above, nothing herein + shall supersede or modify the terms of any separate license + agreement you may have executed with Licensor regarding such + Contributions. + + 6. Trademarks. This License does not grant permission to use the + trade names, trademarks, service marks, or product names of the + Licensor, except as required for reasonable and customary use + in describing the origin of the Work and reproducing the content + of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or + conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or + FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for + determining the appropriateness of using or redistributing the + Work and assume any risks associated with Your exercise of + permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and + grossly negligent acts) or agreed to in writing, shall any + Contributor be liable to You for damages, including any direct, + indirect, special, incidental, or consequential damages of any + character arising as a result of this License or out of the use + or inability to use the Work (including but not limited to + damages for loss of goodwill, work stoppage, computer failure or + malfunction, or any and all other commercial damages or losses), + even if such Contributor has been advised of the possibility of + such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by + reason of your accepting any such warranty or additional + liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied. See the License for the specific language governing + permissions and limitations under the License. + +
+ + diff --git a/hadocs/dita-ot/trunk/src/gettingstarted/tasks/info/hacopyright.dita b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/info/hacopyright.dita new file mode 100644 index 00000000..65e6bbdd --- /dev/null +++ b/hadocs/dita-ot/trunk/src/gettingstarted/tasks/info/hacopyright.dita @@ -0,0 +1,51 @@ + + + + + + 版权信息 + +
+

+ HAWEBS信息技术股份有限公司(LOGO) +

+

版权所有 2004-2010 DITA OT 软件开发小组

+

中文参考手册版权所有 2006 - 2010 HAWEBS信息技术股份有限公司

+

基于Apache许可证， 版本2.0。你必须在基于许可证的要求下使用本软件，你可以通过下面的链接来获得相关的具体内容 http://www.apache.org/licenses/LICENSE-2.0。

+
+
+ 相关信息 +

+
+ +