erbook 7.0.0 → 7.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/CREDITS +3 -0
- data/bin/erbook +2 -2
- data/doc/HelloWorld.input +1 -1
- data/doc/api/classes/ERBook/Document.html +153 -150
- data/doc/api/classes/ERBook/Document/Node.html +7 -7
- data/doc/api/classes/ERBook/Template.html +24 -24
- data/doc/api/classes/ERBook/Template/Sandbox.html +6 -6
- data/doc/api/classes/RDoc/AnyMethod.html +32 -28
- data/doc/api/classes/RDoc/TopLevel.html +47 -47
- data/doc/api/classes/String.html +14 -14
- data/doc/api/created.rid +1 -1
- data/doc/api/files/CREDITS.html +68 -0
- data/doc/api/files/lib/erbook/document_rb.html +1 -3
- data/doc/api/files/lib/erbook/rdoc_rb.html +1 -1
- data/doc/api/files/lib/erbook/template_rb.html +1 -1
- data/doc/api/files/lib/erbook/to_xhtml_rb.html +3 -3
- data/doc/api/files/lib/erbook_rb.html +3 -1
- data/doc/api/panel/search_index.js +1 -1
- data/doc/api/panel/tree.js +1 -1
- data/doc/formats.erb +129 -8
- data/doc/history.erb +136 -2
- data/doc/index.erb +2 -2
- data/doc/index.xhtml +1867 -610
- data/doc/intro.erb +29 -13
- data/doc/setup.erb +9 -2
- data/doc/theory.erb +24 -3
- data/doc/usage.erb +11 -2
- data/fmt/xhtml.yaml +913 -707
- data/fmt/{xhtml.icons → xhtml/icons}/index.yaml +2 -2
- data/fmt/{xhtml.icons → xhtml/icons}/mediawiki-1.13.2/COPYING +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/mediawiki-1.13.2/README +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/mediawiki-1.13.2/skins/simple/external.png +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/rakefile +4 -6
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/16x16/places/start-here.png +0 -0
- data/fmt/xhtml/icons/tango-icon-theme-0.8.90/32x32/actions/go-next.png +0 -0
- data/fmt/xhtml/icons/tango-icon-theme-0.8.90/32x32/actions/go-previous.png +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/32x32/places/start-here.png +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/32x32/status/software-update-available.png +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/48x48/apps/accessories-text-editor.png +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/48x48/apps/internet-group-chat.png +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/48x48/emblems/emblem-important.png +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/48x48/status/dialog-error.png +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/48x48/status/dialog-information.png +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/48x48/status/dialog-warning.png +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/COPYING +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/README +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/scalable/actions/bookmark-new.svg +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/scalable/actions/go-home.svg +0 -0
- data/fmt/xhtml/icons/tango-icon-theme-0.8.90/scalable/actions/go-next.svg +191 -0
- data/fmt/xhtml/icons/tango-icon-theme-0.8.90/scalable/actions/go-previous.svg +852 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/scalable/actions/view-refresh.svg +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/scalable/apps/accessories-text-editor.svg +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/scalable/apps/internet-group-chat.svg +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/scalable/emblems/emblem-favorite.svg +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/scalable/emblems/emblem-important.svg +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/scalable/mimetypes/application-certificate.svg +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/scalable/places/start-here.svg +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/scalable/status/dialog-error.svg +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/scalable/status/dialog-information.svg +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/scalable/status/dialog-warning.svg +0 -0
- data/fmt/{xhtml.icons → xhtml/icons}/tango-icon-theme-0.8.90/scalable/status/software-update-available.svg +0 -0
- data/fmt/xhtml/jquery/images/ui-bg_flat_0_aaaaaa_40x100.png +0 -0
- data/fmt/xhtml/jquery/images/ui-bg_flat_75_ffffff_40x100.png +0 -0
- data/fmt/xhtml/jquery/images/ui-bg_glass_55_fbf9ee_1x400.png +0 -0
- data/fmt/xhtml/jquery/images/ui-bg_glass_65_ffffff_1x400.png +0 -0
- data/fmt/xhtml/jquery/images/ui-bg_glass_75_dadada_1x400.png +0 -0
- data/fmt/xhtml/jquery/images/ui-bg_glass_75_e6e6e6_1x400.png +0 -0
- data/fmt/xhtml/jquery/images/ui-bg_glass_95_fef1ec_1x400.png +0 -0
- data/fmt/xhtml/jquery/images/ui-bg_highlight-soft_75_cccccc_1x100.png +0 -0
- data/fmt/xhtml/jquery/images/ui-icons_222222_256x240.png +0 -0
- data/fmt/xhtml/jquery/images/ui-icons_2e83ff_256x240.png +0 -0
- data/fmt/xhtml/jquery/images/ui-icons_454545_256x240.png +0 -0
- data/fmt/xhtml/jquery/images/ui-icons_888888_256x240.png +0 -0
- data/fmt/xhtml/jquery/images/ui-icons_cd0a0a_256x240.png +0 -0
- data/fmt/{xhtml.scripts → xhtml/jquery}/jquery-1.3.2.min.js +0 -0
- data/fmt/xhtml/jquery/jquery-ui-1.7.2.custom.css +406 -0
- data/fmt/xhtml/jquery/jquery-ui-1.7.2.custom.min.js +43 -0
- data/lang/de.yaml +13 -2
- data/lang/el.yaml +13 -2
- data/lang/es.yaml +13 -2
- data/lang/fr.yaml +13 -2
- data/lang/it.yaml +13 -2
- data/lang/ja.yaml +13 -2
- data/lang/ko.yaml +13 -2
- data/lang/nl.yaml +13 -2
- data/lang/phrases.yaml +15 -4
- data/lang/pt.yaml +13 -2
- data/lang/ru.yaml +13 -2
- data/lang/zh.yaml +13 -2
- data/lang/zt.yaml +13 -2
- data/lib/erbook.rb +10 -8
- data/lib/erbook/document.rb +144 -139
- data/lib/erbook/rdoc.rb +29 -7
- data/lib/erbook/template.rb +2 -2
- data/lib/erbook/to_xhtml.rb +6 -2
- metadata +78 -45
- data/doc/api/files/ANN_eml.html +0 -276
- data/doc/api/files/ANN_html.html +0 -407
- data/doc/api/files/ANN_txt.html +0 -271
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/32x32/actions/go-down.png +0 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/32x32/actions/go-up.png +0 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/scalable/actions/go-down.svg +0 -200
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/scalable/actions/go-up.svg +0 -196
- data/fmt/xhtml.scripts/jquery.localscroll-1.2.7-min.js +0 -9
- data/fmt/xhtml.scripts/jquery.scrollTo-1.4.1-min.js +0 -11
data/doc/api/created.rid
CHANGED
@@ -1 +1 @@
|
|
1
|
-
|
1
|
+
Sun, 30 Aug 2009 20:40:28 -0700
|
@@ -0,0 +1,68 @@
|
|
1
|
+
<?xml version="1.0" encoding="utf-8"?>
|
2
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
3
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
5
|
+
<head>
|
6
|
+
<title>CREDITS</title>
|
7
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
8
|
+
<link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" />
|
9
|
+
<link rel="stylesheet" href="../css/main.css" type="text/css" media="screen" />
|
10
|
+
<script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
|
11
|
+
<script src="../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
|
12
|
+
<script src="../js/main.js" type="text/javascript" charset="utf-8"></script>
|
13
|
+
</head>
|
14
|
+
|
15
|
+
<body>
|
16
|
+
<div class="banner">
|
17
|
+
<h1>
|
18
|
+
CREDITS
|
19
|
+
</h1>
|
20
|
+
<ul class="files">
|
21
|
+
<li>CREDITS</li>
|
22
|
+
<li>Last modified: Sun Aug 30 18:31:05 -0700 2009</li>
|
23
|
+
</ul>
|
24
|
+
</div>
|
25
|
+
|
26
|
+
<div id="bodyContent">
|
27
|
+
<div id="content">
|
28
|
+
|
29
|
+
<div class="description">
|
30
|
+
<ul>
|
31
|
+
<li>Jens Vierbuchen
|
32
|
+
|
33
|
+
</li>
|
34
|
+
<li>Maunika Gosike
|
35
|
+
|
36
|
+
</li>
|
37
|
+
<li>[Zhang Chiyuan](<a
|
38
|
+
href="http://lifegoo.pluskid.org">lifegoo.pluskid.org</a>)
|
39
|
+
|
40
|
+
</li>
|
41
|
+
</ul>
|
42
|
+
|
43
|
+
</div>
|
44
|
+
|
45
|
+
|
46
|
+
|
47
|
+
|
48
|
+
|
49
|
+
|
50
|
+
|
51
|
+
|
52
|
+
|
53
|
+
|
54
|
+
|
55
|
+
|
56
|
+
|
57
|
+
|
58
|
+
|
59
|
+
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
|
64
|
+
|
65
|
+
</div>
|
66
|
+
</div>
|
67
|
+
</body>
|
68
|
+
</html>
|
@@ -19,7 +19,7 @@
|
|
19
19
|
</h1>
|
20
20
|
<ul class="files">
|
21
21
|
<li>lib/erbook/document.rb</li>
|
22
|
-
<li>Last modified: Sun
|
22
|
+
<li>Last modified: Sun Aug 30 18:31:07 -0700 2009</li>
|
23
23
|
</ul>
|
24
24
|
</div>
|
25
25
|
|
@@ -39,8 +39,6 @@
|
|
39
39
|
|
40
40
|
<li>enumerator</li>
|
41
41
|
|
42
|
-
<li>ostruct</li>
|
43
|
-
|
44
42
|
</ul>
|
45
43
|
|
46
44
|
|
@@ -19,7 +19,7 @@
|
|
19
19
|
</h1>
|
20
20
|
<ul class="files">
|
21
21
|
<li>lib/erbook/to_xhtml.rb</li>
|
22
|
-
<li>Last modified: Sun
|
22
|
+
<li>Last modified: Sun Aug 30 18:31:07 -0700 2009</li>
|
23
23
|
</ul>
|
24
24
|
</div>
|
25
25
|
|
@@ -29,8 +29,8 @@
|
|
29
29
|
<div class="description">
|
30
30
|
<p>
|
31
31
|
This file defines the <a
|
32
|
-
href="../../../classes/String.html#
|
33
|
-
href="../../../classes/String.html#
|
32
|
+
href="../../../classes/String.html#M000040">String#to_xhtml</a> and <a
|
33
|
+
href="../../../classes/String.html#M000039">String#to_inline_xhtml</a>
|
34
34
|
methods, which are invoked to transform plain text into XHTML.
|
35
35
|
</p>
|
36
36
|
<p>
|
@@ -19,7 +19,7 @@
|
|
19
19
|
</h1>
|
20
20
|
<ul class="files">
|
21
21
|
<li>lib/erbook.rb</li>
|
22
|
-
<li>Last modified: Sun
|
22
|
+
<li>Last modified: Sun Aug 30 20:35:14 -0700 2009</li>
|
23
23
|
</ul>
|
24
24
|
</div>
|
25
25
|
|
@@ -37,6 +37,8 @@
|
|
37
37
|
|
38
38
|
<li>erbook/document</li>
|
39
39
|
|
40
|
+
<li>ostruct</li>
|
41
|
+
|
40
42
|
</ul>
|
41
43
|
|
42
44
|
|
@@ -1 +1 @@
|
|
1
|
-
var search_data = {"index":{"info":[["ERBook","lib\/erbook.rb","classes\/ERBook.html","","",1],["Document","ERBook","classes\/ERBook\/Document.html"," < Object","",1],["Node","ERBook::Document","classes\/ERBook\/Document\/Node.html"," < OpenStruct","",1],["Template","ERBook","classes\/ERBook\/Template.html"," < Ember::Template","eRuby template that provides access to the underlying result buffer (which contains the result of template",1],["Sandbox","ERBook::Template","classes\/ERBook\/Template\/Sandbox.html"," < Object","Environment for template evaluation. ",1],["RDoc","lib\/erbook\/rdoc.rb","classes\/RDoc.html","","",1],["AnyMethod","RDoc","classes\/RDoc\/AnyMethod.html"," < Object","",1],["TopLevel","RDoc","classes\/RDoc\/TopLevel.html"," < Object","",1],["String","lib\/erbook\/to_xhtml.rb","classes\/String.html"," < Object","",1],["__block_content__","ERBook::Template::Sandbox","classes\/ERBook\/Template\/Sandbox.html#
|
1
|
+
var search_data = {"index":{"searchIndex":["erbook","document","node","template","sandbox","rdoc","anymethod","toplevel","string","__block_content__()","all_classes()","all_methods()","all_modules()","buffer()","comment_html()","decl()","full_name()","new()","new()","parse()","parse_file()","refresh_all_classes_and_modules()","render()","render_with()","to_inline_xhtml()","to_s()","to_s()","to_xhtml()","top_level()","credits","license","erbook.rb","document.rb","rdoc.rb","template.rb","to_xhtml.rb"],"longSearchIndex":["lib\/erbook.rb","erbook","erbook::document","erbook","erbook::template","lib\/erbook\/rdoc.rb","rdoc","rdoc","lib\/erbook\/to_xhtml.rb","erbook::template::sandbox","rdoc::toplevel","rdoc::toplevel","rdoc::toplevel","erbook::template","rdoc::anymethod","rdoc::anymethod","rdoc::anymethod","erbook::document","erbook::template","rdoc::toplevel","rdoc::toplevel","rdoc::toplevel","erbook::template","erbook::template","string","erbook::document","erbook::document::node","string","rdoc::anymethod","files\/credits.html","files\/license.html","files\/lib\/erbook_rb.html","files\/lib\/erbook\/document_rb.html","files\/lib\/erbook\/rdoc_rb.html","files\/lib\/erbook\/template_rb.html","files\/lib\/erbook\/to_xhtml_rb.html"],"info":[["ERBook","lib\/erbook.rb","classes\/ERBook.html"," < ","",1],["Document","ERBook","classes\/ERBook\/Document.html"," < Object","",1],["Node","ERBook::Document","classes\/ERBook\/Document\/Node.html"," < OpenStruct","",1],["Template","ERBook","classes\/ERBook\/Template.html"," < Ember::Template","eRuby template that provides access to the underlying result buffer (which contains the result of template",1],["Sandbox","ERBook::Template","classes\/ERBook\/Template\/Sandbox.html"," < Object","Environment for template evaluation. ",1],["RDoc","lib\/erbook\/rdoc.rb","classes\/RDoc.html"," < ","",1],["AnyMethod","RDoc","classes\/RDoc\/AnyMethod.html"," < Object","",1],["TopLevel","RDoc","classes\/RDoc\/TopLevel.html"," < Object","",1],["String","lib\/erbook\/to_xhtml.rb","classes\/String.html"," < Object","",1],["__block_content__","ERBook::Template::Sandbox","classes\/ERBook\/Template\/Sandbox.html#M000045","(*block_args)","Returns an array of things that the given block wants to append to the buffer. If the given block does",2],["all_classes","RDoc::TopLevel","classes\/RDoc\/TopLevel.html#M000051","()","Returns an array of all classes recorded thus far. ",2],["all_methods","RDoc::TopLevel","classes\/RDoc\/TopLevel.html#M000053","()","Returns an array of RDoc::AnyMethod objects representing all methods recorded thus far. ",2],["all_modules","RDoc::TopLevel","classes\/RDoc\/TopLevel.html#M000052","()","Returns an array of all modules recorded thus far. ",2],["buffer","ERBook::Template","classes\/ERBook\/Template.html#M000042","()","Returns the result of template evaluation thus far. ",2],["comment_html","RDoc::AnyMethod","classes\/RDoc\/AnyMethod.html#M000059","()","Returns a HTML version of this method's comment. ",2],["decl","RDoc::AnyMethod","classes\/RDoc\/AnyMethod.html#M000058","()","Returns a complete method declaration with block parameters and all. ",2],["full_name","RDoc::AnyMethod","classes\/RDoc\/AnyMethod.html#M000057","()","Returns the fully qualified name of this method. ",2],["new","ERBook::Document","classes\/ERBook\/Document.html#M000048","(format_name, input_text, input_file, options = {})","==== Parameters [format_name] Either the short-hand name of a built-in format or the path to a format",2],["new","ERBook::Template","classes\/ERBook\/Template.html#M000038","(source, input, unindent = true, safe_level = nil)","==== Parameters [source] Replacement for the ambiguous '(erb)' identifier in stack traces; so that the",2],["parse","RDoc::TopLevel","classes\/RDoc\/TopLevel.html#M000055","(code_string, file_name = __FILE__)","Returns a RDoc::TopLevel object containing information parsed from the given code string. This information",2],["parse_file","RDoc::TopLevel","classes\/RDoc\/TopLevel.html#M000056","(file_name)","Returns a RDoc::TopLevel object containing information parsed from the code in the given file. This",2],["refresh_all_classes_and_modules","RDoc::TopLevel","classes\/RDoc\/TopLevel.html#M000054","()","Update the return value of the all_classes_and_modules() method to *really* include every class and every",2],["render","ERBook::Template","classes\/ERBook\/Template.html#M000041","()","Returns the output of evaluating this template inside the given context. If no context is given, then",2],["render_with","ERBook::Template","classes\/ERBook\/Template.html#M000043","(inst_vars = {})","Renders this template within a fresh sandbox that is populated with the given instance variables, whose",2],["to_inline_xhtml","String","classes\/String.html#M000039","()","Transforms this string into an *inline* XHTML string (one that does not contain any block-level XHTML",2],["to_s","ERBook::Document","classes\/ERBook\/Document.html#M000061","()","Returns the output of this document. ",2],["to_s","ERBook::Document::Node","classes\/ERBook\/Document\/Node.html#M000062","()","Returns the output of this node. ",2],["to_xhtml","String","classes\/String.html#M000040","(inline = false)","Transforms this string into XHTML while ensuring that the result contains one or more block-level elements",2],["top_level","RDoc::AnyMethod","classes\/RDoc\/AnyMethod.html#M000060","()","Returns the RDoc::TopLevel object which contains this method. ",2],["CREDITS","files\/CREDITS.html","files\/CREDITS.html","","* Jens Vierbuchen * Maunika Gosike * [Zhang Chiyuan](http:\/\/lifegoo.pluskid.org) ",3],["LICENSE","files\/LICENSE.html","files\/LICENSE.html","","(the ISC license) Copyright 2006 Suraj N. Kurapati <sunaku@gmail.com> Permission to use, copy, modify,",3],["erbook.rb","files\/lib\/erbook_rb.html","files\/lib\/erbook_rb.html",""," ",3],["document.rb","files\/lib\/erbook\/document_rb.html","files\/lib\/erbook\/document_rb.html",""," ",3],["rdoc.rb","files\/lib\/erbook\/rdoc_rb.html","files\/lib\/erbook\/rdoc_rb.html","","Workaround for `rdoc --fmt xml` not dumping information about methods. ",3],["template.rb","files\/lib\/erbook\/template_rb.html","files\/lib\/erbook\/template_rb.html",""," ",3],["to_xhtml.rb","files\/lib\/erbook\/to_xhtml_rb.html","files\/lib\/erbook\/to_xhtml_rb.html","","This file defines the String#to_xhtml and String#to_inline_xhtml methods, which are invoked to transform",3]]}}
|
data/doc/api/panel/tree.js
CHANGED
@@ -1 +1 @@
|
|
1
|
-
var tree = [["ERBook","classes\/ERBook.html","",[["Document","classes\/ERBook\/Document.html"," < Object",[["Node","classes\/ERBook\/Document\/Node.html"," < OpenStruct",[]]]],["Template","classes\/ERBook\/Template.html"," < Ember::Template",[["Sandbox","classes\/ERBook\/Template\/Sandbox.html"," < Object",[]]]]]],["RDoc","classes\/RDoc.html","",[["AnyMethod","classes\/RDoc\/AnyMethod.html"," < Object",[]],["TopLevel","classes\/RDoc\/TopLevel.html"," < Object",[]]]],["String","classes\/String.html"," < Object",[]]]
|
1
|
+
var tree = [["","","files",[["CREDITS","files\/CREDITS.html","",[]],["LICENSE","files\/LICENSE.html","",[]],["","","lib",[["","","erbook",[["document.rb","files\/lib\/erbook\/document_rb.html","",[]],["rdoc.rb","files\/lib\/erbook\/rdoc_rb.html","",[]],["template.rb","files\/lib\/erbook\/template_rb.html","",[]],["to_xhtml.rb","files\/lib\/erbook\/to_xhtml_rb.html","",[]]]],["erbook.rb","files\/lib\/erbook_rb.html","",[]]]]]],["ERBook","classes\/ERBook.html","",[["Document","classes\/ERBook\/Document.html"," < Object",[["Node","classes\/ERBook\/Document\/Node.html"," < OpenStruct",[]]]],["Template","classes\/ERBook\/Template.html"," < Ember::Template",[["Sandbox","classes\/ERBook\/Template\/Sandbox.html"," < Object",[]]]]]],["RDoc","classes\/RDoc.html","",[["AnyMethod","classes\/RDoc\/AnyMethod.html"," < Object",[]],["TopLevel","classes\/RDoc\/TopLevel.html"," < Object",[]]]],["String","classes\/String.html"," < Object",[]]]
|
data/doc/formats.erb
CHANGED
@@ -1,28 +1,33 @@
|
|
1
1
|
%#--
|
2
|
-
%# Copyright
|
3
|
-
%# See
|
2
|
+
%# Copyright protects this work.
|
3
|
+
%# See LICENSE file for details.
|
4
4
|
%#++
|
5
5
|
|
6
6
|
%|part "Formats"
|
7
|
+
|
7
8
|
This part describes the default formats provided along with <%= $project %>. The <%= xref "SpecFile", "format specification files" %> for these formats can be found in the <tt>fmt/</tt> directory of the <%= $project %> installation directory (see <%= xref "Manifest" %>).
|
8
9
|
|
9
10
|
These formats are meant to serve as working examples. If you require more functionality from one of these formats, simply make a copy of the corresponding format specification file and edit the copy to suit your needs. If you would like to contribute or discuss your enhancements to these default formats, you can <%= xref "License", "contact the author" %>.
|
10
11
|
|
12
|
+
|
11
13
|
%|chapter "XHTML (web page)", "xhtml"
|
14
|
+
|
12
15
|
This format generates a _monolithic_ XHTML document that allows users to easily search for a particular topic using nothing more than their web browser's built-in text search mechanism. This facilitates offline reading, where an Internet search engine is not available.
|
13
16
|
|
14
17
|
When viewing an XHTML document in a graphical web browser, you will notice navigation menus to the left of chapters, sections, figures, admonitions, and so on. These menus contain hyperlinks that make it easy to navigate the XHTML document, especially for users of text-only web browsers.
|
15
18
|
|
16
|
-
Furthermore, the XHTML document comes equipped with a stylesheet
|
19
|
+
Furthermore, the XHTML document comes equipped with a stylesheet suitable for printing. In particular, users of web browsers that support CSS3 selectors will notice that all hyperlinks have been expanded to include their target URL next to them. Try the "print preview" function of your web browser to see how the XHTML document would appear when printed.
|
20
|
+
|
17
21
|
|
18
22
|
%|section "Text to XHTML conversion"
|
23
|
+
|
19
24
|
The <tt>lib/<%= $program %>/to_xhtml.rb</tt> file inside <%= $project %>'s installation directory (see <%= xref "Manifest" %>) defines the following methods:
|
20
25
|
|
21
26
|
* `String#to_xhtml` - Transforms this string into XHTML while ensuring that the result contains one or more block-level elements at the root.
|
22
27
|
|
23
|
-
* `String
|
28
|
+
* `String#to_inline_xhtml` - Transforms this string into an *inline* XHTML string (one that does not contain any block-level XHTML elements at the root).
|
24
29
|
|
25
|
-
The default implementation of the `String#to_xhtml` method employs the [Markdown](http://daringfireball.net/projects/markdown/) markup system. If you do not like Markdown or wish to use a different markup system for text in your documents, then simply edit the <tt>to_xhtml.rb</tt> file and adjust the source code of the default `String#to_xhtml` and `String
|
30
|
+
The default implementation of the `String#to_xhtml` method employs the [Markdown](http://daringfireball.net/projects/markdown/) markup system. If you do not like Markdown or wish to use a different markup system for text in your documents, then simply edit the <tt>to_xhtml.rb</tt> file and adjust the source code of the default `String#to_xhtml` and `String#to_inline_xhtml` methods accordingly.
|
26
31
|
|
27
32
|
For example, if you replace the entire <tt>to_xhtml.rb</tt> file with the following code, then the output of all nodes will appear within red boxes in the final output document.
|
28
33
|
|
@@ -44,7 +49,9 @@
|
|
44
49
|
|
45
50
|
In addition to supporting Markdown syntax, the default implementation has some additional features which are described in the following subsections.
|
46
51
|
|
52
|
+
|
47
53
|
%|section "Syntax coloring for source code"
|
54
|
+
|
48
55
|
Syntax coloring is _automatically added_ to source code found inside the **<code>** and **</code>** HTML tags. The syntax coloring library, [CodeRay](http://coderay.rubychan.de), currently supports the following programming languages:
|
49
56
|
* Ruby
|
50
57
|
* C
|
@@ -53,7 +60,9 @@
|
|
53
60
|
* RHTML (Rails)
|
54
61
|
* Nitro-XHTML
|
55
62
|
|
63
|
+
|
56
64
|
%|section "Specifying the programming language"
|
65
|
+
|
57
66
|
Because different programming languages have different syntax coloring schemes, you can specify the language of your source code using the `lang` attribute to ensure that only the appropriate coloring scheme is used. Note that unless the `lang` attribute is specified, _Ruby_ is assumed to be the programming language of all source code by default.
|
58
67
|
|
59
68
|
<% sampleCode = %q{
|
@@ -91,17 +100,23 @@
|
|
91
100
|
|
92
101
|
<code lang="html"><%= verbatim sampleCode %></code>
|
93
102
|
|
103
|
+
|
94
104
|
%|section "Smart sizing of source code"
|
105
|
+
|
95
106
|
Source code is _automatically sized_ to be displayed as either a line or paragraph of text, depending on whether it contains line breaks.
|
96
107
|
|
97
108
|
For example, here is a single line <code>life = true or false</code> of code. And here is a paragraph <code>life =
|
98
109
|
true or
|
99
110
|
false</code> of code.
|
100
111
|
|
112
|
+
|
101
113
|
%|section "Protecting verbatim text"
|
114
|
+
|
102
115
|
Sometimes you just need to protect some text from being mangled by the text-to-XHTML conversion process . In such cases, you can wrap the text you want to proctect within **<noformat>** and **</noformat>** tags.
|
103
116
|
|
117
|
+
|
104
118
|
%|section "Parameters"
|
119
|
+
|
105
120
|
The XHTML format accepts the following document parameters. To disable the default value for a particular parameter, simply set that parameter to `nil`. For example, to disable the `$authors` parameter, you would write `$authors = nil` in your input document.
|
106
121
|
|
107
122
|
| Parameter | Type | Default value | Description |
|
@@ -113,7 +128,9 @@
|
|
113
128
|
| `$logo` | `String` | `nil` | Arbitrary content that goes above the document title in the default header. |
|
114
129
|
| `$feeds` | `Hash` | `nil` | A mapping of feed URL to feed format. Here is an example: <code>$feeds = { "my_rss_feed.xml" => "rss", "my_atom_feed.xml" => "atom" }</code> |
|
115
130
|
|
131
|
+
|
116
132
|
%|section "Methods"
|
133
|
+
|
117
134
|
The XHTML format provides the following methods. In the method declarations shown below,
|
118
135
|
* a pound sign (#) indicates that the method is an *instance method*, meaning that it can only be invoked on instances of a class, not on the classes themselves.
|
119
136
|
* a double colon sign (::) indicates that the method is a *class method*, meaning that it can only be invoked on a class.
|
@@ -124,14 +141,26 @@
|
|
124
141
|
|
125
142
|
RDoc::TopLevel.parse @format['code']
|
126
143
|
RDoc::TopLevel.parse_file 'lib/erbook/to_xhtml.rb'
|
144
|
+
|
145
|
+
methods_by_owner = Hash.new {|h,k| h[k] = [] }
|
127
146
|
RDoc::TopLevel.all_methods.each do |m|
|
128
|
-
|
129
|
-
|
147
|
+
methods_by_owner[m.parent.full_name] << m
|
148
|
+
end
|
149
|
+
|
150
|
+
methods_by_owner.each do |owner, methods|
|
151
|
+
section "`#{owner}`" do
|
152
|
+
methods.each do |m|
|
153
|
+
paragraph "`#{m.name}`" do
|
154
|
+
"`#{m.decl}`\n\n#{m.comment_html}"
|
155
|
+
end
|
156
|
+
end
|
130
157
|
end
|
131
158
|
end
|
132
159
|
%>
|
133
160
|
|
161
|
+
|
134
162
|
%|chapter "Nodes", "xhtml.nodes"
|
163
|
+
|
135
164
|
Unless otherwise noted, all nodes defined by the XHTML format accept two arguments, in this order:
|
136
165
|
1. a required *title* for the node
|
137
166
|
2. an optional *unique identifier* for the node
|
@@ -145,19 +174,29 @@
|
|
145
174
|
| toc | Boolean | Include this node in the **Table of Contents** (TOC)? |
|
146
175
|
| lof | Boolean | Include this node in the **List of Figures** (LOF)? |
|
147
176
|
|
177
|
+
|
148
178
|
%|section "Structural nodes"
|
179
|
+
|
149
180
|
The nodes described in this section form the overall structure of the output document.
|
150
181
|
|
182
|
+
|
151
183
|
%|section "header", "xhtml.nodes.header"
|
184
|
+
|
152
185
|
This node overrides the logo, title, list of authors, and date when the document was written, all of which are shown at the top of the document.
|
153
186
|
|
187
|
+
|
154
188
|
%|section "footer", "xhtml.nodes.footer"
|
189
|
+
|
155
190
|
This node overrides (1) the date when this document was generated and (2) the hyperlink to the <%= $project %> website, shown at the bottom of the document. The hyperlink is there as a way of saying thanks for <%= $project %>, the _wonderful_ little utility you have grown so fond of! ;-)
|
156
191
|
|
192
|
+
|
157
193
|
%|section "abstract", "xhtml.nodes.abstract"
|
194
|
+
|
158
195
|
A summary of the entire document. This is what most readers will _skim_ through, if you are lucky. Alas, nobody reads entire documents these days! :-(
|
159
196
|
|
197
|
+
|
160
198
|
%|section "xref", "xhtml.nodes.xref"
|
199
|
+
|
161
200
|
A cross-reference; a hyperlink that takes you to any node in the document.
|
162
201
|
|
163
202
|
The first argument of this node is either the unique identifier or the user-defined title of the node you wish to cross-reference. If no nodes in the document have the given identifier or user-defined title, then an error will be raised.
|
@@ -176,131 +215,207 @@
|
|
176
215
|
|
177
216
|
appears in the output document like this: <%= xref "SpecFile", "custom link text" %>.
|
178
217
|
|
218
|
+
|
179
219
|
%|section "Organizational nodes"
|
220
|
+
|
180
221
|
The nodes described in this section are meant to help organize the document's content logically. Based on how deeply these nodes are nested in the document, their heading will be larger (shallow depth) or smaller (deep depth).
|
181
222
|
|
223
|
+
|
182
224
|
%|section "node", "xhtml.nodes.node"
|
225
|
+
|
183
226
|
A placeholder that simply passes its content to the output.
|
184
227
|
|
185
228
|
This node has no real use in the writing of a document. It mainly helps programmers define "virtual" nodes that simply wrap some user-provided content. Programmers can then manipluate the content of those virtual nodes when processing the document.
|
186
229
|
|
230
|
+
|
187
231
|
%|node "An example"
|
232
|
+
|
188
233
|
This is how a **node** node appears.
|
189
234
|
|
235
|
+
|
190
236
|
%|section "part", "xhtml.nodes.part"
|
237
|
+
|
191
238
|
A collection of chapters.
|
192
239
|
|
240
|
+
|
193
241
|
%|part "An example"
|
242
|
+
|
194
243
|
This is how a **part** node appears.
|
195
244
|
|
245
|
+
|
196
246
|
%|section "chapter", "xhtml.nodes.chapter"
|
247
|
+
|
197
248
|
A collection of sections.
|
198
249
|
|
250
|
+
|
199
251
|
%|chapter "An example"
|
252
|
+
|
200
253
|
This is how a **chapter** node appears.
|
201
254
|
|
255
|
+
|
202
256
|
%|section "section", "xhtml.nodes.section"
|
257
|
+
|
203
258
|
A collection of paragraphs about a particular topic.
|
204
259
|
|
260
|
+
|
205
261
|
%|section "An example"
|
262
|
+
|
206
263
|
This is how a **section** node appears.
|
207
264
|
|
265
|
+
|
208
266
|
%|section "paragraph", "xhtml.nodes.paragraph"
|
267
|
+
|
209
268
|
A collection of sentences about a particular idea.
|
210
269
|
|
270
|
+
|
211
271
|
%|paragraph "An example"
|
272
|
+
|
212
273
|
This is how a **paragraph** node appears. Notice that there is no LaTeX-style index number in the heading of this **paragraph** node.
|
213
274
|
|
275
|
+
|
214
276
|
%|section "Admonition nodes"
|
277
|
+
|
215
278
|
An admonition is basically a box that is indented more deeply than the text surrounding it. It is typically used to convey extraneous or pertinent information about the application of ideas discussed in the surrounding text.
|
216
279
|
|
217
280
|
I like to follow the KDE guidelines<%= cite "KDE.admonitions" %> when determining which admonition to use in my documents.
|
218
281
|
|
282
|
+
|
219
283
|
%|reference "KDE.admonitions"
|
284
|
+
|
220
285
|
L. Watts, "Admonitions: Tips, hints, and Warnings", in _The KDE DocBook Authors guide_, Chapter 13, \[Online document], 22 September 2004 (Revision 1.00.00), \[cited 8 December 2007], Available at <%= hyperlink "http://l10n.kde.org/docs/markup/tips-hints-etc.html" %>
|
221
286
|
|
287
|
+
|
222
288
|
%|section "warning", "xhtml.nodes.warning"
|
289
|
+
|
223
290
|
Use a **warning** node when "data loss could occur if you follow the procedure being described." <%= cite "KDE.admonitions" %>
|
224
291
|
|
292
|
+
|
225
293
|
%|warning "An example"
|
294
|
+
|
226
295
|
This is how a **warning** node appears.
|
227
296
|
|
297
|
+
|
228
298
|
%|section "caution", "xhtml.nodes.caution"
|
299
|
+
|
229
300
|
bq. A note of caution. Use this for example when the reader may lose easily recovered or replaceable information (e.g. user settings), or when they could cause data loss if they don't correctly follow the procedure being outlined. <%= cite "KDE.admonitions" %>
|
230
301
|
|
302
|
+
|
231
303
|
%|caution "An example"
|
304
|
+
|
232
305
|
This is how a **caution** node appears.
|
233
306
|
|
307
|
+
|
234
308
|
%|section "important", "xhtml.nodes.important"
|
309
|
+
|
235
310
|
Use an **important** node when:
|
236
311
|
|
237
312
|
bq. When there is no danger of data loss, but you wish to make clear to the reader a consequence that isn't immediately obvious (e.g. when changing the font for one instance of a program also changes the default setting, and this isn't clear from the GUI.) <%= cite "KDE.admonitions" %>
|
238
313
|
|
314
|
+
|
239
315
|
%|important "An example"
|
316
|
+
|
240
317
|
This is how a **important** node appears.
|
241
318
|
|
319
|
+
|
242
320
|
%|section "note", "xhtml.nodes.note"
|
321
|
+
|
243
322
|
Use a **note** node to convey:
|
244
323
|
|
245
324
|
bq. Information the user should be aware of, but is peripheral to the actual task being described. <%= cite "KDE.admonitions" %>
|
246
325
|
|
326
|
+
|
247
327
|
%|note "An example"
|
328
|
+
|
248
329
|
This is how a **note** node appears.
|
249
330
|
|
331
|
+
|
250
332
|
%|section "tip", "xhtml.nodes.tip"
|
333
|
+
|
251
334
|
Use a **tip** node when:
|
252
335
|
|
253
336
|
bq. When you're giving a hint to make things easier or more productive for the reader. <%= cite "KDE.admonitions" %>
|
254
337
|
|
338
|
+
|
255
339
|
%|tip "An example"
|
340
|
+
|
256
341
|
This is how a **tip** node appears.
|
257
342
|
|
343
|
+
|
258
344
|
%|section "Auxilary materials"
|
345
|
+
|
259
346
|
%|section "figure", "xhtml.nodes.figure"
|
260
347
|
A diagram, sketch, image, or illustration; something that visually depicts an idea or thought.
|
261
348
|
|
349
|
+
|
262
350
|
%|figure "An example"
|
351
|
+
|
263
352
|
This is how a **figure** node appears.
|
264
353
|
|
354
|
+
|
265
355
|
%|section "table", "xhtml.nodes.table"
|
356
|
+
|
266
357
|
Information (typically measurement data) represented in tabular form for easy reading, comparison, and analysis.
|
267
358
|
|
359
|
+
|
268
360
|
%|table "An example"
|
361
|
+
|
269
362
|
This is how a **table** node appears.
|
270
363
|
|
364
|
+
|
271
365
|
%|section "example", "xhtml.nodes.example"
|
366
|
+
|
272
367
|
A sample application of an idea or thought.
|
273
368
|
|
369
|
+
|
274
370
|
%|example "An example"
|
371
|
+
|
275
372
|
This is how a **example** node appears.
|
276
373
|
|
374
|
+
|
277
375
|
%|section "equation", "xhtml.nodes.equation"
|
376
|
+
|
278
377
|
A mathematical equation or formula.
|
279
378
|
|
379
|
+
|
280
380
|
%|equation "An example"
|
381
|
+
|
281
382
|
This is how a **equation** node appears.
|
282
383
|
|
384
|
+
|
283
385
|
%|section "procedure", "xhtml.nodes.procedure"
|
386
|
+
|
284
387
|
An outline; a series of steps outlining some kind of process.
|
285
388
|
|
389
|
+
|
286
390
|
%|procedure "An example"
|
391
|
+
|
287
392
|
This is how a **procedure** node appears.
|
288
393
|
|
289
|
-
|
394
|
+
|
395
|
+
%|section "Bibliographic nodes"
|
396
|
+
|
290
397
|
The nodes in this section deal with attribution of ideas---an important weapon against plagiarism.
|
291
398
|
|
399
|
+
|
292
400
|
%|section "reference", "xhtml.nodes.reference"
|
401
|
+
|
293
402
|
This node stores bibliography information about an information source that is relevant to your document.
|
294
403
|
|
295
404
|
If you wish to cite a certain source in several places in your document, start by creating a **reference** node first and then use a **cite** node (see <%= xref "xhtml.nodes.cite" %>) to perform the citation.
|
296
405
|
|
406
|
+
|
297
407
|
%|paragraph "An example"
|
408
|
+
|
298
409
|
See <%= xref "xhtml.nodes.reference.example" %> for an example of how a **reference** node appears.
|
299
410
|
|
411
|
+
|
300
412
|
%|reference "xhtml.nodes.reference.example"
|
413
|
+
|
301
414
|
This is how a **reference** node appears.
|
302
415
|
|
416
|
+
|
303
417
|
%|section "cite", "xhtml.nodes.cite"
|
418
|
+
|
304
419
|
A citation to a **reference** node (see <%= xref "xhtml.nodes.reference" %>) in the document's bibliography.
|
305
420
|
|
306
421
|
The first argument of this node is the unique identifier of the reference node you wish to cite. You can specify additional arguments to give more detail about the citation.
|
@@ -319,17 +434,23 @@
|
|
319
434
|
|
320
435
|
<% patches_are_welcome = "This format is not yet implemented. Patches are welcome! :-)" %>
|
321
436
|
|
437
|
+
|
322
438
|
%|chapter "Plain text", "text"
|
439
|
+
|
323
440
|
<%= patches_are_welcome %>
|
324
441
|
|
325
442
|
<%= hyperlink "http://en.wikipedia.org/wiki/Plain_text" %>
|
326
443
|
|
444
|
+
|
327
445
|
%|chapter "LaTeX (PDF)", "latex"
|
446
|
+
|
328
447
|
<%= patches_are_welcome %>
|
329
448
|
|
330
449
|
<%= hyperlink "http://www.latex-project.org" %>
|
331
450
|
|
451
|
+
|
332
452
|
%|chapter "UNIX manual page", "man"
|
453
|
+
|
333
454
|
<%= patches_are_welcome %>
|
334
455
|
|
335
456
|
<%= hyperlink "http://en.wikipedia.org/wiki/Man_page" %>
|