DOCSHUB DOCSHUB
  • Library
  • Avaya Support Site Avaya Learning Blogs Videos & Podcasts Knowledge base Report Product bugs
Deutsch English Español (México) Français Français (Canada) Italiano Magyar Nederlands Polski Português (Brasil) Română Русский עברית العربية 中文(简体) 中文(繁體) 日本語 한국어
Login
DOCSHUB DOCSHUB
  • Library
  • Avaya Support Site Avaya Learning Blogs Videos & Podcasts Knowledge base Report Product bugs
  • Deutsch English Español (México) Français Français (Canada) Italiano Magyar Nederlands Polski Português (Brasil) Română Русский עברית العربية 中文(简体) 中文(繁體) 日本語 한국어
Login

DITA and Tridion Docs Work Instructions and Guidelines

Table of Contents

Type to filter navigation items by title
  • Content model overview
    • Content model
    • Why XML
    • DITA
    • Content relevance guidelines
    • Starting a new DITA project
  • Topic types
    • Concept topics
    • Task topics
    • Reference topics
    • Structure topics
    • Scenario topics
    • Resolution topics
    • Glossary topic
  • Working with the repository
    • Browsing the repository
      • Browsing the repository from Publication Manager
      • Browsing the repository from Oxygen XML Author
    • Previewing an object in the repository
    • Folders
      • Information to create a new project in Tridion Docs
      • Creating a new folder from Browse Repository
    • Moving objects across folders in Browse Repository
    • Moving folder from one location to another
    • Logging on to the Tridion Docs web interface
    • Viewing checkin history for an object
    • Changing your SDL account password
    • Importing non-DITA files to Tridion Docs
  • Working with publications
    • Publications
    • Starting Publication Manager
    • Opening a publication
    • Creating a publication
      • Creating a new publication
      • Creating a new version of a publication
      • Saving a publication as a new publication
    • Publication properties
    • Viewing or changing the properties of a publication
    • Copying objects from one publication to another
    • Saving a publication
    • Closing a publication
    • Capturing the word count for a document
    • Capturing the file count in a publication
  • Creating and modifying DITA maps
    • Content components
    • DITA Maps and BookMaps
    • Deliverable map
    • Creating a map
    • Map properties
    • Important information about copying elements
    • Copying a topic or map
    • Creating a copy of a map
    • Adding objects to a map
      • Adding a topic or map to a map
      • Adding multiple topics to a map
      • Adding a non-DITA file to a map
      • Inserting a topichead into a map
    • Bookmaps
      • Bookmap elements
      • Editing a bookmap
      • Adding a trademark to the mainbooktitle in a deliverable map
      • Working with legal content
        • Legal content for product documents
        • Adding the common legal topic to your publication
        • Creating a legal topic for developer content
      • Inserting a line break in a book title for a PDF output
      • Adding a new chapter to a bookmap
      • Creating chapter groupings in a bookmap by using the part element
      • Adding an appendix to a bookmap
      • Adding a glossary to a bookmap
      • BookMap guidelines
      • Using a bookmap for Eclipse Help
    • Checking out a map to make updates in Publication Manager
    • Checking in a map
    • Moving objects in a map
    • Removing objects from a map
    • Adding a trademark to a navtitle in a DITA map
    • Adding author name in the deliverable map
    • DITA Map guidelines
    • Aggregated topics (chunking)
      • Using chunking to create aggregated topics
  • Creating and modifying topics
    • Creating a new topic
    • Topic properties
    • Creating a copy of an existing topic
    • Checking out a topic from a publication
    • Checking out a topic from the Tridion Docs repository
    • Adding or modifying content in a topic
    • Changing the font display size in Editor
    • Adding explanatory text before a step
    • Opening a topic in Oxygen XML Author in read-only mode
    • Checking in a topic
    • Creating troubleshooting, alarm, event, and error topics
    • Identifying migrated topics with duplicate Tridion Docs titles
    • Topic title guidelines
    • Accessibility standards
    • Indexing and keywords guidelines and tips
    • Important information about copying elements
    • Marking a task step or substep as optional
    • Inserting XML comments into topics
    • Modifying element attributes
    • Replacing tags in the topic
    • Inline markup
    • Tagging code exhibits
    • Tagging system-outputted text
    • Copying text into topics from external sources
      • Copying multiple lines of text into a topic
      • Copying text into a codeblock element
      • Copying rows and columns from an Excel spreadsheet or Word table
    • Scaling code samples in codeblock
    • Inserting a non-breaking space into a topic
    • Tagging filepath elements that contain variables
    • Performing a completeness check on a topic
    • Inserting links to footnotes in a topic
    • Identifying elements not to translate
    • Printing the tag view of a topic in Editor
    • Embedding video in a DITA topic
    • Forcing worksheets and checklists to start on a new page
    • Editing tips
    • Change tracking
      • Enabling and disabling change tracking in a topic
      • Accepting or rejecting changes in topics
  • Working with web interface
    • Creating a folder from web interface
    • Changing the folder properties from web interface
    • Deleting the folder from web interface
  • Making metadata changes in bulk
    • Metadata changes in bulk
    • Changing metadata in bulk
  • Working with tables
    • Creating a simple table
    • Creating a complex table
    • Modifying a simple table or a part table
    • Modifying an existing complex table
    • Setting the orientation of a table to landscape
    • Extending a table element to the left margin
    • Extending a simpletable and parttable to the left margin
    • Splitting the row in a table
    • Suppressing color banding in tables
  • Context-sensitive help
    • Supporting context-sensitive help for HTML outputs without context IDs
    • Supporting context-sensitive help for HTML outputs that use context IDs (Eclipse Help, .chm, and Heritage Nortel projects)
    • Context-sensitive help support in content migrated from Astoria
  • Working with output
    • Supported output formats
    • DITA Open Toolkit
    • Output tab options
    • Output status
    • Selecting the output format for a publication
    • Output properties
    • Generating output
    • Programs available on Avaya Documentation Center
    • Specifying a copyright range for an output
    • Setting the date of your outputs to the current date
    • Producing a draft output to compare two publication versions
    • Producing a Validator PDF output
    • Validator PDF output formatting
    • Breadcrumbs in HTML outputs
      • How breadcrumbs work
      • Enabling breadcrumbs in HTML outputs
      • Specifying a unique output filename for multiple topic instances to support breadcrumbs
    • Downloading output
    • Checking the publishing logs for errors
    • Viewing the publishing queue
    • Viewing publishing logs on the Tridion Docs web interface
    • Viewing publishing logs from Publication Manager
    • Downloading outputs from the Tridion Docs web interface
    • Checking accessibility and generating a report
    • Deleting and adding a TOC and index to a PDF output
    • Changing the HTML output extension to .htm
    • Support for non-Avaya branded outputs
      • Adding a custom logo in outputs
      • Removing the comments link in the footer
      • Changing the email address in the comments link in the footer
      • Customizing the copyright holder
      • Changing the color scheme for a frameset HTML output
      • Changing the color scheme for an HTML5 output
    • Producing the Eclipse help outputs
  • Publishing documents on the Avaya Documentation Center
    • Guidelines to publish content on Avaya Documentation Center
    • Avaya Documentation Center publishing checklist
    • Preparing content for publishing on the Avaya Documentation Center
    • Replacing the document or publishing for new release on the Avaya Documentation Center
    • Avaya Documentation Center postpublishing checklist
    • Adding videos in a document
      • Videos in documents
      • Preparing for adding videos in a document
      • Implementing videos in a document
      • Creating a video publication
      • Linking video topics in documents
      • Publishing video content on Documentation Center
      • Verifying video content on Documentation Center
      • Maintaining video content on Documentation Center
      • Removing videos from Documentation Center
      • Considerations for linking Videos in documents
    • Best practices
      • Avoiding accidental overwriting of output on Avaya Documentation Center
  • Linking and references
    • Types of linking in DITA
      • Links in maps
      • Cross-reference links in topic
    • Hierarchical links and relationship table links
      • Hierarchical links
      • Linking attributes
      • Suppressing linking to nested topics
      • Topic sequences in HTML outputs
      • Defining topic sequence linking for an HTML output
      • Relationship tables
        • Relationship tables overview
        • Relationship table guidelines
        • Adding relationships
        • Removing relationships
    • Cross-references (inline links)
      • Inserting a cross reference to another topic
      • Inserting cross references to elements within a topic
      • Inserting a cross reference to a non-DITA file
      • Inserting a link to a web site
      • Inserting an email link in a topic
      • Inserting a link to an external topic on Avaya Documentation Center
  • Reusing content and viewing reuse information
    • Reuse in DITA
      • Reuse types
      • Common topics
    • Reuse and localization
    • Guidelines for reusing content
    • Planning your content reuse
      • Identification of reusable content
      • Identification of source topics
    • Adding an ID to elements
    • Reusing an element
    • Creating a common topic for document titles
    • Reuse of inline elements and document titles
    • Locating the source of a conref
    • Viewing where an object is used from the web interface
    • Viewing where a topic is used from Publication Manager
    • Viewing where a topic is used from Oxygen XML Author
    • Viewing where an element is used
  • Working with conditions
    • Conditional content
    • Condition states in Tridion Docs
    • Applying conditions to elements in topics
    • Removing conditions from elements in topics
    • Applying conditions to table rows
    • Applying conditions to table columns
    • Conditionalizing a topic or map
    • Removing condition from topics in a map
    • Removing conditions from your list in Condition Builder
    • Viewing all conditions used in a publication
    • Viewing where conditions are used
    • Previewing conditions in a topic or map
    • Selecting conditions in a publication
  • Workflow
    • Changing the workflow status when checking in a topic
    • Changing the workflow status of an object from the Desktop Repository
    • Delivering content to localization
    • Releasing a publication
    • Preparing topics for an editorial review
    • Setting up a peer review
    • Generating a workflow report
    • Changing the workflow status of objects from the web interface
    • Viewing workflow status of objects from the publication baseline
    • Inbox
    • Viewing your inboxes
    • Releasing a publication
  • Working with publication baselines
    • Baselines
    • Information provided in a publication baseline
    • Manually selecting the object versions used in a publication
    • Checking for newer versions of objects in the baseline
    • Freezing the baseline
    • Freeze Baseline report
    • Cleaning up the baseline
    • Viewing where an object in the baseline is used
  • Working with versions and branches
    • Versions and branches
    • Whether to create a new version or branch
      • Scenario 1: Changes required in the latest version of an object
      • Scenario 2: Changes required in an earlier version of an object
      • Scenario 3: Changes required in all released versions of an object
      • Scenario 4: Changes required in earlier released version of an object and in the current draft version
    • When to create a new version of objects in a publication
    • Branching best practice
    • Tips for managing concurrent versions
    • Viewing the version of all objects in a publication
    • Checking for newer versions of objects in the baseline
    • Changing the version of an object used in a publication
    • Creating new versions or branches
      • Using Publication Manager to create a new version or branch
      • Using the desktop repository to create a new version or branch
      • Using the publication baseline to create a new version or branch
      • Using the publication baseline to create new versions of multiple released topics
    • Selecting the version of a publication or topic to modify
    • Selecting the version of a map to modify
    • Deleting an unused version or branch of a topic, map, or image
    • Deleting an unused version of a publication
    • Comparing versions and revisions
      • Comparing topic versions from Publication Manager
      • Comparing topic versions from the desktop repository
      • Comparing topic revisions in the Tridion Docs web interface
      • Comparing publication versions in the Tridion Docs web interface
  • Managing graphics
    • Image guidelines
    • Accessibility of images
    • Making images and objects accessible
    • Line drawings
    • Screenshot considerations and guidelines
    • Icons
    • Photographs
    • Importing images
    • Image properties
    • Inserting an image in a topic
    • Scaling images in topics
    • Setting the orientation of a figure to landscape
    • Extending an image to the left margin
    • Extending an image past the right margin
    • Updating an image by checking it out and modifying it
    • Updating an image by uploading a new version in the web interface
    • Forcing a large image to the next page in a 3-column quick reference guide
    • Creating images with links
  • Working offline
    • Local storage
    • Viewing a list of topics in your local storage
    • Checking out a topic in preparation for working offline
    • Managing topics open in Editor if you lose your connection
    • Modifying a topic in local storage
    • Comparing a topic in Local Storage with the version stored in the Tridion Docs repository
    • Opening a topic in Oxygen XML Author in read-only mode
    • Checking in a locally stored topic to the Tridion Docs repository
    • Deleting content from your local storage
  • Troubleshooting
    • SDL server maintenance schedule
    • Requesting assistance with the DITA authoring tools
      • DITA Authoring Tools support
      • Creating a new support request
      • Create DITA support ticket
      • Filtering or sorting the Jira tickets
      • How support requests are managed
    • Capturing log files for troubleshooting
    • Capturing data on a Tridion Docs connection issue
    • Conref errors appear in the Publication Manager preview
    • Conref was not expanded error
    • Publication Manager crashes while opening a publication
    • Link text of cross reference does not match the target topic
    • Directories appear to be empty
    • Local storage is blocked by another application error
    • Error that configuration file could not be saved because it is in use
    • Error when trying to generate workflow report about no information found
    • Baseline freeze fails even though publishing log shows no errors
    • Table goes off the page in the PDF output
    • Tables cells are blank in the output even though the table cells contain content
    • Elements in Oxygen XML Author are right aligned
    • Images appear smaller on Documentation Center
    • Icon size is larger than expected
    • Copyright year in the legal page is incorrect
    • Unable to add accounts
    • Publishing-related issues
      • Locating a GUID referenced in a publishing log error
      • Publishing fails with error [DOTJ013E][ERROR] Failed to parse the referenced file
      • Publish fails with null error in log file
      • Error opening PDF: There was an error opening this document. The file is damaged and could not be repaired
      • [DOTX031E][ERROR] File is not available to resolve link information
      • Publication fails with no log included in the zip file
      • [exec] AHFCmd :WARNING: Error Code : 11792 (2E10)
      • Publish report includes a note that “Illustration xxx en-us High is unavailable”
      • [DOTX019W] [WARN]: The type attribute on a topicref element does not match the target topic
      • Publishing fails with error: “Expected scheme-specific part at index 5: http:”
    • Localization-related issues
      • Unable to translate objects
      • Unable to translate
      • Unable to translate objects for the new program
  • Defining variables using key references
    • Key references
    • Creating key maps to define key references for variables
    • Using keydef variables in your topics
    • Setting up variables using key references that reuse existing elements
    • Adding a keydef variable that reuses an existing element
  • Searches and metrics
    • Searching the repository
      • About searches
      • Performing searches
      • Search parameters
    • Searching for an element and attribute in a topic
    • Capturing metrics
      • Tridion Docs dashboard
      • Capturing metrics using the dashboard
      • Creating reports from the Dashboard
      • Saving Dashboard selections as favorites
  • Checklists
    • Project checklists
    • Topic authoring checklist
    • Checklist for creating a new publication
    • Checklist for releasing a publication
    • Checklist for preparing content for Localization
  • DITA element reference
  • A
  • C
  • D
  • E
  • F
  • G
  • I
  • K
  • L
  • M
  • N
  • O
  • P
  • Q
  • R
  • S
  • T
  • U
  • V
  • W
  • X
  • Elements that are not used
  • Creating SVG images using Inkscape
    • Introduction
      • The Inkscape interface
      • The Inkscape toolbar
    • Downloading and installing Inkscape
    • Using Inkscape
      • Creating a new vector image in Inkscape
      • Drawing shapes
      • Drawing a diamond shape
      • Drawing lines
      • Drawing arrows
      • Embedding text in an object
      • Altering the dimensions of an object
      • Importing graphics into Inkscape
      • Menu shortcut keys
    • Checklist for delivering SVG graphics to Localization
  • Glossary
    • publication
    • baseline
    • GUID
Home
DITA and Tridion Docs Work Instructions and Guidelines
Working with output

Working with output

Share this page

  • On LinkedIn
  • On X
  • On Email

PDF Export Options

  • This Topic
  • Entire Document
Last Updated : Jul 19, 2017 |
Common - DITA Supporting Content
Avaya Documentation Standards
Using
5.0
Send Feedback

Topic navigation

Previous Topic

Context-sensitive help support in content migrated from Astoria

Next Topic

Supported output formats

In this article

STAY CONNECTED

Twitter Youtube Linkedin
Footer Icon
  • Sitemap
  • Terms of use
  • Privacy
  • Cookie Policy
  • Trademarks
  • Accessibility
© 2026 Avaya LLC