rdoc 4.0.1 → 4.1.0.preview.3

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.

This version of rdoc might be problematic. Click here for more details.

Files changed (140) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data.tar.gz.sig +0 -0
  4. data/.autotest +1 -3
  5. data/{DEVELOPERS.rdoc → CONTRIBUTING.rdoc} +28 -3
  6. data/ExampleMarkdown.md +37 -0
  7. data/ExampleRDoc.rdoc +208 -0
  8. data/History.rdoc +81 -0
  9. data/Manifest.txt +11 -2
  10. data/README.rdoc +5 -5
  11. data/Rakefile +34 -4
  12. data/lib/rdoc.rb +4 -3
  13. data/lib/rdoc/any_method.rb +48 -4
  14. data/lib/rdoc/class_module.rb +16 -2
  15. data/lib/rdoc/code_object.rb +85 -24
  16. data/lib/rdoc/comment.rb +0 -3
  17. data/lib/rdoc/constant.rb +9 -1
  18. data/lib/rdoc/context.rb +20 -2
  19. data/lib/rdoc/cross_reference.rb +1 -1
  20. data/lib/rdoc/extend.rb +4 -112
  21. data/lib/rdoc/generator/darkfish.rb +46 -7
  22. data/lib/rdoc/generator/template/darkfish/_footer.rhtml +4 -4
  23. data/lib/rdoc/generator/template/darkfish/_head.rhtml +14 -8
  24. data/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml +4 -3
  25. data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml +3 -3
  26. data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +3 -4
  27. data/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml +4 -3
  28. data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +3 -4
  29. data/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml +3 -3
  30. data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +4 -4
  31. data/lib/rdoc/generator/template/darkfish/_sidebar_navigation.rhtml +9 -5
  32. data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +5 -5
  33. data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +4 -3
  34. data/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml +12 -7
  35. data/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml +5 -4
  36. data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +6 -7
  37. data/lib/rdoc/generator/template/darkfish/class.rhtml +36 -41
  38. data/lib/rdoc/generator/template/darkfish/fonts.css +167 -0
  39. data/lib/rdoc/generator/template/darkfish/fonts/Lato-Light.ttf +0 -0
  40. data/lib/rdoc/generator/template/darkfish/fonts/Lato-LightItalic.ttf +0 -0
  41. data/lib/rdoc/generator/template/darkfish/fonts/Lato-Regular.ttf +0 -0
  42. data/lib/rdoc/generator/template/darkfish/fonts/Lato-RegularItalic.ttf +0 -0
  43. data/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Bold.ttf +0 -0
  44. data/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Regular.ttf +0 -0
  45. data/lib/rdoc/generator/template/darkfish/images/add.png +0 -0
  46. data/lib/rdoc/generator/template/darkfish/images/arrow_up.png +0 -0
  47. data/lib/rdoc/generator/template/darkfish/images/delete.png +0 -0
  48. data/lib/rdoc/generator/template/darkfish/images/tag_blue.png +0 -0
  49. data/lib/rdoc/generator/template/darkfish/index.rhtml +11 -7
  50. data/lib/rdoc/generator/template/darkfish/js/darkfish.js +0 -15
  51. data/lib/rdoc/generator/template/darkfish/js/search.js +12 -4
  52. data/lib/rdoc/generator/template/darkfish/page.rhtml +9 -9
  53. data/lib/rdoc/generator/template/darkfish/rdoc.css +226 -241
  54. data/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml +5 -5
  55. data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +13 -6
  56. data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +17 -14
  57. data/lib/rdoc/include.rb +4 -114
  58. data/lib/rdoc/known_classes.rb +1 -0
  59. data/lib/rdoc/markdown.kpeg +126 -117
  60. data/lib/rdoc/markdown.rb +404 -389
  61. data/lib/rdoc/markdown/literals_1_8.kpeg +1 -1
  62. data/lib/rdoc/markdown/literals_1_8.rb +15 -12
  63. data/lib/rdoc/markdown/literals_1_9.kpeg +1 -1
  64. data/lib/rdoc/markdown/literals_1_9.rb +15 -12
  65. data/lib/rdoc/markup.rb +10 -13
  66. data/lib/rdoc/markup/attribute_manager.rb +3 -2
  67. data/lib/rdoc/markup/formatter.rb +3 -3
  68. data/lib/rdoc/markup/heading.rb +13 -0
  69. data/lib/rdoc/markup/parser.rb +10 -3
  70. data/lib/rdoc/markup/pre_process.rb +1 -1
  71. data/lib/rdoc/markup/to_html.rb +46 -31
  72. data/lib/rdoc/markup/to_html_crossref.rb +3 -0
  73. data/lib/rdoc/markup/to_joined_paragraph.rb +1 -1
  74. data/lib/rdoc/markup/to_markdown.rb +7 -5
  75. data/lib/rdoc/markup/verbatim.rb +1 -1
  76. data/lib/rdoc/method_attr.rb +13 -1
  77. data/lib/rdoc/mixin.rb +120 -0
  78. data/lib/rdoc/normal_class.rb +4 -0
  79. data/lib/rdoc/normal_module.rb +4 -0
  80. data/lib/rdoc/options.rb +42 -8
  81. data/lib/rdoc/parser.rb +4 -2
  82. data/lib/rdoc/parser/c.rb +13 -7
  83. data/lib/rdoc/parser/ruby.rb +683 -480
  84. data/lib/rdoc/rdoc.rb +4 -3
  85. data/lib/rdoc/ri/driver.rb +174 -103
  86. data/lib/rdoc/ri/paths.rb +6 -6
  87. data/lib/rdoc/ruby_lex.rb +125 -102
  88. data/lib/rdoc/ruby_token.rb +41 -40
  89. data/lib/rdoc/servlet.rb +16 -6
  90. data/lib/rdoc/stats.rb +61 -48
  91. data/lib/rdoc/store.rb +5 -3
  92. data/lib/rdoc/test_case.rb +39 -0
  93. data/lib/rdoc/tom_doc.rb +28 -4
  94. data/lib/rdoc/top_level.rb +2 -2
  95. data/test/test_rdoc_any_method.rb +104 -1
  96. data/test/test_rdoc_class_module.rb +9 -15
  97. data/test/test_rdoc_code_object.rb +133 -8
  98. data/test/test_rdoc_context.rb +17 -0
  99. data/test/test_rdoc_context_section.rb +0 -7
  100. data/test/test_rdoc_cross_reference.rb +4 -3
  101. data/test/test_rdoc_generator_darkfish.rb +61 -19
  102. data/test/test_rdoc_generator_json_index.rb +0 -11
  103. data/test/test_rdoc_generator_ri.rb +0 -8
  104. data/test/test_rdoc_markdown.rb +15 -12
  105. data/test/test_rdoc_markdown_test.rb +0 -7
  106. data/test/test_rdoc_markup_attribute_manager.rb +121 -0
  107. data/test/test_rdoc_markup_document.rb +0 -7
  108. data/test/test_rdoc_markup_formatter.rb +29 -3
  109. data/test/test_rdoc_markup_heading.rb +9 -0
  110. data/test/test_rdoc_markup_parser.rb +0 -7
  111. data/test/test_rdoc_markup_pre_process.rb +15 -3
  112. data/test/test_rdoc_markup_raw.rb +0 -7
  113. data/test/test_rdoc_markup_to_html.rb +50 -8
  114. data/test/test_rdoc_markup_to_html_crossref.rb +7 -0
  115. data/test/test_rdoc_markup_to_html_snippet.rb +4 -4
  116. data/test/test_rdoc_markup_to_markdown.rb +6 -0
  117. data/test/test_rdoc_method_attr.rb +8 -0
  118. data/test/test_rdoc_normal_class.rb +5 -0
  119. data/test/test_rdoc_normal_module.rb +5 -0
  120. data/test/test_rdoc_options.rb +61 -22
  121. data/test/test_rdoc_parser.rb +10 -0
  122. data/test/test_rdoc_parser_c.rb +17 -5
  123. data/test/test_rdoc_parser_changelog.rb +0 -7
  124. data/test/test_rdoc_parser_rd.rb +0 -7
  125. data/test/test_rdoc_parser_ruby.rb +305 -28
  126. data/test/test_rdoc_rd_block_parser.rb +0 -8
  127. data/test/test_rdoc_rd_inline_parser.rb +0 -1
  128. data/test/test_rdoc_rdoc.rb +27 -1
  129. data/test/test_rdoc_ri_driver.rb +19 -7
  130. data/test/test_rdoc_ruby_lex.rb +116 -9
  131. data/test/test_rdoc_rubygems_hook.rb +1 -1
  132. data/test/test_rdoc_servlet.rb +44 -6
  133. data/test/test_rdoc_stats.rb +161 -141
  134. data/test/test_rdoc_store.rb +11 -19
  135. data/test/test_rdoc_text.rb +0 -7
  136. data/test/test_rdoc_tom_doc.rb +44 -16
  137. data/test/xref_test_case.rb +2 -0
  138. metadata +28 -27
  139. metadata.gz.sig +0 -0
  140. data/test/test_attribute_manager.rb +0 -120
