tombruijn / kotoba Goto Github PK

Confirmed bug

Rather than [:bold, :italic] prawn only accepts either one of the values, not an array, while the docs would indicate otherwise.

http://prawn.majesticseacreature.com/docs/0.11.1/Prawn/Text.html

Two solutions:

• All formatting should be done inline and only things like spacing, leading, etc. defined on a text command.
• Do not pass style to text, but filter it out and tell users they can't define style on whole sections of text with the layout configurator, but that it is meant only for inline code spans?

http://prawn.majesticseacreature.com/docs/0.11.1/Prawn/Text.html

CMD + F => <color>

Automatic ToC generation?

Kotoba.config.layout.toc do |t|
  t.title = "Table of Contents"
  t.page = 2
  t.filler = "." # Title..............3
  t.levels = 2 # Two levels deep
  # etc.
end

Let Kotoba calculate a line height automatically based on a user's font size when the line height is not set?

• Does it contribute anything?
• Does it make anything easier?
• Should there be a line height default at all? (if it is not implemented this should probably be set to nil || 0)

Lists now do not indent from the prefix, but from the text.

Example

Expected output:

- I am a list
  on two lines.

Received output:

- I am a list
on two lines.

Solution

A possible solution would be to use the indent prawn method, but that would require the list to be wrapped in a bounding_box and the prefix to be placed in a different way.

Add styling options for links, emphasis, bold, etc.

• The Styling class has all the configuration needed (right now).
• The inline formatting method in the prawn converter needs to support all of them.
• The em and b methods should use inline formatting method.
• Move into its own modules (out of prawn converter)

This list contains issues/features from the start, I'm slowly moving new issues into their own separate issues. So check out the issue tracker as well.
When everything is checked on this issue it will be closed.

Must have

Sections

• Support for sections (be able to configure its support: on/off)
• Customize section spacing (a line or a moved cursor distance) ecb632b
• Start new chapters (different dir) on a new page
• Custom blank/new pages through markdown 206f8fe

Paragraphs

• Support for paragraph indent toggle (on/off)
• Support for book indent toggle (on/off) (first paragraph of a section has no indent)

Headers and Footers

• Support for footers and headers, be able to specify a block or text and kotoba will position it
• Customize header and footer spacing from bounding box (footer) or top of page (header)

Page numbering

• Customize page numbering (position and string page <page> of <total> (actual syntax)
• Page numbering automatic position based on recurring element type (top/bottom page)
• Page numbering should listen to all layouts, loop through them and call prawn's page numbering with the layout's page range.

Styling layouts

• Support for layout_for [page..range] do |p| etc..
• Add your own font, see pull request #4
• customize indent on any style, better options since 0c8b637, but still not solved/tested entirely
• PDF outline: a Table of contents, but as metadata, not as text in the PDF

1. Moved to issue #6: automatic line height based on (a user's) font size (when not set by user).

Other

• Send data about the title and author to prawn's info hash
• PDF export testing https://github.com/prawnpdf/pdf-inspector (taken up as a continuous progress)

Should have

• Custom metadata to add to PDF
• PDF security, see Prawn

Could have

• Moved to issue #7: Table of Contents generation at a page of your choosing? config.layout.toc.page = 2

Styling:

• headings
• paragraphs
• ordered lists
• unordered lists
• code blocks
• inline code
• quote blocks
• horizontal rules
• horizontal rule styling
• ref definitions
• links
• images
• emphasis
• strong
• divs
• inline formatting support, for non-markdown supported styling as seen here: http://prawn.majesticseacreature.com/docs/0.11.1/Prawn/Text.html (see #2)
  • strikethrough
  • underline
  • color
  • font size
• Smartypants quotes
• Support for entities & * " '
• A to_filtered_text method that clears any inline formatting for use in Toc

Allow automatic numbering of headings just like how li-s are numbered.

Kotoba.config.layout.heading 1 do |h|
  h.prefix = "{n} "
end

Examples

As a prefix

1 Heading

Just a number (how to support that through a prefix?)

1

Maybe even add line break support so headings can turn out like:

                5
Somewhere in the middle of the story