RTFMd 0.10301.1 → 0.10301.2

data/README.md

@@ -1,9 +1,7 @@
-RTFMd -- fork of gollum
-========================
+RTFMd
+=====
 
-## FORK
-
-Forked from `defunkt/gollum`:
+Forked from `defunkt/gollum` with:
 
 * Sinatra mountable app
 * Stylized to look like ronn HTML man pages
@@ -13,33 +11,35 @@ Forked from `defunkt/gollum`:
 
 ## DESCRIPTION
 
-Gollum is a simple wiki system built on top of Git that powers GitHub Wikis.
+* documentation is still a very rough WIP, so trust nothing here until I can remove the Gollum bits that no longer apply.
+
+RTFMd is a simple wiki system built on top of Git that powers GitHub Wikis.
 
-Gollum wikis are simply Git repositories that adhere to a specific format.
-Gollum pages may be written in a variety of formats and can be edited in a
+RTFMd wikis are simply Git repositories that adhere to a specific format.
+RTFMd pages may be written in a variety of formats and can be edited in a
 number of ways depending on your needs. You can edit your wiki locally:
 
 * With your favorite text editor or IDE (changes will be visible after committing).
-* With the Gollum Ruby API.
+* With the RTFMd Ruby API.
 
-Gollum follows the rules of [Semantic Versioning](http://semver.org/) and uses
+RTFMd follows the rules of [Semantic Versioning](http://semver.org/) and uses
 [TomDoc](http://tomdoc.org/) for inline documentation.
 
 
 ## RUNNING
 
-To view your Gollum repository locally via the built in web
-interface, simply install the Gollum gem, navigate to your repository via the
+To view your RTFMd repository locally via the built in web
+interface, simply install the RTFMd gem, navigate to your repository via the
 command line, and run the executable:
 
-    bin/golem
+    bin/rtfmd
 
-This will start up a web server running the Gollum frontend and you can view
+This will start up a web server running the RTFMd frontend and you can view
 your wiki at http://localhost:3000
 
 ## REPO STRUCTURE
 
-A Gollum repository's contents are designed to be human editable. Page content
+A RTFMd repository's contents are designed to be human editable. Page content
 is written in `page files` and may be organized into directories any way you
 choose. Special footers can be created in `footer files`. Other content
 (images, PDFs, etc) may also be present and organized in the same way.
@@ -52,7 +52,7 @@ Page files may be written in Markdown with extensions:
 * Markdown: .mkd, .markdown, .mdown, .mkdn, .md
 * ronn: .ronn
 
-Gollum detects the page file format via the extension, so files must have one
+RTFMd detects the page file format via the extension, so files must have one
 of the supported extensions in order to be converted.
 
 Page file names may contain any printable UTF-8 character except space
@@ -85,7 +85,7 @@ subdirectories that do not have a footer file of their own.
 
 ## HTML SANITIZATION
 
-For security and compatibility reasons Gollum wikis may not contain custom CSS
+For security and compatibility reasons RTFMd wikis may not contain custom CSS
 or JavaScript. These tags will be stripped from the converted HTML. See
 `docs/sanitization.mkd` for more details on what tags and attributes are
 allowed.
@@ -93,7 +93,7 @@ allowed.
 
 ## BRACKET TAGS
 
-A variety of Gollum tags use a double bracket syntax. For example:
+A variety of RTFMd tags use a double bracket syntax. For example:
 
     [[Link]]
 
@@ -114,7 +114,7 @@ Some formats, such as MediaWiki, support the opposite syntax:
 
 ## PAGE LINKS
 
-To link to another Gollum wiki page, use the Gollum Page Link Tag.
+To link to another RTFMd wiki page, use the RTFMd Page Link Tag.
 
     [[Frodo Baggins]]
 
@@ -133,7 +133,7 @@ page name, you can specify the actual page name after a pipe:
 The above tag will link to `Frodo-Baggins.mkd` using "Frodo" as the link text.
 
 The page file may exist anywhere in the directory structure of the repository.
-Gollum does a breadth first search and uses the first match that it finds.
+RTFMd does a breadth first search and uses the first match that it finds.
 
 Here are a few more examples:
 
@@ -156,17 +156,17 @@ underlying markup format.
 
 ## ABSOLUTE VS. RELATIVE VS. EXTERNAL PATH
 
-For Gollum tags that operate on static files (images, PDFs, etc), the paths
+For RTFMd tags that operate on static files (images, PDFs, etc), the paths
 may be referenced as either relative, absolute, or external. Relative paths
 point to a static file relative to the page file within the directory
-structure of the Gollum repo (even though after conversion, all page files
+structure of the RTFMd repo (even though after conversion, all page files
 appear to be top level). These paths are NOT prefixed with a slash. For
 example:
 
     gollum.pdf
     docs/diagram.png
 
-Absolute paths point to a static file relative to the Gollum repo's
+Absolute paths point to a static file relative to the RTFMd repo's
 root, regardless of where the page file is stored within the directory
 structure. These paths ARE prefixed with a slash. For example:
 
@@ -185,10 +185,10 @@ whatever works best in your situation.
 
 ## FILE LINKS
 
-To link to static files that are contained in the Gollum repository you should
-use the Gollum File Link Tag.
+To link to static files that are contained in the RTFMd repository you should
+use the RTFMd File Link Tag.
 
-    [[Gollum|gollum.pdf]]
+    [[RTFMd|gollum.pdf]]
 
 The first part of the tag is the link text. The path to the file appears after
 the pipe.
@@ -196,8 +196,8 @@ the pipe.
 
 ## IMAGES
 
-To display images that are contained in the Gollum repository you should use
-the Gollum Image Tag. This will display the actual image on the page.
+To display images that are contained in the RTFMd repository you should use
+the RTFMd Image Tag. This will display the actual image on the page.
 
     [[gollum.png]]
 
@@ -206,13 +206,13 @@ can specify between pipe delimiters.
 
 To specify alt text, use the `alt=` option. Default is no alt text.
 
-    [[gollum.png|alt=Gollum and his precious wiki]]
+    [[gollum.png|alt=RTFMd and his precious wiki]]
 
 To place the image in a frame, use the `frame` option. When combined with the
 `alt=` option, the alt text will be used as a caption as well. Default is no
 frame.
 
-    [[gollum.png|frame|alt=Gollum and his precious wiki]]
+    [[gollum.png|frame|alt=RTFMd and his precious wiki]]
 
 To specify the alignment of the image on the page, use the `align=` option.
 Possible values are `left`, `center`, and `right`. Default is `left`.
@@ -279,7 +279,7 @@ line.
 
 ## API DOCUMENTATION
 
-The Gollum API allows you to retrieve raw or formatted wiki content from a Git
+The RTFMd API allows you to retrieve raw or formatted wiki content from a Git
 repository, write new content to the repository, and collect various meta data
 about the wiki as a whole.
 
@@ -288,7 +288,7 @@ Initialize the Gollum::Repo object:
     # Require rubygems if necessary
     require 'rubygems'
 
-    # Require the Gollum library
+    # Require the RTFMd library
     require 'gollum'
 
     # Create a new Gollum::Wiki object by initializing it with the path to the

data/RTFMd.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'RTFMd'
-  s.version           = '0.10301.1'
+  s.version           = '0.10301.2'
   s.date              = '2011-12-16'
 
   s.summary     = "A simple, Markdown documentation helper."
@@ -45,6 +45,7 @@ Gem::Specification.new do |s|
     README.md
     Rakefile
     bin/rtfm
+    bin/rtfmd
     docs/sanitization.md
     RTFMd.gemspec
     lib/gollum.rb

data/bin/rtfm

@@ -1,12 +0,0 @@
-#!/bin/bash -e
-
-if [[ -n $1 ]]; then
-  GOLEM_WIKI=$1; shift
-else
-  GOLEM_WIKI=$(pwd)
-fi
-
-export GOLEM_WIKI
-
-bundle check 2>&- || { bundle install --local && bundle check; }
-exec bundle exec thin start -R config/golem.ru

data/bin/rtfmd

@@ -0,0 +1,12 @@
+#!/bin/bash -e
+
+if [[ -n $1 ]]; then
+  GOLEM_WIKI=$1; shift
+else
+  GOLEM_WIKI=$(pwd)
+fi
+
+export GOLEM_WIKI
+
+bundle check 2>&- || { bundle install --local && bundle check; }
+exec bundle exec thin start -R config/golem.ru

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: RTFMd
 version: !ruby/object:Gem::Version 
-  hash: 41193
+  hash: 41199
   prerelease: 
   segments: 
   - 0
   - 10301
-  - 1
-  version: 0.10301.1
+  - 2
+  version: 0.10301.2
 platform: ruby
 authors: 
 - Tom Bombadil
@@ -292,6 +292,7 @@ files:
 - README.md
 - Rakefile
 - bin/rtfm
+- bin/rtfmd
 - docs/sanitization.md
 - RTFMd.gemspec
 - lib/gollum.rb