RubyGems - ronn - Versions diffs - 0.6.6 → 0.7.0 - Mend

ronn 0.6.6 → 0.7.0

Files changed (46) hide show

data/CHANGES +34 -0
data/INSTALLING +18 -0
data/README.md +43 -69
data/Rakefile +9 -10
data/bin/ronn +66 -49
data/config.ru +1 -1
data/lib/ronn.rb +35 -9
data/lib/ronn/document.rb +239 -135
data/lib/ronn/index.rb +183 -0
data/lib/ronn/roff.rb +48 -28
data/lib/ronn/template.rb +22 -8
data/lib/ronn/template/dark.css +1 -4
data/lib/ronn/template/default.html +0 -2
data/lib/ronn/template/man.css +12 -12
data/lib/ronn/utils.rb +8 -0
data/man/index.html +78 -0
data/man/index.txt +15 -0
data/man/{ronn.5 → ronn-format.7} +26 -30
data/man/{ronn.5.ronn → ronn-format.7.ronn} +39 -39
data/man/ronn.1 +47 -15
data/man/ronn.1.ronn +53 -23
data/ronn.gemspec +14 -8
data/test/angle_bracket_syntax.html +4 -2
data/test/basic_document.html +4 -2
data/test/custom_title_document.html +1 -2
data/test/definition_list_syntax.html +4 -2
data/test/dots_at_line_start_test.roff +10 -0
data/test/dots_at_line_start_test.ronn +4 -0
data/test/entity_encoding_test.html +24 -2
data/test/entity_encoding_test.roff +41 -1
data/test/entity_encoding_test.ronn +17 -0
data/test/index.txt +8 -0
data/test/markdown_syntax.html +5 -3
data/test/markdown_syntax.roff +4 -4
data/test/middle_paragraph.html +4 -2
data/test/missing_spaces.roff +3 -0
data/test/section_reference_links.html +4 -2
data/test/{ronn_test.rb → test_ronn.rb} +18 -5
data/test/{document_test.rb → test_ronn_document.rb} +59 -8
data/test/test_ronn_index.rb +73 -0
data/test/titleless_document.html +7 -2
data/test/titleless_document.ronn +3 -2
data/test/underline_spacing_test.roff +5 -0
metadata +30 -14
data/man/ronn.7 +0 -168
data/man/ronn.7.ronn +0 -120

data/man/ronn.7.ronn DELETED

@@ -1,120 +0,0 @@
-ronn -- the opposite of roff
-============================
-## DESCRIPTION
-Ronn is a text format and toolchain for creating UNIX manpages. It converts
-markdown to standard UNIX roff manpages and formatted HTML manuals for the web.
-The source format includes all of Markdown but has a more rigid structure and
-includes extensions that provide features commonly found in manpages (definition
-lists, link notation, etc.). The ronn(5) manual page defines the format in
-detail.
-## DOCUMENTATION
-The `.ronn` files located under the `man/` directory show off a wide range of
-ronn capabilities and are the source of Ronn's own documentation.  The source
-files and generated HTML / roff output files are available at:
-  * [ronn(1)](http://rtomayko.github.com/ronn/ronn.1) -
-    convert markdown files to manpages.<br>
-    [source file](http://github.com/rtomayko/ronn/blob/master/man/ronn.1.ronn),
-    [roff output](http://github.com/rtomayko/ronn/blob/master/man/ronn.1)
-  * [ronn(5)](http://rtomayko.github.com/ronn/ronn.5) -
-    markdown-based text format for authoring manpages<br>
-    [source file](http://github.com/rtomayko/ronn/blob/master/man/ronn.5.ronn),
-    [roff output](http://github.com/rtomayko/ronn/blob/master/man/ronn.5)
-## INSTALL
-Install with Rubygems:
-    $ [sudo] gem install ronn
-    $ ronn --help
-Or, clone the git repository:
-    $ git clone git://github.com/rtomayko/ronn.git
-    $ PATH=ronn/bin:$PATH
-    $ ronn --help
-## BASIC USAGE
-Build roff and HTML output files for one or more input files:
-    $ ronn man/ronn.5.ronn
-    roff: man/ronn.5
-    html: man/ronn.5.html
-View a roff manpage with man(1):
-    $ man man/ronn.5
-Generate only a standalone HTML version of one or more files:
-    $ ronn --html man/markdown.5.ronn
-    html: man/markdown.5.html
-Build roff versions of all ronn files in a directory:
-    $ ronn --roff man/*.ronn
-View a ronn file as if it were a manpage without building intermediate files:
-    $ ronn --man man/markdown.5.ronn
-The [ronn(1)](http://rtomayko.github.com/ronn/ronn.1) manual page includes
-comprehensive documentation on `ronn` command line options.
-## ABOUT
-Some people say UNIX manual pages are a poor and outdated style of
-documentation. I disagree:
-- Man pages follow a well defined structure that's immediately familiar. This
-  provides developers with a useful starting point when documenting new tools,
-  libraries, and formats.
-- Man pages get to the point. Because they're written in an inverted style, with
-  a SYNOPSIS section followed by additional detail, prose and references to
-  other sources of information, man pages provide the best of both cheat sheet
-  and reference style documentation.
-- Man pages have extremely -- unbelievably -- limited text formatting
-  capabilities. You get a couple of headings, lists, bold, underline and no
-  more. This is a feature.
-- Although two levels of section hierarchy are technically supported, most man
-  pages use only a single level. Unwieldy document hierarchies complicate
-  otherwise good documentation.  Feynman covered all of physics -- heavenly
-  bodies through QED -- with only two levels of document hierarchy (_The Feynman
-  Lectures on Physics_, 1970).
-- Man pages have a simple referencing syntax; e.g., sh(1), fork(2), markdown(7).
-  HTML versions can use this to generate links between pages.
-- The classical terminal man page display is typographically well thought out.
-  Big bold section headings, justified monospace text, nicely indented
-  paragraphs, intelligently aligned definition lists, and an informational
-  header and footer.
-Unfortunately, figuring out how to create a manpage is a fairly tedious process.
-The roff/man macro languages are highly extensible, fractured between multiple
-dialects, and include a bunch of device specific stuff irrelevant to modern
-publishing tools.
-Ronn aims to address many of the issues with manpage creation while preserving
-the things that makes manpages a great form of documentation.
-## COPYING
-Ronn is Copyright (C) 2009 [Ryan Tomayko](http://tomayko.com/about)<br>
-See the file COPYING for information of licensing and distribution.
-## SEE ALSO
-[ronn(1)](http://rtomayko.github.com/ronn/ronn.1),
-[ronn(5)](http://rtomayko.github.com/ronn/ronn.5),
-markdown(5)