source: vbox/trunk/src/libs/dita-ot-1.8.5/docsrc/readme/DITA-h2d-ant.xml@ 99507

<?xml version="1.0" encoding="utf-8"?>
<!-- This file is part of the DITA Open Toolkit project hosted on 
     Sourceforge.net. See the accompanying license.txt file for 
     applicable licenses.-->
<!-- (c) Copyright IBM Corp. 2005, 2006 All Rights Reserved. -->

<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="h2d-ant" xml:lang="en-us">
    <title>Migrating HTML to DITA with Ant script</title>
    <refbody>
        <section>
            <title>Running example</title>
        <ol>
            <li>Start the command window.</li>
            <li>Navigate to the directory of the migration tool.</li>
            <li>Use ant script to run the migration, on the command line, enter the following command:
                <codeblock>ant -Dargs.input={file|direcotry} -Dargs.output={direcotry} -Dargs.infotype={topic|concept|task|reference}</codeblock>
            </li>
        </ol>
        <note>The namespace problem listed in <xref href="DITA-limitations.xml"/> 
          has been fixed by adding a new preprocess step in the script in 
          release 1.2.1.</note>
        <p>You can also add other parameters to the command. See the following table for details.</p>
        </section>
        <section>
            <title>Supported Parameters</title>
            <p>The following table lists the supported parameters that you can set with the ant script.</p>
            <table>
                <title>Table of supported parameters</title>
                <tgroup cols="3">
                    <colspec colname="col1"/>
                    <colspec colname="col2"/>
                    <colspec colname="col3"/>
                    <thead>
                        <row valign="bottom">
                            <entry colname="col1">Parameter</entry>
                            <entry colname="col2">Descriptoin</entry>
                            <entry colname="col3">Required</entry>
                        </row>
                    </thead>
                    <tbody>
                        <row>
                            <entry colname="col1">args.input</entry>
                            <entry colname="col2">The input of the migration. 
                                It can be a file or directory. Default is 
                                current directory.</entry>
                            <entry colname="col3">No.</entry>
                        </row>
                        <row>
                            <entry colname="col1"> args.include.subdirs</entry>
                            <entry colname="col2">The parameter to specify if 
                                sub directories under the input directory is 
                                included. "yes" and "no" are valid 
                                values. Default is "no".<note>Any value that is 
                                not "yes" is regarded as "no".</note></entry>
                            <entry colname="col3">No.</entry>
                        </row>
                        <row>
                            <entry colname="col1">args.output</entry>
                            <entry colname="col2">The output directory of 
                                genrated DITA files. Default is the current 
                                directory.</entry>
                            <entry colname="col3">No.</entry>
                        </row>
                        <row>
                            <entry colname="col1">args.infotype</entry>
                            <entry colname="col2">The infotype of generated 
                                DITA files, topics, concept, task, and 
                                reference are valid values. Default is 
                                topic.</entry>
                            <entry colname="col3">No.</entry>
                        </row>
                        <row>
                            <entry colname="col1">args.dita.ext</entry>
                            <entry colname="col2">The extension of generated 
                                DITA files. This extension also used to convert 
                                links that go to other DITA topic. ".dita" and 
                                ".xml" are valid values. Default is ".dita".</entry>
                            <entry colname="col3">No.</entry>
                        </row>
                        <row>
                            <entry colname="col1">args.xsl</entry>
                            <entry colname="col2">The xsl file to replace the 
                                default xsl file.</entry>
                            <entry colname="col3">No.</entry>
                        </row>
                        <row>
                            <entry colname="col1">args.lang</entry>
                            <entry colname="col2">The default language of 
                                output DITA files. Default is "en-us".
                                <note>For supported language, please refer to 
                                    <codeph>strings.xml</codeph> under the 
                                    directory 
                                    <codeph>${ditaot_dir}/xsl/common</codeph>.
                                </note>
                            </entry>
                            <entry colname="col3">No.</entry>
                        </row>
                    </tbody>
                </tgroup>
            </table>
        </section>
    </refbody>
</reference>