RubyGems - ronn-ng - Versions diffs - 0.7.4 - Mend

ronn-ng 0.7.4

Files changed (68) hide show

checksums.yaml +7 -0
data/AUTHORS +8 -0
data/CHANGES +184 -0
data/INSTALLING +20 -0
data/LICENSE.txt +11 -0
data/README.md +113 -0
data/Rakefile +163 -0
data/bin/ronn +223 -0
data/config.ru +15 -0
data/lib/ronn.rb +50 -0
data/lib/ronn/document.rb +495 -0
data/lib/ronn/index.rb +183 -0
data/lib/ronn/roff.rb +302 -0
data/lib/ronn/server.rb +70 -0
data/lib/ronn/template.rb +171 -0
data/lib/ronn/template/80c.css +6 -0
data/lib/ronn/template/dark.css +18 -0
data/lib/ronn/template/darktoc.css +17 -0
data/lib/ronn/template/default.html +41 -0
data/lib/ronn/template/man.css +100 -0
data/lib/ronn/template/print.css +5 -0
data/lib/ronn/template/screen.css +105 -0
data/lib/ronn/template/toc.css +27 -0
data/lib/ronn/utils.rb +55 -0
data/man/index.html +78 -0
data/man/index.txt +15 -0
data/man/ronn-format.7 +201 -0
data/man/ronn-format.7.ronn +157 -0
data/man/ronn.1 +325 -0
data/man/ronn.1.ronn +306 -0
data/ronn-ng.gemspec +97 -0
data/test/angle_bracket_syntax.html +18 -0
data/test/angle_bracket_syntax.ronn +12 -0
data/test/basic_document.html +9 -0
data/test/basic_document.ronn +4 -0
data/test/contest.rb +68 -0
data/test/custom_title_document.html +6 -0
data/test/custom_title_document.ronn +5 -0
data/test/definition_list_syntax.html +21 -0
data/test/definition_list_syntax.roff +26 -0
data/test/definition_list_syntax.ronn +18 -0
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 +35 -0
data/test/entity_encoding_test.roff +61 -0
data/test/entity_encoding_test.ronn +25 -0
data/test/index.txt +8 -0
data/test/markdown_syntax.html +957 -0
data/test/markdown_syntax.roff +1467 -0
data/test/markdown_syntax.ronn +881 -0
data/test/middle_paragraph.html +15 -0
data/test/middle_paragraph.roff +13 -0
data/test/middle_paragraph.ronn +10 -0
data/test/missing_spaces.roff +9 -0
data/test/missing_spaces.ronn +2 -0
data/test/pre_block_with_quotes.roff +13 -0
data/test/pre_block_with_quotes.ronn +6 -0
data/test/section_reference_links.html +17 -0
data/test/section_reference_links.roff +10 -0
data/test/section_reference_links.ronn +12 -0
data/test/test_ronn.rb +110 -0
data/test/test_ronn_document.rb +186 -0
data/test/test_ronn_index.rb +73 -0
data/test/titleless_document.html +10 -0
data/test/titleless_document.ronn +3 -0
data/test/underline_spacing_test.roff +21 -0
data/test/underline_spacing_test.ronn +11 -0
metadata +176 -0

data/lib/ronn/template/toc.css ADDED Viewed

@@ -0,0 +1,27 @@
+/* toc.css - enable table of contents */
+.man-navigation {
+    display:block !important;
+    position:fixed;
+    top:0;
+    left:113ex; /* .mp width + padding */
+    height:100%;
+    width:100%;
+    padding:48px 0 0 0;
+    border-left:1px solid #dbdbdb;
+    background:#eee;
+}
+.man-navigation a,
+.man-navigation a:hover,
+.man-navigation a:link,
+.man-navigation a:visited {
+    display:block;
+    margin:0;
+    padding:5px 2px 5px 30px;
+    color:#999;
+    text-decoration:none;
+}
+.man-navigation a:hover {
+    color:#111;
+    text-decoration:underline;
+}

data/lib/ronn/utils.rb ADDED Viewed

@@ -0,0 +1,55 @@
+require 'set'
+require 'cgi'
+module Ronn
+  module Utils
+    # All HTML 4 elements and some that are in common use.
+    HTML = %w[
+      a abbr acronym address applet area b base basefont bdo big blockquote body br
+      button caption center cite code col colgroup dd del dfn dir div dl dt em
+      fieldset font form frame frameset h1 h2 h3 h4 h5 h6 head hr html i iframe img
+      input ins isindex kbd label legend li link map menu meta noframes noscript
+      object ol optgroup option p param pre q s samp script select small span strike
+      strong style sub sup table tbody td textarea tfoot th thead title tr tt u ul var
+    ].to_set
+    # Block elements.
+    HTML_BLOCK = %w[
+      blockquote body colgroup dd div dl dt fieldset form frame frameset
+      h1 h2 h3 h4 h5 h6 hr head html iframe li noframes noscript
+      object ol optgroup option p param pre script select
+      style table tbody td textarea tfoot th thead title tr tt ul
+    ].to_set
+    # Inline elements
+    HTML_INLINE = HTML - HTML_BLOCK
+    # Elements that don't have a closing tag.
+    HTML_EMPTY  = %w[area base basefont br col hr input link meta].to_set
+    def block_element?(name)
+      HTML_BLOCK.include?(name)
+    end
+    def inline_element?(name)
+      HTML_INLINE.include?(name)
+    end
+    def empty_element?(name)
+      HTML_EMPTY.include?(name)
+    end
+    def html_element?(name)
+      HTML.include?(name)
+    end
+    def child_of?(node, tag)
+      while node
+        return true if node.name && node.name.downcase == tag
+        node = node.parent
+      end
+      false
+    end
+  end
+end

data/man/index.html ADDED Viewed