data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml CHANGED
@@ -1,12 +1,12 @@
1
1
  <% simple_files = @files.select { |f| f.text? } %>
2
2
  <% unless simple_files.empty? then %>
3
- <nav id="fileindex-section" class="section project-section">
4
- <h3 class="section-header">Pages</h3>
3
+ <div id="fileindex-section" class="nav-section">
4
+ <h3>Pages</h3>
5
5
 
6
- <ul>
6
+ <ul class="link-list">
7
7
  <% simple_files.each do |f| %>
8
- <li class="file"><a href="<%= rel_prefix %>/<%= f.path %>"><%= h f.page_name %></a>
8
+ <li><a href="<%= rel_prefix %>/<%= f.path %>"><%= h f.page_name %></a>
9
9
  <% end %>
10
10
  </ul>
11
- </nav>
11
+ </div>
12
12
  <% end %>
data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml CHANGED
@@ -1,10 +1,11 @@
1
1
  <% if klass.type == 'class' then %>
2
- <nav id="parent-class-section" class="section">
3
- <h3 class="section-header">Parent</h3>
2
+ <div id="parent-class-section" class="nav-section">
3
+ <h3>Parent</h3>
4
+
4
5
  <% if klass.superclass and not String === klass.superclass then %>
5
6
  <p class="link"><a href="<%= klass.aref_to klass.superclass.path %>"><%= klass.superclass.full_name %></a>
