From bb6495e76058a47c4e1339c26deaf69af2bdcb4f Mon Sep 17 00:00:00 2001 From: Radu Coravu Date: Fri, 31 May 2024 08:37:50 +0300 Subject: [PATCH] EXM-54339 Used AI to improve readability. --- ...collaboration-and-publishing-overview.dita | 251 +++++++++--------- 1 file changed, 131 insertions(+), 120 deletions(-) diff --git a/topics/dita-xml-editing-collaboration-and-publishing-overview.dita b/topics/dita-xml-editing-collaboration-and-publishing-overview.dita index f5081f6..0eb8a1d 100644 --- a/topics/dita-xml-editing-collaboration-and-publishing-overview.dita +++ b/topics/dita-xml-editing-collaboration-and-publishing-overview.dita @@ -2,9 +2,9 @@ DITA XML Editing, Collaboration and Publishing Overview - This is an overview of the possibilities Oxygen XML offers to edit DITA XML content, - reuse, profile, review and and publish to various output formats like WebHelp Responsive and - CSS-based PDF. + Oxygen XML provides a wide range of features for editing, reusing, profiling, + reviewing, and publishing DITA XML content. You can create various output formats, such as + responsive WebHelp and PDF documents styled with CSS. Radu Coravu @@ -14,19 +14,20 @@
Overview -

An overview of the application's DITA XML editing support can be found here: . Some of the strong points:

+

You can find an overview of the application's DITA XML editing support here: . Here are some of the key features:

    -
  • Permanent user based licensing.
    • -
  • Cross platform availability.
    • -
  • Complete DITA XML editing, review and publishing support.
    • -
  • Great technical support.
    • +
  • Permanent user-based licensing.
    • +
  • Available on multiple platforms.
    • +
  • Comprehensive support for editing, reviewing, and publishing DITA XML + content.
    • +
  • Excellent technical support.

-

Some frequently asked questions about the overall solution, which companies can - benefit from using it and how the solution is usually purchased can be found here: - .

+

For answers to common questions about the overall solution, which companies can + benefit from using it, and how it is typically purchased, please see: .

