-
Notifications
You must be signed in to change notification settings - Fork 490
OPENNLP-1792: Add docbkx plugin config to produce PDF of dev manual #920
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
OPENNLP-1792: Add docbkx plugin config to produce PDF of dev manual #920
Conversation
35f99d7 to
9e02e12
Compare
e440c2a to
e7ae840
Compare
- modernizes xml files of the OpenNLP dev manual to use Docbook dtd in version 5.x - adds plugin configuration to produce the PDF as separate outcome - adds xsl file for customization of the layout of text in the PDF - adds hyphenation support for PDF and epub versions - introduces specific profiles for html, pdf, and epub3 targets of the dev manual - adds cover entry to opennlp.xml for epub target - fixes inconsistencies in dev manual's structure (duplicate ids...) - fixes 'informaltable' column counts, mainly in cli.xml - fixes missing inlinemediaobject for parsetree1.png image include causing trouble during epub3 generation - adds config for pdf and epub file inclusion to bin.xml config in opennlp-distr/assembly
e7ae840 to
50461bf
Compare
|
Note: I ran checks for the resulting epub file (German output)
So it seems, epubcheck is telling us, we create a valid EBook for the OpenNLP dev manual, including a cover image. |
- modernizes xml files of the OpenNLP dev manual to use Docbook dtd in version 5.x - adds plugin configuration to produce the PDF as separate outcome - adds xsl file for customization of the layout of text in the PDF - adds hyphenation support for PDF and epub versions - introduces specific profiles for html, pdf, and epub3 targets of the dev manual - adds cover entry to opennlp.xml for epub target - fixes inconsistencies in dev manual's structure (duplicate ids...) - fixes 'informaltable' column counts, mainly in cli.xml - fixes missing inlinemediaobject for parsetree1.png image include causing trouble during epub3 generation - adds config for pdf and epub file inclusion to bin.xml config in opennlp-distr/assembly
atarora
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good !
Thanks !
…920) * OPENNLP-1792: Add docbkx plugin config to produce PDF of dev manual - modernizes xml files of the OpenNLP dev manual to use Docbook dtd in version 5.x - adds plugin configuration to produce the PDF as separate outcome - adds xsl file for customization of the layout of text in the PDF - adds hyphenation support for PDF and epub versions - introduces specific profiles for html, pdf, and epub3 targets of the dev manual - adds cover entry to opennlp.xml for epub target - fixes inconsistencies in dev manual's structure (duplicate ids...) - fixes 'informaltable' column counts, mainly in cli.xml - fixes missing inlinemediaobject for parsetree1.png image include causing trouble during epub3 generation - adds config for pdf and epub file inclusion to bin.xml config in opennlp-distr/assembly (cherry picked from commit 58d91f0)
What does this PR do?
OPENNLP-1792: Add docbkx plugin config to produce PDF of dev manual
opennlp-distr/assemblyHow to reproduce on local machine
cd opennlp-docsmvn clean verify -Pdocs-manual-html -Pdocs-manual-pdf -Pdocs-manual-epubtarget/docbkxfor sub directoriespdf,html, and separateopennlp.epubfile.Tasks
Thank you for contributing to Apache OpenNLP.
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
For all changes:
Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
Does your PR title start with OPENNLP-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
Has your PR been rebased against the latest commit within the target branch (typically main)?
Is your initial contribution a single, squashed commit?
For code changes:
For documentation related changes:
Note:
Please ensure that once the PR is submitted, you check GitHub Actions for build issues and submit an update to your PR as soon as possible.