Skip to content

A sandbox to migrate manual to docbook 5

Notifications You must be signed in to change notification settings

omegat-org/omegat-manual

Repository files navigation

OmegaT manuals gradle build

Here is an experimental repository to build OmegaT manuals with Gradle. OmegaT genuine repository has manuals which are built with Docker workflow.

The provision here does not use Docker/Container to generate HTML from docbook XMLs.

How to build HTML manual

Please execute the Gradle command

./gradlew manualHtmls

You will find HTML files under build/docs/manual/

Supported languages

7 languages: CA, DE, EN, FR, IT, JA, NL

Sources

Tasks are defined as a custom local plugin defined in build-logic

source difference from original manual source

  1. Folder location: src/docs/manual/<lang> and src/docs/greeting/<lang>
  2. Name of the main source file: OmegaTUsersManual_xincludes_full.xml
  3. DTD of the index file: the first 2 lines of the index file should be like
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
  1. CSS file is located at src/docs/style/omegat.css
  2. XSL files are located at src/docs/xsl/
  3. Place First_Steps.xml in src/docs/greeting/<lang>

GitHub Actions

You can download build artifact from GitHub Actions page with "artifact" link