6
7
  <% else %>
7
8
  <p class="link"><%= klass.superclass %>
8
9
  <% end %>
9
- </nav>
10
+ </div>
10
11
  <% end %>
data/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml CHANGED
@@ -1,10 +1,15 @@
1
- <nav id="search-section" class="section project-section" class="initially-hidden">
1
+ <div id="search-section" role="search" class="project-section initially-hidden">
2
2
  <form action="#" method="get" accept-charset="utf-8">
3
- <h3 class="section-header">
4
- <input type="text" name="search" placeholder="Search" id="search-field"
3
+ <div id="search-field-wrapper">
4
+ <input id="search-field" role="combobox" aria-label="Search"
5
+ aria-autocomplete="list" aria-controls="search-results"
6
+ type="text" name="search" placeholder="Search"
5
7
  title="Type to search, Up and Down to navigate, Enter to load">
6
- </h3>
7
- </form>
8
+ </div>
8
9
 
9
- <ul id="search-results" class="initially-hidden"></ul>
10
- </nav>
10
+ <ul id="search-results" aria-label="Search Results"
11
+ aria-busy="false" aria-expanded="false"
12
+ aria-atomic="false" aria-live="polite"
13
+ aria-relevant="all" class="initially-hidden"></ul>
14
+ </form>
15
+ </div>
data/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml CHANGED
@@ -1,10 +1,11 @@
1
1
  <% unless klass.sections.length == 1 then %>
2
- <nav id="sections-section" class="section">
3
- <h3 class="section-header">Sections</h3>
4
- <ul class="link-list">
2
+ <div id="sections-section" class="nav-section">
3
+ <h3>Sections</h3>
4
+
5
+ <ul class="link-list" role="directory">
5
6
  <% klass.sort_sections.each do |section| %>
6
7
  <li><a href="#<%= section.aref %>"><%= h section.title %></a></li>
7
8
  <% end %>
8
9
  </ul>
9
- </nav>
10
+ </div>
10
11
  <% end %>
data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml CHANGED
@@ -6,14 +6,13 @@
6
6
  table = current.parse(comment).table_of_contents
7
7
 
8
8
  if table.length > 1 then %>
9
- <div id="table-of-contents">
10
- <nav class="section">
11
- <h3 class="section-header">Table of Contents</h3>
12
- <ul>
9
+ <div class="nav-section">
10
+ <h3>Table of Contents</h3>
11
+
12
+ <ul class="link-list" role="directory">
13
13
  <% table.each do |heading| %>
14
- <li><a href="#<%= heading.aref %>"><%= heading.plain_html %></a>
14
+ <li><a href="#<%= heading.label current %>"><%= heading.plain_html %></a>
15
15
  <% end %>
16
- </ul>
17
- </nav>
16
+ </ul>
18
17
  </div>
19
18
  <% end %>
data/lib/rdoc/generator/template/darkfish/class.rhtml CHANGED
@@ -1,16 +1,12 @@
1
- <body id="top" class="<%= klass.type %>">
2
- <nav id="metadata">
3
- <%= render '_sidebar_navigation.rhtml' %>
4
-
5
- <%= render '_sidebar_search.rhtml' %>
1
+ <body id="top" role="document" class="<%= klass.type %>">
2
+ <nav role="navigation">
3
+ <div id="project-navigation">
4
+ <%= render '_sidebar_navigation.rhtml' %>
5
+ <%= render '_sidebar_search.rhtml' %>
6
+ </div>
6
7
 
7
8
  <%= render '_sidebar_table_of_contents.rhtml' %>
8
9
 
9
- <div id="file-metadata">
10
- <%= render '_sidebar_in_files.rhtml' %>
11
- <%= render '_sidebar_VCS_info.rhtml' %>
12
- </div>
13
-
14
10
  <div id="class-metadata">
15
11
  <%= render '_sidebar_sections.rhtml' %>
16
12
  <%= render '_sidebar_parent.rhtml' %>
@@ -18,52 +14,50 @@
18
14
  <%= render '_sidebar_extends.rhtml' %>
19
15
  <%= render '_sidebar_methods.rhtml' %>
20
16
  </div>
21
-
22
- <div id="project-metadata">
23
- <%= render '_sidebar_pages.rhtml' %>
24
- <%= render '_sidebar_classes.rhtml' %>
25
- </div>
26
17
  </nav>
27
18
 
28
- <div id="documentation">
29
- <h1 class="<%= klass.type %>"><%= klass.type %> <%= klass.full_name %></h1>
19
+ <main role="main" aria-labelledby="<%=h klass.aref %>">
20
+ <h1 id="<%=h klass.aref %>" class="<%= klass.type %>">
21
+ <%= klass.type %> <%= klass.full_name %>
22
+ </h1>
30
23
 
31
- <div id="description" class="description">
24
+ <section class="description">
32
25
  <%= klass.description %>
33
- </div><!-- description -->
26
+ </section>
34
27
 
35
28
  <% klass.each_section do |section, constants, attributes| %>
36
29
  <% constants = constants.select { |const| const.display? } %>
37
30
  <% attributes = attributes.select { |attr| attr.display? } %>
38
31
  <section id="<%= section.aref %>" class="documentation-section">
39
32
  <% if section.title then %>
40
- <div class="documentation-section-title">
41
- <h2 class="section-header">
33
+ <header class="documentation-section-title">
34
+ <h2>
42
35
  <%= section.title %>
43
36
  </h2>
44
37
  <span class="section-click-top">
45
38
  <a href="#top">&uarr; top</a>
46
39
  </span>
47
- </div>
40
+ </header>
48
41
  <% end %>
49
42
 
50
43
  <% if section.comment then %>
51
- <div class="description">
44
+ <div>
52
45
  <%= section.description %>
53
46
  </div>
54
47
  <% end %>
55
48
 
56
49
  <% unless constants.empty? then %>
57
- <!-- Constants -->
58
- <section id="constants-list" class="section">
59
- <h3 class="section-header">Constants</h3>
50
+ <section class="constants-list">
51
+ <header>
52
+ <h3>Constants</h3>
53
+ </header>
60
54
  <dl>
61
55
  <% constants.each do |const| %>
62
56
  <dt id="<%= const.name %>"><%= const.name %>
63
57
  <% if const.comment then %>
64
- <dd class="description"><%= const.description.strip %>
58
+ <dd><%= const.description.strip %>
65
59
  <% else %>
66
- <dd class="description missing-docs">(Not documented)
60
+ <dd class="missing-docs">(Not documented)
67
61
  <% end %>
68
62
  <% end %>
69
63
  </dl>
@@ -71,9 +65,10 @@
71
65
  <% end %>
72
66
 
73
67
  <% unless attributes.empty? then %>
74
- <!-- Attributes -->
75
- <section id="attribute-method-details" class="method-section section">
76
- <h3 class="section-header">Attributes</h3>
68
+ <section class="attribute-method-details" class="method-section">
69
+ <header>
70
+ <h3>Attributes</h3>
71
+ </header>
77
72
 
78
73
  <% attributes.each do |attrib| %>
79
74
  <div id="<%= attrib.aref %>" class="method-detail">
@@ -91,16 +86,17 @@
91
86
  </div>
92
87
  </div>
93
88
  <% end %>
94
- </section><!-- attribute-method-details -->
89
+ </section>
95
90
  <% end %>
96
91
 
97
- <!-- Methods -->
98
92
  <% klass.methods_by_type(section).each do |type, visibilities|
99
93
  next if visibilities.empty?
100
94
  visibilities.each do |visibility, methods|
101
95
  next if methods.empty? %>
102
- <section id="<%= visibility %>-<%= type %>-<%= section.aref %>-method-details" class="method-section section">
103
- <h3 class="section-header"><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h3>
96
+ <section id="<%= visibility %>-<%= type %>-<%= section.aref %>-method-details" class="method-section">
97
+ <header>
98
+ <h3><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h3>
99
+ </header>
104
100
 
105
101
  <% methods.each do |method| %>
106
102
  <div id="<%= method.aref %>" class="method-detail <%= method.is_alias_for ? "method-alias" : '' %>">
@@ -146,7 +142,7 @@
146
142
  <% if method.token_stream then %>
147
143
  <div class="method-source-code" id="<%= method.html_name %>-source">
148
144
  <pre><%= method.markup_code %></pre>
149
- </div><!-- <%= method.html_name %>-source -->
145
+ </div>
150
146
  <% end %>
151
147
  </div>
152
148
 
@@ -167,13 +163,12 @@
167
163
  Alias for: <a href="<%= klass.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
168
164
  </div>
169
165
  <% end %>
170
- </div><!-- <%= method.html_name %>-method -->
166
+ </div>
171
167
 
172
168
  <% end %>
173
- </section><!-- <%= visibility %>-<%= type %>-method-details -->
169
+ </section>
174
170
  <% end
175
171
  end %>
176
- </section><!-- <%= section.aref %> -->
172
+ </section>
177
173
  <% end %>
178
-
179
- </div><!-- documentation -->
174
+ </main>
data/lib/rdoc/generator/template/darkfish/fonts.css ADDED
@@ -0,0 +1,167 @@
1
+ /*
2
+ * Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/),
3
+ * with Reserved Font Name "Source". All Rights Reserved. Source is a
4
+ * trademark of Adobe Systems Incorporated in the United States and/or other
5
+ * countries.
6
+ *
7
+ * This Font Software is licensed under the SIL Open Font License, Version
8
+ * 1.1.
9
+ *
10
+ * This license is copied below, and is also available with a FAQ at:
11
+ * http://scripts.sil.org/OFL
12
+ */
13
+
14
+ @font-face {
15
+ font-family: "Source Code Pro";
16
+ font-style: normal;
17
+ font-weight: 400;
18
+ src: local("Source Code Pro"),
19
+ local("SourceCodePro-Regular"),
20
+ url("fonts/SourceCodePro-Regular.ttf") format("truetype");
21
+ }
22
+
23
+ @font-face {
24
+ font-family: "Source Code Pro";
25
+ font-style: normal;
26
+ font-weight: 700;
27
+ src: local("Source Code Pro Bold"),
28
+ local("SourceCodePro-Bold"),
29
+ url("fonts/SourceCodePro-Bold.ttf") format("truetype");
30
+ }
31
+
32
+ /*
33
+ * Copyright (c) 2010, Łukasz Dziedzic (dziedzic@typoland.com),
34
+ * with Reserved Font Name Lato.
35
+ *
36
+ * This Font Software is licensed under the SIL Open Font License, Version
37
+ * 1.1.
38
+ *
39
+ * This license is copied below, and is also available with a FAQ at:
40
+ * http://scripts.sil.org/OFL
41
+ */
42
+
43
+ @font-face {
44
+ font-family: "Lato";
45
+ font-style: normal;
46
+ font-weight: 300;
47
+ src: local("Lato Light"),
48
+ local("Lato-Light"),
49
+ url("fonts/Lato-Light.ttf") format("truetype");
50
+ }
51
+
52
+ @font-face {
53
+ font-family: "Lato";
54
+ font-style: italic;
55
+ font-weight: 300;
56
+ src: local("Lato Light Italic"),
57
+ local("Lato-LightItalic"),
58
+ url("fonts/Lato-LightItalic.ttf") format("truetype");
59
+ }
60
+
61
+ @font-face {
62
+ font-family: "Lato";
63
+ font-style: normal;
64
+ font-weight: 700;
65
+ src: local("Lato Regular"),
66
+ local("Lato-Regular"),
67
+ url("fonts/Lato-Regular.ttf") format("truetype");
68
+ }
69
+
70
+ @font-face {
71
+ font-family: "Lato";
72
+ font-style: italic;
73
+ font-weight: 700;
74
+ src: local("Lato Italic"),
75
+ local("Lato-Italic"),
76
+ url("fonts/Lato-RegularItalic.ttf") format("truetype");
77
+ }
78
+
79
+ /*
80
+ * -----------------------------------------------------------
81
+ * SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
82
+ * -----------------------------------------------------------
83
+ *
84
+ * PREAMBLE
85
+ * The goals of the Open Font License (OFL) are to stimulate worldwide
86
+ * development of collaborative font projects, to support the font creation
87
+ * efforts of academic and linguistic communities, and to provide a free and
88
+ * open framework in which fonts may be shared and improved in partnership
89
+ * with others.
90
+ *
91
+ * The OFL allows the licensed fonts to be used, studied, modified and
92
+ * redistributed freely as long as they are not sold by themselves. The
93
+ * fonts, including any derivative works, can be bundled, embedded,
94
+ * redistributed and/or sold with any software provided that any reserved
95
+ * names are not used by derivative works. The fonts and derivatives,
96
+ * however, cannot be released under any other type of license. The
97
+ * requirement for fonts to remain under this license does not apply
98
+ * to any document created using the fonts or their derivatives.
99
+ *
100
+ * DEFINITIONS
101
+ * "Font Software" refers to the set of files released by the Copyright
102
+ * Holder(s) under this license and clearly marked as such. This may
103
+ * include source files, build scripts and documentation.
104
+ *
105
+ * "Reserved Font Name" refers to any names specified as such after the
106
+ * copyright statement(s).
107
+ *
108
+ * "Original Version" refers to the collection of Font Software components as
109
+ * distributed by the Copyright Holder(s).
110
+ *
111
+ * "Modified Version" refers to any derivative made by adding to, deleting,
112
+ * or substituting -- in part or in whole -- any of the components of the
113
+ * Original Version, by changing formats or by porting the Font Software to a
114
+ * new environment.
115
+ *
116
+ * "Author" refers to any designer, engineer, programmer, technical
117
+ * writer or other person who contributed to the Font Software.
118
+ *
119
+ * PERMISSION & CONDITIONS
120
+ * Permission is hereby granted, free of charge, to any person obtaining
121
+ * a copy of the Font Software, to use, study, copy, merge, embed, modify,
122
+ * redistribute, and sell modified and unmodified copies of the Font
123
+ * Software, subject to the following conditions:
124
+ *
125
+ * 1) Neither the Font Software nor any of its individual components,
126
+ * in Original or Modified Versions, may be sold by itself.
127
+ *
128
+ * 2) Original or Modified Versions of the Font Software may be bundled,
129
+ * redistributed and/or sold with any software, provided that each copy
130
+ * contains the above copyright notice and this license. These can be
131
+ * included either as stand-alone text files, human-readable headers or
132
+ * in the appropriate machine-readable metadata fields within text or
133
+ * binary files as long as those fields can be easily viewed by the user.
134
+ *
135
+ * 3) No Modified Version of the Font Software may use the Reserved Font
136
+ * Name(s) unless explicit written permission is granted by the corresponding
137
+ * Copyright Holder. This restriction only applies to the primary font name as
138
+ * presented to the users.
139
+ *
140
+ * 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
141
+ * Software shall not be used to promote, endorse or advertise any
142
+ * Modified Version, except to acknowledge the contribution(s) of the
143
+ * Copyright Holder(s) and the Author(s) or with their explicit written
144
+ * permission.
145
+ *
146
+ * 5) The Font Software, modified or unmodified, in part or in whole,
147
+ * must be distributed entirely under this license, and must not be
148
+ * distributed under any other license. The requirement for fonts to
149
+ * remain under this license does not apply to any document created
150
+ * using the Font Software.
151
+ *
152
+ * TERMINATION
153
+ * This license becomes null and void if any of the above conditions are
154
+ * not met.
155
+ *
156
+ * DISCLAIMER
157
+ * THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
158
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
159
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
160
+ * OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
161
+ * COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
162
+ * INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
163
+ * DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
164
+ * FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
165
+ * OTHER DEALINGS IN THE FONT SOFTWARE.
166
+ */
167
+
data/lib/rdoc/generator/template/darkfish/index.rhtml CHANGED
@@ -1,8 +1,10 @@
1
- <body>
2
- <nav id="metadata">
3
- <%= render '_sidebar_navigation.rhtml' %>
1
+ <body id="top" role="document" class="file">
2
+ <nav role="navigation">
3
+ <div id="project-navigation">
4
+ <%= render '_sidebar_navigation.rhtml' %>
4
5
 
5
- <%= render '_sidebar_search.rhtml' %>
6
+ <%= render '_sidebar_search.rhtml' %>
7
+ </div>
6
8
 
7
9
  <div id="project-metadata">
8
10
  <%= render '_sidebar_pages.rhtml' %>
@@ -10,10 +12,12 @@
10
12
  </div>
11
13
  </nav>
12
14
 
13
- <div id="documentation" class="description">
14
- <% if @options.main_page && main_page = @files.find { |f| f.full_name == @options.main_page } then %>
15
+ <main role="main">
16
+ <% if @options.main_page and
17
+ main_page = @files.find { |f| f.full_name == @options.main_page } then %>
15
18
  <%= main_page.description %>
16
19
  <% else %>
17
20
  <p>This is the API documentation for <%= @title %>.
18
21
  <% end %>
19
- </div>
22
+ </main>
23
+