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 a3b5338 commit 82dc236
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion git-tech-writers/git_client_applications.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<li><b>SourceTree</b></li>
<li><b>GitHub Desktop</b></li>
<li><b>Git</b> console</li>
<li><xref href="https://www.oxygenxml.com/doc/ug-editor/topics/git-addon.html" format="html"
<li><xref href="https://www.oxygenxml.com/doc/ug-addons/topics/git-addon.html" format="html"
scope="external"><b>Git Client</b></xref> add-on in Oxygen XML Editor</li>
<li>Web-based clients like Oxygen <xref href="https://www.oxygenxml.com/xml_web_author.html"
format="html" scope="external"><b>Web Author</b></xref>
Expand Down
2 changes: 1 addition & 1 deletion git-tech-writers/git_validation.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
</ul></li>
<li>Validate on the client side before committing or pushing changes. For example,
the Oxygen <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/git-addon.html#git-addon__section_lvb_pqy_kpb"
href="https://www.oxygenxml.com/doc/ug-addons/topics/git-addon.html#git-addon__section_lvb_pqy_kpb"
format="html" scope="external">Git Client add-on</xref> allows two types of
client side validation:<ul id="ul_usj_ftj_5wb">
<li>Validate modified resources before committing.</li>
Expand Down
4 changes: 2 additions & 2 deletions topics/10_things_i_enjoy_about_the_new_oxygen_json_editor.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@
</ul></li>
<li>As another neat feature of being an Oxygen application, in the Oxygen JSON
Editor, you can install useful free add-ons like the <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/git-addon.html"
href="https://www.oxygenxml.com/doc/ug-addons/topics/git-addon.html"
format="html" scope="external">Git client-add on</xref>, <b
id="b_fvz_y1c_d1c">Batch Documents Converter</b>, or the <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/xsd-to-json-schema-converter-x2.html"
href="https://www.oxygenxml.com/doc/ug-addons/topics/xsd-to-json-schema-converter-x2.html"
format="html" scope="external">JSON Schema Documentation generator
add-on</xref>.</li>
<li>All the nifty conversion tools (<b id="b_ehv_k1c_d1c">JSON to YAML</b>, <b
Expand Down
20 changes: 10 additions & 10 deletions topics/add_ons_for_technical_documentation.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<p>Oxygen XML Author can be enhanced by installing add-ons. There are a large number of free
and useful add-ons for technical documentation writers and we will explore some of them.
Documentation and installation instructions for all Oxygen add-ons can be found <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">here</xref>.<dl id="dl_g3z_x31_dxb">
<dlentry>
<dt><xref href="ai_positron.dita"/></dt>
Expand All @@ -25,7 +25,7 @@
</dlentry>
<dlentry>
<dt><xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/fluenta-dita-translation-add-on.html"
href="https://www.oxygenxml.com/doc/ug-addons/topics/fluenta-dita-translation-add-on.html"
format="html" scope="external">Fluenta DITA Translation
Add-on</xref></dt>
<dd>Create and manage XLiff files from your DITA XML content using the Fluenta libraries.<ul>
Expand All @@ -36,13 +36,13 @@
</dlentry>
<dlentry>
<dt><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">Batch Documents Converter</xref></dt>
<dd>Convert various formats like Word, HTML, Markdown, DocBook, Open API, or
Confluence into other formats like DITA XML.</dd>
</dlentry>
<dlentry>
<dt><xref href="https://www.oxygenxml.com/doc/ug-editor/topics/git-addon.html"
<dt><xref href="https://www.oxygenxml.com/doc/ug-addons/topics/git-addon.html"
format="html" scope="external">Git Client add-on</xref></dt>
<dd>Collaborate with your colleagues on a Git project. Comes with support for: <ul>
<li>Git Staging<ul>
Expand All @@ -54,23 +54,23 @@
</dlentry>
<dlentry>
<dt><xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/content-fusion-addon.html"
href="https://www.oxygenxml.com/doc/ug-addons/topics/content-fusion-addon.html"
format="html" scope="external">Content Fusion Connector
Add-on</xref></dt>
<dd>Create review tasks for collaborators and subject matter experts who can
later review the tasks in a web browser.</dd>
</dlentry>
<dlentry>
<dt><xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/ofb-feedback-comments-manager.html"
href="https://www.oxygenxml.com/doc/ug-addons/topics/ofb-feedback-comments-manager.html"
format="html" scope="external">Feedback Comments Manager
Add-on</xref></dt>
<dd>View and manage comments made in the Oxygen WebHelp Feedback forms directly
in the Oxygen application.</dd>
</dlentry>
<dlentry>
<dt><xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/terminology-checker-addon.html"
href="https://www.oxygenxml.com/doc/ug-addons/topics/terminology-checker-addon.html"
format="html" scope="external">Terminology Checker Add-on</xref></dt>
<dd>
<ul>
Expand All @@ -82,21 +82,21 @@
</dlentry>
<dlentry>
<dt><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></dt>
<dd>Create or explore already available tutorials to learn various Oxygen
features.</dd>
</dlentry>
<dlentry>
<dt><xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/dita-prolog-updater.html"
href="https://www.oxygenxml.com/doc/ug-addons/topics/dita-prolog-updater.html"
format="html" scope="external">DITA Prolog Updater Add-on</xref></dt>
<dd>Automatically update the author name and revision dates in the prolog
section when saving DITA topics or maps in Oxygen.</dd>
</dlentry>
<dlentry>
<dt><xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/dita-outgoing-references-addon.html"
href="https://www.oxygenxml.com/doc/ug-addons/topics/dita-outgoing-references-addon.html"
format="html" scope="external">DITA References View Add-on</xref></dt>
<dd>See the set of outgoing and incoming references for each opened DITA topic,
including references defined in a relationship table.</dd>
Expand Down
6 changes: 3 additions & 3 deletions topics/ai-positron-assistant-retrospective-analysis.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,15 @@
</section>
<section><title>Predefined actions</title>Over time, we improved how we write prompts for
the many <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/ai_positron.html#ai_positron__section_z5l_qbx_jbc"
href="https://www.oxygenxml.com/doc/ug-addons/topics/ai_positron.html#ai_positron__section_z5l_qbx_jbc"
format="html" scope="external">predefined actions</xref> that come with the add-on.
For each action, we try to give a clear prompt with lots of details so the AI engine can
produce the best results. We test our predefined actions using both manual and automatic
tests. We got the best results with Open AI GPT-4 engines and the engines provided by
<b>Anthropic Claude</b>, like <b>Sonnet</b>.</section>
<section><title>Custom actions</title>We wanted to give companies the flexibility to create
their own <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/ai_positron.html#ai_positron__section_rly_wp4_wxb"
href="https://www.oxygenxml.com/doc/ug-addons/topics/ai_positron.html#ai_positron__section_rly_wp4_wxb"
format="html" scope="external">custom actions</xref> using specific prompts to solve
their unique problems. With the add-on, we provide a <b>JSON</b> schema that defines all
aspects of implementing custom AI actions. The key to a successful action is to make it
Expand All @@ -77,7 +77,7 @@
Draft</uicontrol> use the AI engine to expand existing content and create
valid DITA XML content. Since AI engines can make mistakes if they don't have
enough details, we added support for <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/ai_positron.html#ai_positron__ai-p-rag"
href="https://www.oxygenxml.com/doc/ug-addons/topics/ai_positron.html#ai_positron__ai-p-rag"
format="html" scope="external"><b>RAG</b></xref> (retrieval augmented
generation) functions. These functions use the existing project content to give
the AI engine enough useful information to create new DITA XML content. A common
Expand Down
14 changes: 7 additions & 7 deletions topics/ai_positron.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
<ul id="ul_sdg_1x5_4bc">
<li>Oxygen desktop allows installing two flavors of the add-on:<ul id="ul_rqp_cx5_4bc">
<li>
<p><xref href="https://www.oxygenxml.com/doc/ug-editor/topics/ai_positron.html"
<p><xref href="https://www.oxygenxml.com/doc/ug-addons/topics/ai_positron.html"
format="html" scope="external">AI Positron Assistant add-on</xref>.</p>
<p>This add-on works through a subscription-based model using the <xref
href="https://www.oxygenxml.com/aipositron/user_terms.html" format="html"
Expand All @@ -51,7 +51,7 @@
</li>
<li>
<p><xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/ai_positron_enterprise.html"
href="https://www.oxygenxml.com/doc/ug-addons/topics/ai_positron_enterprise.html"
format="html" scope="external">AI Positron Assistant Enterprise add-on.</xref></p>
<p>This add-on allows end users to connect to their own AI engine server. The
following connection types are supported:<ul id="ul_twp_5z5_4bc">
Expand Down Expand Up @@ -89,7 +89,7 @@
<p>After installing the add-on, the following features are available in the Oxygen desktop:<ul
id="ul_b43_ldv_4bc">
<li><xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/ai_positron.html#ai_positron__section_a3d_sgl_4xb"
href="https://www.oxygenxml.com/doc/ug-addons/topics/ai_positron.html#ai_positron__section_a3d_sgl_4xb"
format="html" scope="external">AI Positron Assistant</xref> side view. This side view
contains the following functionality:<ul id="ul_np4_ndv_4bc">
<li>Invoke various actions to generate and re-write content using AI.</li>
Expand All @@ -115,7 +115,7 @@
content in the chat pane (within the <uicontrol>AI Positron Assistant</uicontrol> view)
that can be used to solve the problem.</li>
<li>The add-on contributes two <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/ai_positron.html#ai_positron__section_j1x_jk3_qxb"
href="https://www.oxygenxml.com/doc/ug-addons/topics/ai_positron.html#ai_positron__section_j1x_jk3_qxb"
format="html" scope="external">XPath extension functions</xref>
(<codeph>ai:transform-content</codeph> and <codeph>ai:verify-content</codeph>) that
can be used to rephrase content or to perform validation checks on existing
Expand All @@ -125,15 +125,15 @@
<section id="section_hph_m3v_4bc">
<title>Predefined and Custom Actions</title>
<p>Once you log in to the server, a <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/ai_positron.html#ai_positron__section_utc_twz_1xb"
href="https://www.oxygenxml.com/doc/ug-addons/topics/ai_positron.html#ai_positron__section_utc_twz_1xb"
format="html" scope="external">set of predefined actions</xref> are available, grouped in
categories: <b>Accessibility</b>, <b>Content Generation</b>, <b>Development</b>,
<b>Rewrite</b>, <b>Overview</b>, <b>Marketing</b>, and <b>Translation</b>. The <xref
href="https://github.com/oxygenxml-incubator/ai-positron-assistant-samples/blob/main/README.md"
format="html" scope="external">AI Positron Assistant Samples Playground</xref> samples
project contains useful samples to test the functionality of these actions.</p>
<p><xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/ai_positron.html#ai_positron__section_rly_wp4_wxb"
href="https://www.oxygenxml.com/doc/ug-addons/topics/ai_positron.html#ai_positron__section_rly_wp4_wxb"
format="html" scope="external">Custom actions</xref> can also be created and used. The
same <xref
href="https://github.com/oxygenxml-incubator/ai-positron-assistant-samples/tree/main/Custom%20Actions"
Expand All @@ -151,7 +151,7 @@
<section id="section_bws_2lv_4bc">
<title>Batch Processing</title>
<p>The <xref
href="https://www.oxygenxml.com/doc/ug-editor/topics/ai_positron.html#ai_positron__ai_refactoring"
href="https://www.oxygenxml.com/doc/ug-addons/topics/ai_positron.html#ai_positron__ai_refactoring"
format="html" scope="external"><b>AI Positron Refactoring</b></xref> actions added to the
<b>Project</b> and <b>DITA Maps Manager</b> views are a way to run actions on multiple
files. For example, you could use the predefined <uicontrol>Translate to</uicontrol> action
Expand Down

0 comments on commit 82dc236

Please sign in to comment.