Creating help site from scratch

Post here questions and problems related to editing and publishing DITA content.
MV1983
Posts: 3
Joined: Mon Feb 07, 2022 7:58 am

Creating help site from scratch

Post by MV1983 »

I have take up a new role where I will be producing online help for a software application. There is no content, database, or CMS as of now. Should I take up Oxygen XML editor, or will Oxygen author suffice for me to seamlessly publish online help guides and be able to access PDF copies as well. Also what other background software or setup will I need to be able to run Oxygen editor/author without any issues?

Apologies if these seem too broad or generic. Hope you can help me with this query.
Radu
Posts: 9450
Joined: Fri Jul 09, 2004 5:18 pm

Re: Creating help site from scratch

Post by Radu »

Hi,
Oxygen XML Author is enough for you to edit DITA XML content and publish it to Web based or PDF outputs using CSS to customize these outputs.
I would recommend you use a Git repository to store the DITA content (maybe a private GitHub repository for example) and use Oxygen's free Git add-on to check out the content and commit it to the repository.

https://www.oxygenxml.com/doc/versions/ ... addon.html

A couple of past webinars to get you started are linked here:
https://blog.oxygenxml.com/topics/learn ... wyk_5fj_2v

Also a past webinar about using Oxygen with a Docs-as-code methodology:
https://www.oxygenxml.com/events/2020/w ... pment.html

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
MV1983
Posts: 3
Joined: Mon Feb 07, 2022 7:58 am

Re: Creating help site from scratch

Post by MV1983 »

We have a bitbucket account. We also have SharePoint. Which might be better suited as a repository? Could 2e also use one drive as a repository?

Also if I need to produce .chm files will I be able to do that and publish the content using Oxygen Author?
Radu
Posts: 9450
Joined: Fri Jul 09, 2004 5:18 pm

Re: Creating help site from scratch

Post by Radu »

Hi,
We have a bitbucket account. We also have SharePoint. Which might be better suited as a repository? Could 2e also use one drive as a repository?
I would probably prefer BitBucket with the Oxygen Git client add-on:
https://www.oxygenxml.com/doc/versions/ ... addon.html
But it depends on what your team is comfortable with, we also have a Sharepoint integration but only for Oxygen Enterprise edition (you need to choose buy licenses for Oxygen XML Author Enterprise instead of Professional on our Buy page):
https://www.oxygenxml.com/doc/versions/ ... ction.html
But a trial license of Oxygen XML Author works with Sharepoint so you can test the Sharepoint integration while on trial.
Also if I need to produce .chm files will I be able to do that and publish the content using Oxygen Author?
Yes, you have transformation scenarios for DITA Map to Windows Help.

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
MV1983
Posts: 3
Joined: Mon Feb 07, 2022 7:58 am

Re: Creating help site from scratch

Post by MV1983 »

How do I publish a project to my website? I tried using my local c folder to save the files. The webhelp responsive output shows my c drive address. How do I direct the output to open in my website help section?
Radu
Posts: 9450
Joined: Fri Jul 09, 2004 5:18 pm

Re: Creating help site from scratch

Post by Radu »

Hi,

Oxygen will indeed save the output folder containing HTML and Jaavscript files to your local disk. If you want to publish the output folder to a web site you will need to manually upload the content there depending on the facilities your web server has for this.

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
Post Reply