Skip to main content

Produce books with Plone and export them in a high quality PDF.

Project description

ftw.book

This package provides content types for creating a book which can be exported as PDF.

http://onegov.ch/approved.png/image

Certified: 01/2013

Features

  • Provides a content type “Book” which defines the root of a book.

  • Provides a content type “Chapter” for creating the structure of a book. Chapters are nestable.

  • Content is added to chapters using simplelayout blocks.

  • Provides an action for exporting the book or a single chapter recursively as PDF.

  • Provides LaTeX representations for the default simplelayout blocks.

  • Adds fields for injecting LaTeX code to every content type within a book using schemaextender.

  • Provides a “Reader” view which displays the book on one page for a enjoyable reading experience.

  • Provides simplalayout “Table” block for enter tabular data using a datagrid widget which generates HTML table representation which also convertable into a PDF.

Usage

  • Add ftw.book to your buildout configuration:

[instance]
eggs +=
    ftw.book
  • Install the generic import profile.

  • Install a LaTeX distribution, see ftw.pdfgenerator install instructions.

Compatibility

Runs with Plone 4.1, 4.2 or 4.3.

Development / tests

For running the full PDF generation tests ImageMagick is required for diffing the PDFs.

Changelog

2.2.14 (2013-05-24)

  • Allow HTML in table objects. This makes it possible to do things such as marking only one word in a cell as bold or using <sup>. [jone]

2.2.13 (2013-05-24)

  • Register HTMLBlock view only for IWithinBookLayer. This allows us to reuse the block outside of a book with default simplelayout block view. The advantage is that the title is not book-style-numbered (dynamic_title). [jone]

2.2.12 (2013-04-16)

  • Lawgiver support: add permission. [jone]

  • JQuery 1.7 support in reader view: access height / positioning differently. [jone]

  • Fix floated images overlapping footnotes / page border. [jone]

  • Fix image floating / image widths in two column environment. [jone]

  • Table footnotes: use text/x-html-safe output format and only allow text/html input. [jone]

  • HTMLBlock: reset HTML otuput type of after making it more strict in simplelayout_schemas. [jone]

  • Let Contributors add Table objects by default. [jone]

2.2.11 (2013-01-24)

  • Fix nested and empty visual highlights causes LaTeX errors. [jone]

  • Fix bug when using hyphens within highlighted text. [jone]

  • Use local text formatting commands, such as textbf instead of {bf }. [jone]

2.2.10 (2013-01-21)

  • Fix move and copy for books. [tschanzt]

  • onegov.ch approved: add badge to readme. [jone]

  • Load missing CMFCore permissions. [jone]

  • Table: add new format combinations with indenting and grey. [jone]

  • Fix table data importer. [jone]

  • Add landscape support (admin only). [jone]

  • Add a checkbox to the LaTeX schemata for inserting column breaks. [jone]

  • Add fields to LaTeX schemata (admin) for inserting page breaks. [jone]

  • Add field to blocks for hiding a shown title from the table of contents. [jone]

  • Fix reader view so that it does not break when there are Discussion Items. [jone]

  • Add LaTeX two column support by adding a “preferred layout” field (admin only). [jone]

  • Index page: use navigation type configuration for excluding types, so that it also works with comments. [jone]

  • Fix navigation portlet eventhandler so that removing plone site does not break. [jone]

2.2.9 (2012-10-16)

  • Reader view: support min-height on #content element. [jone]

  • Fix navigation portlet when it is moved. [tschanzt]

  • Make documentstab work with document_date. [tschanzt]

2.2.8 (2012-08-20)

  • Disable filter box on “Index” tab. [jone]

  • Do not search block types but their parents (chapter), as this concept was changed in simplelayout. [jone]

  • Fix positioning floating images by inserting a zero-hspace. [jone]

  • Update German view translation. [jone]

  • Disable setting default page for Book and Chapter. Those types are not normal folders and setting the default page is therefore not common. [jone]

2.2.7 (2012-07-17)

  • Fix floating problem with full width images in paragraph blocks. [jone]

  • Chapter: define schema explicitly. [jone]

  • Fix issue with LinguaPlone: Imports from Products.LinguaPlone instead of Products.Archetypes. [treinhard]

2.2.6 (2012-06-26)

  • Support for LinguaPlone. [treinhard]

2.2.5 (2012-06-13)

  • Higlighting: include soulutf8 LaTeX package and move conversion to seperate subconverter for including the packages lazily. [jone]

  • Table: fix enitity handling in table generator. [jone]

