Add ability to generate a pdf of the community policies#18
Open
Add ability to generate a pdf of the community policies#18
Conversation
Contributor
Contributor
|
Thank you for fixing PDF generation. I have a few comments:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR makes it possible to generate a pdf of the package policies and installation policies. This is done with pandoc and panflute (python package for pandoc filters).
In order to get decent pdf output, some reformatting of the markdown had to be done:
For one, superscripts had to be changed to comply with the pandoc flavored markdown rather than GitHub flavored. As such, superscripts do not render on GitHub - instead they look like this: ^1^.
Also, the markdown text had to be wrapped at approx. 80 characters so that it fits in the rendered pdf.
Thirdly, to make it possible to link to individual installation policies in the PDF, they have been prefixed with an 'I', that is, installation policy 1, is now installation policy I1. This also will make it easier for people to refer to installation policies (removes ambiguity).
The rendered PDFs are attached below (updated with fix for multilevel bullets):
xsdk-community-policies.pdf
xsdk-installation-policies.pdf