git-scribe-qp 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b587fd4d83b88a0feca292eba5d3b1416f18e07
+  data.tar.gz: 7ad558082e7db4eedb135600c55352b12c59c57d
+SHA512:
+  metadata.gz: a8c534fe0ac67c07946231aa6c25e1c61840e3379b4800c89d0b75ece7e2156d046f067a3a9f1ce6482f810617fb833e72e86c520cc4e0d16e91ecdd46168106
+  data.tar.gz: 76ffa94ff6ecf6af16785fc862906ff81b161fa86db7fc18c2f58bea9fa514558638ed754c664fe0856ed3aa89886bdddd3515d9f1a2a6a9407dbf6aed6c013b

data/.gitignore

@@ -0,0 +1,4 @@
+example/output
+output
+.DS_Store
+*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    git-scribe (0.1.1)
+      grit
+      liquid
+      nokogiri
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    grit (2.5.0)
+      diff-lcs (~> 1.1)
+      mime-types (~> 1.15)
+      posix-spawn (~> 0.3.6)
+    liquid (2.3.0)
+    mime-types (1.19)
+    nokogiri (1.5.5)
+    posix-spawn (0.3.6)
+    rake (0.9.2)
+    test-unit (2.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  git-scribe!
+  rake
+  test-unit

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2007-2011 Scott Chacon
+
+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/Pygments.txt

@@ -0,0 +1,44 @@
+The general idea is:
+
+In book.xml, convert:
+
+```
+[source,javascript] blah, blah, blah
+```
+
+To:
+
+```
+[source]//javascript
+blah, blah, blah
+```
+
+In book.fo, run pygments on
+
+```
+<fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" space-after.minimum="0.8em" space-after.optimum="1em" space-after.maximum="1.2em" hyphenate="false" wrap-option="no-wrap" white-space-collapse="false" white-space-treatment="preserve" linefeed-treatment="preserve" text-align="start" font-family="monospace" font-size="10pt" keep-together.within-column="always" background-color="#E0E0E0" border="0" id="d0e234">//javascript
+// The game area
+var scene = new THREE.Scene();
+```
+
+To get:
+
+```
+$  gamingjs git:(master) ✗ pygmentize -O style=trac -f bb -l javascript book/includes/building_an_avatar/avatar_head.js
+[color=#999988][i]// The game area
+[/i][/color][b]var[/b] scene [b]=[/b] [b]new[/b] THREE.Scene();
+
+[color=#999988][i]// The camera
+[/i][/color][b]var[/b] aspect_ratio [b]=[/b] [color=#999999]window[/color].innerWidth [b]/[/b] [color=#999999]window[/color].innerHeight;
+[b]var[/b] camera [b]=[/b] [b]new[/b] THREE.PerspectiveCamera([color=#009999]75[/color], aspect_ratio, [color=#009999]1[/color], [color=#009999]10000[/color]);
+camera.position.z [b]=[/b] [color=#009999]500[/color];
+scene.add(camera);
+```
+
+And then convert to:
+
+```
+<fo:block space-before.minimum="0.8em" space-before.optimum="1em" space-before.maximum="1.2em" space-after.minimum="0.8em" space-after.optimum="1em" space-after.maximum="1.2em" hyphenate="false" wrap-option="no-wrap" white-space-collapse="false" white-space-treatment="preserve" linefeed-treatment="preserve" text-align="start" font-family="monospace" font-size="10pt" keep-together.within-column="always" background-color="#E0E0E0" border="0" id="d0e234"><fo:inline font-style="italic" color="grey">// The game area</fo:inline>
+<fo:inline font-weight="bold" color="blue">var</fo:inline> scene = <fo:inline font-weight="bold" color="blue">new</fo:inline> THREE.Scene();
+
+```

data/README.asciidoc

@@ -0,0 +1,131 @@
+This Fork
+---------
+
+I forked this to add Chinese support to git-scribe.
+
+The upstream uses `a2x` with `--icons` param, which leads to encoding errors if I set the encoding to utf-8.
+
+I also merged almost all changes by @eee-c in his fork.
+
+eee-c's Fork
+============
+This fork is used to maintain my ebooks: http://spdybook.com,
+http://recipeswithbackbone.com, and http://dartforhipsters.com. It
+adds some features (page resizing, formatting tweaks, Kindle Fire
+compatibility, ebook zip). Most features could (and will) eventually
+appear in the upstream, but some, particularly page sizing are
+incompatible with the saxon-based upstream (this fork remains tied to
+xsltproc).
+
+Unless you absolutely need my features, you should use upstream. As
+such, there will never be an official ruby gem. If you really, really
+want this, clone the repository and install with:
+
+    gem build git-scribe.gemspec
+    gem install git-scribe-0.1.1.gem
+
+
+Git Scribe
+==========
+
+The git-scribe tool is a simple command line toolset to help you use Git, GitHub and Asciidoc
+to write e-books.  This provides tools for setting up the structure, collaborating with co-authors, doing technical and copy-editing, handling translations, taking errata, as well as publishing online, pdf, mobi (Kindle) and epub (iBooks, Nook) versions.
+
+The project is targeted for writing books of any length, but should also be usable for articles and stuff too, though for a while you'll have to just do it as a really short book.
+
+Features
+========
+
+Eventually, these are the feature goals for the project:
+
+* Easy: Syntax-Highlighted Code, Formula, Diagrams
+* Site Generation: Comment, Search, Permalinks
+* Pegging versions of the book to versions of the tool it documents
+* Technical and Copy editing workflow tools
+* Translation workflow tools
+* Selling (possibly): Kindle, iBooks, Lulu, Pledgie(?)
+
+The idea is that you use the tool to generate a known structure, write in asciidoc and let the tool handle everything else for you.  I want authors to be able to focus on writing and not have to worry about anything else (website, multiple format generation, etc).
+
+A good AsciiDoc cheat sheet: http://powerman.name/doc/asciidoc#_text
+
+Disclaimer
+==========
+
+This tool is a work in progress.  At the 1.0 release, this file will be totally up to date, but for now I may have documented some stuff that doesn't yet work.  Contact me personally if you are interested in working on it.
+
+Installing
+==========
+
+You can install git-scribe via RubyGems.
+
+    $ gem install git-scribe
+
+For local generation (eventually pushing to GitHub will handle gen for you), it depends on a couple things like:
+
+* Git
+* Ruby
+* asciidoc, a2x (8.6.4)
+* xsltproc
+* source-highlight (3.1)
+* FOP (1.0) - for PDF generation
+
+Usage
+=====
+
+Check if you have everything installed properly for local generation with `check`:
+
+    $ git scribe check
+    asciidoc - ok
+    xsltproc - ok
+    a2x      - ok
+    highlighting - ok
+    fop      - ok
+
+If you are on OSX and using Homebrew http://mxcl.github.com/homebrew/ you can install dependencies easily:
+
+----
+$ brew install asciidoc source-highlight fop
+$ brew install https://gist.github.com/raw/4064648/kindlegen.rb
+----
+
+If you are on Ubuntu, you can install the dependencies with apt-get:
+
+----
+$ sudo apt-get install asciidoc
+$ sudo apt-get install source-highlight
+$ sudo apt-get install fop
+----
+
+Kindlegen: http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000765211
+
+Initialize a new book with `init`:
+
+    $ git scribe init <directory name>
+
+This will set up the outline for your book.  All the book content goes into the 'book' subdirectory with 'book.asc' as the starting point.  If you want to split the writing up into multiple files you can simply include them in the book.asc file.  The generated files have an example of this.
+
+Then you can generate your book content with the 'git scribe gen' command:
+
+    $ git scribe gen [site|html|pdf|epub|mobi|ebook|all]
+
+Eventually, simply pushing to GitHub will take care of this for you.  
+
+*UPDATED:* Just added is the ability to create ZIP file containing the three formats needed to publish an ebook (PDF, EPUB, and MOBI).  This feature will create a ZIP named after the title of your book ("The SPDY Book" produces `the_spdy_book.zip`).  To do this, generate an "ebook":
+
+    $ git scribe gen ebook
+
+_n.b._ This may change in the future.
+
+
+Roadmap
+=======
+
+See SPEC.asciidoc for what this file should look like eventually.
+
+Contributing
+============
+
+If you want to hack on this, fork it, improve it and send me a pull request.
+
+To get started using it, just clone it and call the ./bin/git-scribe script directly from either the `example` subdir or your own book directory.  If you add a feature, make sure it's included in the example subdirectory so I can test it out.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/SPEC.asciidoc

@@ -0,0 +1,126 @@
+The Dream
+=========
+
+This is where I'm documenting basically what I want the README to eventually look like.  This is sort of my Document Driven Development file.  I'm trying to envision what the git-scribe project should look like as I write the tool.  I didn't want it to be in the readme yet so as not to confuse people.  All the commands are just ideas and what not.  If you have an idea of how you would like things to look, add them here and send a pull request.
+
+I want to get the full workflows worked out here (with technical details) before I even try to implement them.
+
+Start a Book
+============
+
+    $ git scribe init (--type=[code,math]) (--license=[public,cc]) (--lang=en) [project]
+
+Generates a skeleton, license file and readmes with instructions for authors and contributors.
+Also records version of scribe workflow we're using into .gitscribe file.
+
+* shows cheat-sheet of how to use grep, tag, diff (--word)
+
+Work on a Book
+==============
+
+    $ git scribe check
+
+Run checks to make sure you have all the tools you need and your system can do stuff.
+
+    $ git scribe register (--role=[author,reviewer,editor,translator])
+
+Register yourself and your role in this book.
+  kept in .git/scribe
+
+To Do List
+==========
+
+    $ git scribe todo
+
+* lists boilerplate you still haven't filled out 
+  (title, author, description, chapter, cover, bio, biblio, price, license, etc)
+  most of that is kept in .gitscribe
+
+Writing
+=======
+
+    $ git scribe new chapter
+
+Editing
+=======
+
+    $ git scribe review
+
+TODO: address technical reviewing and copy-editing
+
+Translating - Translator
+========================
+
+    $ git scribe trans start (--edition=1.1) de
+
+Sets up pre-commit hook to check that commit message is formatted correctly, copies over main language to 'de'
+
+http://en.wikipedia.org/wiki/IETF_language_tag
+
+    $ git scribe trans changes (--since=2010-01-01)
+
+    $ git scribe trans done SHA
+
+Translating - Maintainer
+========================
+
+    $ git scribe trans complete
+
+See which translations are what percent complete.
+
+- get list of translators for each translation
+
+Editions
+========
+This is meant to be done infrequently - like an edition of a book or a major version of a framework that is being documented.  Publishing editions too often makes work difficult on translators, so be prudent.
+
+    $ git scribe --tool-version=1.7 publish [major|minor]
+
+Tags the edition with the next major or minor number, generates a branch for maintainance for this edition.
+
+Generate Media
+==============
+
+    $ git scribe gen (--lang=de) (--edition=1.0) [site,pdf,mobi,epub]
+
+OR
+
+    $ git push origin
+
+Sell
+====
+
+    $ git scribe sell --price=8.00 [--lang=de] (ibooks,kindle,nook,lulu)
+
+
+Layout
+======
+
+The layout that the `git scribe init` produces looks like this:
+
+[source]
+----
+* book/
+|`--* book.asc
+|`--* 01_first_chapter.asc
+|`--* 02_second_chapter.asc
+|`--* 99_backmatter.asc
+|`--* image/
+|    `--* 01.01-example-image.png
+|    `--* 01.02-another-image.png
+|    `--* 02.01-an-image.png
+|`--* include/
+|    `--* 02.01-code.c
+* style/
+|`--* style.css
+* site/
+|`--* layout.html
+* test/
+|`--* 01_test.rb
+* LICENSE.txt
+* README.asciidoc
+* .gitscribe
+----
+
+Not all of those files would be generated (like the test files and the site files which are overrides for the site templates), but examples would and it would give a usable starting point for new authorship.  This example would be a valid and somewhat complex layout.
+

data/TODO.txt

@@ -0,0 +1,17 @@
+To-Do List
+=============
+
+* move to GLI?
+
+* workflow
+  - review / copy editing
+  - translation
+  - edition release
+  - maint branches (pegging to software revs)
+
+* book search
+* site comments
+* github-side generation
+* docbook import / direct from docbook
+* external auto-publishing / monetization (?)
+  - amazon/ibooks/lulu integration

data/bin/git-scribe

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'git-scribe'
+require 'git-scribe/cli'
+
+GitScribe.new.run

data/docbook-xsl/.CatalogManager.properties.example

@@ -0,0 +1,61 @@
+######################################################################## 
+# CatalogManager provides an interface to the catalog properties.
+# Properties can come from two places: from system properties or
+# from a CatalogManager.properties file. This class provides a
+# transparent interface to both, with system properties preferred 
+# over property file values.
+
+#######################################################################
+# Catalog Files:
+# The semicolon-delimited list of catalog files.
+# Example: catalogs=/etc/xml/catalog;~/catalog.xml
+
+catalogs=
+
+#######################################################################
+# Relative Catalogs:
+# If false, relative catalog URIs are made absolute with respect to the
+# base URI of the CatalogManager.properties file. This setting only 
+# applies to catalog URIs obtained from the catalogs property in the
+# CatalogManager.properties file
+# Example: relative-catalogs = [yes|no]
+
+relative-catalogs=yes
+
+#######################################################################
+# Verbosity:
+# If non-zero, the Catalog classes will print informative and debugging
+# messages. The higher the number, the more messages.
+# Example: verbosity = [0..99]
+
+verbosity=0
+
+#######################################################################
+# Prefer:
+# Which identifier is preferred, "public" or "system"?
+# Example: xml.catalog.prefer = [public|system]
+
+prefer=system
+
+#######################################################################
+# Static-catalog:
+# Should a single catalog be constructed for all parsing, or should a
+# different catalog be created for each parser?
+# Example: static-catalog = [yes|no]
+
+static-catalog=yes
+
+#######################################################################
+# Allow-oasis-xml-catalog-pi
+# If the source document contains "oasis-xml-catalog" processing 
+# instructions, should they be used?
+# Example: allow-oasis-xml-catalog-pi = [yes|no]
+
+allow-oasis-xml-catalog-pi=yes
+
+#######################################################################
+# catalog-class-name
+# If you're using the convenience classes 
+# org.apache.xml.resolver.tools.*, this setting allows you to specify
+# an alternate class name to use for the underlying catalog.
+# Example: catalog-class-name=org.apache.xml.resolver.Resolver