DITA Maps Manager @@ -46,91 +47,93 @@
  • Spell Check in Files.

    • -

    Past webinars recording covering DITA XML editing with Oxygen: .

    +

    If you want to learn more about editing DITA XML with Oxygen, you can watch + recordings of past webinars here: .

    Topic Editing -

    Full support to edit Oxygen XML Editor provides comprehensive support for editing DITA XML Topics. Some highlights:

      -
    • Change Tags Visualisation Mode.
      • -
    • CSS Styles drop down.
      • -
    • Content Completion Window.
      • -
    • Helper side views (Outline, Attributes, Elements views, DITA Reusable - Components).
      • -
    • Menu/Contextual Menu and Toolbar with DITA specific actions:
        -
      • Insert links.
        • -
      • Content Reuse.
        • -
      • Edit Profiling Attributes.
        • -
      • Work with tables.
        • -
      • Insert references image and media resources.
        • -
      • Insert lists, paragraph, bold/italic/underline styling.
        • + format="html" scope="external">DITA XML Topics. Here are some key + features:
          +
        • Ability to change the Tags Visualization Mode.
          • +
        • Access to a CSS Styles drop-down menu.
          • +
        • Availability of a Content Completion Window.
          • +
        • Helpful side views, including the Outline, Attributes, Elements views, and + DITA Reusable Components.
          • +
        • DITA-specific actions accessible through the Menu, Contextual Menu, and + Toolbar, such as:
            +
          • Inserting links.
            • +
          • Reusing content.
            • +
          • Editing Profiling Attributes.
            • +
          • Working with tables.
            • +
          • Inserting references to image and media resources.
            • +
          • Inserting lists, paragraphs, and applying bold, italic, or underline + styling.
          • -
        • Multiple ways to insert links and content references using copy/paste, drag - and drop.
          • +
        • Various methods to insert links and content references, including copy/paste + and drag and drop.

        -

        Past webinars recording covering DITA XML editing with Oxygen: .

        +

        For more information on editing DITA XML with Oxygen, you can watch past webinar + recordings: .

    Content Reuse -

    The DITA XML standard has lots of content reuse - capabilities. Oxygen allows you to utilize the The DITA XML standard offers a wide range of content reuse features. + Oxygen allows you to harness the full potential of the DITA 1.3 standard:

    • Reuse product names using key definitions with keywords.
    • Reuse XML elements in multiple places.
    • Reuse ranges of XML elements.
      • -
    • Push reusable content in target topics.
      • -
    • Reuse entire DITA XML topics in multiple parts of the DITA Map.
      • -
    • Use DITA 1.3 key scopes to reuse topics with variable content in various +
    • Push reusable content into target topics.
      • +
    • Reuse entire DITA XML topics in various parts of the DITA Map.
      • +
    • Use DITA 1.3 key scopes to reuse topics with variable content in different contexts.

    -

    UI capabilities to insert reusable content:

      +

      Oxygen provides several user interface features to insert reusable content:

      • DITA Maps Manager -> Insert Key Definition with Keyword.
        • -
      • DITA XML topic editing toolbar with possibilities to Reuse - Content.
        • -
      • Using special paste to paste content references in topics.
        • +
      • DITA XML topic editing toolbar with options to Reuse Content.
        • +
      • Using special paste to insert content references in topics.
      • The DITA Reusable Components side view.
      • Content Completion actions to insert reusable content (keyrefs and conrefs).

      -

      Past webinars recording covering DITA XML content reuse with Oxygen: .

      +

      For more information on DITA XML content reuse with Oxygen, check out the past + webinar recordings: .

    Profiling/Filters

    Profiling capabilities allow generating - multiple similar user manuals from the same DITA XML content.

    -

    With Oxygen you can:

      -
    • Define values for the DITA profiling attributes and they can be easily - managed to filter content in the published output.
      • -
    • Switch between profile sets to see how the edited content looks like before - publishing.
      • + format="html" scope="external">Profiling capabilities make it possible to + create many similar user manuals from the same DITA XML content.

      +

      With Oxygen, you can:

        +
      • Set values for the DITA profiling attributes. These can be easily managed to + filter content in the published output.
        • +
      • Change between profile sets. This lets you see how the edited content will + look before publishing.

      -

      Past webinars recording covering DITA XML profiling with Oxygen: .

      +

      You can watch past webinar recordings that cover DITA XML profiling with Oxygen: + .

    Project-wide Refactoring -
      +
      • The Main Files support in the - Oxygen Project view allows powerful refactoring operations:
          -
        • Move or rename either one or multiple files.
          • -
        • Change directory names or move entire directories.
          • + format="html" scope="external">Main Files feature in the + Oxygen Project view enables powerful refactoring operations:
            +
          • You can move or rename one or multiple files.
            • +
          • You can change directory names or move entire directories.
          -
        • Apply You can apply XML refactoring actions on multiple + format="html" scope="external">XML refactoring actions to multiple files or entire folders.
    @@ -149,112 +152,120 @@
  • Schematron checks with quick fixes can be added to report structural problems.
    • -
  • The integrated spell checker and the The built-in spell checker and the Terminology Checker add-on can be used to check for content-related problems.
    • - Migration from Other Formats + Migrating from Other Formats
      -
    • You can use the smart paste support to convert MS Word or Web content to DITA - XML content on paste.
      • -
    • Or you can use the Oxygen Batch Documents Converter add-on to migrate various document formats to +
    • You can use the smart paste feature to convert Microsoft Word or web content + into DITA XML format when you paste it.
      • +
    • Alternatively, you can use the Oxygen Batch Documents Converter add-on to convert various document formats to DITA XML.
      • -
    • Dynamic on the fly conversions are also available for You can also perform on-the-fly conversions for Markdown, OpenAPI or Word documents - referenced directly in a DITA Map.
      • + format="html" scope="external">Markdown, OpenAPI, or Microsoft Word + documents that are directly referenced in a DITA map.
    Framework Customizations -

    Customize the overall DITA XML editing functionality by:

      -
    • Adding new actions in the DITA specific menus and toolbars.
      • -
    • Remove existing actions.
      • +

      You can customize the overall DITA XML editing + functionality in several ways:

        +
      • Add new actions to the DITA-specific menus and toolbars.
        • +
      • Remove existing actions that you don't need.
      • Customize the content completion window to add or remove entries.
        • -
      • Customize the visual editing using - your custom CSS.
        • + >content completion window by adding or removing entries. +
      • Customize the visual editing + experience by using your own custom CSS.
      • Use your own new file templates.
        • -
      • Add custom validation stages using custom schemas or new file templates to create new documents.
        • +
      • Add custom validation stages by using custom schemas or Schematron checks.
        • -
      • and much more...
        • +
      • And there are many other customization options available!

    Useful Add-ons -

    The Oxygen default add-ons repository offers a variety of The Oxygen default add-ons repository provides a range of useful add-ons among which the following can be - mentioned:

      -
    • Git Client add-on - Connect to Git repositories.
      • -
    • Content Fusion connector - Allow SMEs to review technical documentation - content directly in a web broser.
      • -
    • Batch Documents Converter - Convert from various formats like MS Word, - DocBook, Markdown, XHTML to DITA XML.
      • -
    • Terminology Checker - Check for terminology related problems.
      • -
    • Fluenta DITA Translation Add-on - Use the Fluenta third party library to - create XLiff exports from DITA Maps and to import DITA Maps from translated - XLiff files.
      • -
    • Oxygen AI Positron Assistant.
      • + scope="external">helpful add-ons. Some of the most notable ones + include:
        +
      • Git Client add-on - Allows you to connect to Git repositories.
        • +
      • Content Fusion connector - Enables subject matter experts (SMEs) to review + technical documentation content directly in a web browser.
        • +
      • Batch Documents Converter - Converts documents from various formats such as + MS Word, DocBook, Markdown, and XHTML to DITA XML.
        • +
      • Terminology Checker - Checks for terminology-related issues in your + content.
        • +
      • Fluenta DITA Translation Add-on - Uses the Fluenta third-party library to + create XLIFF exports from DITA Maps and import DITA Maps from translated + XLIFF files.
        • +
      • Oxygen AI Positron Assistant - Provides AI-powered assistance for content + creation and editing.

    Review -

    People can give feedback on the written technical documentation in various ways:

      There are several ways for people to provide feedback on technical documentation:
        -
      • Internal Internally review directly in the Oxygen - desktop application:
          -
        • Use change tracking to make changes to existing content or to - accept/reject changes.
          • -
        • Use the comments support to add comments, reply to comments or + format="html" scope="external">review the content directly in the + Oxygen desktop application:
            +
          • Use change tracking to modify existing content or to accept/reject + changes.
            • +
          • Use the comments feature to add comments, reply to comments, or resolve them.
          • -
        • Internal review content using the Review content internally using the Content Fusion platform.
          • -
        • Internal or external review by publishing to WebHelp Responsive output and - using the Feedback platform.
          • +
        • Review content internally or externally by publishing it to WebHelp + Responsive output and using the Feedback platform.

    Translate -

    Oxygen has support to:

      -
    • Export from the DITA Maps Manager view a DITA Map as a zip in order - to provide it to a translation agency.
      • -
    • Fluenta DITA Translation Add-on - Use the Fluenta third party library to - create XLiff exports from DITA Maps and to import DITA Maps from translated +

      Oxygen provides support for:

        +
      • Exporting a DITA Map as a zip file from the DITA Maps Manager view, + which can be sent to a translation agency.
        • +
      • Using the Fluenta DITA Translation Add-on, a third-party library, to + generate XLiff exports from DITA Maps and import DITA Maps from translated XLiff files.

      -

      An in depth article about translation:

      +

      For a more detailed explanation of the translation process, please refer to the + following article:

    Publishing -

    Oxygen's bundled Oxygen Publishing Engine based on the DITA Open - Toolkit open source project allows publishing DITA XML content to Oxygen comes with a built-in Oxygen Publishing Engine that is based on the + DITA Open Toolkit open source project. This engine allows you to publish + DITA XML content to various outputs like WebHelp + format="html" scope="external">various outputs such as WebHelp Responsive, PDF (CSS customization based), PDF (XSL-FO - customization based), MS Word, EPUB, Windows Help, Markdown and other.

    -

    The WebHelp Responsive and PDF (CSS customization based) outputs can be - customized by creating publishing templates:

      + customization based), MS Word, EPUB, Windows Help, Markdown, and more.

      +

      You can customize the WebHelp Responsive and PDF (CSS customization + based) outputs by creating publishing templates in two ways:

      • By using the Oxygen Styles Basket Web Site.
        • -
      • By using the user's guide articles and samples to customise the CSSs: .
        • +
      • By following the user's guide articles and samples to customize the CSS + files: .

      -

      Some more articles about publishing customizations: .

      +

      For more information about publishing customizations, see the following articles: + .