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

Add single file HTML and MD output of spec and store it in each ERC #9

Closed
6 tasks done
nuest opened this issue Feb 9, 2017 · 5 comments
Closed
6 tasks done
Assignees

Comments

@nuest
Copy link
Member

nuest commented Feb 9, 2017

use https://github.com/jgrassler/mkdocs-pandoc to create single file, then https://github.com/jgrassler/mkdocs-pandoc#usage-example and http://pandoc.org/demos.html to create

@nuest nuest self-assigned this Feb 9, 2017
@nuest
Copy link
Member Author

nuest commented Feb 9, 2017

@7048730 should we store the spec within the ERC as a PDF or as an HTML file?

@nuest nuest changed the title Add single file HTML and PDF output to travis build Add single file HTML and PDF output to travis build and store it in each ERC Feb 9, 2017
@nuest nuest changed the title Add single file HTML and PDF output to travis build and store it in each ERC Add single file HTML and PDF output of spec and store it in each ERC Feb 9, 2017
@ghost
Copy link

ghost commented Feb 10, 2017

how about PDF/A for long term preservation and additionally markdown for usability?

@nuest
Copy link
Member Author

nuest commented Feb 10, 2017

PDF/A with pandoc... that could be a challenge :-). I didn't find anything in that direction, so any pointers are helpful.

An what about the file names and paths?

@ghost
Copy link

ghost commented Feb 15, 2017

cf. jgm/pandoc#3215

Since PDF/A seems problematic, I'd go for a text version that is as much plain text as possible. On the other hand, as we do use a lot of hyperlinks, we might be okay using markdown anyway, which is after all only very lightwightedly encoded and thus easy to preserve.

As for the filenames and paths, it might be reasonable from a preservationist's point of view to include the different spec outputs in directories that label them, e.g. erc/spec/markdown/spec.md and so on. At a point, one could add addtional information on the formats used here within that dir.

@nuest
Copy link
Member Author

nuest commented Mar 29, 2017

No PDF/A for us, paths to the plain text documents are listed in the archival metadata, see #10

@nuest nuest changed the title Add single file HTML and PDF output of spec and store it in each ERC Add single file HTML and MD output of spec and store it in each ERC Mar 29, 2017
@nuest nuest assigned ghost Mar 29, 2017
@nuest nuest closed this as completed in b33737a Nov 14, 2017
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

1 participant