Skip to content

Commit

Permalink
Fixed broken links to add-ons UG
Browse files Browse the repository at this point in the history
  • Loading branch information
@raducoravu
raducoravu committed Dec 6, 2024
1 parent 82dc236 commit eecbb24
Show file tree
Hide file tree
Showing 21 changed files with 45 additions and 54 deletions.
2 changes: 1 addition & 1 deletion topics/building_validating_and_publishing_using_github_actions.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
format="gradle" scope="external">Gradle build file</xref> that
downloads the <b>Oxygen Publishing Engine</b>, licenses it, produces the
output, and stores it in a specific folder.</li>
<li>Create a <b>GitHub</b> action that runs the build file and then uses the <xref href="https://github.com/aws-actions/configure-aws-credentials" format="html" scope="external">aws-actions/configure-aws-credentials</xref> action to configure the AWS credentials, followed by the <xref href="https://github.com/aws-actions/s3-sync" format="html" scope="external">aws-actions/s3-sync</xref> action to sync the output folder with the S3 bucket.</li>
<li>Create a <b>GitHub</b> action that runs the build file and then uses the <xref href="https://github.com/aws-actions/configure-aws-credentials" format="html" scope="external">aws-actions/configure-aws-credentials</xref> action to configure the AWS credentials, followed by the <xref href="https://github.com/aws-actions" format="html" scope="external">aws-actions/s3-sync</xref> action to sync the output folder with the S3 bucket.</li>
</ol></li>
<li>Validate the entire DITA project using the Oxygen <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/scripting_oxygen_dita_validate_and_check_for_completeness.html"
Expand Down
2 changes: 1 addition & 1 deletion topics/dita-xml-editing-collaboration-and-publishing-overview.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@
<section id="section_myn_1yg_4bc">
<title>Useful Add-ons</title>
<p>The Oxygen default add-ons repository provides a range of <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/add-ons.html" format="html"
href="https://www.oxygenxml.com/doc/ug-addons/topics/add-ons.html" format="html"
scope="external">helpful add-ons</xref>. Some of the most notable ones
include:<ul id="ul_e2k_13h_4bc">
<li><b>Git Client</b> add-on - Allows you to connect to Git repositories.</li>
Expand Down
4 changes: 1 addition & 3 deletions topics/ditaToPDF.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@
scope="external">TopLeaf</xref> XML Publisher commercial product allows you to produce
various outputs like PDF and EPUB from XML content. The application also has a visual PDF
layout formatter, it comes also with a DITA OT plugin and has installation instructions
for Oxygen:<xref
href="https://turnkey.com.au/topleaf-downloads/"
format="html" scope="external"/>.</li>
for Oxygen.</li>
<li><xref href="https://www.miramo.com/download/documentation/Miramo_DITA-OT_GettingStarted.pdf" format="html" scope="external"
>Miramo</xref>, again a commercial solution which recently started developing support
for DITA using a DITA OT plugin. Possibly user based DITA to PDF publishing will be free
Expand Down
6 changes: 3 additions & 3 deletions topics/dita_for_small_teams.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -125,15 +125,15 @@
format="html" scope="external">Oxygen Web Author</xref> to connect to
the Git Repository and create a new topic or modify an existing one.</li>
<li>Clone the repository to the local file system using Oxygen XML Author with
the <xref href="https://github.com/oxygenxml/Oxygen-Git-Plugin"
the <xref href="https://www.oxygenxml.com/doc/ug-addons/topics/git-addon.html"
format="html" scope="external">Git Add-on</xref> installed.</li>
</ul></p>
</section>
<section id="section_khz_rxy_tkb">
<title>Using Oxygen XML Author to Create/Modify Content in the Repository</title>
<p>
<ul id="ul_cf2_5xy_tkb">
<li>Install the <xref href="https://github.com/oxygenxml/Oxygen-Git-Plugin"
<li>Install the <xref href="https://www.oxygenxml.com/doc/ug-addons/topics/git-addon.html"
format="html" scope="external">Git Add-on</xref> in Oxygen XML
Author.</li>
<li>Open the <uicontrol>Git Staging</uicontrol> view and use the
Expand Down Expand Up @@ -356,7 +356,7 @@
href="https://www.oxygenxml.com/oxygen_scripting.html" format="html"
scope="external">special scripting license</xref> on pull requests. An
example for such a validation action is in the Oxygen XML Blog: <xref
href="https://github.com/oxygenxml/blog/blob/master/.github/workflows/workflow.yml"
href="https://github.com/oxygenxml/blog/blob/master/.github/workflows/"
format="yml" scope="external"/>. The validation runs on any opened pull
request: <xref href="https://github.com/oxygenxml/blog/pull/25"
format="html" scope="external"/>.</li>
Expand Down
9 changes: 4 additions & 5 deletions topics/dita_oriented_tips_and_tricks.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,19 @@
format="html" scope="external">Oxygen standalone version</xref>. I will enumerate some of
the most interesting one:</p>
<ul id="ul_xbw_ccs_gfb">
<li><xref href="https://github.com/oxygenxml/oxygen-git-plugin" format="html"
scope="external">Git add-on</xref>. This plugin adds a side view allowing you to do some
<li>Git add-on. This plugin adds a side view allowing you to do some
common Git operations like pull, commit, push (mostly 90% of what a regular Git user would
do).</li>
<li><xref href="https://www.oxygenxml.com/doc/ug-editor/topics/content-fusion-addon.html"
<li><xref href="https://www.oxygenxml.com/doc/ug-addons/topics/content-fusion-addon.html"
format="html" scope="external">Content Fusion Connector add-on</xref>. Collaborate with
your peers by sending them links that allow them to give you feedback on your work using a
web browser without the need to pre-install anything on their side. </li>
<li><xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/translation-package-builder-addon.html"
href="https://www.oxygenxml.com/doc/ug-addons/topics/translation-package-builder-addon.html"
format="html" scope="external">Translation package builder</xref>. Small plugin that can
be used to prepare a zip file containing only the topics that have changed from one
version to another.</li>
<li><xref href="https://www.oxygenxml.com/doc/ug-editor/topics/batch-converter-addon.html"
<li><xref href="https://www.oxygenxml.com/doc/ug-addons/topics/batch-converter-addon.html"
format="html" scope="external">Batch convertor add-on</xref>. Converts multiple HTML,
Markdown, Excel files to DITA.</li>
</ul>
Expand Down
4 changes: 2 additions & 2 deletions topics/exampleOfADITAImplementationFortech.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<p>We store our DITA content in a private <b>GitHub</b> repository and we also made a public
<b>GitHub</b> repository containing a copy of our user manual's DITA content:<xref
href="https://github.com/oxygenxml/userguide" format="html" scope="external"/>. We use the
free Oxygen <xref href="https://www.oxygenxml.com/doc/ug-editor/topics/git-addon.html"
free Oxygen <xref href="https://www.oxygenxml.com/doc/ug-addons/topics/git-addon.html"
format="html" scope="external">Git client add-on</xref> for collaborating on the project.
Other external Git clients like <b>SourceTree</b> or <b>Fork</b> can also be used to check
out, edit and push changes to the Git repository. Our editing workflow is similar to what is
Expand All @@ -64,7 +64,7 @@
</section>
<section id="section_wvl_dgw_z5b">
<title>Oxygen Content Fusion</title>
<p>The <xref href="https://www.oxygenxml.com/doc/ug-editor/topics/content-fusion-addon.html"
<p>The <xref href="https://www.oxygenxml.com/doc/ug-addons/topics/content-fusion-addon.html"
format="html" scope="external">Content Fusion add-on</xref> for XML Author allows uploading
the edited content to a cloud server and providing a web editing tool for people to provide
feedback and review the DITA content directly in a web browser: <xref
Expand Down
4 changes: 2 additions & 2 deletions topics/general_tips_and_tricks.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -374,11 +374,11 @@
<li><xref href="https://github.com/oxygenxml/oxygen-git-plugin" format="html" scope="external"
>Git add-on</xref>. This plugin adds a side view allowing you to do some common Git operations
like pull, commit, push (mostly 90% of what a regular Git user would do).</li>
<li><xref href="https://www.oxygenxml.com/doc/ug-editor/topics/content-fusion-addon.html"
<li><xref href="https://www.oxygenxml.com/doc/ug-addons/topics/content-fusion-addon.html"
format="html" scope="external">Content Fusion Connector add-on</xref>. Collaborate with your
peers by sending them links that allow them to give you feedback on your work using a web
browser without the need to pre-install anything on their side. </li>
<li><xref href="https://www.oxygenxml.com/doc/ug-editor/topics/batch-converter-addon.html"
<li><xref href="https://www.oxygenxml.com/doc/ug-addons/topics/batch-converter-addon.html"
format="html" scope="external">Batch convertor add-on</xref>. Converts multiple HTML,
Markdown, Excel files to DITA.</li>
</ul>
Expand Down
6 changes: 2 additions & 4 deletions topics/learnDita.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@
<p><xref href="https://stefan-jung.org/dita-introduction/"
format="html" scope="external">DITA Introduction</xref> articles by Stefan Jung.</p>
<p>The free Oxygen <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/live-tutorials-addon.html"
href="https://www.oxygenxml.com/doc/ug-addons/topics/live-tutorials-addon.html"
format="html" scope="external">Live Tutorials add-on</xref> contains various small
tutorials for learning DITA.</p>
<p>The DITA 1.3 standard specification can be found here: <xref
Expand All @@ -95,7 +95,7 @@
<title>Resources for customizing the DITA output formats</title>
<p>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 <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/customize_webhelp.html"
href="https://www.oxygenxml.com/doc/ug-editor/topics/wh-responsive-customization-tips.html"
format="html" scope="external">WebHelp customizations</xref>.</p>
<p>For PDF-based outputs we recommend, support and maintain our <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/pdf-css-customization.html"
Expand Down Expand Up @@ -141,8 +141,6 @@
<li><b>Udemy</b>: <xref
href="https://www.udemy.com/course/technical-writing-how-to-write-using-dita-xml/"
format="html" scope="external"/>.</li>
<li><b>Hyperwrite</b>: <xref href="http://www.hyperwrite.com/Training/crsoxygenintro.aspx"
format="aspx" scope="external"/>.</li>
<li>Basic principles and theory of DITA, 10 hour recorded training course by <b>Tony
Self</b>: <xref
href="https://firehead-training.net/course/dita-concepts" format="html"
Expand Down
4 changes: 2 additions & 2 deletions topics/migratingFmToDita.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,11 @@
Add-on</dt>
<dd>The Batch Documents Converter add-on has to be installed in Oxygen for
this step. Follow the installation procedure <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/batch-converter-addon.html"
href="https://www.oxygenxml.com/doc/ug-addons/topics/batch-converter-addon.html"
format="html" scope="external">here</xref>.</dd>
<dd>Before converting the document, you should configure which headings are
handled as topics or sections. For this, use the <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/batch-converter-addon.html#batch-converter-addon__maximumHeadingLevelForCreatingTopics"
href="https://www.oxygenxml.com/doc/ug-addons/topics/batch-converter-addon.html#batch-converter-addon__maximumHeadingLevelForCreatingTopics"
format="html" scope="external"><uicontrol>Maximum Heading Level for
Creating Topics</uicontrol></xref> options from the add-on's
preferences page.</dd>
Expand Down
16 changes: 8 additions & 8 deletions topics/migrating_to_dita.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<title>Migrating DocBook Content to DITA.</title>
<p>You can migrate one or multiple DocBook documents to DITA using the <b>Oxygen Batch
Documents Converter</b> add-on: <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/batch-converter-addon.html"
href="https://www.oxygenxml.com/doc/ug-addons/topics/batch-converter-addon.html"
format="html" scope="external"/>.</p>
<p>The <b>DocBook to DITA</b> conversion contains an option named <b>Create DITA maps from
DocBook documents containing multiple sections</b>. When this option is selected, all
Expand All @@ -40,7 +40,7 @@
format="html" scope="external"><i>Smart Paste</i></xref> functionality to copy content
from an Excel spreadsheet and paste it inside an opened DITA topic. Also, as an alternate
possibility, the <b>Oxygen Batch Documents Converter</b> add-on was updated to be able to batch
convert Excel to DITA: <xref href="https://www.oxygenxml.com/doc/ug-editor/topics/batch-converter-addon.html"
convert Excel to DITA: <xref href="https://www.oxygenxml.com/doc/ug-addons/topics/batch-converter-addon.html"
format="html" scope="external"/>.</p>
</section>
<section id="section_p4y_nv4_4gb">
Expand All @@ -60,7 +60,7 @@
as <b>DocBook</b> with <b>Libre Office</b>, then apply the <b>DocBook to DITA</b>
transformation scenario shipped in Oxygen to convert DocBook to DITA. </li>
<li>Save the Google document as HTML then use the Oxygen batch converter add-on to convert
it to DITA: <xref href="https://www.oxygenxml.com/doc/ug-editor/topics/batch-converter-addon.html"
it to DITA: <xref href="https://www.oxygenxml.com/doc/ug-addons/topics/batch-converter-addon.html"
format="html" scope="external"/>.</li>
</ul></p>
</section>
Expand All @@ -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 <b>Oxygen Batch Documents Converter</b> add-on: <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/batch-converter-addon.html" format="html"
href="https://www.oxygenxml.com/doc/ug-addons/topics/batch-converter-addon.html" format="html"
scope="external"/>.</p>
</section>
<section id="section_ss1_gw4_4gb">
Expand All @@ -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 <b>Author</b> visual editing mode. If you want to convert multiple HTML files,
you can use the <b>Oxygen Batch Documents Converter</b> add-on: <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/batch-converter-addon.html" format="html"
href="https://www.oxygenxml.com/doc/ug-addons/topics/batch-converter-addon.html" format="html"
scope="external"/>.</p>
</section>
<section id="section_imj_py4_4gb">
Expand All @@ -101,7 +101,7 @@
<section id="section_hpn_vrm_lsb">
<title>Migrating Confluence Content to DITA</title>
<p>To convert Confluence content to DITA, you can use the <b>Oxygen Batch Documents Converter</b>
add-on: <xref href="https://www.oxygenxml.com/doc/ug-editor/topics/batch-converter-addon.html" format="html"
add-on: <xref href="https://www.oxygenxml.com/doc/ug-addons/topics/batch-converter-addon.html" format="html"
scope="external"/>.</p>
<p>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 <b>Space
Expand All @@ -122,7 +122,7 @@
<p>The <xref href="https://pandoc.org/" format="html" scope="external">Pandoc</xref>
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 <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/batch-converter-addon.html"
href="https://www.oxygenxml.com/doc/ug-addons/topics/batch-converter-addon.html"
format="html" scope="external">Oxygen Batch
Documents Converter</xref> add-on.</p>
</section>
Expand All @@ -131,7 +131,7 @@
<p>You may use a third-party application (like <xref href="https://pandoc.org/" format="html"
scope="external">Pandoc</xref>) to convert LaTex content to Word or HTML. Afterwards use
the <b>Oxygen Batch Documents Converter</b>: <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/batch-converter-addon.html"
href="https://www.oxygenxml.com/doc/ug-addons/topics/batch-converter-addon.html"
format="html" scope="external"/></p>
</section>
<section id="section_zv4_hy4_4gb">
Expand Down
4 changes: 2 additions & 2 deletions topics/migrating_word_to_dita_bdc/converting_word_document.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
</prolog>
<body>
<p>For converting the Word document you have to install the Batch Documents
Converter add-on in Oxygen. For this, you can follow the <xref href="https://www.oxygenxml.com/doc/ug-editor/topics/batch-converter-addon.html#batch-converter-addon__section_tdq_wvx_qsb" format="html" scope="external">installation procedure</xref>
Converter add-on in Oxygen. For this, you can follow the <xref href="https://www.oxygenxml.com/doc/ug-addons/topics/batch-converter-addon.html#batch-converter-addon__section_tdq_wvx_qsb" format="html" scope="external">installation procedure</xref>
from the documentation.</p>
<section id="configurarea-maparii-de-stiluri">
<title>Configuring Word styles mapping</title>
Expand All @@ -22,7 +22,7 @@ PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
default styles.</p>
<p>Here you have more information about the <uicontrol>Word Styles Mapping</uicontrol>
option: <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/batch-converter-addon.html#batch-converter-addon__wordStylesMapping"
href="https://www.oxygenxml.com/doc/ug-addons/topics/batch-converter-addon.html#batch-converter-addon__wordStylesMapping"
format="html" scope="external">Conversions from Word</xref></p>
<p> This is an example of styles configuration: <xref href="frequently_asked_questions.dita#word-to-dita-frequently-asked-questions/how-to-fix-unknown-style-warnings"/></p>
</section>
Expand Down
2 changes: 1 addition & 1 deletion topics/migrating_word_to_dita_bdc/frequently_asked_questions.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
</p>
<p>For more information about the <uicontrol>Word styles mapping</uicontrol> configuration,
see the following section from the documentation: <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/batch-converter-addon.html#batch-converter-addon__wordStylesMapping"
href="https://www.oxygenxml.com/doc/ug-addons/topics/batch-converter-addon.html#batch-converter-addon__wordStylesMapping"
format="html" scope="external">Conversions from Word</xref>.</p>
</answer>
</qagroup>
Expand Down
2 changes: 1 addition & 1 deletion ...cs/migrating_word_to_dita_bdc/migrating_word_to_dita_using_batch_documents_converter.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
</critdates>
</prolog>
<body>
<p>This blog post presents how you can migrate from MS Word to DITA using the <xref href="https://www.oxygenxml.com/doc/ug-editor/topics/batch-converter-addon.html" format="html"
<p>This blog post presents how you can migrate from MS Word to DITA using the <xref href="https://www.oxygenxml.com/doc/ug-addons/topics/batch-converter-addon.html" format="html"
scope="external">Oxygen Batch Documents Converter add-on</xref>.</p>
<p>The migration process has three main stages:
<ol>
Expand Down
Loading

0 comments on commit eecbb24

Please sign in to comment.