docubot 0.0.1 → 0.2

data/lib/docubot/shells/default/0_License.md

@@ -0,0 +1,60 @@
+This is a simple, no-frills [Markdown](http://daringfireball.net/projects/markdown/basics) file.
+(This waiver is from [Via Ferrata](http://www.nelsonrocks.org/)'s waiver package, with a few
+additional stylistic modifications to show Markdown.)
+
+**Nelson Rocks Preserve** is covered in steep terrain with loose, slippery and unstable footing.
+The weather can make matters worse. Sheer drops are everywhere. You may fall, be injured or die.
+There are hidden holes. You could break your leg. There are wild animals, which may be vicious,
+poisonous or carriers of deadly diseases. These include poisonous snakes and insects. Plants can
+be poisonous as well.
+
+_Real dangers are present even on trails._ Trails are not sidewalks. They can be, and are,
+steep, slippery and dangerous. Trail features made or enhanced by humans, such as steps, walls
+and railings (if any) can break, collapse, or otherwise fail catastrophically at any time.
+
+* Stay on the trails whenever possible. The terrain, in addition to being dangerous, is
+  surprisingly complex. You may get lost. Carry food, water and first aid supplies at all times.
+* Rocks and other objects can fall from the cliffs. They can tumble down slopes. This can happen
+  naturally, or be caused by people above you, such as climbers. Rocks of all sizes, including
+  huge boulders, can shift, move or fall with no warning. Use of helmets is advised for anyone
+  approaching the rock formations. They can be purchased or rented at Seneca Rocks. They won't
+  save you if you get hit by something big or on another part of your body.
+* Weather can be dangerous, regardless of the forecast. Be prepared with extra clothing, including
+  rain gear.
+* Please know that scrambling in high places (scrambling is moving over terrain steep enough to
+  use your hands) without proper experience, training and equipment, or allowing children to do so
+  is dangerous.
+
+The Preserve does not provide rangers or security personnel. The other people in the preserve,
+including other visitors, our employees, agents, and guests, and anyone else who might sneak in,
+may be stupid, reckless, or otherwise dangerous. They may be mentally ill, criminally insane,
+drunk, using illegal drugs and/or armed with deadly weapons and ready to use them. We aren't
+necessarily going to do anything about it. We refuse to take responsibility.
+
+If you climb, you may die or be seriously injured. This is true whether you are experienced or
+not, trained or not, equipped or not, though training and equipment may help. It's a fact,
+climbing is extremely dangerous. If you don't like it, stay at home. You really shouldn't be
+doing it anyway. We do not provide supervision or instruction. We are not responsible for, and
+do not inspect or maintain, climbing anchors (including bolts, pitons, slings, trees, etc.) As
+far as we know, any of them can and will fail and send you plunging to your death. There are
+countless tons of loose rock ready to be dislodged and fall on you or someone else. There are
+any number of extremely and unusually dangerous conditions existing on and around the rocks, and
+elsewhere on the property. We may or may not know about any specific hazard, but even if we do,
+don't expect us to try to warn you. You're on your own.
+
+Rescue services are not provided by the Preserve, and may not be available quickly or at all.
+Local rescue squads may not be equipped for or trained in mountain rescue. If you are lucky
+enough to have somebody try to rescue you or treat your injuries, they may be incompetent or
+worse. This includes doctors and hospitals. We assume no responsibility. Also, if you decide to
+participate in a rescue of some other unfortunate, that's your choice. Don't do it unless you
+are willing to assume all risks.
+
+By entering the Preserve, you are agreeing that we owe you no duty of care or any other duty. We
+promise you nothing. We do not and will not even try to keep the premises safe for any purpose.
+The premises are not safe for any purpose. This is no joke. We won't even try to warn you about
+any dangerous or hazardous condition, whether we know about it or not. If we do decide to warn
+you about something, that doesn't mean we will try to warn you about anything else. If we do
+make an effort to fix an unsafe condition, we may not try to correct any others, and we may make
+matters worse! We and our employees or agents may do things that are unwise and dangerous.
+Sorry, we're not responsible. We may give you bad advice. Don't listen to us. In short, ENTER
+AND USE THE PRESERVE AT YOUR OWN RISK. And have fun!

data/lib/docubot/shells/default/Appendix/Glossary.md

@@ -0,0 +1,5 @@
+template: glossary
++++
+This page uses the glossary template, which has the smarts to generate HTML from the glossary terms gleaned throughout the site.
+
+The Glossary template doesn't actually use the `contents` of the page, so it doesn't matter what I put here.

data/lib/docubot/shells/default/Appendix/Index_Page.md

@@ -0,0 +1,8 @@
+template   : index
+title      : Index
+description: Custom template to generate HTML index.
++++
+YOU DO NOT NEED THIS FILE IF YOU ARE GENERATING CHMs.
+
+The `index` template is really only useful for generating HTML indexes, since the CHM writer
+generates the information necessary for the CHM to have its own special Index tab.

data/lib/docubot/shells/default/Appendix/Table of Contents.md

@@ -0,0 +1,5 @@
+template: toc
++++
+This page uses the `toc` template, which has the smarts to generate HTML from the table of contents gathered from the site.
+
+The `toc` template is really only useful for generating HTML TOCs, since the CHM writer generates the information necessary for the CHM to have its own special Contents tab.

data/lib/docubot/shells/default/index.txt

@@ -0,0 +1,3 @@
+company: FrobozzCo
+title: Froboz Reference Manual
++++

data/lib/docubot/shells/docubot-help/0_License.md

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010 Gavin Kistner, Harold Hausman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/docubot/shells/docubot-help/1_Getting_Started.md

@@ -0,0 +1,48 @@
+# Organizing the Project
+The names and structure of files and folders are used for the table of contents.
+The only exceptions are:
+
+* As seen here, leading digits (used to sort items) are removed from the titles.
+* Also as seen here, underscores in the name are replaced with spaces.
+* Specifying a `title` attribute in the metasection overrides the file/folder name.
+* Files may be hidden from the contents by putting `hide: true` in the metasection.
+* A few special folders at the root of the project--`_glossary`, `_static`, and
+  `_templates`--are exempt from conversion and the table of contents.
+
+# Creating Project Files
+The file extension of files in the project folder controls the interpretation of the
+markup. There are currently are five converters (of varying usefulness) which may be
+used to convert your markup to HTML:
+
+1. **[Markdown](http://daringfireball.net/projects/markdown/syntax)** (*.md):
+   This is the simplest (useful) markup converter. It has the benefits of being
+   easy to read and sensible to author with almost no knowledge of HTML.
+   
+   The downside is that there is very little semantic markup available beyond
+   headings and lists. You can inject inline HTML as you wish, however.
+
+2. **[Textile](http://redcloth.org/textile)** (*.rc, *.textile): 
+   Textile has a lot of nice formatting features not present in Markdown.
+   Further, it provides a much tighter coupling with HTML, allowing you to express
+   a lot of HTML concepts in a markup format slightly better than HTML.
+   
+   It's better than HTML, but not as much fun to write in.
+
+3. **HTML** (*.html, *.htm):
+   This 'converter' just passes the HTML through untouched.
+   (We plan on adding some sanitization options.)
+
+4. **Raw Code** (*.rb, *.c, *.h, *.cpp, *.cs, *.txt, *.raw):
+   Files with any of the above extensions will be wrapped in an HTML `<pre>` tag
+	 and sent along as the content of the page.
+
+5. **[Haml](http://haml-lang.com/docs.html)** (*.haml):
+   Haml is the language that all the templates of DocuBot are written in.
+   It's a super-elegant, minimalist way of expressing HTML structure, merging
+   in Ruby code where you see fit.
+   
+   It also lets you drop into Markup, Textile, or a variety of other
+   [filters](http://haml-lang.com/docs/yardoc/file.HAML_REFERENCE.html#filters)
+   for any section.
+   
+   Haml is useful for pages where you need a lot of specific HTML structure.

data/lib/docubot/shells/docubot-help/2_Basic_Concepts/1 Interpage Links.md

@@ -0,0 +1 @@
+Use relative paths, but end in .html

data/lib/docubot/shells/docubot-help/2_Basic_Concepts/2 Generating the Output.md

@@ -0,0 +1 @@
+`docubot -h`

data/lib/docubot/shells/docubot-help/2_Basic_Concepts/3 Customizing Templates.md

@@ -0,0 +1 @@
+Files in `_templates` override the default templates. See also CSS and JS in `_root`, which is copied to the root of the app.

data/lib/docubot/shells/docubot-help/2_Basic_Concepts/4 Adding Images.md

@@ -0,0 +1,2 @@
+* Unrecognized files are copied as-is to the same directory.
+* You can also use the global `_static` directory which will be copied wholesale.

data/lib/docubot/shells/docubot-help/2_Basic_Concepts/index.md

@@ -0,0 +1,6 @@
+title: Basic Concepts, Yo!
++++
+You can set attributes for a section with a file named `index.*` in the directory.
+Among other things, this lets you set titles containing characters not allowed on the file system.
+
+(The title of this section in the table of contents will have the exclamation point.)

data/lib/docubot/shells/docubot-help/3_Advanced_Topics/Controlling Glossary.md

@@ -0,0 +1,3 @@
+* Put named terms in a `_glossary` folder at the root of the site.
+* Use double dollars around $$glossary terms$$ to add links to them on the page.
+* Use $$double dollars with colon:glossary term$$ to link alternative text to a standard entry.

data/lib/docubot/shells/docubot-help/3_Advanced_Topics/Controlling Indexing.md

@@ -0,0 +1,10 @@
+keywords: Indexing, Keyword Management
+no-index: headings, definitions
++++
+Use the `keywords` tag along with comma-delimited terms or phrases to add specific entries in the index for the page.
+
+By default, every heading in every page is included in the index for the documentation. The `no-index: headings` info in the metasection above prevents that for this page.
+
+Definition titles (`<dt>...</dt>` in the HTML) are also put in the index by default. Use `no-index: definitions` to exclude them.
+
+Put double-at signs around text in the page to @@add a word or phrase the index@@.

data/lib/docubot/shells/docubot-help/3_Advanced_Topics/Controlling the Table of Contents.md

@@ -0,0 +1,7 @@
+toc: #bones-and-groups #rigid-body-type #physical-mesh
++++
+* Use `toc: hide` to remove a page from the table of contents.
+* Use `toc: #list #of-html #identifiers` to add specific elements on the page,
+  referenced by HTML id, as sub-section links in the table of contents.
+  The contents of the HTML tag with that id will be used as the index header.
+* TODO: Use `icon: <somename>` to specify a specific CHM icon in the TOC.

data/lib/docubot/shells/docubot-help/3_Advanced_Topics/Switching Page Templates.md

@@ -0,0 +1 @@
+Using the `template` meta keyword.

data/lib/docubot/shells/docubot-help/4_Appendix/Glossary.md

@@ -0,0 +1,5 @@
+template: glossary
++++
+This page uses the glossary template, which has the smarts to generate HTML from the glossary terms gleaned throughout the site.
+
+The Glossary template doesn't actually use the `contents` of the page, so it doesn't matter what I put here.

data/lib/docubot/shells/docubot-help/4_Appendix/Index_Page.md

@@ -0,0 +1,6 @@
+template: index
+title: Index
++++
+This page uses the `index` template, which has the smarts to generate HTML from the indexed terms gleaned throughout the site.
+
+The `index` template is really only useful for generating HTML indexes, since the CHM writer generates the information necessary for the CHM to have its own special Index tab.

data/lib/docubot/shells/docubot-help/4_Appendix/Table of Contents.md

@@ -0,0 +1,7 @@
+template   : toc
+description: Custom template to generate HTML TOC.
++++
+YOU DO NOT NEED THIS FILE IF YOU ARE GENERATING CHMs.
+
+The `toc` template is really only useful for generating HTML contents, since the CHM writer
+generates the information necessary for the CHM to have its own special Contents tab.

data/lib/docubot/shells/docubot-help/_glossary/Template.md

@@ -0,0 +1 @@
+A [Haml](http://haml-lang.com/docs.html) file used to wrap markup and generated content around your page.

data/lib/docubot/shells/docubot-help/index.txt

@@ -0,0 +1,8 @@
+company: Froboz Widgets
+title  : Froboz Widgets Reference Manual
+author : Gavin Kistner
+edited : 2010-Jan-14
++++
+A file named `index.*` (one of the recognized markup types) lets you specify global variables for the project.
+
+Not every variable you put in the meta section has to be used; you can put your own metadata there.

data/lib/docubot/shells/nvphysx/0_License.md

@@ -0,0 +1,3 @@
+style: license nosidebar
++++
+![NVIDIA 3D Badge](_static/NVBadge_3D.png)

data/lib/docubot/shells/nvphysx/1_Getting_Started.haml

@@ -0,0 +1,51 @@
+keywords: Basics
+toc     : welcome authoring glossary index
++++
+%h2#welcome Welcome to DocuBot for NVIDIA PhysX
+%p.sidebar
+	%img(width='150' src='_static/NVBadge_3D.png')
+	NVIDIA 3D Badge
+	%span#out
+:textile
+	This template shows the standard page style, which has a 350px sidebar on the right for including
+	images related to the text.
+	
+	To put images (with an optional description) in the sidebar, place them inside a paragraph with
+	the CSS class @sidebar@. They will float to the right next to your content.
+	
+	Each header will--by default--wait to begin until all images on the right have finished.
+
+%h2#authoring Authoring Content	
+<p class="sidebar"><img src="_static/PhysXbyNV_Black.png" width="180"></p>
+:markdown
+	The headers on each page should start at `h2` (not `h1`); `h1` is used for the title at the top of the page.
+	 
+	As shown in this template, if you apply HTML `id` attributes to the headers (or any other HTML element), and list those
+	identifiers under a toc entry at the top of the page, the Table of Contents will include sub-links to the headings.
+	
+%h2#glossary Glossary Entries
+%p
+	To create a reference to a glossary term, surround it in double dollar signs.
+	For example, $$NVIDIA$$ makes $$PhysX$$ and $$APEX Libraries:APEX$$.
+%p
+	As shown in the APEX link above, you can have the glossary text be different from the term it links to
+	by putting the words you want first, followed by a colon, followed by the actual glossary term to link to.
+%p
+	This works in all markups. (The processing happens after the markup is converted to HTML.)
+	
+%h2#index Managing the Index
+%p The index is automatically populated with the text from headings and defintions on the pages.
+%p To add additional terms, you can:
+%ul
+	%li
+		Use a <code>keywords</code> section at the top of the page with comma-delimited keywords or
+		phrases that you want the index to associate with the current page.
+	%li
+		:markdown
+			Put two `@` signs around any word or phrase in your text that you wanted added to the index.
+			
+			For example, imagine that this page talked about @@sexy code@@; the index now knows about that.
+			
+			Note that this syntax doesn't currently work with textile, because it uses single @ characters to
+			denote code. This will be fixed in the future (by processing glossary and index snippets before markup).
+	

data/lib/docubot/shells/nvphysx/Appendix/Glossary.md

@@ -0,0 +1,7 @@
+template: glossary
++++
+This page uses the glossary template, which has the smarts to generate HTML
+from the glossary terms defined in the `_glossary` directory.
+
+The Glossary template doesn't actually use the `contents` of this page, so
+it doesn't matter what I put here.

data/lib/docubot/shells/nvphysx/_glossary/APEX.md

@@ -0,0 +1 @@
+A multi-platform, scalable dynamics framework.

data/lib/docubot/shells/nvphysx/_glossary/NVIDIA.md

@@ -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.

data/lib/docubot/shells/nvphysx/_glossary/PhysX.textile

@@ -0,0 +1,3 @@
+note: Due to a bug in the Markdown converter with unicode characters, textile must be used for pages with unicode.
++++
+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.

data/lib/docubot/shells/nvphysx/_templates/_root/common.css

@@ -0,0 +1,264 @@
+html, body
+{
+    margin:0;
+    padding:0;
+    font-family:    Verdana, Arial, Helvetica, sans-serif;
+    font-size:      1.1em;
+    font-style:     normal;
+    font-weight:    normal;
+    color:          black;
+}
+body{
+	background:white url(right-sidebar.png) repeat-y top right;
+}
+
+body.nosidebar{
+	background-image:none;
+}
+
+#breadcrumb
+{
+	margin:0;
+	background:black url(nvidia-logo.gif) no-repeat left center;
+	padding-left:56px;
+	font-family: 'Arial', sans-serif;
+	font-size:14px; font-weight:bold;
+	white-space:nowrap;
+	height:40px; line-height:40px; color:white; overflow:hidden;
+	color:#fff;
+}
+
+#breadcrumb a
+{
+	color:#fff; text-decoration:none
+}
+
+#breadcrumb a:hover
+{
+	color:#74b71b
+}
+#breadcrumb .sep
+{
+	color:#999; font-weight:normal; padding:0 0.2em
+}
+
+div#mainbody
+{
+    font-size:90%;
+    margin:   0 350px 0 10px;
+    padding:  0;
+}
+
+body.nosidebar div#mainbody
+{
+	margin-right:0px;
+}
+
+div#mainbody
+{
+	padding-bottom:2em;
+}
+
+div.section
+{
+	margin-left:2em
+}
+
+a:link, a:visited { white-space:nowrap; color:#6e8e34 }
+a:hover { color:#74b71b }
+
+a.hsglossaryreference {
+	color:#000; cursor:help; border-color:#666 ! important
+}
+a.hsglossaryreference:hover { border-color:#74b71b ! important }
+
+ul { margin-left:2em; clear:left }
+
+strong { white-space:nowrap }
+
+h1 {
+	margin:0;
+	padding-left:14px;
+	padding-right:50px;
+	font-family: 'Arial', sans-serif;
+	white-space:nowrap;
+	font-size:18px;
+	background:#6eb103 url(bg_green_bar_revised.gif) repeat-x;
+	height:30px; line-height:30px; color:white; overflow:hidden;
+	border-bottom:1px solid #999
+}
+
+h2
+{
+	clear:both;
+	margin-top:4em;
+}
+h2, h3, h4
+{
+	border-bottom:1px solid #dddddd;
+	font-size:100%;
+	margin-bottom:0.5em;
+}
+h2.first-child, h3.first-child, h4.first-child
+{
+	margin-top:0
+}
+h3, h4
+{
+	margin-top:2em;
+	color:#666;
+}
+
+p, li, fieldset, dl
+{
+	margin:0;
+	padding:0;
+	padding-right:1em;
+	margin-bottom:1em
+}
+
+.TODO
+{
+    font-family: courier new;
+    color: #ff80ff;
+    font-size: 9pt;
+    font-weight: bold
+}
+
+.sidebar
+{
+    text-align: center;
+    width: 350px;
+    font-family: tahoma,sans-serif;
+    float: right;
+    clear: right;
+    color: #665555;
+    margin:0;
+    padding:0;
+    margin-right: -350px;
+    margin-left: 1em;
+    font-size: 7pt;
+    font-weight: bold;
+}
+.sidebar img
+{
+	display:block;
+	margin:0 auto;
+	margin-bottom:0.5em;
+}
+
+img.floatcap
+{
+	float:left;
+	margin-right:1em;
+	margin-bottom:1em;
+	margin-top:2px;
+}
+
+.moreinfo
+{ 
+	font-style:italic;
+	color:#666;
+}
+
+.moreinfo a
+{
+    color: #6e8e34
+}
+.moreinfo a:hover
+{
+    color: #76b900
+}
+
+p.aside
+{
+	margin-left:4em
+}
+
+div#nonscrollingpagefooter
+{
+	background:white;
+	margin-bottom:0;
+	margin-top:4em;
+	clear:both;
+}
+
+div.tryit
+{
+	border:1px solid #76b900;
+	background:#eef6df;
+	margin:2em 50px;
+	padding:0;
+}
+div.tryit h3
+{
+	background:#76b900;
+	color:white;
+	font-style:normal;
+	padding:2px 0.5em;
+	margin:0;
+	margin-bottom:1em
+}
+div.tryit img.preview
+{
+	float:right;
+	width:180px;
+	margin:-1em 0 1em 1em;
+}
+div.tryit ol
+{
+	margin:1em;
+	padding:0;
+}
+div.tryit li
+{
+	margin:0;
+ 	margin-left:3em;
+ 	margin-bottom:1em	
+}
+div.tryit .results
+{
+	font-style:italic;
+	color:#666
+}
+
+sup
+{
+	font-size:85%
+}
+
+#known-issues h3 { font-style:normal; margin-bottom:0.2em; margin-top:3em; margin-right:1em }
+#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 }
+#known-issues div.description { margin-bottom:2em }
+#known-issues p.workaround { margin-left:2em }
+#known-issues p.workaround strong { color:#666 }
+
+#pagebody
+{
+    font-size:      70%;
+    margin-bottom:  0;
+    margin-top: 1em;
+}
+
+#pagebody h1 {
+	background:#666; color:#ccc; border:1px solid #333; font-size:100%; padding:0.2em 1em; line-height:1em ! important;
+	height:auto ! important; margin-top:1.5em
+}
+
+fieldset { margin-bottom:1.5em; margin-left:1em; padding:0.5em; border-right:none; }
+legend { font-weight:bold; color:#666 }
+fieldset dl { margin:0 2em }
+fieldset p { margin:1em 2em }
+dl.section { margin-left:2em }
+dt { font-weight:bold; font-style:normal; margin-top:0.8em }
+dd { margin-bottom:0.8em }
+
+div#pagefooter {
+	margin-top:10em ! important; margin-bottom:1em ! important; width:25em; overflow:hidden; white-space:nowrap;
+	background:#eee; border:1px solid #ccc; border-left:none; color:#999; font-size:7pt ! important; padding:0.1em 1em
+}
+
+ul.compact li { margin-bottom:0 }
+body.release-notes h3 { margin-left:2em }
+body.release-notes ul { margin-left:4em; margin-top:0; }
+body.release-notes li { margin-bottom:0; margin-top:0; padding:0 ! important; margin-left:1em; line-height:105%; }