### New information

The DITA2Go User's Guide is a perpetual work-in-progress, largely unreviewed.This section identifies substantive additions and corrections since prior editions. Corrections are shown in red.

#### May 15, 2013 version 1.2, update 4

Editing configuration files:

- Edit settings with the DITA2Go Configuration Manager. New tool, accessible from the Project Manager; see §3.2 Editing files with the Configuration Manager.
- Use relative path settings with care! Relativity of some path settings has changed, notably those listed in Table 3-1; see §3.5 Specifying file paths in configuration settings.

Setting basic conversion options:

- One setting for output file extension. Use [Setup]FileSuffix for all output types; see §4.1.6 Checking output type and file extension. Though still recognized, the following are deprecated in favor of [Setup]FileSuffix, which overrides them in any event:

  WordperfectSuffix

  WordSuffix

  XMLSuffix

  HTMLSuffix

- Turn off warnings about undefined formats. New setting ShowUndefinedFormats, on by default; see §4.2 Logging conversion events.

Configuring output formats:

- Format names require valid suffixes. Not just a convention any more; see §7.4 Understanding how to define output formats.

Configuring format components:

- Stream numbers have changed for figures, tables, and equations. If you number figures, tables, or equations, and you use other than the default subformat definitions supplied in system configuration files, you must change your subformat definitions so that figures use stream number 8, tables use stream number 9, and equations use stream number 10; see §8.5.2 Defining number streams.

Generating lists and indexes:

- You get lists, like it or not, as per DITA spec. DITA2Go is required to output whatever booklist components are present in your bookmap; see §14.1 Understanding how DITA2Go produces lists.
- Generate and configure a glossary. New settings GenerateGLS, GLSFile, GLSSuffix, GLSTitle, GLSFormat, GlossaryItem, GLSTitleFormat, GLSXrefFormat, ResetAbbrevAt, UseAbbrevInTitles; see §14.7 Producing a glossary.
- Specify IDXTitle in a language configuration file (correction). This setting belongs in section [IndexText], not in [Index]; see §14.8.1 Specifying output formats for the index.
- RTF indexes now have active links. DITA2Go uses a new method that does not involve creating the Word INDEX field. The following settings, which have no reasonable equivalents in the new system, are deprecated: IndexStyle, IndexLeader, and IndexColumns; see §14.8.4 Configuring index references.
- Override default formats for index entries and references. New sections IndexEntryFormats and IndexRefParaFormats; see §14.8.2 Overriding formats for index entries and references.
- Configure see and see-also entries for variant indexes. New [IndexSeeText] settings SeeStartListIndex and SeeAlsoStartListIndex, new [IndexSeeFormats] settings IndexSeeListStart and IndexSeeAlsoListStart; see §14.8.3 Configuring see and see-also index entries.
- Configure index references. New settings UseCompactForm, FullIndexRanges, IndexRefSep, and IndexRangeSep; see §14.8.4 Configuring index references.
- Configure index alphabetic headings and links. New settings IndexLettersFormat and IndexTopLettersFormat; see §14.8.5 Including heading letters in the index.
- Toss [HTMLOptions]UseIndex. This setting is no longer needed for a non-Help HTML index, which will be built if you include <indexlist> in your map; see §14.8.6 Configuring index features for HTML output.
- Generate multiple variants of the same booklist type. New sections [BookLists], [*BList], [*BLItems], [*BLForms], [*BLRefForms], [IndexClasses], [IndexLists]; see §14.9 Configuring variant booklist components.
- Provide outputclass via PI for indexterms. If your bookmap contains more than one indexlist; see§14.9.5 Mapping indexterms to variant indexes.

Producing on-line Help:

- Use <data /> elements for CSH targets. Additional support for context-sensitive help; see §16.10.2 Specifying CSH mappings.

Generating Microsoft HTML Help:

- Specify binary TOC or index for HTML Help. Newly documented settings BinaryTOC and BinaryIndex; see §18.9.2 Choosing whether to generate binary contents or index.
- Generate a CSH map file. New settings MakeCshMapFile, CshMapFileNumStart, and CshMapFileNumIncrement; see §18.11.3 Specifying and generating a map file for CSH links.

Generating OmniHelp:

- Make compound terms searchable in OmniHelp. Newly documented setting CompoundWordChars; see §19.10.3 Making compound terms searchable.

Converting to DITA XML:

