Skip to content

Commit 584114e

Browse files
committed
Convert dls to sections
1 parent fe6ba8e commit 584114e

File tree

1 file changed

+130
-139
lines changed

1 file changed

+130
-139
lines changed

topics/oxygen_xml_as_a_technical_documentation_solution_faq.dita

Lines changed: 130 additions & 139 deletions
Original file line numberDiff line numberDiff line change
@@ -12,144 +12,135 @@
1212
</critdates>
1313
</prolog>
1414
<body>
15-
<dl id="dl_gdg_wwf_f1c">
16-
<dlentry>
17-
<dt>What does Oxygen XML provide as a tool to a technical documentation team?</dt>
18-
<dd>
19-
<p>Oxygen is a <b>DITA XML</b> desktop editing tool that can be used by
20-
technical documentation writers to <b>write</b>, <b>reuse</b>, and
21-
<b>publish</b> DITA XML content to a variety of output formats, such as
22-
<b>WebHelp Responsive</b> and <b>PDF</b>.</p>
23-
<p>Some of our strong capabilities are listed <xref
24-
href="oxygen-dita-strong-points.dita">here</xref>.</p>
25-
</dd>
26-
</dlentry>
27-
<dlentry>
28-
<dt>To which companies would you recommend a DITA XML based solution for writing
29-
technical documentation?</dt>
30-
<dd>I would recommend the use of the DITA XML standard for writing technical
31-
documentation with Oxygen XML as an editing tool to companies that have one of
32-
the following conditions fulfilled:<ul id="ul_ef1_wbn_f1c">
33-
<li>They have multiple similar products and want to take advantage of DITA
34-
XML high reuse capabilities and condition profiling/filters to produce
35-
multiple similar, but not identical, manuals from the same project.</li>
36-
<li>They want to add structure-based validation rules that must be followed
37-
by all members of a team.</li>
38-
<li>They want to create their own custom vocabulary of semantic
39-
elements.</li>
40-
<li>Besides web-based outputs, they also want to produce PDFs and want to
41-
have a relatively high degree of control over the PDF
42-
customization.</li>
43-
</ul>More details here: <xref
44-
href="types_of_companies_which_would_benefit_from_the_dita_xml_standard.dita"
45-
/>.</dd>
46-
</dlentry>
47-
<dlentry>
48-
<dt>Is Oxygen a Content Management System?</dt>
49-
<dd>
50-
<p><b>Oxygen</b> is not a <b>content management system</b>, we do not store the
51-
content that you are editing on our side. </p>
52-
<p>Our clients use <b>Oxygen XML</b> for collaboration on a technical
53-
documentation project in one of these ways:</p>
54-
<ul id="ul_scc_cxf_f1c">
55-
<li>We have clients who use Oxygen's <xref
56-
href="https://www.oxygenxml.com/doc/ug-addons/topics/git-addon.html"
57-
format="html" scope="external"><b>Git client add-on</b></xref> to
58-
collaborate on the same project using a <xref
59-
href="../git-tech-writers/using_git_for_technical_writing.dita">Git
60-
repository</xref>.</li>
61-
<li><b>Oxygen</b> also has built-in support for working with <xref
62-
href="https://www.oxygenxml.com/doc/ug-editor/topics/sharepoint-connection.html"
63-
format="html" scope="external"><b>SharePoint</b></xref> repositories
64-
if you want to store the edited content on <b>SharePoint</b>.</li>
65-
<li>There are commercial <b>CMSs</b> (content management systems) that have
66-
integrations with <b>Oxygen</b>. Some of them are listed <xref
67-
href="https://www.oxygenxml.com/partners.html#cmssolutionpartners"
68-
format="html" scope="external">here</xref>. These commercial content
69-
management systems such as <b>Astoria</b>, <b>Bluestream</b>,
70-
<b>Componize</b> usually have plugins that allow <b>Oxygen</b> to
71-
connect to the <b>CMS</b> remote storage, open documents, edit and save
72-
them back. But the price of the commercial content management systems is
73-
separate from the price of an <b>Oxygen</b> license.</li>
74-
</ul>
75-
</dd>
76-
</dlentry>
77-
<dlentry>
78-
<dt>What Oxygen products should I buy for our technical documentation team?</dt>
79-
<dd>All of our prices are transparently available <xref
80-
href="https://www.oxygenxml.com/buy.html" format="html" scope="external"
81-
>here</xref>. <p>The usual purchase suggestion for a technical writer's team
82-
is something like this:</p><p>
83-
<ul id="ul_b5l_yxf_f1c">
84-
<li>
85-
<p>One permanent user-based license of Oxygen XML Editor
86-
Professional: <xref
87-
href="https://www.oxygenxml.com/buy_new_licenses_professional_smp.html"
88-
format="html" scope="external"/>.</p>
89-
<p>This one license would be for the person who is in charge of
90-
customizing the published output as well as writing content.</p>
91-
</li>
92-
<li>
93-
<p>A permanent license of Oxygen XML Author professional for each
94-
full time tech writer: <xref
95-
href="https://www.oxygenxml.com/buy_new_licenses_author_professional_smp.html"
96-
format="html" scope="external"/>.</p>
97-
<p>The <b>Oxygen XML Author</b> allows writers to visually edit
98-
<b>DITA XML</b> content and to publish it to <b>WebHelp</b>,
99-
<b>PDF</b>, and other formats.</p>
100-
</li>
101-
<li>
102-
<p>Any other occasional contributor or reviewer (subject matter
103-
experts or engineers, for example) can use our Content Fusion
104-
platform to give feedback on the content directly from a web
105-
browser. </p>
106-
<p>A video of how <b>Content Fusion</b> Works: <xref
107-
href="https://www.oxygenxml.com/content_fusion/take_a_tour.html"
108-
format="html" scope="external"/>.</p>
109-
<p>And the pricing, depending on the number of people who would
110-
simultaneously review the content: <xref
111-
href="https://www.oxygenxml.com/content_fusion/buy_content_fusion.html"
112-
format="html" scope="external"/>.</p>
113-
</li>
114-
</ul>
115-
</p></dd>
116-
</dlentry>
117-
<dlentry>
118-
<dt>What type of customer support and training will I get from the Oxygen team?</dt>
119-
<dd>
120-
<p>We help customers with advice and any problems they encounter when using our
121-
application. </p>
122-
<p>For example, if you want to create your own publishing customizations, these
123-
are usually done using CSS. You would have one colleague on your side
124-
creating the customization and asking us questions along the way. We do not
125-
implement full customizations for you, but we guide you along the way.</p>
126-
<p>As for training, we have lots of videos and online resources for learning to
127-
use Oxygen to produce technical documentation: <xref
128-
href="learnDita.dita"/>.</p>
129-
<p>We can offer you a one-time web meeting to show you how Oxygen works in
130-
general, but if you want a more rigorous training, we have partners like
131-
Ryffine or Mekon who offer such courses: <xref
132-
href="learnDita.dita#learnDita/section_rqq_nhj_4jb"/>.</p>
133-
</dd>
134-
</dlentry>
135-
<dlentry>
136-
<dt>How can I convert my current content to DITA XML?</dt>
137-
<dd>You can find advice about how to convert various document formats to DITA XML
138-
<xref
139-
href="https://www.oxygenxml.com/doc/ug-editor/topics/dita-migrating-various-formats.html"
140-
format="html" scope="external">here</xref>. For any other document format,
141-
the advice is to possibly try to export it to HTML content and then use the free
142-
Oxygen <b>Batch Documents Converter</b> add-on.</dd>
143-
</dlentry>
144-
<dlentry>
145-
<dt>Do you have case studies or references from companies who are successfully using
146-
Oxygen? </dt>
147-
<dd>Some of our customers who have agreed to be officially listed are mentioned
148-
here: <xref href="https://www.oxygenxml.com/customers.html" format="html"
149-
scope="external"/>.</dd>
150-
<dd>Also some testimonials: <xref href="https://www.oxygenxml.com/case_studies.html"
151-
format="html" scope="external"/>.</dd>
152-
</dlentry>
153-
</dl>
15+
<section id="section_pyy_klr_sdc">
16+
<title>What does Oxygen XML provide as a tool to a technical documentation team?</title>
17+
<p>Oxygen is a <b>DITA XML</b> desktop editing tool that can be used by technical
18+
documentation writers to <b>write</b>, <b>reuse</b>, and <b>publish</b> DITA XML
19+
content to a variety of output formats, such as <b>WebHelp Responsive</b> and
20+
<b>PDF</b>.</p>
21+
<p>Some of our strong capabilities are listed <xref
22+
href="oxygen-dita-strong-points.dita">here</xref>.</p>
23+
</section>
24+
<section id="section_rqv_llr_sdc">
25+
<title>To which companies would you recommend a DITA XML based solution for writing
26+
technical documentation?</title>
27+
<p>I would recommend the use of the DITA XML standard for writing technical
28+
documentation with Oxygen XML as an editing tool to companies that have one of the
29+
following conditions fulfilled:<ul id="ul_ef1_wbn_f1c">
30+
<li>They have multiple similar products and want to take advantage of DITA XML
31+
high reuse capabilities and condition profiling/filters to produce multiple
32+
similar, but not identical, manuals from the same project.</li>
33+
<li>They want to add structure-based validation rules that must be followed by
34+
all members of a team.</li>
35+
<li>They want to create their own custom vocabulary of semantic elements.</li>
36+
<li>Besides web-based outputs, they also want to produce PDFs and want to have a
37+
relatively high degree of control over the PDF customization.</li>
38+
</ul>More details here: <xref
39+
href="types_of_companies_which_would_benefit_from_the_dita_xml_standard.dita"
40+
/>.</p>
41+
</section>
42+
<section id="section_rjs_mlr_sdc">
43+
<title>Is Oxygen a Content Management System?</title>
44+
<p><b>Oxygen</b> is not a <b>content management system</b>, we do not store the content
45+
that you are editing on our side. </p>
46+
<p>Our clients use <b>Oxygen XML</b> for collaboration on a technical documentation
47+
project in one of these ways:</p>
48+
<ul id="ul_scc_cxf_f1c">
49+
<li>We have clients who use Oxygen's <xref
50+
href="https://www.oxygenxml.com/doc/ug-addons/topics/git-addon.html"
51+
format="html" scope="external"><b>Git client add-on</b></xref> to
52+
collaborate on the same project using a <xref
53+
href="../git-tech-writers/using_git_for_technical_writing.dita">Git
54+
repository</xref>.</li>
55+
<li><b>Oxygen</b> also has built-in support for working with <xref
56+
href="https://www.oxygenxml.com/doc/ug-editor/topics/sharepoint-connection.html"
57+
format="html" scope="external"><b>SharePoint</b></xref> repositories if you
58+
want to store the edited content on <b>SharePoint</b>.</li>
59+
<li>There are commercial <b>CMSs</b> (content management systems) that have
60+
integrations with <b>Oxygen</b>. Some of them are listed <xref
61+
href="https://www.oxygenxml.com/partners.html#cmssolutionpartners"
62+
format="html" scope="external">here</xref>. These commercial content
63+
management systems such as <b>Astoria</b>, <b>Bluestream</b>, <b>Componize</b>
64+
usually have plugins that allow <b>Oxygen</b> to connect to the <b>CMS</b>
65+
remote storage, open documents, edit and save them back. But the price of the
66+
commercial content management systems is separate from the price of an
67+
<b>Oxygen</b> license.</li>
68+
</ul>
69+
</section>
70+
<section id="section_jtk_nlr_sdc">
71+
<title>What Oxygen products should I buy for our technical documentation team?</title>
72+
<p>
73+
All of our prices are transparently available <xref
74+
href="https://www.oxygenxml.com/buy.html" format="html"
75+
scope="external">here</xref>.</p> <p>The usual purchase suggestion for a
76+
technical writer's team is something like this:</p><p>
77+
<ul id="ul_v5h_4lr_sdc">
78+
<li>
79+
<p>One permanent user-based license of Oxygen XML Editor
80+
Professional: <xref
81+
href="https://www.oxygenxml.com/buy_new_licenses_professional_smp.html"
82+
format="html" scope="external"/>.</p>
83+
<p>This one license would be for the person who is in charge
84+
of customizing the published output as well as writing
85+
content.</p>
86+
</li>
87+
<li>
88+
<p>A permanent license of Oxygen XML Author professional for
89+
each full time tech writer: <xref
90+
href="https://www.oxygenxml.com/buy_new_licenses_author_professional_smp.html"
91+
format="html" scope="external"/>.</p>
92+
<p>The <b>Oxygen XML Author</b> allows writers to visually
93+
edit <b>DITA XML</b> content and to publish it to
94+
<b>WebHelp</b>, <b>PDF</b>, and other formats.</p>
95+
</li>
96+
<li>
97+
<p>Any other occasional contributor or reviewer (subject
98+
matter experts or engineers, for example) can use our
99+
Content Fusion platform to give feedback on the content
100+
directly from a web browser. </p>
101+
<p>A video of how <b>Content Fusion</b> Works: <xref
102+
href="https://www.oxygenxml.com/content_fusion/take_a_tour.html"
103+
format="html" scope="external"/>.</p>
104+
<p>And the pricing, depending on the number of people who
105+
would simultaneously review the content: <xref
106+
href="https://www.oxygenxml.com/content_fusion/buy_content_fusion.html"
107+
format="html" scope="external"/>.</p>
108+
</li>
109+
</ul>
110+
</p>
111+
</section>
112+
<section id="section_mln_rlr_sdc">
113+
<title>What type of customer support and training will I get from the Oxygen
114+
team?</title>
115+
<p>We help customers with advice and any problems they encounter when using our
116+
application. </p>
117+
<p>For example, if you want to create your own publishing customizations, these are
118+
usually done using CSS. You would have one colleague on your side creating the
119+
customization and asking us questions along the way. We do not implement full
120+
customizations for you, but we guide you along the way.</p>
121+
<p>As for training, we have lots of videos and online resources for learning to use
122+
Oxygen to produce technical documentation: <xref href="learnDita.dita"/>.</p>
123+
<p>We can offer you a one-time web meeting to show you how Oxygen works in general, but
124+
if you want a more rigorous training, we have partners like Ryffine or Mekon who
125+
offer such courses: <xref href="learnDita.dita#learnDita/section_rqq_nhj_4jb"/>.</p>
126+
</section>
127+
<section id="section_vhh_slr_sdc">
128+
<title>How can I convert my current content to DITA XML?</title>
129+
<p>You can find advice about how to convert various document formats to DITA XML <xref
130+
href="https://www.oxygenxml.com/doc/ug-editor/topics/dita-migrating-various-formats.html"
131+
format="html" scope="external">here</xref>. For any other document format, the
132+
advice is to possibly try to export it to HTML content and then use the free Oxygen
133+
<b>Batch Documents Converter</b> add-on.</p>
134+
</section>
135+
<section id="section_xwc_tlr_sdc">
136+
<title>Do you have case studies or references from companies who are successfully using
137+
Oxygen? </title>
138+
<p>Some of our customers who have agreed to be officially listed are
139+
mentioned here: <xref href="https://www.oxygenxml.com/customers.html"
140+
format="html" scope="external"/>.</p>
141+
<p>Also some testimonials: <xref
142+
href="https://www.oxygenxml.com/case_studies.html" format="html"
143+
scope="external"/>.</p>
144+
</section>
154145
</body>
155146
</topic>

0 commit comments

Comments
 (0)