« Changelog History


Ronn v0.6 Release Notes

Release Date: 2010-06-13 // almost 14 years ago

  • 🔋 Features:

    • HTML: New styling system: ronn --style=toc,print program.1.ronn ronn -s dark,toc,/path/to/custom.css man/*.ronn

    The --style (-s) option takes a list of CSS stylesheets to embed into the generated HTML. Stylesheets are inserted in the order specified and can use the cascade to add or remove visual elements.

    Ronn ships with a few built in styles: toc, dark, 80c, and print. You can insert your own by giving the path or manipulating the RONN_STYLE environment variable.

    See ronn(1) for full details on all of these things (rtomayko)

    • HTML: It's now possible to generate a Table Of Contents of manpage sections. The TOC is disabled by default. To enable it: ronn --style=toc file.ronn (sunaku)

    • HTML: The RONN_LAYOUT environment variable can be used to apply a custom mustache layout template:

    RONN_LAYOUT=mine.mustache ronn man/great-program.1.ronn

    See lib/ronn/template/default.html for default markup and features (defunkt)

    • HTML: All heading elements include page anchor id attributes to make it possible to link to a specific manpage section (sunaku)

    • HTML: Markdown reference links can be used to refer to sections. To link to the SEE ALSO section of the current manpage, use: [SEE ALSO][], or [to control the link text][SEE ALSO], or even use the relative URL. (rtomayko)

    • 💅 HTML: 80 character terminal style: ronn -s 80c file.ronn -- precisely emulates a 80c terminal (sunaku)

    • 💅 HTML: Various appearance changes to the default stylesheet: smaller type with consistent vertical baseline; darker type for more contrast; em, var, and u are italic instead of underline (rtomayko)

    • 💅 HTML: Various print stylesheet tweaks, including hyperlinks and layout enhancements (sunaku)

    • 🏗 ROFF: ronn --warnings (-w) shows troff warnings on stderr when building or viewing manuals. (rtomayko)

    • ROFF: Ordered lists. (sunaku)

    • ROFF: URLs for hyperlinks are shown immediately after hyperlink text. (sunaku)

    • The RONN_MANUAL, RONN_ORGANIZATION, and RONN_DATE environment variables establish the default values of the --manual, --organization, and --date options (rtomayko)

    🐛 Bugs:

    • ROFF: Don't crash with empty preformatted blocks (sunaku)

    • ROFF: A whole bunch of weird whitespace related problems in roff output, such as the first line of definition lists being indented by two characters (rtomayko)

    • ROFF: All ['".] characters are backslash escaped in roff output. These characters are used for various roff macro syntax (rtomayko)

    🗄 Deprecations, Obsoletions:

    • 💻 The ronn(1) command line interface has changed in ways that are not backward-compatible with previous versions of ronn. The --build option is assumed when one or more .ronn files is given on the command line. Previous versions write generated content to standard output with no explicit --build options.

    The default behavior when no files are given remains the same as previous versions: ronn source text is read from stdin and roff is written to stdout.

    See `ronn --help' or the ronn(1) manual for more on command line interface changes.

    (rtomayko, defunkt)

    • HTML: Ronn no longer uses a specific monospace font-family; the system default monospace font is used instead. Use 'ronn --style' to set up a font stack (rtomayko)

    • 🚚 HTML: The following HTML elements are deprecated and will be removed at some point: div#man, div#man ol.man, div#man ol.head, div#man ol.man.

    The .mp, .man-decor, .man-head, .man-foot, .man-title, and .man-navigation classes should be used instead (rtomayko)

    • 📦 The markdown(5) manpage is no longer shipped with the ronn package. It is shipped with the latest version of rdiscount, however. (rtomayko, sunaku)