- Wrap anchored images in <fig> as an exception. Newly documented HTML format property Figure; see §24.7.2 Specifying what to include in a <fig> wrapper.
- Keep selected topics out of the TOC. New PI marker type DITANoTOC; see §24.8.6 Omitting a DITA topic from the TOC.
- CSH targets via TopicAlias markers are included by default. New setting UseTopicAlias; see §24.10 Including CSH targets in DITA XML.

Creating HTML links :

- Tell DITA2Go to leave link text case alone. Although its internal default value is No, MakeFileHrefsLower is set to Yes in system file d2htm_config.ini, which is referenced for every HTML output type. If you want DITA2Go to leave case alone in hypertext links, you must explicitly set MakeFileHrefsLower to No in a project or local configuration file; see §28.2.6 Forcing link text to lowercase.

Mapping text formats to HTML/XML:

- Assign HTML tags in new configuration sections. [ParaTags] and [CharTags] replace [ParaStyles] and [CharStyles], respectively; see:

  §30.2.1 Assigning HTML tags and attributes to paragraph formats

  §30.3 Mapping character formats

- Distinguish paragraph (block) from character (inline) format properties. New sections [HTMLParaStyles] and [HTMLCharStyles] supersede [HTMLStyles], which is still honored; see §30.4 Assigning properties to text formats.
- Exclude size attribute from font tags. Newly documented setting UseFontSize; see §30.6.4 Excluding face and size attributes from font tags.

Including graphics in HTML:

- Indent images without using CSS. Only if CSS is not an option; see §32.5.2 Indenting images (deprecated).

Converting tables to HTML:

- Indent tables without using CSS. Only if CSS is not an option; see §33.5.1 Indenting tables (deprecated).

Working with macros:

- Distinguish between paragraph and character code inclusions. New sections:

  Old section | New for paragraph formats | New for character formats
      [StyleCodeAfter]
      [ParaStyleCodeAfter]
      [CharStyleCodeAfter]
      [StyleCodeBefore]
      [ParaStyleCodeBefore]
      [CharStyleCodeBefore]
      [StyleCodeEnd]
      [ParaStyleCodeEnd]
      [CharStyleCodeEnd]
      [StyleCodeReplace]
      [ParaStyleCodeReplace]
      [CharStyleCodeReplace]
      [StyleCodeStart]
      [ParaStyleCodeStart]
      [CharStyleCodeStart]

  The old sections are deprecated, but still honored; see §37.9.3 Surrounding or replacing text with code or macros.

Working with processing instructions :

- Replace PI marker content with code. New section [MarkerTypeCodeReplace]; see §38.5 Inserting code with PI markers.

#### August 21, 2012 update 03

Generating Microsoft HTML Help:

- Exclude selected topics from FTS for HTML Help. An inelegant hack via @search or new PI marker Search; see §18.10 Providing full-text search (FTS) for HTML Help.

Converting to HTML/XHTML:

- Prevent adjacent HTML <pre> elements from merging. New setting MergePre; see §22.6.4 Preventing adjacent <pre> elements from merging.

Setting up CSS for HTML:

- Omit element tags from CSS selectors. New setting SelectorIncludesTag; see §31.7.9 Omitting tags from CSS selectors.

Converting tables to HTML:

- HTML table rows are now wrapped in groups by default. Reversed setting HeadFootBodyTags; see §33.3.2.4 Wrapping table row groups.

#### May 1, 2012, version 4.0, update 54

Editing configuration files:

- Override, or produce the effect of, the @print attribute. New setting PrintProject, new PI marker Print; see §4.1.7 Producing print output selectively.
- Pop up current log file if conversion errors occur. New settings EditorFileName and HistoryFileName; see §4.2 Logging conversion events.

Mapping elements to output formats:

- Ignore outputclass attributes for border and shading properties. New setting OutputclassHasBorderShadeFormats; see §6.2 Specifying options for naming formats.
- Specify a default heading for <note> elements. The DITA2Go default is no heading; see §6.5.8 Understanding default attribute-based prefixes and headings.
- Designate a table row as a table footer row on output. New setting TableFooterClass; see §6.9 Specifying formats and options for tables.
- Give draft comments special formats; see §6.11 Specifying options for draft comments.

Configuring format components:

- Include page numbers, text, and spaces in cross-reference formats. Previously undocumented building blocks; see Table 8-5.

