diff --git a/topics/building_validating_and_publishing_using_github_actions.dita b/topics/building_validating_and_publishing_using_github_actions.dita index 5db5331c..831465b8 100644 --- a/topics/building_validating_and_publishing_using_github_actions.dita +++ b/topics/building_validating_and_publishing_using_github_actions.dita @@ -50,7 +50,7 @@ format="gradle" scope="external">Gradle build file that downloads the Oxygen Publishing Engine, licenses it, produces the output, and stores it in a specific folder. -
  • Create a GitHub action that runs the build file and then uses the aws-actions/configure-aws-credentials action to configure the AWS credentials, followed by the aws-actions/s3-sync action to sync the output folder with the S3 bucket.
    • +
  • Create a GitHub action that runs the build file and then uses the aws-actions/configure-aws-credentials action to configure the AWS credentials, followed by the aws-actions/s3-sync action to sync the output folder with the S3 bucket.
  • Validate the entire DITA project using the Oxygen Useful Add-ons

    The Oxygen default add-ons repository provides a range of helpful add-ons. Some of the most notable ones include:

    @@ -133,7 +133,7 @@ Using Oxygen XML Author to Create/Modify Content in the Repository

    diff --git a/topics/learnDita.dita b/topics/learnDita.dita index c2a97072..0731f29b 100644 --- a/topics/learnDita.dita +++ b/topics/learnDita.dita @@ -77,7 +77,7 @@

    DITA Introduction articles by Stefan Jung.

    The free Oxygen Live Tutorials add-on contains various small tutorials for learning DITA.

    The DITA 1.3 standard specification can be found here: Resources for customizing the DITA output formats

    Usually customizing the XHTML based outputs means creating your custom CSS selectors. If you generate WebHelp output using Oxygen, we have a section explaining basic WebHelp customizations.

    For PDF-based outputs we recommend, support and maintain our Udemy: .

    • -
  • Hyperwrite: .
  • Basic principles and theory of DITA, 10 hour recorded training course by Tony Self:
    The Batch Documents Converter add-on has to be installed in Oxygen for this step. Follow the installation procedure here.
    Before converting the document, you should configure which headings are handled as topics or sections. For this, use the Maximum Heading Level for Creating Topics options from the add-on's preferences page.
    diff --git a/topics/migrating_to_dita.dita b/topics/migrating_to_dita.dita index 84781f0f..90d8f3bc 100644 --- a/topics/migrating_to_dita.dita +++ b/topics/migrating_to_dita.dita @@ -19,7 +19,7 @@ Migrating DocBook Content to DITA.

    You can migrate one or multiple DocBook documents to DITA using the Oxygen Batch Documents Converter add-on: .

    The DocBook to DITA conversion contains an option named Create DITA maps from DocBook documents containing multiple sections. When this option is selected, all @@ -40,7 +40,7 @@ format="html" scope="external">Smart Paste functionality to copy content from an Excel spreadsheet and paste it inside an opened DITA topic. Also, as an alternate possibility, the Oxygen Batch Documents Converter add-on was updated to be able to batch - convert Excel to DITA: .

    @@ -60,7 +60,7 @@ as DocBook with Libre Office, then apply the DocBook to DITA transformation scenario shipped in Oxygen to convert DocBook to DITA.
  • Save the Google document as HTML then use the Oxygen batch converter add-on to convert - it to DITA: .

    • @@ -72,7 +72,7 @@ href="https://www.oxygenxml.com/doc/ug-editor/topics/markdown-dita-2.html" format="html" scope="external"/>. If you want to convert multiple Markdown documents at once, you can use the Oxygen Batch Documents Converter add-on: .

    @@ -83,7 +83,7 @@ HTML documents in a web browser, then copy the contents and paste it in a DITA topic opened in Oxygen's Author visual editing mode. If you want to convert multiple HTML files, you can use the Oxygen Batch Documents Converter add-on: .

    @@ -101,7 +101,7 @@
    Migrating Confluence Content to DITA

    To convert Confluence content to DITA, you can use the Oxygen Batch Documents Converter - add-on: .

    You first need to export the content to HTML. For this, log in to your Confluence account and navigate to the specific space that you want to export. Then go to Space @@ -122,7 +122,7 @@

    The Pandoc third-party application can be used to convert reStructuredText content to DocBook or HTML. Then, you can convert the DocBook or HTML content to DITA using the Oxygen Batch Documents Converter add-on.

    @@ -131,7 +131,7 @@

    You may use a third-party application (like Pandoc) to convert LaTex content to Word or HTML. Afterwards use the Oxygen Batch Documents Converter:

    diff --git a/topics/migrating_word_to_dita_bdc/converting_word_document.dita b/topics/migrating_word_to_dita_bdc/converting_word_document.dita index 37022def..0f8c1a29 100644 --- a/topics/migrating_word_to_dita_bdc/converting_word_document.dita +++ b/topics/migrating_word_to_dita_bdc/converting_word_document.dita @@ -11,7 +11,7 @@ PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">

    For converting the Word document you have to install the Batch Documents - Converter add-on in Oxygen. For this, you can follow the installation procedure + Converter add-on in Oxygen. For this, you can follow the installation procedure from the documentation.

    Configuring Word styles mapping @@ -22,7 +22,7 @@ PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> default styles.

    Here you have more information about the Word Styles Mapping option: Conversions from Word

    This is an example of styles configuration:

    diff --git a/topics/migrating_word_to_dita_bdc/frequently_asked_questions.dita b/topics/migrating_word_to_dita_bdc/frequently_asked_questions.dita index e401ff46..76fd0b1f 100644 --- a/topics/migrating_word_to_dita_bdc/frequently_asked_questions.dita +++ b/topics/migrating_word_to_dita_bdc/frequently_asked_questions.dita @@ -63,7 +63,7 @@

    For more information about the Word styles mapping configuration, see the following section from the documentation: Conversions from Word.

    diff --git a/topics/migrating_word_to_dita_bdc/migrating_word_to_dita_using_batch_documents_converter.dita b/topics/migrating_word_to_dita_bdc/migrating_word_to_dita_using_batch_documents_converter.dita index 7e4a998e..185cd13b 100644 --- a/topics/migrating_word_to_dita_bdc/migrating_word_to_dita_using_batch_documents_converter.dita +++ b/topics/migrating_word_to_dita_bdc/migrating_word_to_dita_using_batch_documents_converter.dita @@ -10,7 +10,7 @@ PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> -

    This blog post presents how you can migrate from MS Word to DITA using the This blog post presents how you can migrate from MS Word to DITA using the Oxygen Batch Documents Converter add-on.

    The migration process has three main stages:

      diff --git a/topics/oxygen_xml_as_a_technical_documentation_solution_faq.dita b/topics/oxygen_xml_as_a_technical_documentation_solution_faq.dita index bcfb1fd5..a59614b3 100644 --- a/topics/oxygen_xml_as_a_technical_documentation_solution_faq.dita +++ b/topics/oxygen_xml_as_a_technical_documentation_solution_faq.dita @@ -53,7 +53,7 @@ documentation project in one of these ways:

      • We have clients who use Oxygen's Git client add-on to collaborate on the same project using a Git diff --git a/topics/similarities_tech_docs_soft_engs.dita b/topics/similarities_tech_docs_soft_engs.dita index 2c7f624c..0f2f716a 100644 --- a/topics/similarities_tech_docs_soft_engs.dita +++ b/topics/similarities_tech_docs_soft_engs.dita @@ -333,7 +333,7 @@
      • The foreign element allows adding non DITA XML content and can be used for various enhancements like embedding HTML content directly in DITA topics.
      • The data element can be used almost diff --git a/topics/startup_dita_project.dita b/topics/startup_dita_project.dita index d2a90c81..b70016db 100644 --- a/topics/startup_dita_project.dita +++ b/topics/startup_dita_project.dita @@ -35,7 +35,7 @@ the DITA content when publishing.
      • images - Contains images used in the DITA project.
      • oxygen-term-checker - Contains a terminology file with an example rule.
      • publishing - Contains a Terminology Checking

        For checking terminology, you can use the Oxygen Terminology Checker add-on. You can add terminology rules to the oxygen-term-checker folder. For example, the Oxygen user manual uses a set of Vale rules to check for

        The Fluenta DITA Translation add-on can help with all of these steps.

        diff --git a/topics/useful-dita-ot-plugins.dita b/topics/useful-dita-ot-plugins.dita index 817979bc..4c87107e 100644 --- a/topics/useful-dita-ot-plugins.dita +++ b/topics/useful-dita-ot-plugins.dita @@ -44,7 +44,7 @@ Use Markdown content directly in DITA Maps

        This plugin developed by Jarno Elovirta can be used to publish hybrid DITA projects containing both DITA and Markdown topics to any output format: .

        + href="https://github.com/jelovirt/org.lwdita" format="html" scope="external"/>.

    Embed video and audio resources in DITA topics diff --git a/topics/using_git_hooks_with_dita.dita b/topics/using_git_hooks_with_dita.dita index 7b334ada..fd9e75b8 100644 --- a/topics/using_git_hooks_with_dita.dita +++ b/topics/using_git_hooks_with_dita.dita @@ -4,7 +4,7 @@ Using Git client-side hooks to run DITA publishing pipelines This topic describes how to use Git client-side hooks to execute DITA commands and publishing workflows, with an emphasis on using the Oxygen's Git Client. Alex Jitianu @@ -21,9 +21,7 @@ library relies on CYGWIN to run the Git hooks. CYGWIN must be installed and added to the path. -
  • If you are running on Windows, you either need an Oxygen Git client version 2.0.0 or one newer than +
  • If you are running on Windows, you either need an Oxygen Git client version 2.0.0 or one newer than 2.1.1 (at the time this post is written, 2.1.1 was the latest version, but a new one will soon be released). We are basically avoiding versions that come bundled with JGit 5.6.0, which has this
  • Uninstall the current Oxygen Git client version, if one is present.
    • -
  • Download Oxygen Git client version 2.0.0.
    • +
  • Download Oxygen Git client version 2.0.0.
  • Unzip it inside {oxygenInstallDir}/plugins. Make sure you don't create any intermediate folders. The path should be like this: {oxygenInstallDir}/git.support-2.0.0/plugin.xml.
    • @@ -56,7 +52,7 @@ Using a client side hook with a DITA project

    The main scenario we are focusing on in this topic is about using client-side hooks while working with DITA and storing it in a Git repository, and how to enable Oxygen’s - built-in Git Client to execute these hooks.

    @@ -146,4 +142,4 @@ ant_exec_args="$ant_exec_args \"-buildfile\" \"$BUILD_FILE\" \"-main\" \"org.dit
    - \ No newline at end of file + diff --git a/topics/webhelp-dita-strong-points.dita b/topics/webhelp-dita-strong-points.dita index 7f91268a..962d1c17 100644 --- a/topics/webhelp-dita-strong-points.dita +++ b/topics/webhelp-dita-strong-points.dita @@ -35,7 +35,7 @@
  • It contains its own search engine implemented in Javascript (with support for AND, OR, exact match, auto complete, and highlights). The search engine can assign various weights and priorities to various elements..
  • It automatically generates an Index page if the DITA content contains index elements.
    • diff --git a/topics/welcome.dita b/topics/welcome.dita index 23158356..c27867be 100644 --- a/topics/welcome.dita +++ b/topics/welcome.dita @@ -36,7 +36,7 @@ contents) the blog was migrated to DITA XML content stored on GitHub and is now hosted both on the Oxygen XML Web site and on the Netlify platform: .

    + href="https://oxygenxmlblog.netlify.app/" format="html" scope="external"/>.

    How the <ph keyref="oxygen"/> Blog Works @@ -86,7 +86,7 @@
  • Make changes to your forked project or to a branch from it.
    • If you have the application installed, you can - download our Git add-on that should allow you to clone the fork, make changes, and then commit and push them to your repository.
      • @@ -111,7 +111,7 @@
    • After all changes have been made to your fork of the project, you can create a pull request to the original GitHub project.
    • There is a GitHub action implemented in the project which will automatically run DITA validation on the entire project branch and will report on the pull request if the validation is successful.