Migrate pdf format #135
Merged
Migrate pdf format #135
Conversation
This file contains 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
It was not considered to be appendices in pdf.
When we use asciidoctor-pdf, UTF-8 is supported.
- :partnums: Book parts are assigned roman numerals when the attribute partnums is set. - :sectnums: If set, numbers sections to depth specified by sectnumlevels(default 3). - :sectlinks: Turns section titles into self-referencing links. - :!compat-mode: use the new Asciidoctor syntax
Using asciidoctor-pdf it would be easier to generate differnt formats of documents with single source. For example, pdf file generation can use its' own custom settings, and still benefits the same foundation of asciidoc. This change mainly includes improvement of pdf file generation. - Header/Footer - TOC - Appendix - Admonition icon is now available in pdf NOTE: This is still WIP, so keeping old commands in Makefile
shaape is not maintained since 2014. ditaa looks to be still maintained, and more popular.
Need to use a font that has circled number.
- VERSION to indicate version info inside sections. When further descriptions are needed, authors can use this admonition. - Create style directory and put config files in it. - Adjust Makefile
This is still WIP, but added/update new installation info about asciidoctor.
|
First impression: Nice! |
happi
reviewed
Apr 20, 2020
happi
reviewed
Apr 20, 2020
|
The new style and format of the PDF looks really nice, especially the new diagrams are nice. |
|
Figure 25(Port Communication) might need some changes to work nicely with ditaa. |
|
All in all much needed improvements. |
|
While you are at it, a list of instructions for installing build tools for linux might be a good idea. If you don't have access to a Linux/Ubuntu system I can fix that after merge. |
|
@happi Thank you for your feedback, I will work on your comments and update here once I'm done. |
- for pdf, ./images - for html, ./site/images
- Update README for the list of install/requirements - Update Makefile to build beam-book.pdf using new build tools
- Removed "scale" option of diita - Adjusted the diagrams so that it looks better when there are multiple boxes - Fix equal sign rendered by diita, by using arrow symbol instead of equal sign
- Port communication diagram - Entities on Erlang Node diagram
It makes link macros not working.
|
@happi Updated:
I'm sure there are still lots of errors, please let me know if you want to fix something. |
|
Great work! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 is an attempt to improve maintainability by introducing the usage of asciidoctor-pdf instead of dblatex to generate pdf file. Since both
asciidoctorandasciidoctor-pdfare under the same project, it's easier to use both together, and they are actively maintained, and easy to customize a variety of features.Alongside the migration of pdf generator, this PR introduced/improved the following items:
asciidocdocuments - sinceasciidoctorandasciidoctor-pdfboth understand UTF-8, no need for extra work for both tools(asciidocand dblatex) to deal with Unicode character sets. I think this would make it easier to resolve issues like HTML Entity for * (*) is not rendered properly #124VERSIONto indicate version info of OTP for each sections, related to Suggestion: Make explicit the version of Erlang in the book #77This is still WIP, and I'd like to get some feedback to work further.
Also, I appreciate my current employer TubiTV for allowing me to work on this for 2 days as part of our second annual "oss-a-thon" event.