Add ability to generate a pdf of the community policies

[balos1]

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

[ulrikeyang]

Hi Cody, Thanks for doing this. It looks great! Ulrike From: Cody Balos <[email protected]> Sent: Friday, July 12, 2019 3:02 PM To: xsdk-project/xsdk-community-policies <[email protected]> Cc: Yang, Ulrike Meier <[email protected]>; Review requested <[email protected]> Subject: [xsdk-project/xsdk-community-policies] Add ability to generate a pdf of the community policies (#18) 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: xsdk-community-policies.pdf<https://github.com/xsdk-project/xsdk-community-policies/files/3388099/xsdk-community-policies.pdf> xsdk-installation-policies.pdf<https://github.com/xsdk-project/xsdk-community-policies/files/3388101/xsdk-installation-policies.pdf>

…

________________________________ You can view, comment on, or merge this pull request online at: #18 Commit Summary * setup pdf generation infrastructure * make adjustments for prettier PDF output * fix logo in pdf * add comments on how to generate the PDF * update policy-input solicitation url * create installation policy guide pdf generator * format installation policies to 80 columns for better pdf generation * format package policies to 80 columns for better pdf generation * fix formatting in installation policies markdown * fix text wrapping * fix link color in PDF produced File Changes * D installation_policies/1.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-0> (9) * D installation_policies/10.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-1> (7) * D installation_policies/11.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-2> (2) * D installation_policies/12.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-3> (2) * D installation_policies/13.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-4> (2) * D installation_policies/2.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-5> (5) * D installation_policies/3.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-6> (28) * D installation_policies/4.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-7> (5) * D installation_policies/5.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-8> (5) * D installation_policies/6.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-9> (5) * D installation_policies/7.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-10> (6) * D installation_policies/8.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-11> (6) * D installation_policies/9.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-12> (7) * A installation_policies/I1.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-13> (13) * A installation_policies/I10.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-14> (14) * A installation_policies/I11.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-15> (4) * A installation_policies/I12.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-16> (5) * A installation_policies/I13.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-17> (6) * A installation_policies/I2.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-18> (8) * A installation_policies/I3.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-19> (40) * A installation_policies/I4.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-20> (9) * A installation_policies/I5.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-21> (9) * A installation_policies/I6.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-22> (8) * A installation_policies/I7.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-23> (10) * A installation_policies/I8.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-24> (10) * A installation_policies/I9.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-25> (13) * M installation_policies/README.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-26> (127) * M installation_policies/discussion_and_examples.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-27> (105) * A installation_policies/pdf/01.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-28> (1) * A installation_policies/pdf/02.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-29> (1) * A installation_policies/pdf/03.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-30> (1) * A installation_policies/pdf/04.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-31> (1) * A installation_policies/pdf/05.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-32> (1) * A installation_policies/pdf/06.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-33> (1) * A installation_policies/pdf/07.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-34> (1) * A installation_policies/pdf/08.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-35> (1) * A installation_policies/pdf/09.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-36> (1) * A installation_policies/pdf/10.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-37> (1) * A installation_policies/pdf/11.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-38> (1) * A installation_policies/pdf/12.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-39> (1) * A installation_policies/pdf/13.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-40> (1) * A installation_policies/pdf/Makefile<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-41> (14) * A installation_policies/pdf/fixlinks.py<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-42> (27) * A installation_policies/pdf/xsdk-installation-policies.pdf<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-43> (0) * M package_policies/M1.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-44> (23) * M package_policies/M10.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-45> (11) * M package_policies/M11.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-46> (30) * M package_policies/M12.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-47> (23) * M package_policies/M13.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-48> (11) * M package_policies/M14.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-49> (7) * M package_policies/M15.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-50> (8) * M package_policies/M16.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-51> (13) * M package_policies/M2.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-52> (14) * M package_policies/M3.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-53> (22) * M package_policies/M4.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-54> (24) * M package_policies/M5.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-55> (9) * M package_policies/M6.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-56> (17) * M package_policies/M7.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-57> (32) * M package_policies/M8.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-58> (16) * M package_policies/M9.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-59> (16) * M package_policies/R1.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-60> (10) * M package_policies/R2.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-61> (6) * M package_policies/R3.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-62> (26) * M package_policies/R4.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-63> (17) * M package_policies/R5.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-64> (8) * M package_policies/R6.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-65> (10) * M package_policies/R7.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-66> (26) * M package_policies/README.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-67> (186) * A package_policies/pdf/01.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-68> (1) * A package_policies/pdf/02.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-69> (1) * A package_policies/pdf/03.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-70> (1) * A package_policies/pdf/04.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-71> (1) * A package_policies/pdf/05.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-72> (1) * A package_policies/pdf/06.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-73> (1) * A package_policies/pdf/07.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-74> (1) * A package_policies/pdf/08.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-75> (1) * A package_policies/pdf/09.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-76> (1) * A package_policies/pdf/10.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-77> (1) * A package_policies/pdf/11.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-78> (1) * A package_policies/pdf/12.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-79> (1) * A package_policies/pdf/13.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-80> (1) * A package_policies/pdf/14.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-81> (1) * A package_policies/pdf/15.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-82> (1) * A package_policies/pdf/16.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-83> (1) * A package_policies/pdf/17.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-84> (1) * A package_policies/pdf/18.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-85> (1) * A package_policies/pdf/19.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-86> (1) * A package_policies/pdf/20.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-87> (1) * A package_policies/pdf/21.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-88> (1) * A package_policies/pdf/22.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-89> (1) * A package_policies/pdf/23.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-90> (1) * A package_policies/pdf/24.md<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-91> (1) * A package_policies/pdf/Makefile<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-92> (14) * A package_policies/pdf/fixlinks.py<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-93> (27) * A package_policies/pdf/xsdk-community-policies.pdf<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-94> (0) * M res/xsdk-logo.png<https://github.com/xsdk-project/xsdk-community-policies/pull/18/files#diff-95> (0) Patch Links: * https://github.com/xsdk-project/xsdk-community-policies/pull/18.patch * https://github.com/xsdk-project/xsdk-community-policies/pull/18.diff — You are receiving this because your review was requested. Reply to this email directly, view it on GitHub<#18?email_source=notifications&email_token=AD4NLLKFOWEJQPUVJLA7QUDP7D5OTA5CNFSM4ICSDM7KYY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4G67IT6Q>, or mute the thread<https://github.com/notifications/unsubscribe-auth/AD4NLLIYVWZXST7JTRO2S2LP7D5OTANCNFSM4ICSDM7A>.

[luszczek]

Thank you for fixing PDF generation.

I have a few comments:

• we could fix the usage: "Environmental Research" but "environment variable"

• the long links spill on the margin in the PDF. Shouldn't they use hyperref's url macro instead of href?

• Do we need the PDF output in the repo? I'd rather just keep the source.

• The link to Trilinos Trac is broken. I think the word "Overview" was cut off: http://trac.trilinos.org/wiki/TribitsLifecycleModelOverview