doc/intro.erb in erbook-6.1.0 vs doc/intro.erb in erbook-7.0.0
- old
+ new
@@ -1,37 +1,45 @@
-<% chapter "Introduction" do %>
- <% eruby_url = "http://en.wikipedia.org/wiki/ERuby" %>
+%#--
+%# Copyright 2007 Suraj N. Kurapati
+%# See the LICENSE file for details.
+%#++
- <% project_summary do %>
- **<%= $project %>** is an extensible document processor that emits <%= xref "HelloWorld", "any document you can imagine" %> from [eRuby templates](<%= eruby_url %>) that allow scripting and dynamic content generation.
+% eruby_url = "http://en.wikipedia.org/wiki/ERuby"
+% api_url = './api/index.html'
+% repo_url = 'http://github.com/sunaku/' + $program
+% repo_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 %>) that allow scripting and dynamic content generation.
+
A working <%= xref "xhtml", "XHTML (web page)" %> format is provided, while <%= xref "latex", "LaTeX (PDF)" %>, <%= xref "man", "UNIX manual page" %>, and <%= xref "text", "plain text" %> formats are planned... <%= xref "License", "patches are welcome" %>!
- <% end %>
- **<%= $project %>** is exciting because:
- * Its documents are scriptable [eRuby templates](<%= eruby_url %>).
- * It lets you <%= xref "HelloWorld", "define your own document formats" %>.
- * Its core contains less than 300 lines of code.
+ <%= $project %> is exciting because:
+ * Its documents are scriptable [eRuby templates](<%= eruby_url %>).
+ * It lets you <%= xref "HelloWorld", "define your own document formats" %>.
+ * Its core contains less than 300 lines of code.
- These features distinguish **<%= $project %>** from the competition, which offers neither scriptable documents nor definable document formats:
- * [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)
+ These features distinguish <%= $project %> from the competition, which offers neither scriptable documents nor definable document formats:
+ * [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)
- <% section "Logistics" do %>
- * <%= xref "History", "Release notes" %> --- history of project releases.
- * [Source code](http://github.com/sunaku/<%= $program %>) --- obtain via [Git](http://git.or.cz) or browse online.
- * [API reference](api/index.html) --- documentation for source code.
+ %|section "Logistics"
+ * <%= xref "History", "Release notes" %> --- history of project releases.
+ * [Source code](<%= repo_url %>) --- obtain via <%= repo_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 authors" %>.
- <% paragraph "Version numbers" do %>
- **<%= $project %>** releases are numbered in *major.minor.patch*
+ %|paragraph "Version numbers"
+ <%= $project %> releases are numbered in *major.minor.patch*
form according to the [RubyGems rational versioning
policy](http://www.rubygems.org/read/chapter/7), which
can be summarized thus:
<table markdown="1">
@@ -65,46 +73,40 @@
<td style="background-color: #FFE4E1;">No</td>
<td>Yes</td>
</tr>
</tbody>
</table>
- <% end %>
- <% end %>
- <% section "License" do %>
- <%# include ../LICENSE #%>
- <% end %>
+ %|section "License"
+ %< "../LICENSE"
- <% section "Credits" do |n| %>
- <%= $logo = n.xref_link("".to_inline_xhtml) %>
- <%# include README #%>
+ %|section "Credits" |n|
+ %= $logo = n.xref_link("".to_inline_xhtml)
+ %< "README"
- **<%= $project %>** is made possible by
+ <%= $project %> is made possible by
<%= xref "History", "contributions" %>
from users like you:
* Jens Vierbuchen
* Maunika Gosike
* [Zhang Chiyuan](http://lifegoo.pluskid.org)
- <% end %>
- <% section "Reviews" do %>
+ %|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.
+ > 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
+ > \[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!
- <% end %>
-<% end %>
\ No newline at end of file