Sharing Oxygen settings with co-workers

Having trouble installing <oXygen/>? Got a bug to report? Post it all here.
chymical
Posts: 16
Joined: Wed Nov 24, 2010 12:37 pm

Sharing Oxygen settings with co-workers

Post by chymical » Fri May 20, 2011 12:05 pm

Hi,

I have created some transformation scenarios and want to share them with one of my colleagues, including ditaval files that I have made. Can I do this automatically using projects or some other method? I have looked at using the project, but I really cannot understand what that even does. I am sorry to say that the help does not really explain the project settings very well, or how it is useful.

John

Radu
Posts: 6437
Joined: Fri Jul 09, 2004 5:18 pm

Re: Sharing Oxygen settings with co-workers

Post by Radu » Fri May 20, 2011 12:29 pm

Hi John,

Did you read this user manual topic?
http://www.oxygenxml.com/doc/ug-oxygen/ ... aring.html

Basically you can create a new folder on your local drive with full write access (or in the local working copy if you are using SVN for example).
From Oxygen in the Project view you can create a new project ".xpr" file and save it in that folder. In that folder you can also add the additional resources like the "ditaval" filter or make links to other directories in your Working Copy.

From the "Configure Transformation Scenario" dialog you can pass the scenarios to Project options.
This means that all your custom defined scenarios will be saved in the project projectName.xpr file.

In the transformation scenarios you have to make sure that you have no absolute file references. For example you can reference the DITAVAL file using the construct:

${pd}/filter.ditaval

The ${pd} will get expanded by Oxygen to the current Project Directory.

Then if you share that folder with everybody and they have the same project opened in the Project View they should also have the same scenarios available.

This is the same approach we use in our Oxygen User Manual project.
Scenarios, Author formatting options and Profiling Conditions (the entire preference pages) are all passed to project level and the project file is committed to our SVN server so that everybody can update from it. When editing our user manual we always have this project opened in the Project view.

Another alternative would be to export your transformation scenarios from the menu Options->Export Global Transformation Scenarios and have your colleagues import them. But this alternative does not deal with additional resources, like the DITAVAL file in your case.

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

chymical
Posts: 16
Joined: Wed Nov 24, 2010 12:37 pm

Re: Sharing Oxygen settings with co-workers

Post by chymical » Fri May 20, 2011 2:28 pm

Hi Radu,

Thanks for this. I did not find the topic because I did not know what to search for! I will follow the instructions...

Oleksii
Posts: 40
Joined: Wed Jul 19, 2017 6:04 pm
Location: Austria
Contact:

Re: Sharing Oxygen settings with co-workers

Post by Oleksii » Fri Mar 29, 2019 12:20 pm

Hi Radu,

as the topic was discussed in 2011 I'd like to ask if the approach of sharing an .xpr via SVN is still the best option? (I need to share at least transformation/validation scenarios and formatting settings for xml.)

The inconvenience could be that the colleagues should revert their local changes before updating; a good workaround could be using the logical folders for every colleague.

What are your experiences?

Radu
Posts: 6437
Joined: Fri Jul 09, 2004 5:18 pm

Re: Sharing Oxygen settings with co-workers

Post by Radu » Fri Mar 29, 2019 4:50 pm

Hi Oleksii,

That's how we collaborate on the Oxygen user's manual internally.
Our user's guide is on GitHub and we have an "userguide.xpr" which we commit and everybody is using the same project file when editing:

https://github.com/oxygenxml/userguide/tree/master/DITA

When working with SVN I think you can also make a file read-only but I'm not sure how, you would need to test this on your side.
The alternative is to use a plugin like this one which imposes a fixed set of XML options to the Oxygen application where it is installed:

https://github.com/oxygenxml/wsaccess-j ... se-options

and a plugin can be packed as an add-on so that users can install it using Oxygen's "Install add-ons" support.

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

Post Reply