2.2.4 (2012-06-11)

  • Paragraph: validate table widths and show a viewlet to editors with a hint that the table widths should be defined. [jone]

  • LaTeX: use soulutf8 instead of soul package for allowing utf8 characters in highlighted text. [jone]

  • Within books HTML <h?> tags should not be converted to LaTeX headers. We use chapters and block titles for building the book structure. This fixes inconsistency between plone view heading numbering and LaTeX’s numbering. [jone]

2.2.3 (2012-05-16)

  • Fix latexinjection extender - use IWithinBookLayer. [mathias.leimgruber]

  • Fix LaTeX markup of Remark. [jone]

  • Refactor image handling. [jone]

2.2.1 (2012-05-09)

  • Table LaTeX view: fix footnote LaTeX conversion. [jone]

  • Optimized Table-layout so that it is more like plone default. [eschmutz]

  • Fix condition in paragraph latex view (blob storage). [mathias.leimgruber]

2.2 (2012-04-30)

  • Switch Book metadata fields to AttributeStorage. [jone]

  • Add new content-type: Table [eschmutz]

  • Add new content-type: Remark. Used to add comments in a chapter of a book [eschmutz]

2.1 (2012-04-02)

  • Added a alternative default book view based on ftw.tabbedview [mathias.leimgruber]

  • Added ftw.tabbedview based overview. [mathias.leimgruber]

2.0.2 (2012-03-22)

  • Fix view_methods of Book FTI (should include default view). [jone]

2.0.1 (2012-03-22)

  • Fix heading counters: count objects where the user has no View permission. [jone]

  • Reset heading counters for getting consistent heading numbers on partical exports. #6 [jone]

  • Use term “Version” instead of “Release” in default book layout. #5 [jone]

  • Added simplelayout-block-wrapper to chapter view (Simplelayout issue). [mathias.leimgruber]

2.0 (2012-03-05)

  • Add HTML Block content type. [jone]

  • Add upgrade step for setting default book layout. [jone]

  • Default layout: add logo and logo-width fields. [jone]

  • Look for css class ‘bookReaderLastElement’ when trying to determine the last element for reader height calculation. [buchi]

  • Set Content-Type header for JSON responses to ‘application/json’ to prevent theming. [buchi]

  • Compatibility with new simplelayout version on plone4 branch. [jone]

  • Implement a seperate class for chapters. There is a migration step for migrating existing chapters. [jone]

  • Fix edit icon for chapters. [jone]

  • Remove pagestyle field: pagestyle is not support by the new layout. [jone]

  • Use schema extender for enabling default-layout specific fields. Move default layout to seperate module. [jone]

  • Implement support for multiple layouts, selectable in the book. [jone]

  • Re-add converting visualHighlight to new ftw.pdfgenerator implementation. [jone]

  • Add “PDF” action to folder_contents on book and chapter types. This allows do export only the selected chapters. [jone]

  • Use export_pdf view instead of as_pdf since it was changed in ftw.pdfgenerator. [jone]

  • Image block PDF representation: use description as caption and use no caption if description is empty. [jone]

  • Add fields release, author and author address to book, used in latex layout. [jone]

  • Add missing fncychap.sty to default layout (required by sphinx layout). [jone]

  • Fix a bug which made the pdflatex process hanging when an image had no valid layout defined. Defaulting to 100% width fixes the issue. [jone]

  • Replace plonegov.pdflatex with ftw.pdfgenerator. [jone]

  • Fix schema extender problem with schema extender. [jone]

  • Added Bookview which displays the table of contents of the book [ttschanz]

  • Fix bug where PDF rendering failed: Remove uncessary / wrong acqusition wrapper check. [jone]

  • Use TOC-prefixes for displaying headers within a book. Display headers within a book in the right size. [eschmutz]

  • Add a IWithinBookLayer request layer. [jone]

  • Implemented a navigation portlet on book level, which does not display parents for narrowing into the context. An additional back-to-parent portlet provides a link to the parent. [ttschanz]

1.1.1 (2011-10-19)

  • Readerview: fix strange brain comparing problem by building the toc numbers in a different way. [jone]

1.1 (2011-10-18)

  • Implemented new reader view displaying the whole book with AJAX lazy loading. [jone]

  • Code cleanup and tests improvement. [jone]

  • Added LaTeX code injection support for admin users. Allows to inject LaTeX code before and after every object within a book. [jbaumann]

  • Added custom html2latex rule for rendering <span class=”vislualHighlight”> [jbaumann]

1.0 (2010-11-02)

  • Added Icons / fix setup.py / egg structure. [mathias.leimgruber]

  • LaTeX options (toc, loi, lot, …), links and images in latex. [jinfanger]

0.1 (2009-09-04)

  • Implemented support for title page, table of contents and other listings. [jinfanger]

  • Added action for rendering a book or a chapter as PDF. [jinfanger]

  • Implementation of basic features.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page