docubot 0.6.1 → 0.6.2

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

@@ -1,60 +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
+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

@@ -1,5 +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.
-
+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

@@ -1,8 +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.
+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

@@ -1,5 +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.
-
+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/docubot-help/0_License.md

@@ -1,21 +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 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

@@ -1,48 +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.
-   
+# 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/4 Adding Images.md

@@ -1,2 +1,2 @@
-* Unrecognized files are copied as-is to the same directory.
+* 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

@@ -1,6 +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.
-
+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

@@ -1,3 +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.
+* 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

@@ -1,10 +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.
-
+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

@@ -1,5 +1,5 @@
-toc: #bones-and-groups, #rigid-body-type, #physical-mesh
-+++
-* 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.
+toc: #bones-and-groups, #rigid-body-type, #physical-mesh
++++
+* 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.

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

@@ -1,5 +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.
-
+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

@@ -1,6 +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.
-
+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

@@ -1,7 +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.
+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/index.txt

@@ -1,8 +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.
-
+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/snippet.rb

@@ -1,19 +1,19 @@
-# encoding: UTF-8
-module DocuBot
-	@snippets = {}
-	
-	def self.handle_snippet( regexp, &handler )
-		@snippets[ regexp ] = handler
-	end
-	
-	def self.process_snippets( page, html )
-		# TODO: Don't process snippets on the 'raw' file types
-		@snippets.inject(html){ |h,(regexp,handler)| h.gsub( regexp ){ |str| handler[ str, page ] } }
-	end
-	
-	Dir[ DocuBot::DIR/'docubot/snippets/*.rb' ].each do |snippet|
-		require snippet
-	end
-	
-end
-
+# encoding: UTF-8
+module DocuBot
+	@snippets = {}
+	
+	def self.handle_snippet( regexp, &handler )
+		@snippets[ regexp ] = handler
+	end
+	
+	def self.process_snippets( page, html )
+		# TODO: Don't process snippets on the 'raw' file types
+		@snippets.inject(html){ |h,(regexp,handler)| h.gsub( regexp ){ |str| handler[ str, page ] } }
+	end
+	
+	Dir[ DocuBot::DIR/'docubot/snippets/*.rb' ].each do |snippet|
+		require snippet
+	end
+	
+end
+