oxygen-term-checker in Framework?

[raybiss]

Hi,
How about distributing the oxygen-term-checker folder with a Framework?
Our integrator have decided to bundle our Framework as an add-on, which is a great idea.
It was previously done through a project file and I was planning to copy the "oxygen-term-checker" folder in this project.
Now I would also like to get rid of the project and bundling the "oxygen-term-checker" folder with the Framework sounds better than having to distribute it as a stand-alone folder and instruct writer to point the terminology checker to it.
Could Oxygen 26 support that feature?
Thanks,
Raymond

[Radu]

Hi Raymond,

You cannot distribute an "oxygen-term-checker" folder with a framework.
But you can create an Oxygen plugin which comes with terminology checker rules:
https://www.oxygenxml.com/doc/ug-editor ... c2_m4d_y5b
And this plugin can be packed as an add-on.
So for example your users would need to install two Oxygen add-ons, one for the framework and one for the term checker rules add-on.
In an Oxygen plugin you can also specify a framework folder:

https://www.oxygenxml.com/doc/ug-editor ... nsion.html

So you could have a single plugin (packed as a single add-on) which comes with both the framework folder and the term checker rules folder.

Regards,
Radu

[chrispitude]

We simulate this by (1) storing Terminology add-on settings in the .xpr project file as Project settings, and (2) specifying the terminology rules directory inside where our custom framework directory is:

image.png (70.84 KiB) Viewed 814 times

Although perhaps it's not really part of the framework itself, it's still a good organizational place to put it.

We also specify that the Terminology Checker be part of our Oxygen project:

image.png (64.88 KiB) Viewed 814 times

so that for new Oxygen installations, the user is prompted to install the add-on automatically.

[Radu]

Hi Chris,

From this remark:

Now I would also like to get rid of the project and bundling the "oxygen-term-checker" folder with the Framework sounds better than having to distribute it as a stand-alone folder and instruct writer to point the terminology checker to it.

I think Raymond's original question is more about a folder containing terminology checker rules, not the actual terminology checker add-on.

Regards,
Radu

[chrispitude]

Radu - agreed! I only included this second part for bonus points. The first part is how we distribute our Terminology Checker settings in our framework directory (even though it's not really a part of the framework itself).

[raybiss]

Thanks Radu!
It worked like a charm.
Raymond