Specifying conditional processing:

- Limit the scope of keydefs to named map branches. New settings UseBranchKeydefs and KeydefsOnlyWithinBranch; see §9.6.6 Limiting the scope of keydefs by branch.
- Keyref named map branches. New PI marker type KeyrefBranch; see §9.6.7 Directing a key reference to the correct branch.

Including content by reference:

- Push to more places than specified for DITA 1.2. New push actions pushatstart and pushatend; see §10.1 Pushing and pulling content by reference.
- Include external code snippets. New PI marker types ExtCode*, plus support for RFC 5147 fragment identifiers; see §10.2 Referencing external code or text fragments.

Defining element sets and properties:

- Assign element type properties to class attributes. Not just to element names; see:
  - §11.2.3 Assigning properties to element types
  - §B. Element type default properties.
- New element type properties: CascadeSet, CascadeItem, Draft, Abbrev, NoLevel, NoNumber, Task, BookTitle, PList, PLEntry, PLTerm, PLDef, Navtitle, Reference, Glossary, and Trademark; see:
  - §11.2.2 Understanding what properties are available
  - §B. Element type default properties

Generating lists and indexes:

- Specify different suffixes for the base names of generated files. New settings TOCSuffix, LOFSuffix, LOTSuffix, and IDXSuffix; see §14.2 Naming generated HTML list and index files.
- Get navigation titles into the TOC. And set defaults to use if attributes are missing. New settings TopicheadsHaveNavtitles, LockAllNavtitles, UseAllInTOC; see §14.3 Generating a table of contents.

Converting to print RTF:

- Produce .doc or .docx files via Word macro. See §15.10.1 Supporting more than one version of Word.

Producing on-line Help:

- Choose plain or modified topic titles for TOC entries. New setting UseNavtitleMarkers; see §16.4.2 Including contents entries in HTML-based Help.
- Produce index meta elements for Microsoft Help Viewer. New setting UseHVIndex; see §16.5.2 Preparing index entries for Microsoft Help Viewer.

Generating Microsoft HTML Help:

- Omit code-page mapping for uncompiled HTML Help. New setting UseCodePage; see §18.3.5 Deciding whether to compile HTML Help.
- Generate Asian or Cyrillic HTML Help. New code-page DLLs; see §18.12 Generating HTML Help in non-Western languages.
- Fixed spaces become ideographs for Japanese HTML Help. Or you can map them to something else; see §18.12 Generating HTML Help in non-Western languages.
- Exclude content from full-text search. If no @search attributes in your topicrefs, use new PI marker Search; see §19.10.7 Excluding content from being searched.

Converting to HTML/XHTML:

- For ePub, XHTML output can provide input to Calibre. See §22.1 Deciding which type of output to produce.
- For HTML 5 output, set DOCTYPE as appropriate. See §22.4.1 Specifying HTML/XML version, DOCTYPE, and DTD.
- Generate XHTML for Confluence 4.x. New settings Confluence, ConfluenceLinks, and ConfluenceLink*; see §22.10 Generating XHTML for Confluence 4.x.
- Change the View Output starting topic for HTML/XHTML. New setting ViewOutputFile; see §22.12 Specifying a starting topic for HTML or XHTML.

Splitting and extracting files:

- Insert space or a separator between HTML topics in a single output file. New [Inserts] keyword TopicBreak; see:

  §27.6.2 Assigning code to [Inserts] keywords for splits and extracts

  §37.9.2 Invoking macros at predetermined points in output.

Setting up CSS for HTML:

- Replace spaces in CSS class names with hyphens or underscores. Instead of only alphanumerics as a value for ClassSpaceChar; see §31.7.1 Understanding CSS class name restrictions.

Including graphics in HTML:

- Omit empty alt attribute values from HTML output. New setting AllowEmptyAlt; see §32.7 Providing (or omitting) alternate text for images.

Converting tables to HTML:

Automating DITA2Go conversions:

- Execute system commands before and after conversion. New automation keywords SystemStartCommand, SystemWrapCommand, SystemEndCommand; see §43.1 Executing operating-system commands.

Producing deliverable results:

- Gather referenced graphics files for distribution. New setting CopyOriginalGraphics; see §44.7.1 Copying referenced graphics to a distribution directory.

Previous Topic: Availability

Next Topic: Colophon

Parent Topic: About this guide

Sibling Topics:

Availability

Colophon