diff --git a/dev_ref/DITA-OTArchitecture.dita b/dev_ref/DITA-OTArchitecture.dita index afa77d79c..20463ea59 100644 --- a/dev_ref/DITA-OTArchitecture.dita +++ b/dev_ref/DITA-OTArchitecture.dita @@ -5,7 +5,7 @@ Architecture of the DITA Open Toolkit - DITA-OT Architecture + DITA-OT architecture The DITA Open Toolkit is an open-source implementation of the OASIS specification for the Darwin Information Typing Architecture. The toolkit uses Ant, XSLT, and Java to transform DITA content (maps and diff --git a/dev_ref/custom-plugins.dita b/dev_ref/custom-plugins.dita new file mode 100644 index 000000000..0a373b04f --- /dev/null +++ b/dev_ref/custom-plugins.dita @@ -0,0 +1,42 @@ + + + + + + Customizing DITA-OT with plug-ins + + Custom plug-ins + + You can install or create DITA-OT plug-ins to change the default output types in + various ways, to add entirely new kinds of output formats, or to implement support for your DITA topic + specializations. + + + +
+ Plug-in benefits +

Plug-ins allow you to extend the toolkit in a way that is consistent, easy-to-share, and possible to preserve + through toolkit upgrades.

+

The DITA-OT plug-in mechanism provides the following benefits:

+
    +
  • Plug-ins can easily be shared with other users, teams, or companies. Typically, all users need to do is to + unzip and run a single installation command. With many builds, even that installation step is automatic.
    • +
  • Plug-ins permit overrides or customizations to grow from simple to complex over time, with no increased + complexity to the extension mechanism.
    • +
  • Plug-ins can be moved from version to version of the DITA-OT simply by reinstalling or copying the directory + from one installation to another. There is no need to re-integrate code based on updates to the core + processing of the DITA-OT.
    • +
  • Plug-ins can build upon each other. If you like a plug-in, simply install that plug-in, and then create your + own plug-in that builds on top of it. The two plug-ins can then be distributed to your team as a unit, or you + can share your own extensions with the original provider.
    • +
+
+ +
+ Plug-in structure +

A plug-in consists of a directory, typically stored within the plugins/ directory inside + of the DITA-OT. Every plug-in is controlled by a file named plugin.xml, which is located in + the root directory of the plug-in.

+
+ + diff --git a/dev_ref/customization.ditamap b/dev_ref/customization.ditamap new file mode 100644 index 000000000..83fd33428 --- /dev/null +++ b/dev_ref/customization.ditamap @@ -0,0 +1,15 @@ + + + + + + Customizing/Extending DITA-OT + + + + + + + + + diff --git a/dev_ref/dev_ref.ditamap b/dev_ref/dev_ref.ditamap index f21c8ef15..3e7e77ae8 100644 --- a/dev_ref/dev_ref.ditamap +++ b/dev_ref/dev_ref.ditamap @@ -38,16 +38,7 @@ - - - - - - - - - - + diff --git a/dev_ref/extending-the-ot.dita b/dev_ref/extending-the-ot.dita index 047b16ce2..323a442b5 100644 --- a/dev_ref/extending-the-ot.dita +++ b/dev_ref/extending-the-ot.dita @@ -3,33 +3,30 @@ - Extending the DITA Open Toolkit + Customizing the DITA Open Toolkit - Extending the DITA-OT + Customizing DITA-OT - There are several methods that can be used to extend the toolkit; not all of them are recommended or - supported. The best way to create most extensions is with a plug-in; extended documentation for creating plug-ins is - provided in the next section. + There are several methods that can be used to customize and extend the toolkit. The best way to create most + extensions is with a plug-in; extended documentation for creating plug-ins is provided in the following + topics.
-
    -
  • Creating a plug-in can be very simple to very complex, and is generally the best method for changing or - extending the toolkit. Plug-ins can be used to accomplish almost any modification that is needed for toolkit - processing, from minor style tweaks to extensive, complicated new output formats.
    • -
  • The PDF process was initially developed independently of the toolkit, and created its own extension - mechanism using customization directories. Many (but not quite all) of the capabilities available through PDF - customization directories are now available through plug-ins.
    • -
  • Using a single XSL file as an override by passing it in as a parameter. For example, when building XHTML - content, the XSL parameter allows users to specify a single local XSL file (inside or outside of the toolkit) - that is called in place of the default XHTML code. Typically, this code imports the default processing code, - and overrides a couple of processing routines. This approach is best when the override is very minimal, or - when the style varies from build to build. However, any extension made with this sort of override is also - possible with a plug-in.
    • -
  • Editing DITA-OT code directly may work in some cases, but is not advised. Modifying the code directly - significantly increases the work and risk involved with future upgrades. It is also likely that such - modifications will break plug-ins provided by others, limiting the function available to the toolkit.
    • -
+

Creating a plug-in can be very simple to very complex, and is generally the best method for changing or + extending the toolkit. Plug-ins can be used to accomplish almost any modification that is needed for toolkit + processing, from minor style tweaks to extensive, complicated new output formats.

+

A single XSL file can be used as an override by passing it in as a parameter. For example, when building XHTML + content, the XSL parameter allows users to specify a single local XSL file (inside or outside of the toolkit) + that is called in place of the default XHTML code. Typically, this code imports the default processing code, and + overrides a couple of processing routines. This approach is best when the override is very minimal, or when the + style varies from build to build. However, any extension made with this sort of override is also possible with a + plug-in.

+

Editing DITA-OT code directly is strongly discouraged. Modifying the code directly significantly increases the + work and risk involved with future upgrades. It is also likely that such modifications will break plug-ins + provided by others, limiting the functions available to the toolkit.

+ Any changes made directly in the code would be overwritten when upgrading to newer versions + of DITA-OT, so users that have customized their toolkit installation in this way are often “stuck” on older + versions of the toolkit and unable to take advantage of improvements in recent versions of DITA-OT.
- diff --git a/dev_ref/html-customization.dita b/dev_ref/html-customization.dita index c3105173b..5f94d2f08 100644 --- a/dev_ref/html-customization.dita +++ b/dev_ref/html-customization.dita @@ -4,6 +4,7 @@ Customizing HTML output - There are several ways to customize the default HTML output. You can easily adjust the look and feel just - by setting parameters and adding custom CSS, or create plug-ins for more complex customizations. + You can adjust the look and feel of your HTML output without + creating a DITA-OT plugin by including custom CSS, headers and footers, or + table-of-contents navigation in topics. diff --git a/dev_ref/html-customization.ditamap b/dev_ref/html-customization.ditamap index 007efe720..9054252cb 100644 --- a/dev_ref/html-customization.ditamap +++ b/dev_ref/html-customization.ditamap @@ -4,15 +4,19 @@ Customizing HTML output - - - - - + + + Customizing HTML + + + + + + - - - + + + diff --git a/dev_ref/java-api.dita b/dev_ref/java-api.dita index 99a93f632..83b78df3d 100644 --- a/dev_ref/java-api.dita +++ b/dev_ref/java-api.dita @@ -4,8 +4,8 @@ Java API - DITA-OT 2.5 includes a new Java Application Programming Interface to allow developers to embed DITA-OT more - easily into other Java programs. + DITA-OT includes a Java Application Programming Interface to allow developers to embed DITA-OT more easily + into other Java programs. diff --git a/dev_ref/migration.ditamap b/dev_ref/migration.ditamap index 14085a72b..3bb702eb4 100644 --- a/dev_ref/migration.ditamap +++ b/dev_ref/migration.ditamap @@ -4,19 +4,66 @@ Migrating customizations - - - - - - - - - - - - - - + + + + To 3.0 + + + + + To 2.5 + + + + + To 2.4 + + + + + To 2.3 + + + + + To 2.2 + + + + + To 2.1 + + + + + To 2.0 + + + + + To 1.8 + + + + + To 1.7 + + + + Flagging updates + + + + + + To 1.6 + + + + + To 1.5.4 + + diff --git a/dev_ref/pdf-customization.ditamap b/dev_ref/pdf-customization.ditamap index 11532168f..7d748ba3b 100644 --- a/dev_ref/pdf-customization.ditamap +++ b/dev_ref/pdf-customization.ditamap @@ -4,13 +4,28 @@ Customizing PDF output - - - - - - - - + + + Customizing PDF + + + + + + + Customization best practices + + + + + Simple PDF plug-in example + + + + + Custom PDF plug-in resources + + + diff --git a/dev_ref/plug-ins.ditamap b/dev_ref/plug-ins.ditamap index c1afa74e7..e90fe4865 100644 --- a/dev_ref/plug-ins.ditamap +++ b/dev_ref/plug-ins.ditamap @@ -4,24 +4,25 @@ Creating DITA-OT plug-ins - - - - - + + + + + + + + + + + + + + + + + - - - - - - - - - - - - + @@ -31,74 +32,74 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/dev_ref/plugin-addgeneratedtext.dita b/dev_ref/plugin-addgeneratedtext.dita index 39ba7c94f..af4e4cbaf 100644 --- a/dev_ref/plugin-addgeneratedtext.dita +++ b/dev_ref/plugin-addgeneratedtext.dita @@ -3,7 +3,7 @@ - Modifying or adding generated text + Customizing generated text Generated text is the term for strings that are automatically added by the build, such as "Note" before the contents of a note element. diff --git a/dev_ref/plugin-applications.dita b/dev_ref/plugin-applications.dita new file mode 100644 index 000000000..d4eed18c8 --- /dev/null +++ b/dev_ref/plugin-applications.dita @@ -0,0 +1,9 @@ + + + + + + Plug-in applications + Plug-ins allow you to extend the functionality of the DITA-OT. This might entail adding support for + specialized document types, integrating processing overrides, or defining new output transformations. + diff --git a/dev_ref/plugin-benefits.dita b/dev_ref/plugin-benefits.dita deleted file mode 100644 index 87e010b83..000000000 --- a/dev_ref/plugin-benefits.dita +++ /dev/null @@ -1,22 +0,0 @@ - - - - Benefits of plug-ins - Plug-ins permit users to extend the toolkit in a way that is consistent, easy-to-share, and possible to - preserve through toolkit upgrades. - -

The DITA-OT plug-in mechanism provides the following benefits:

-
    -
  • Plug-ins can easily be shared with other users, teams, or companies. Typically, all users need to do is to - unzip and run a single installation command. With many builds, even that installation step is automatic.
    • -
  • Plug-ins permit overrides or customizations to grow from simple to complex over time, with no increased - complexity to the extension mechanism.
    • -
  • Plug-ins can be moved from version to version of the DITA-OT simply by reinstalling or copying the directory - from one installation to another. There is no need to re-integrate code based on updates to the core processing - of the DITA-OT.
    • -
  • Plug-ins can build upon each other. If you like a plug-in, simply install that plug-in, and then create your - own plug-in that builds on top of it. The two plug-ins can then be distributed to your team as a unit, or you - can share your own extensions with the original provider.
    • -
- - diff --git a/dev_ref/plugin-creating.dita b/dev_ref/plugin-creating.dita deleted file mode 100644 index 27a71af54..000000000 --- a/dev_ref/plugin-creating.dita +++ /dev/null @@ -1,6 +0,0 @@ - - - - Creating plug-ins - You can use DITA-OT plug-ins to extend the DITA Open Toolkit. - diff --git a/dev_ref/plugins-overview.dita b/dev_ref/plugins-overview.dita deleted file mode 100644 index 17a042105..000000000 --- a/dev_ref/plugins-overview.dita +++ /dev/null @@ -1,17 +0,0 @@ - - - - - Overview of plug-ins - Plug-ins enable users to extend the functionality of the DITA-OT. This might entail adding support for - specialized document types, integrating processing overrides, or defining new output - transformations. - -
-

A plug-in consists of a directory, typically stored within the - plugins/ directory inside of the DITA-OT. Every plug-in is controlled - by a file named plugin.xml, which is located in the root directory of - the plug-in.

-
- - diff --git a/dev_ref/reference.dita b/dev_ref/reference.dita new file mode 100644 index 000000000..5e13d1aa0 --- /dev/null +++ b/dev_ref/reference.dita @@ -0,0 +1,8 @@ + + + + + + Reference + Additional DITA-OT reference information. + diff --git a/dev_ref/reference.ditamap b/dev_ref/reference.ditamap new file mode 100644 index 000000000..3ce1e4309 --- /dev/null +++ b/dev_ref/reference.ditamap @@ -0,0 +1,98 @@ + + + + + + Reference + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Chunking definition in the DITA 1.2 specification + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/extension-points/extension-points.ditamap b/extension-points/extension-points.ditamap index 7c9427e1e..ed3f6ad2a 100644 --- a/extension-points/extension-points.ditamap +++ b/extension-points/extension-points.ditamap @@ -4,22 +4,23 @@ DITA-OT extension points - - - - - - - + + + + + + + + - - - - - - - + + + + + + + - + diff --git a/getting-started/installing-client.dita b/getting-started/installing-client.dita index b3c75aaa4..a1a8ae89e 100644 --- a/getting-started/installing-client.dita +++ b/getting-started/installing-client.dita @@ -3,9 +3,9 @@ - Installing the distribution package + Installing the DITA Open Toolkit - Installing the toolkit + Installing DITA-OT The DITA-OT distribution package can be installed on Linux, macOS, and Windows. It contains everything that you need to run the toolkit except for Java. diff --git a/getting-started/installing.ditamap b/getting-started/installing.ditamap new file mode 100644 index 000000000..87316377a --- /dev/null +++ b/getting-started/installing.ditamap @@ -0,0 +1,22 @@ + + + + + + Installing + + + + + + Building output + + + + first-build- + + + + + diff --git a/index.dita b/index.dita index 25a18652e..9b9d407de 100644 --- a/index.dita +++ b/index.dita @@ -5,7 +5,7 @@ DITA Open Toolkit <keyword keyref="release"/> The DITA Open Toolkit, or DITA-OT for short, is a set of Java-based, open-source - tools that provide processing for XML content authored in the Darwin Information Typing + tools that provide processing for content authored in the Darwin Information Typing Architecture. @@ -14,14 +14,26 @@
DITA-OT documentation -

The DITA Open Toolkit documentation provides information about installing, running, - configuring and extending the toolkit. Each part is available in the navigation panel.

+

The DITA Open Toolkit documentation provides information about installing, running, configuring and extending + the toolkit.

  • See the for information on the changes in the current release.
    • -
    • -
    • -
    • -
    • +
  • + shows how to install the toolkit and run a build to verify the + installation.
    • +
  • introduces the new input formats supported in DITA-OT 3.0.
    • +
  • provides information about transforming content, and the + available output formats.
    • +
  • explains how to adjust the behavior of the DITA Open Toolkit via + dita command arguments and options, DITA-OT parameter settings, and configuration + properties.
    • +
  • provides more advanced information on extending the DITA-OT. and describe some of the most common + customization scenarios. More advanced solutions are described in .
    • +
  • The section contains information about resolving problems that you + might encounter.
    • +
  • topics provide additional information about the DITA-OT architecture, API and + specification support, and other .
diff --git a/license/license.ditamap b/license/license.ditamap index eaa55235f..dd206158f 100644 --- a/license/license.ditamap +++ b/license/license.ditamap @@ -4,7 +4,7 @@ License Information - - + + diff --git a/parameters/index.dita b/parameters/index.dita index d59096006..6d9f06a4e 100644 --- a/parameters/index.dita +++ b/parameters/index.dita @@ -3,13 +3,12 @@ - DITA Open Toolkit Parameter Reference + Setting DITA Open Toolkit parameters - Parameter Reference + Setting parameters - The Parameter Reference is designed to help users to locate information easily - and quickly. It includes documentation for dita command arguments and options, DITA-OT - parameters, and configuration properties. + You can adjust the behavior of the DITA Open Toolkit via dita command + arguments and options, DITA-OT parameters settings, and configuration properties. diff --git a/parameters/parameters.ditamap b/parameters/parameters.ditamap index f4341b414..5cdd1d630 100644 --- a/parameters/parameters.ditamap +++ b/parameters/parameters.ditamap @@ -4,24 +4,22 @@ Parameter Reference - - - - - - - - - - - - - + + + + + + + + + + + - - - - - + + + + + diff --git a/release-notes/index.dita b/release-notes/index.dita index 6cd69da73..149d26cee 100644 --- a/release-notes/index.dita +++ b/release-notes/index.dita @@ -4,6 +4,9 @@ DITA Open Toolkit <keyword keyref="maintenance-version"/> Release Notes + + Release Notes + DITA Open Toolkit is a feature release that provides new features and diff --git a/resources/common-resources.ditamap b/resources/common-resources.ditamap index 382eb29e0..59081261d 100644 --- a/resources/common-resources.ditamap +++ b/resources/common-resources.ditamap @@ -4,8 +4,9 @@ Common Resources - - - - + + + + + diff --git a/resources/common-toc.ditamap b/resources/common-toc.ditamap new file mode 100644 index 000000000..2e7eb2c18 --- /dev/null +++ b/resources/common-toc.ditamap @@ -0,0 +1,41 @@ + + + + + + DITA Open Toolkit <keyword keyref="release"/> + + + + + + + + + + + + + + + + + + + + + + + + + + + + Resources + + + + + + + diff --git a/resources/key-definitions.ditamap b/resources/key-definitions.ditamap index 5545a636b..db630b7c0 100644 --- a/resources/key-definitions.ditamap +++ b/resources/key-definitions.ditamap @@ -6,6 +6,9 @@ + + + diff --git a/resources/reltable.ditamap b/resources/reltable.ditamap index 98080bfa6..b69891e9b 100644 --- a/resources/reltable.ditamap +++ b/resources/reltable.ditamap @@ -6,14 +6,14 @@ - + How to add support for new languages in HTML - + Languages supported by the core toolkit @@ -30,23 +30,23 @@ - + - - + + - + - + Eclipse help transformation @@ -54,12 +54,14 @@ - + + + - + HTML help transformation @@ -67,12 +69,14 @@ - + + + - + PDF transformation @@ -80,12 +84,13 @@ - + + - + XHTML transformation @@ -95,13 +100,14 @@ - - + + + - + HTML5 transformation @@ -111,8 +117,61 @@ - - + + + + + + + + + + Markdown transformations + + + + + + + + + + + + + Normalized DITA transformations + + + + + + + + + + + + + TocJS transformation + + + + + + + + + + + + + troff transformation + + + + + + @@ -121,7 +180,7 @@ - + @@ -130,26 +189,45 @@ - - + + - Source and target: Transformations and all-transformations topics + Source and target - - - - + + + + + + + + + + + + + + + + + + + + + + + - + @@ -161,31 +239,31 @@ - + - - - - + + + + - + - + - + - - - + + + @@ -208,7 +286,7 @@ External resources - + @@ -216,7 +294,7 @@ - + Localization overview in the OASIS DITA standard - + @@ -237,11 +315,11 @@ - + - - + + @@ -253,18 +331,18 @@ - - - - - - - - - + + + + + + + + + - + @@ -276,11 +354,11 @@ - + - - + + diff --git a/resources/source-files.ditamap b/resources/source-files.ditamap new file mode 100644 index 000000000..945b4c1ce --- /dev/null +++ b/resources/source-files.ditamap @@ -0,0 +1,186 @@ + + + + + Source File Key Definitions + + Provides key definitions for each DITA topic in the repository. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/samples/properties/docs-build-pdf.properties b/samples/properties/docs-build-pdf.properties index c7190de18..e6e375c71 100644 --- a/samples/properties/docs-build-pdf.properties +++ b/samples/properties/docs-build-pdf.properties @@ -1,3 +1,6 @@ +# Disable default MiniToC layout +args.chapter.layout = BASIC + # Generate headings for sections within task topics: args.gen.task.lbl = YES diff --git a/site.ditamap b/site.ditamap index 6cfcb5115..1d5a2f52e 100644 --- a/site.ditamap +++ b/site.ditamap @@ -4,29 +4,7 @@ DITA Open Toolkit <keyword keyref="release"/> - - - - - - - - - - - - - - - - Contributing - - - - - Who we are - - - + + diff --git a/user-guide/alternative-input-formats.dita b/user-guide/alternative-input-formats.dita index e630d6133..0decd458e 100644 --- a/user-guide/alternative-input-formats.dita +++ b/user-guide/alternative-input-formats.dita @@ -4,6 +4,9 @@ Alternative authoring formats + + Authoring formats + As of release 3.0, DITA-OT supports several alternative input formats in addition to standard DITA XML, including Markdown and the proposed MDITA and HDITA authoring formats currently in development for Lightweight DITA. diff --git a/user-guide/determining-version-of-ditaot.dita b/user-guide/determining-version-of-ditaot.dita index 47ea3b5d0..0d0b8084c 100644 --- a/user-guide/determining-version-of-ditaot.dita +++ b/user-guide/determining-version-of-ditaot.dita @@ -3,8 +3,11 @@ - Checking the DITA-OT version - You can determine the version of the DITA Open Toolkit from a command prompt. + Checking the DITA-OT version number + + Checking the version + + You can determine the version number of the DITA Open Toolkit from a command prompt. @@ -33,5 +36,9 @@ + +

The DITA-OT version number appears on the console:

+ DITA-OT version + diff --git a/user-guide/globalization-supported-in-dita-ot.dita b/user-guide/globalization-supported-in-dita-ot.dita index b150fe108..534f7a3e5 100644 --- a/user-guide/globalization-supported-in-dita-ot.dita +++ b/user-guide/globalization-supported-in-dita-ot.dita @@ -4,6 +4,9 @@ Globalization support offered by the DITA-OT + + Globalization support + The DITA Open Toolkit offers globalization support in the following areas: Generated text, index sorting, and bi-directional text. @@ -12,7 +15,8 @@
Generated text
Generated text is text that is rendered automatically in the output that is generated by the - DITA-OT; this text is not located in the DITA source files. The following are examples of generated text:
    + DITA-OT; this text is not located in the DITA source files. The following are examples of generated text: +
    • The word "Chapter" in a PDF file.
    • The phrases "Related concepts," "Related tasks," and "Related reference" in HTML output.
@@ -26,13 +30,13 @@
Bi-directional text
The DITA-OT contains style sheets (CSS files) that support both left-to-right (LTR) and right-to-left - (RTL) languages in HTML based transformations. PDF supports both LTR and RTL rendering based on the document language. - The dir attribute can be used to override the default rendering direction.
+ (RTL) languages in HTML based transformations. PDF supports both LTR and RTL rendering based on the document + language. The dir attribute can be used to override the default rendering direction. When the DITA-OT generates output, it takes the first value for the xml:lang attribute that it encounters, and then it uses that value to create generated text, perform index sorting, and determine which default CSS file is used. If no value for the xml:lang attribute is found, the toolkit defaults - to US English. You can use the configuration.properties - to change the default language.

+ to US English. You can use the configuration.properties to change the default language.

 diff --git a/user-guide/globalizing.ditamap b/user-guide/globalizing.ditamap index d530a52b6..e4cc2453f 100644 --- a/user-guide/globalizing.ditamap +++ b/user-guide/globalizing.ditamap @@ -4,8 +4,9 @@ Globalizing DITA content - - - + + + + diff --git a/user-guide/increasing-the-jvm.dita b/user-guide/increasing-the-jvm.dita index 5610fcd0f..310f5c5f2 100644 --- a/user-guide/increasing-the-jvm.dita +++ b/user-guide/increasing-the-jvm.dita @@ -4,6 +4,9 @@ Increasing Java memory allocation + + Increasing Java memory + If you are working with large documents with extensive metadata or key references, you will need to increase the memory allocation for the Java process. You can do this from the command-line prompt for a specific session, or you can increase the value of the ANT_OPTS environment variable. diff --git a/user-guide/input-formats.ditamap b/user-guide/input-formats.ditamap index 2ce69b4a7..00a394ad8 100644 --- a/user-guide/input-formats.ditamap +++ b/user-guide/input-formats.ditamap @@ -4,9 +4,9 @@ Input formats - - - - - + + + + + diff --git a/user-guide/publishing-reltables.ditamap b/user-guide/publishing-reltables.ditamap index 9564e64de..9a91e9636 100644 --- a/user-guide/publishing-reltables.ditamap +++ b/user-guide/publishing-reltables.ditamap @@ -21,6 +21,7 @@ + diff --git a/user-guide/publishing-with-ant.dita b/user-guide/publishing-with-ant.dita index 5889f3a78..0c24ca3a0 100644 --- a/user-guide/publishing-with-ant.dita +++ b/user-guide/publishing-with-ant.dita @@ -3,7 +3,7 @@ - Publishing DITA content from Ant + Building output using Ant You can use Ant to invoke the DITA Open Toolkit and generate output. You can use the complete set of parameters that are supported by the toolkit. diff --git a/user-guide/publishing.ditamap b/user-guide/publishing.ditamap index 37cae7a3c..d09f9e15b 100644 --- a/user-guide/publishing.ditamap +++ b/user-guide/publishing.ditamap @@ -4,26 +4,37 @@ Publishing - - + + + + Using the dita command + + + + build- + + + - Using the dita command + Using a properties file - - - build- - - - - - - - - + + + Migrating Ant builds + + + + Using Ant + + + + + + + + diff --git a/user-guide/transformations.ditamap b/user-guide/transformations.ditamap index 8f5ee849c..10a2ffbcf 100644 --- a/user-guide/transformations.ditamap +++ b/user-guide/transformations.ditamap @@ -4,17 +4,18 @@ DITA-OT transformations - - - - - - - - - - - - + + + Output formats + + + + + + + + + + diff --git a/user-guide/transforming-dita-content.dita b/user-guide/transforming-dita-content.dita index 00b3c6f0d..3c20f78bd 100644 --- a/user-guide/transforming-dita-content.dita +++ b/user-guide/transforming-dita-content.dita @@ -3,7 +3,7 @@ - Publishing DITA content + Building output You can use either the dita command-line tool or Ant to transform DITA content to the various output formats that are supported by the DITA Open Toolkit. diff --git a/user-guide/troubleshooting.ditamap b/user-guide/troubleshooting.ditamap index 44e71fa77..e4657eff5 100644 --- a/user-guide/troubleshooting.ditamap +++ b/user-guide/troubleshooting.ditamap @@ -4,17 +4,13 @@ Troubleshooting - - - - - - - - - - - - - + + + + + + + + + diff --git a/user-guide/using-dita-command.dita b/user-guide/using-dita-command.dita index 9e7f72042..28edc648c 100644 --- a/user-guide/using-dita-command.dita +++ b/user-guide/using-dita-command.dita @@ -7,14 +7,16 @@ You can generate output using the DITA Open Toolkit dita command-line tool. Build parameters can be specified on the command line or with .properties files. - The DITA-OT client is a command-line tool with no graphical user interface. + The DITA-OT client is a command-line tool with no graphical user interface. To verify + that your installation works correctly, you can build output using the sample files included in the distribution + package. Open a terminal window by typing the following in the search bar:
    -
  • On OS X and Linux, type Terminal.
    • -
  • On Windows, type Command Prompt.
    • +
  • On Linux and macOS, type Terminal.
    • +
  • On Windows, type Command Prompt.
 diff --git a/user-guide/verifying-output.dita b/user-guide/verifying-output.dita new file mode 100644 index 000000000..e9df755aa --- /dev/null +++ b/user-guide/verifying-output.dita @@ -0,0 +1,9 @@ + + + + + + Verifying output + After building your output, check it for correctness and check the build log for warnings or + errors. + diff --git a/userguide-book.ditamap b/userguide-book.ditamap index 9a16f61f1..b9e31fc00 100644 --- a/userguide-book.ditamap +++ b/userguide-book.ditamap @@ -17,15 +17,26 @@ - - - + + - - + + - - + + + + + + + + + + + + + + diff --git a/userguide.ditamap b/userguide.ditamap index f95e2fb9b..34feedbeb 100644 --- a/userguide.ditamap +++ b/userguide.ditamap @@ -4,21 +4,8 @@ DITA Open Toolkit <keyword keyref="release"/> - - - - - - - - - - - - - - - + + Source and target: Links that apply only to HTML version of distribution documentation @@ -29,11 +16,19 @@ - + + + + + + + + +