Hyphenation

Post here questions and problems related to editing and publishing DITA content.
scarey
Posts: 6
Joined: Mon Dec 08, 2025 5:11 pm

Hyphenation

Post by scarey »

I'm trying to see if I can configure the hyphenation rules for ditamap publishing (CSS > PDF). The docs don't seem to be quite right for this though:
The docs tell me the license terms are in [CHEMISTRY_INSTALL_DIR]/config/hyph but they're actually in [CHEMISTRY_INSTALL_DIR]/lib. Is the list of supported languages default correct in the docs?

The docs suggest adding fop-hyph.jar to [CHEMISTRY_INSTALL_DIR]/lib but when I do this, oxygen complains during startup that 'there are additional libraries present in the applications libraries folder' and insists that I remove it.

When it comes to adding new dictionaries, the docs describe .xml files but the downloaded package only contains pre-compiled .hyp files. It also says:
You can copy the dictionaries you need to change in another directory, then use the parameter to reference it inside your transformation.
but it's not clear which parameter it's talking about.

Essentially, this is what I'd like to do:
Enable default hyphenation for the languages in the TeX dictionaries
I have a repository (folder) for each language of our documentation. I'd like to keep an xml file alongside the dita documents which describes any hyphenation customisations I've made for that language (like a glossary)
What I'd like to avoid is having each user update/modify the installation files with customisations because these will likely get lost during updates/re-installs etc.

Thanks
julien_lacour
Posts: 769
Joined: Wed Oct 16, 2019 3:47 pm

Re: Hyphenation

Post by julien_lacour »

Hello,

The documentation mentions the license terms are listed in the XML files in the config/hyph directory, it is a comment under <hyphenation-info>. What have you found in the lib folder?
The correct list of built-in dictionaries is the following:
da Danish
de German
de_CH German (Switzerland)
en English
es Spanish
fr French
it Italian
nb Norwegian Bokmål
nl Dutch
pt Portuguese
ru Russian
sv Swedish
th Thai

The correct step to copy the library is here:
Copy the fop-hyph.jar file to the [DITA_OT_DIR]/plugins/com.oxygenxml.pdf.css/lib/oxygen-pdf-chemistry/lib directory.
In the same user guide topic, you will find the parameter name which is 'args.hyph.dir'.
I've added a documentation task to correct the problems you have found.

For your use-case, distribute the XML dictionaries alongside your DITA content. Then, set the 'args.hyph.dir' parameter in a scenario saved at the project-level. This ensures that every user opening the Oxygen project will automatically have the scenario preconfigured with the correct parameter.

Regards,
Julien
scarey
Posts: 6
Joined: Mon Dec 08, 2025 5:11 pm

Re: Hyphenation

Post by scarey »

Thanks for the link to the correct docs
The lib folder I referred to is the C:\Users\<username>\AppData\Local\Programs\Oxygen XML Editor 28\lib folder which is what the OxygenXML Editor docs point to. I assumed that was the right location as it contains these files:
image.png
The Chemistry docs refer to the [OPE_INSTALL_DIR]. Where is this on a Windows machine?

Thanks
You do not have the required permissions to view the files attached to this post.
scarey
Posts: 6
Joined: Mon Dec 08, 2025 5:11 pm

Re: Hyphenation

Post by scarey »

Is it this?
C:\Users\<username>\AppData\Local\Programs\Oxygen XML Editor 28\frameworks\dita\DITA-OT\plugins\com.oxygenxml.pdf.css
julien_lacour
Posts: 769
Joined: Wed Oct 16, 2019 3:47 pm

Re: Hyphenation

Post by julien_lacour »

Hello,

If you have Oxygen installed the license files are the one you mentioned but depending on the installation (you may have Oxygen Publishing Engine or Oxygen PDF Chemistry as standalone applications) these files may not be available and you need to refer to the XML files themselves.
Depending on the manual you may find DITA_OT_DIR or OPE_INSTALL_DIR, if you are using the built-in engine, both point to the same directory. In your case C:\Users\<username>\AppData\Local\Programs\Oxygen XML Editor 28\frameworks\dita\DITA-OT.

Regards,
Julien
scarey
Posts: 6
Joined: Mon Dec 08, 2025 5:11 pm

Re: Hyphenation

Post by scarey »

I think I'm on the right track now.
I have Oxygen Editor so those hyph files don't seem to be included and there is no config/hyph directory anywhere.
I've found the xml files now too - I was thrown off as the sourceforge link downloads a zip of the compiled files.
For reference, this is the link for the xml files
https://sourceforge.net/projects/offo/f ... p/download

Thanks for your help
julien_lacour
Posts: 769
Joined: Wed Oct 16, 2019 3:47 pm

Re: Hyphenation

Post by julien_lacour »

Hello,

In Oxygen, the .hyph files are included into OXYGEN_INSTALL_DIR/lib/oxygen-pdf-chemistry.jar this is why you can't find them.
You can find the uncompiled files here: https://sourceforge.net/projects/offo/f ... nation/2.2, they are contained in the offo-hyphenation.zip.
You should be able to use both files types in combination with args.hyph.dir parameter.

Regards,
Julien
Post Reply