Contributing to OmegaT documentation

Work on the OmegaT related documentation is carried out in the OmegaT repository.

The source files of manuals are in src_docs/manual folder. Manual source uses the Docbook 5.2 format.

There are also contribution manual for developers, manual writers and translators. The source files of contribution manual are in src_docs/developer Contribution manual source uses the MarkDown, and we convert it into HTML using MkDocs processing system.

When OmegaT start without project folder in command line, you will find First Steps short document on OmegaT editor screen. Its sources are stored in src_docs/greeting folder.

Documentation rules and procedures

Documentation contribution follows the same rules are code contributions. See Contributing to OmegaT development for more information.

You can also consult our SourceForge documentation tracker for potential contributions.

Manual snapshot release

When the document source is modified, the CI/CD processes automatically build the HTML manuals and publish that snapshot on the web server at https://omegat.sourceforge.io/manual-snapshot/.

License

All the files in src_docs folder and below are published under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

When combining them with works licensed under CC BY-SA 4.0 special conditions apply. Check CC BY-SA 4.0 NOW ONE-WAY COMPATIBLE WITH GPLV3 for more information.