Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Manual improvements #388

merged 18 commits into from Aug 17, 2012


None yet
2 participants

aguids commented Aug 15, 2012

There's a boatload of changes there. Many are little tweaks. The most significant stuff is:

  • Refactor of the generator code for the manual
  • Add CodeRay gem for syntax highlighting
  • Change the manual page size to FOLIO
  • New design

aguids added some commits Aug 5, 2012

@aguids aguids Extract low level internal file handling from the manual into an appr…
…opriate ExampleFile class.
@aguids aguids Automatically reset all settings that might have undesired effects on…
… the Manual design in between evaluating the examples.
@aguids aguids Read the file from ExampleFile in an appropriate method ec4b52a
@aguids aguids Refactoring the Manual generator:
* Use a DSL to define the package files
* Extract the procedural code used to traverse the packages' example hierarchy into a set of classes using the visitor pattern
@aguids aguids Use the new organization name (prawnpdf) in an example link f0c8c1d
@aguids aguids Extract example header, prose and code blocks into their own methods 94794f9
@aguids aguids Updated manual styles for Package header, example headers, as well as…
… code and prose blocks
@aguids aguids Update package pages and manual pages to use prose blocks and increas…
…ed their size to FOLIO, which is the same width as the default LETTER. The reason for the size increase is that there was examples where it was too much stuff to cram into a single page with introductory text, code snippet and the code eval. The new design also makes use of more white space so the new size gives some breathing room for all these blocks.
@aguids aguids Use some settings for calculations of margins and the page rhythm. Ex…
…tract code for bounding boxes used on headers and within the pages.
@aguids aguids Use settings for colors and text leading a7ff660
@aguids aguids Move the processing of code tags and URLs on introductory text from E…
…xampleFile back to Example
@aguids aguids Renders a box with the link to the example file on github whenever th…
…e option to :eval_source is set to false.
@aguids aguids Render a border beneath the page headers 5f3064e
@aguids aguids Extract a method for colored_box c148e8b
@aguids aguids Split the security encryption example in two 7cc912c
@aguids aguids Add syntax highlight support to the manual using the coderay gem 9b7c80e
@aguids aguids Now that table accepts image cells, it makes more sense for the image…
… package to come before the table package in the manual.
@aguids aguids Many tweaks to the manual examples fixing typos, rewording some expla…
…nations, adding missing <code> tags, refactoring some of the examples' code, etc.

@bradediger bradediger added a commit that referenced this pull request Aug 17, 2012

@bradediger bradediger Merge pull request #388 from aguids/manual
Manual improvements

@bradediger bradediger merged commit 4018ee0 into prawnpdf:master Aug 17, 2012


bradediger commented Aug 17, 2012

Merged, thanks for the awesome updates!

I also added f30d859, which turns on :optimize_objects and :compress, reducing the manual size to under 800k.

New manual has been uploaded to http://prawn.majesticseacreature.com/manual.pdf.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment