docubot 0.2.2 → 0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (45) hide show
  1. data/bin/docubot +4 -0
  2. data/lib/docubot.rb +5 -1
  3. data/lib/docubot/bundle.rb +10 -5
  4. data/lib/docubot/index.rb +5 -4
  5. data/lib/docubot/page.rb +25 -4
  6. data/lib/docubot/templates/index.haml +20 -13
  7. data/lib/docubot/templates/toc.haml +2 -0
  8. data/lib/docubot/writers/chm.rb +5 -1
  9. data/lib/docubot/writers/html.rb +3 -0
  10. data/test/site1_html/A Slight Change of Heart/1 Ze First Page in Ze Section.html +30 -0
  11. data/test/site1_html/A Slight Change of Heart/2 Another Page in the Section.html +30 -0
  12. data/test/site1_html/A Slight Change of Heart/3_more_crap.html +42 -0
  13. data/test/site1_html/A Slight Change of Heart/3_more_crap.html#frist-post +29 -0
  14. data/test/site1_html/A Slight Change of Heart/3_more_crap.html#moar +29 -0
  15. data/test/site1_html/A Slight Change of Heart/index.html +28 -0
  16. data/test/site1_html/_index.html +17 -0
  17. data/test/site1_html/_toc.html +73 -0
  18. data/test/site1_html/appendices/gkheadftw.html +32 -0
  19. data/test/site1_html/appendices/index.html +28 -0
  20. data/test/site1_html/common.css +108 -0
  21. data/test/site1_html/glossary-terms.js +1 -0
  22. data/test/site1_html/headers.html +42 -0
  23. data/test/site1_html/preamble.html +36 -0
  24. data/test/site1_html/raw.html +33 -0
  25. data/test/site1_html/toc.css +0 -0
  26. data/test/site1_html/toc.js +0 -0
  27. metadata +38 -28
  28. data/lib/docubot/shells/nvphysx/0_License.md +0 -3
  29. data/lib/docubot/shells/nvphysx/1_Getting_Started.haml +0 -51
  30. data/lib/docubot/shells/nvphysx/Appendix/Glossary.md +0 -7
  31. data/lib/docubot/shells/nvphysx/_glossary/APEX.md +0 -1
  32. data/lib/docubot/shells/nvphysx/_glossary/NVIDIA.md +0 -1
  33. data/lib/docubot/shells/nvphysx/_glossary/PhysX.textile +0 -3
  34. data/lib/docubot/shells/nvphysx/_static/NVBadge_3D.png +0 -0
  35. data/lib/docubot/shells/nvphysx/_static/PhysXbyNV_Black.png +0 -0
  36. data/lib/docubot/shells/nvphysx/_templates/_root/bg_green_bar_revised.gif +0 -0
  37. data/lib/docubot/shells/nvphysx/_templates/_root/close.png +0 -0
  38. data/lib/docubot/shells/nvphysx/_templates/_root/common.css +0 -264
  39. data/lib/docubot/shells/nvphysx/_templates/_root/glossary.css +0 -4
  40. data/lib/docubot/shells/nvphysx/_templates/_root/glossary.js +0 -24
  41. data/lib/docubot/shells/nvphysx/_templates/_root/nvdevtools.js +0 -31
  42. data/lib/docubot/shells/nvphysx/_templates/_root/nvidia-logo.gif +0 -0
  43. data/lib/docubot/shells/nvphysx/_templates/_root/right-sidebar.png +0 -0
  44. data/lib/docubot/shells/nvphysx/_templates/top.haml +0 -28
  45. data/lib/docubot/shells/nvphysx/index.txt +0 -5
