Skip to content
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

Generating a PDF version of documentation #15

Open
rolfkleef opened this issue Feb 18, 2014 · 0 comments
Open

Generating a PDF version of documentation #15

rolfkleef opened this issue Feb 18, 2014 · 0 comments
Milestone

Comments

@rolfkleef
Copy link
Contributor

Use case: someone wants to have a single document to have the standard and code lists at hand in e.g. conversations with stakeholders.

Adding "make latexpdf" in the gen.sh script works (if the Latex tool chain is installed), but the resulting PDF file has some issues:

sample PDF: https://dl.dropboxusercontent.com/u/26783104/IATIStandard.pdf

  • Table of contents is missing
  • Sections for elements are hard to recognise, the document structure is not based on the structure of the standard
  • The order of the elements seems somewhat random
  • Code samples may run off the page (no line breaks added)
  • Tables break (esp. the codelists): text doesn't fit, column widths change mid-table.
  • The sub elements are embedded under their parent element, but the changelog for the parent is added after the sub elements, which is confusing (see e.g. contact-info on page 16 onwards in the sample PDF: page 20 has the changelog for the website sub element, then the changelog for contact-info)
  • Some repeated texts are not useful (e.g. "Developer tools View this element in the schema source")

(Probably the source for the PDF needs to be structured in a different way than the HTML version that is used in this version.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants