%#--
%# Copyright protects this work.
%# See LICENSE file for details.
%#++

% eruby_url = "http://en.wikipedia.org/wiki/ERuby"
% api_url = './api/index.html'
% src_url = 'http://github.com/sunaku/' + $program
% src_scm = '[Git](http://git-scm.com)'


%|chapter "Introduction"


  %|project

    <%= $project %> is an extensible document processor that emits <%= xref "HelloWorld", "any document you can imagine" %> from [eRuby templates](<%= eruby_url %>), which allow scripting and dynamic content generation.


  * <%= xref "History", "What's new?" %> --- history of project releases.
  * [Source code](<%= src_url %>) --- obtain via <%= src_scm %> or browse online.
  * [API reference](<%= api_url %>) --- documentation for source code.
  * [Project home](<%= $website %>) --- the <%= $project %> project home page.

  To get help or provide feedback, simply
  <%= xref "License", "contact the author(s)" %>.


  %|section "Features"

    <%= $project %> is exciting because:
    * Its documents are scriptable [eRuby templates](<%= eruby_url %>).
    * It lets you <%= xref "HelloWorld", "define your own document formats" %>.
    * It emits beautiful <%= xref "xhtml", "XHTML (web page)" %> documents.
    * It consists of a mere <%= `sloccount .`[/^Total.+=\s*(\d+)$/, 1] %> lines of code.


    %|note "More document formats are planned"

      <%= xref "latex", "LaTeX (PDF)" %>, <%= xref "man", "UNIX manual page" %>, and <%= xref "text", "plain text" %> document formats are planned for future releases... <%= xref "License", "patches are welcome" %>!


  %|section "License"

    %< "../LICENSE"


  %|section "Credits" |n|

    %= $logo = n.xref_link("![#{$project} logo](#{$program}.png)".to_inline_xhtml)

    %< "README"

    <%= $project %> is made possible by
    %= xref "History", "contributions"
    from users like you:

    %< "../CREDITS"


  %|section "Reviews"

    Tom Cloyd in [ruby-talk](http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/327499):

    > This documentation is simply gorgeous!


    Vitor Peres in [ruby-talk](http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/283052):

    > I actually felt like printing \[this manual], because it's just so well-thought typographically... Even if \[<%= $project %>] weren't great by itself, I'd feel good just looking at the manual.


    Ara T. Howard in [ruby-talk](http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/282949):

    > \[This manual is] a insanely complete and nice looking bit of documentation \[... <%= $project %>] looks like a great project


    Martin DeMello in [ruby-talk](http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/283304):

    > Very nice work indeed!


  %|section "Related works"

    Note that, unlike <%= $project %>, these related works offer *neither* scriptable documents nor definable document formats.  I have yet to encounter another project that does.  If you happen to know, please enlighten me.

    * [DocBook](http://www.docbook.org)
    * [Deplate](http://deplate.sourceforge.net)
    * [SiSU](http://www.jus.uio.no/sisu/SiSU/)
    * [AsciiDoc](http://www.methods.co.nz/asciidoc/)
    * [txt2tags](http://txt2tags.sourceforge.net)
    * [Grutatxt](http://www.triptico.com/software/grutatxt.html)