@@ -1,3 +0,0 @@
1
- style: license nosidebar
2
- +++
3
- ![NVIDIA 3D Badge](_static/NVBadge_3D.png)
@@ -1,51 +0,0 @@
1
- keywords: Basics
2
- toc : welcome authoring glossary index
3
- +++
4
- %h2#welcome Welcome to DocuBot for NVIDIA PhysX
5
- %p.sidebar
6
- %img(width='150' src='_static/NVBadge_3D.png')
7
- NVIDIA 3D Badge
8
- %span#out
9
- :textile
10
- This template shows the standard page style, which has a 350px sidebar on the right for including
11
- images related to the text.
12
-
13
- To put images (with an optional description) in the sidebar, place them inside a paragraph with
14
- the CSS class @sidebar@. They will float to the right next to your content.
15
-
16
- Each header will--by default--wait to begin until all images on the right have finished.
17
-
18
- %h2#authoring Authoring Content
19
- <p class="sidebar"><img src="_static/PhysXbyNV_Black.png" width="180"></p>
20
- :markdown
21
- The headers on each page should start at `h2` (not `h1`); `h1` is used for the title at the top of the page.
22
-
23
- As shown in this template, if you apply HTML `id` attributes to the headers (or any other HTML element), and list those
24
- identifiers under a toc entry at the top of the page, the Table of Contents will include sub-links to the headings.
25
-
26
- %h2#glossary Glossary Entries
27
- %p
28
- To create a reference to a glossary term, surround it in double dollar signs.
29
- For example, $$NVIDIA$$ makes $$PhysX$$ and $$APEX Libraries:APEX$$.
30
- %p
31
- As shown in the APEX link above, you can have the glossary text be different from the term it links to
32
- by putting the words you want first, followed by a colon, followed by the actual glossary term to link to.
33
- %p
34
- This works in all markups. (The processing happens after the markup is converted to HTML.)
35
-
36
- %h2#index Managing the Index
37
- %p The index is automatically populated with the text from headings and defintions on the pages.
38
- %p To add additional terms, you can:
39
- %ul
40
- %li
41
- Use a <code>keywords</code> section at the top of the page with comma-delimited keywords or
42
- phrases that you want the index to associate with the current page.
43
- %li
44
- :markdown
45
- Put two `@` signs around any word or phrase in your text that you wanted added to the index.
46
-
47
- For example, imagine that this page talked about @@sexy code@@; the index now knows about that.
48
-
49
- Note that this syntax doesn't currently work with textile, because it uses single @ characters to
50
- denote code. This will be fixed in the future (by processing glossary and index snippets before markup).
51
-
@@ -1,7 +0,0 @@
1
- template: glossary
2
- +++
3
- This page uses the glossary template, which has the smarts to generate HTML
4
- from the glossary terms defined in the `_glossary` directory.
5
-
6
- The Glossary template doesn't actually use the `contents` of this page, so
7
- it doesn't matter what I put here.
@@ -1 +0,0 @@
1
- A multi-platform, scalable dynamics framework.
@@ -1 +0,0 @@
1
- NVIDIA (Nasdaq: NVDA) is the world leader in visual computing technologies and the inventor of the GPU, a high-performance processor which generates breathtaking, interactive graphics on workstations, personal computers, game consoles, and mobile devices.
@@ -1,3 +0,0 @@
1
- note: Due to a bug in the Markdown converter with unicode characters, textile must be used for pages with unicode.
2
- +++
3
- NVIDIA® PhysX® is a powerful physics engine enabling real-time physics in leading edge PC games. PhysX software is widely adopted by over 150 games and is used by more than 10,000 developers. PhysX is optimized for hardware acceleration by massively parallel processors. GeForce GPUs with PhysX provide an exponential increase in physics processing power taking gaming physics to the next level.
@@ -1,264 +0,0 @@
1
- html, body
2
- {
3
- margin:0;
4
- padding:0;
5
- font-family: Verdana, Arial, Helvetica, sans-serif;
6
- font-size: 1.1em;
7
- font-style: normal;
8
- font-weight: normal;
9
- color: black;
10
- }
11
- body{
12
- background:white url(right-sidebar.png) repeat-y top right;
13
- }
14
-
15
- body.nosidebar{
16
- background-image:none;
17
- }
18
-
19
- #breadcrumb
20
- {
21
- margin:0;
22
- background:black url(nvidia-logo.gif) no-repeat left center;
23
- padding-left:56px;
24
- font-family: 'Arial', sans-serif;
25
- font-size:14px; font-weight:bold;
26
- white-space:nowrap;
27
- height:40px; line-height:40px; color:white; overflow:hidden;
28
- color:#fff;
29
- }
30
-
31
- #breadcrumb a
32
- {
33
- color:#fff; text-decoration:none
34
- }
35
-
36
- #breadcrumb a:hover
37
- {
38
- color:#74b71b
39
- }
40
- #breadcrumb .sep
41
- {
42
- color:#999; font-weight:normal; padding:0 0.2em
43
- }
44
-
45
- div#mainbody
46
- {
47
- font-size:90%;
48
- margin: 0 350px 0 10px;
49
- padding: 0;
50
- }
51
-
52
- body.nosidebar div#mainbody
53
- {
54
- margin-right:0px;
55
- }
56
-
57
- div#mainbody
58
- {
59
- padding-bottom:2em;
60
- }
61
-
62
- div.section
63
- {
64
- margin-left:2em
65
- }
66
-
67
- a:link, a:visited { white-space:nowrap; color:#6e8e34 }
68
- a:hover { color:#74b71b }
69
-
70
- a.hsglossaryreference {
71
- color:#000; cursor:help; border-color:#666 ! important
72
- }
73
- a.hsglossaryreference:hover { border-color:#74b71b ! important }
74
-
75
- ul { margin-left:2em; clear:left }
76
-
77
- strong { white-space:nowrap }
78
-
79
- h1 {
80
- margin:0;
81
- padding-left:14px;
82
- padding-right:50px;
83
- font-family: 'Arial', sans-serif;
84
- white-space:nowrap;
85
- font-size:18px;
86
- background:#6eb103 url(bg_green_bar_revised.gif) repeat-x;
87
- height:30px; line-height:30px; color:white; overflow:hidden;
88
- border-bottom:1px solid #999
89
- }
90
-
91
- h2
92
- {
93
- clear:both;
94
- margin-top:4em;
95
- }
96
- h2, h3, h4
97
- {
98
- border-bottom:1px solid #dddddd;
99
- font-size:100%;
100
- margin-bottom:0.5em;
101
- }
102
- h2.first-child, h3.first-child, h4.first-child
103
- {
104
- margin-top:0
105
- }
106
- h3, h4
107
- {
108
- margin-top:2em;
109
- color:#666;
110
- }
111
-
112
- p, li, fieldset, dl
113
- {
114
- margin:0;
115
- padding:0;
116
- padding-right:1em;
117
- margin-bottom:1em
118
- }
119
-
120
- .TODO
121
- {
122
- font-family: courier new;
123
- color: #ff80ff;
124
- font-size: 9pt;
125
- font-weight: bold
126
- }
127
-
128
- .sidebar
129
- {
130
- text-align: center;
131
- width: 350px;
132
- font-family: tahoma,sans-serif;
133
- float: right;
134
- clear: right;
135
- color: #665555;
136
- margin:0;
137
- padding:0;
138
- margin-right: -350px;
139
- margin-left: 1em;
140
- font-size: 7pt;
141
- font-weight: bold;
142
- }
143
- .sidebar img
144
- {
145
- display:block;
146
- margin:0 auto;
147
- margin-bottom:0.5em;
148
- }
149
-
150
- img.floatcap
151
- {
152
- float:left;
153
- margin-right:1em;
154
- margin-bottom:1em;
155
- margin-top:2px;
156
- }
157
-
158
- .moreinfo
159
- {
160
- font-style:italic;
161
- color:#666;
162
- }
163
-
164
- .moreinfo a
165
- {
166
- color: #6e8e34
167
- }
168
- .moreinfo a:hover
169
- {
170
- color: #76b900
171
- }
172
-
173
- p.aside
174
- {
175
- margin-left:4em
176
- }
177
-
178
- div#nonscrollingpagefooter
179
- {
180
- background:white;
181
- margin-bottom:0;
182
- margin-top:4em;
183
- clear:both;
184
- }
185
-
186
- div.tryit
187
- {
188
- border:1px solid #76b900;
189
- background:#eef6df;
190
- margin:2em 50px;
191
- padding:0;
192
- }
193
- div.tryit h3
194
- {
195
- background:#76b900;
196
- color:white;
197
- font-style:normal;
198
- padding:2px 0.5em;
199
- margin:0;
200
- margin-bottom:1em
201
- }
202
- div.tryit img.preview
203
- {
204
- float:right;
205
- width:180px;
206
- margin:-1em 0 1em 1em;
207
- }
208
- div.tryit ol
209
- {
210
- margin:1em;
211
- padding:0;
212
- }
213
- div.tryit li
214
- {
215
- margin:0;
216
- margin-left:3em;
217
- margin-bottom:1em
218
- }
219
- div.tryit .results
220
- {
221
- font-style:italic;
222
- color:#666
223
- }
224
-
225
- sup
226
- {
227
- font-size:85%
228
- }
229
-
230
- #known-issues h3 { font-style:normal; margin-bottom:0.2em; margin-top:3em; margin-right:1em }
231
- #known-issues h3 span.issue_num { margin-left:1.5em; font-weight:normal; font-size:85%; color:#666; line-height:1.2em; float:right; margin-top:-1.2em; margin-right:1em }
232
- #known-issues div.description { margin-bottom:2em }
233
- #known-issues p.workaround { margin-left:2em }
234
- #known-issues p.workaround strong { color:#666 }
235
-
236
- #pagebody
237
- {
238
- font-size: 70%;
239
- margin-bottom: 0;
240
- margin-top: 1em;
241
- }
242
-
243
- #pagebody h1 {
244
- background:#666; color:#ccc; border:1px solid #333; font-size:100%; padding:0.2em 1em; line-height:1em ! important;
245
- height:auto ! important; margin-top:1.5em
246
- }
247
-
248
- fieldset { margin-bottom:1.5em; margin-left:1em; padding:0.5em; border-right:none; }
249
- legend { font-weight:bold; color:#666 }
250
- fieldset dl { margin:0 2em }
251
- fieldset p { margin:1em 2em }
252
- dl.section { margin-left:2em }
253
- dt { font-weight:bold; font-style:normal; margin-top:0.8em }
254
- dd { margin-bottom:0.8em }
255
-
256
- div#pagefooter {
257
- margin-top:10em ! important; margin-bottom:1em ! important; width:25em; overflow:hidden; white-space:nowrap;
258
- background:#eee; border:1px solid #ccc; border-left:none; color:#999; font-size:7pt ! important; padding:0.1em 1em
259
- }
260
-
261
- ul.compact li { margin-bottom:0 }
262
- body.release-notes h3 { margin-left:2em }
263
- body.release-notes ul { margin-left:4em; margin-top:0; }
264
- body.release-notes li { margin-bottom:0; margin-top:0; padding:0 ! important; margin-left:1em; line-height:105%; }
@@ -1,4 +0,0 @@
1
- #glossary-box { display:none; position:absolute; width:30%; background:#e0efcc; border:1px solid #82a851; padding:0.5em 0.9em; font-size:9pt; font-family:Calibri, Tahoma; }
2
- #glossary-close { width:24px; height:24px; background:url(close.png) no-repeat; position:absolute; right:-12px; top:-12px; cursor:pointer; }
3
- #glossary-box * { margin:0 }
4
- span.glossary { color:#36401C; border-bottom:1px dashed #6e8e34; cursor:help; }
@@ -1,24 +0,0 @@
1
- function glossaryClick(evt){
2
- if (!evt) evt=event;
3
- var target = evt.target || evt.srcElement;
4
- var term = target.getAttribute('term') || target.innerHTML;
5
- var box = document.getElementById('glossary-box');
6
- box.style.display = 'block';
7
- var scroll = (document.documentElement.scrollTop || document.body.scrollTop )*1;
8
- box.style.left = (evt.clientX+5) + 'px';
9
- box.style.top = (evt.clientY+5) + scroll + 'px';
10
-
11
- var html = $glossaryTerms[term.toLowerCase()];
12
- document.getElementById('glossary-defn').innerHTML = html;
13
- }
14
-
15
- handleEvent(window,'load',function(){
16
- for ( var spans=document.getElementsByTagName('span'),i=spans.length-1; i>=0; --i ){
17
- if (cssClass.has(spans[i],'glossary')) handleEvent(spans[i],'click',glossaryClick);
18
- }
19
- var box = document.getElementById('glossary-box');
20
- var close = document.getElementById('glossary-close');
21
- handleEvent( close, 'click', function(){
22
- box.style.display = 'none';
23
- });
24
- });
@@ -1,31 +0,0 @@
1
- function handleEvent(obj,eventName,callback,useCapture){
2
- return obj.addEventListener ? obj.addEventListener(eventName,callback,useCapture||false) : obj.attachEvent("on"+eventName,callback);
3
- }
4
-
5
- cssClass = {
6
- _killCache : {},
7
- _findCache : {},
8
- add : function cssClassAdd(obj,className){
9
- this.kill(obj,className);
10
- obj.className+=(obj.className.length?' ':'')+className;
11
- },
12
- kill : function cssClassKill(obj,className){
13
- var re = this._killCache[className] || (this._killCache[className]=new RegExp('(?:^|\\s+)'+className+'(?:\\s+|$)','g') );
14
- obj.className = obj.className.replace(re,'');
15
- },
16
- has : function cssClassHas(obj,className){
17
- var re = this._findCache[className] || (this._findCache[className]=new RegExp('(?:^|\\s+)'+className+'(?:\\s+|$)') );
18
- return re.test( obj.className );
19
- }
20
- };
21
- function isFirstChild(node){
22
- return node.parentNode.firstChild==node;
23
- }
24
- handleEvent(window,'load',function(){
25
- // Add first-child CSS class since :first-child pseudo-class doesn't work for old IE
26
- for ( var tags=['h2','h3','p','ul','dl','ol'],i=tags.length-1; i>=0; --i ){
27
- for ( var all=document.getElementsByTagName(tags[i]),j=all.length-1; j>=0; --j ){
28
- if (isFirstChild(all[j])) cssClass.add(all[j],'first-child');
29
- }
30
- }
31
- });
@@ -1,28 +0,0 @@
1
- !!! Strict
2
- %html
3
- %head
4
- %meta(http-equiv='Content-Type' content='text/html; charset=utf-8')
5
- %link{:rel=>'stylesheet', :type=>'text/css', :href=>"#{root}common.css", :media=>'all'}
6
- %link{:rel=>'stylesheet', :type=>'text/css', :href=>"#{root}glossary.css", :media=>'all'}
7
- %script{:type=>'text/javascript', :src=>"#{root}nvdevtools.js"}
8
- %script{:type=>'text/javascript', :src=>"#{root}glossary-terms.js"}
9
- %script{:type=>'text/javascript', :src=>"#{root}glossary.js"}
10
- %title= page.title
11
- %body{ :class=>page.style }
12
- #pagetop
13
- #breadcrumb
14
- - toc = page.ancestors.first # The TOC has no page to link to
15
- = toc.short_title || toc.title
16
- %span.sep &gt;
17
- - page.ancestors[1..-1].each do |dad|
18
- %a{ :href=>root/dad.html_path }= dad.short_title || dad.title
19
- %span.sep &gt;
20
- = page.title
21
- %h1#title= page.title
22
- #pagebody
23
- #glossary-box
24
- #glossary-close
25
- #glossary-defn
26
- #mainbody= contents
27
- #pagefooter
28
- Copyright ©#{Time.now.year}#{ " #{global.company}" if global.company? }.
@@ -1,5 +0,0 @@
1
- company : NVIDIA Corporation
2
- title : NVIDIA Reference Manual
3
- short_title: NVIDIA Reference
4
- default : Getting Started
5
- +++