@@ -0,0 +1,78 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Ronn</title>
+  <style>
+    body {
+      font-size:24px;
+      line-height:1.5;
+      font-family:georgia,serif;
+      color:#555;
+    }
+    div#index {
+      width:28em;
+      margin:0 auto;
+    }
+    h1 {
+      text-align:center;
+      font-weight:normal;
+      color:#000;
+      margin-bottom:0;
+      letter-spacing:-3px;
+    }
+    h3 {
+      text-align:center;
+      font-weight:normal;
+      color:#444;
+      margin-top:-20px;
+      margin-bottom:40px;
+    }
+    h4 {
+      font-weight:normal;
+      font-size:26px;
+      color:#111;
+    }
+    p, dl    { margin-left:40px }
+    .aux     { font-family:monospace;font-size:20px;letter-spacing:1px; }
+    .also    { font-size:18px }
+    .copy    { font-size:16px;text-align:center;color:#111 }
+    .man-ref { font-family:monospace;letter-spacing:-2px; }
+  </style>
+</head>
+<body>
+<div id='index'>
+  <h1>Ronn</h1>
+  <h3>Builds manuals</h3>
+  <h4>Auxiliary</h4>
+  <p class='aux'>
+    <a href='http://github.com/apjanke/ronn-ng#readme'>README</a>,
+    <a href='http://github.com/apjanke/ronn-ng/blob/master/INSTALLING#files'>INSTALLING</a>,
+    <a href='http://github.com/apjanke/ronn-ng/blob/master/CHANGES#files'>CHANGES</a>,
+    <a href='http://github.com/apjanke/ronn-ng/blob/master/COPYING#files'>COPYING</a>,
+    <a href='http://github.com/apjanke/ronn-ng/blob/master/AUTHORS#files'>AUTHORS</a>
+  </p>
+  <h4>Manuals</h4>
+  <dl>
+    <dt><a class='man-ref' href='ronn.1.html'>ronn(1)</a></dt>
+    <dd>manual authoring tool</dd>
+    <dt><a class='man-ref' href='ronn-format.7.html'>ronn-format(7)</a></dt>
+    <dd>markdown-based text format for authoring manpages</dd>
+  </dl>
+  <h4>See Also</h4>
+  <p class='also'>
+    <a class='man-ref' href="http://developer.apple.com/mac/library/documentation/Darwin/Reference/ManPages/man5/manpages.5.html">manpages(5)</a>,
+    <a class='man-ref' href="http://daringfireball.net/projects/markdown/syntax">markdown(7)</a>,
+    <a class='man-ref' href="http://man.cx/man(1)">man(1)</a>,
+    <a class='man-ref' href="http://man.cx/roff(7)">roff(7)</a>,
+    <a class='man-ref' href="http://man.cx/groff(1)">groff(1)</a>,
+    <a class='man-ref' href="http://mustache.github.com/mustache.5.html">mustache(5)</a>
+  </p>
+  <p class='copy'>Copyright &copy; 2010 Ryan Tomayko, &copy; 2018 Andrew Janke</p>
+</div>
+</body>
+</html>

data/man/index.txt ADDED Viewed

@@ -0,0 +1,15 @@
+# manuals
+ronn(1)     ronn.1.ronn
+ronn(5)     ronn.5.ronn
+ronn(7)     ronn.7.ronn
+# external manuals
+roff(7)     http://man.cx/roff(7)
+grep(1)     http://man.cx/grep(1)
+groff(1)    http://man.cx/groff(1)
+sh(1)       http://man.cx/sh(1posix)
+test(1)     http://man.cx/test(1)
+fork(2)     http://man.cx/fork(2)
+man(1)      http://man.cx/man(1)
+markdown(7) http://daringfireball.net/projects/markdown/syntax
+manpages(5) http://developer.apple.com/mac/library/documentation/Darwin/Reference/ManPages/man5/manpages.5.html

data/man/ronn-format.7 ADDED Viewed

@@ -0,0 +1,201 @@
+.\" generated with Ronn/v0.7.0
+.\" http://github.com/rtomayko/ronn/tree/0.7.0
+.
+.TH "RONN\-FORMAT" "7" "June 2010" "Ronn 0.7.0" "Ronn Manual"
+.
+.SH "NAME"
+\fBronn\-format\fR \- manual authoring format based on Markdown
+.
+.SH "SYNOPSIS"
+.
+.nf
+name(1) \-\- short, single\-sentence description
+=============================================
+## SYNOPSIS
+`name` [<optional>\.\.\.] <flags>
+## DESCRIPTION
+A normal paragraph\. This can span multiple lines and is terminated with two
+or more line endings \-\- just like Markdown\.
+Inline markup for `code`, `user input`, and **strong** are displayed
+boldface; <variable>, _emphasis_, *emphasis*, are displayed in italics
+(HTML) or underline (roff)\.
+Manual references like sh(1), markdown(7), roff(7), etc\. are hyperlinked in
+HTML output\.
+Link to sections like [STANDARDS][], [SEE ALSO][], or [WITH A DIFFERENT LINK
+TEXT][#SEE\-ALSO]\.
+Definition lists:
+  * `\-a`, `\-\-argument`=[<value>]:
+    One or more paragraphs describing the argument\.
+  * You can put whatever you *want* here, really:
+    Nesting and paragraph spacing are respected\.
+Frequently used sections:
+## OPTIONS
+## SYNTAX
+## ENVIRONMENT
+## RETURN VALUES
+## STANDARDS
+## SECURITY CONSIDERATIONS
+## BUGS
+## HISTORY
+## AUTHOR
+## COPYRIGHT
+## SEE ALSO
+.
+.fi
+.
+.SH "DESCRIPTION"
+The ronn(1) command converts text in a simple markup to Unix manual pages\. The syntax includes all Markdown formatting features, plus conventions for expressing the structure and various notations present in standard Unix manpages\.
+.
+.P
+Not all roff(7) typesetting features can be expressed using ronn syntax\.
+.
+.SH "MANPAGE TITLE"
+Manpages have a \fIname\fR, \fIsection\fR, and a one\-line \fIdescription\fR\. Files must start with a level one heading defining these attributes:
+.
+.IP "" 4
+.
+.nf
+ls(1) \-\- list directory contents
+================================
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Indicates that the manpage is named \fBls\fR in manual section \fB1\fR (\"user commands\")\.
+.
+.SH "SECTION HEADINGS"
+Man section headings are expressed with markdown level two headings\. There are two syntaxes for level two headings\.
+.
+.P
+Hash prefix syntax:
+.
+.IP "" 4
+.
+.nf
+## HEADING TEXT
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Dash underline syntax:
+.
+.IP "" 4
+.
+.nf
+HEADING TEXT
+\-\-\-\-\-\-\-\-\-\-\-\-
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Section headings should be all uppercase and may not contain inline markup\.
+.
+.SH "INLINE MARKUP"
+Manpages have a limited set of text formatting capabilities\. There\'s basically \fBboldface\fR and \fIitalics\fR (often displayed using \fIunderline\fR)\. Ronn uses the following bits of markdown(7) to accomplish this:
+.
+.TP
+\fB`backticks`\fR (markdown compatible)
+Code, flags, commands, and noun\-like things; typically displayed in in \fBboldface\fR\. All text included within \fBbackticks\fR is displayed literally; other inline markup is not processed\. HTML output: \fB<code>\fR\.
+.
+.TP
+\fB**double\-stars**\fR (markdown compatible)
+Also displayed in boldface\. Unlike backticks, inline markup is processed\. HTML output: \fB<strong>\fR\.
+.
+.TP
+\fB<anglequotes>\fR (non\-compatible markdown extension)
+User\-specified arguments, variables, or user input\. Typically displayed with \fIunderline\fR in roff output\. HTML output: \fB<var/>\fR\.
+.
+.TP
+\fB_\fR\fIunderbars\fR\fB_\fR (markdown compatible)
+Emphasis\. May be used for literal option values\. Typically displayed with \fIunderline\fR in roff output\. HTML output: \fB<em>\fR\.
+.
+.P
+Here is grep(1)\'s DESCRIPTION section represented in \fBronn\fR:
+.
+.IP "" 4
+.
+.nf
+`Grep` searches the named input <FILE> (or standard input if
+no files are named, or the file name `\-` is given) for lines
+containing a match to the given <PATTERN>\. By default, `grep`
+prints the matching lines\.
+.
+.fi
+.
+.IP "" 0
+.
+.SH "DEFINITION LISTS"
+The definition list syntax is compatible with markdown\'s unordered list syntax but requires that the first line of each list item be terminated with a colon \"\fB:\fR\" character\. The contents of the first line is the \fIterm\fR; subsequent lines may be comprised of multiple paragraphs, code blocks, standard lists, and nested definition lists\.
+.
+.P
+An example definition list, taken from BSD test(1)\'s \fIDESCRIPTION\fR section:
+.
+.IP "" 4
+.
+.nf
+ The following primaries are used to construct expressions:
+   * `\-b` <file>:
+     True if <file> exists and is a block special file\.
+   * `\-c` <file>:
+     True if _file_ exists and is a character special file\.
+   * `\-d` <file>:
+     True if file exists and is a directory\.
+.
+.fi
+.
+.IP "" 0
+.
+.SH "LINKS"
+All markdown(7) linking features are supported\.
+.
+.P
+Markdown reference\-style links can be used to link to specific sections by name:
+.
+.IP "" 4
+.
+.nf
+## SECTION 1
+See the following section\.
+## SECTION 2
+See [SECTION 1][] or [to put it another way][SECTION 1]\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The anchor name would be \fB#SECTION\-1\fR and \fB#SECTION\-2\fR\. All non\-word characters are removed and spaces are replaced by dashes\.
+.
+.SH "SEE ALSO"
+ronn(1), markdown(7), roff(7)

data/man/ronn-format.7.ronn ADDED Viewed

@@ -0,0 +1,157 @@
+ronn-format(7) -- manual authoring format based on Markdown
+===========================================================
+## SYNOPSIS
+    name(1) -- short, single-sentence description
+    =============================================
+    ## SYNOPSIS
+    `name` [<optional>...] <flags>
+    ## DESCRIPTION
+    A normal paragraph. This can span multiple lines and is terminated with two
+    or more line endings -- just like Markdown.
+    Inline markup for `code`, `user input`, and **strong** are displayed
+    boldface; <variable>, _emphasis_, *emphasis*, are displayed in italics
+    (HTML) or underline (roff).
+    Manual references like sh(1), markdown(7), roff(7), etc. are hyperlinked in
+    HTML output.
+    Link to sections like [STANDARDS][], [SEE ALSO][], or [WITH A DIFFERENT LINK
+    TEXT][#SEE-ALSO].
+    Definition lists:
+      * `-a`, `--argument`=[<value>]:
+        One or more paragraphs describing the argument.
+      * You can put whatever you *want* here, really:
+        Nesting and paragraph spacing are respected.
+    Frequently used sections:
+    ## OPTIONS
+    ## SYNTAX
+    ## ENVIRONMENT
+    ## RETURN VALUES
+    ## STANDARDS
+    ## SECURITY CONSIDERATIONS
+    ## BUGS
+    ## HISTORY
+    ## AUTHOR
+    ## COPYRIGHT
+    ## SEE ALSO
+## DESCRIPTION
+The ronn(1) command converts text in a simple markup to Unix manual pages. The
+syntax includes all Markdown formatting features, plus conventions for
+expressing the structure and various notations present in standard Unix
+manpages.
+Not all roff(7) typesetting features can be expressed using ronn syntax.
+## MANPAGE TITLE
+Manpages have a <name>, <section>, and a one-line <description>. Files must
+start with a level one heading defining these attributes:
+    ls(1) -- list directory contents
+    ================================
+Indicates that the manpage is named `ls` in manual section `1` ("user
+commands").
+## SECTION HEADINGS
+Man section headings are expressed with markdown level two headings. There
+are two syntaxes for level two headings.
+Hash prefix syntax:
+    ## HEADING TEXT
+Dash underline syntax:
+    HEADING TEXT
+    ------------
+Section headings should be all uppercase and may not contain inline markup.
+## INLINE MARKUP
+Manpages have a limited set of text formatting capabilities. There's basically
+<b>boldface</b> and <i>italics</i> (often displayed using <u>underline</u>).
+Ronn uses the following bits of markdown(7) to accomplish this:
+  * <code>\`backticks\`</code> (markdown compatible):
+    Code, flags, commands, and noun-like things; typically displayed in in
+    <b>boldface</b>. All text included within `backticks` is displayed
+    literally; other inline markup is not processed. HTML output:
+    `<code>`.
+  * `**double-stars**` (markdown compatible):
+    Also displayed in boldface. Unlike backticks, inline markup is processed.
+    HTML output: `<strong>`.
+  * `<anglequotes>` (non-compatible markdown extension):
+    User-specified arguments, variables, or user input. Typically displayed with
+    <u>underline</u> in roff output. HTML output: `<var/>`.
+  * `_`_underbars_`_` (markdown compatible):
+    Emphasis. May be used for literal option values. Typically displayed with
+    <u>underline</u> in roff output. HTML output: `<em>`.
+Here is grep(1)'s DESCRIPTION section represented in `ronn`:
+    `Grep` searches the named input <FILE> (or standard input if
+    no files are named, or the file name `-` is given) for lines
+    containing a match to the given <PATTERN>. By default, `grep`
+    prints the matching lines.
+## DEFINITION LISTS
+The definition list syntax is compatible with markdown's unordered list syntax
+but requires that the first line of each list item be terminated with a colon
+"`:`" character. The contents of the first line is the <term>; subsequent lines
+may be comprised of multiple paragraphs, code blocks, standard lists, and nested
+definition lists.
+An example definition list, taken from BSD test(1)'s *DESCRIPTION* section:
+     The following primaries are used to construct expressions:
+       * `-b` <file>:
+         True if <file> exists and is a block special file.
+       * `-c` <file>:
+         True if _file_ exists and is a character special file.
+       * `-d` <file>:
+         True if file exists and is a directory.
+## LINKS
+All markdown(7) linking features are supported.
+Markdown reference-style links can be used to link to specific sections by name:
+    ## SECTION 1
+    See the following section.
+    ## SECTION 2
+    See [SECTION 1][] or [to put it another way][SECTION 1].
+The anchor name would be `#SECTION-1` and `#SECTION-2`. All non-word characters
+are removed and spaces are replaced by dashes.
+## SEE ALSO
+ronn(1), markdown(7), roff(7)