Bayeux 0.1.0

data/.hgrc

@@ -0,0 +1,2 @@
+[extensions]
+rebase = 

data/.rvmrc

@@ -0,0 +1,27 @@
+ruby_string="ruby-1.9.2-p180"
+gemset_name="bayeux"
+
+if rvm list strings | grep -q "${ruby_string}" ; then
+
+  # Load or create the specified environment
+  if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+    && -s "${rvm_path:-$HOME/.rvm}/environments/${ruby_string}@${gemset_name}" ]] ; then
+    \. "${rvm_path:-$HOME/.rvm}/environments/${ruby_string}@${gemset_name}"
+  else
+    rvm --create  "${ruby_string}@${gemset_name}"
+  fi
+
+  # Ensure that Bundler is installed, install it if it is not.
+  if ! command -v bundle ; then
+    gem install bundler
+  fi
+
+  # Bundle while reducing excess noise.
+  bundle | grep -v 'Using' | grep -v 'complete' | sed '/^$/d'
+
+else
+
+  # Notify the user to install the desired interpreter before proceeding.
+  echo "${ruby_string} was not found, please run 'rvm install ${ruby_string}' and then cd back into the project directory."
+
+fi

data/Gemfile

@@ -0,0 +1,42 @@
+###
+### Sources
+###
+
+# Main Ruby Gems site
+source "http://rubygems.org"
+
+###
+### Core Gems. These are required in _all_ environments (additional environments
+###            follow).
+###
+
+# Tree Library (Additional Data Structure)
+gem "rubytree", "~> 0.8.1"
+
+# Code Syntax Highlighting Engine for the HTML Generator 
+gem "spox-plist", "~> 3.0.1"
+gem "spox-textpow", "~> 0.10.3"
+gem "spox-ultraviolet", "~> 0.10.5"
+
+# Log Library
+gem "log4r", "~> 1.1.9"
+
+###
+### Development Gems. All _additional_ gems required by development (as apposed to
+###                   production environments). If it is required at run-time, it
+###                   belongs above.
+group :development do
+
+  # Gem management tools
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+  
+  # Documentation Tools
+  gem "yard", "~> 0.6.0"
+  gem "vclog"
+  
+  # Testing Tools
+  gem "minitest", ">= 0"
+  gem "riot"
+
+end

data/Gemfile.lock

@@ -0,0 +1,42 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ansi (1.2.4)
+    facets (2.9.1)
+    git (1.2.5)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    log4r (1.1.9)
+    minitest (2.1.0)
+    rake (0.8.7)
+    riot (0.12.3)
+      rr
+    rr (1.0.2)
+    rubytree (0.8.1)
+    spox-plist (3.0.1)
+    spox-textpow (0.10.3)
+      spox-plist
+    spox-ultraviolet (0.10.5)
+      spox-textpow
+    vclog (1.8.1)
+      ansi (>= 1.2)
+      facets (>= 2.4)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.0)
+  log4r (~> 1.1.9)
+  minitest
+  riot
+  rubytree (~> 0.8.1)
+  spox-plist (~> 3.0.1)
+  spox-textpow (~> 0.10.3)
+  spox-ultraviolet (~> 0.10.5)
+  vclog
+  yard (~> 0.6.0)

data/HISTORY

@@ -0,0 +1,63 @@
+RELEASE HISTORY
+
+HEAD / 2011-05-05
+
+Current Development (David Love)
+
+Changes:
+
+* 52 General Enhancements
+
+    * Added JSON support to the blocks and syntax tree (needed for exporting the syntax tree to Redis)
+    * Move to the logger library.
+    * Added code to strip offending spaces from the HTML output. This stops spurious blanks being seen in the HTML output.
+    * Added branch pruning to the syntax tree generator. This removes some bugs added by the code to transform the tree (especially around quotes).
+    * Move nanoc filters and helpers into the correct directories.
+    * Added private changes to the spox-ultraviolet branch for Bayeux. These changes cover support for line-numbers that do not start at '1'.
+    * Re-base of Bayeux to include the full nanoc filters and associated code. This marks the start of Bayeux as an independent project.
+    * Change the way single quotes work: now treated as a pseudo-block, so the paragraph tree code can work with fewer exceptions.
+    * Tidy up the code for adding code blocks.
+    * More sophisticated parsing of description lists, which allows richer content in both the list header and list body.
+    * Added basic latex and plain text generators. Latex almost working: text needs to be re-built from the LaTeX version.
+    * Remove debug symbols, and add a very basic text generator instead.
+    * Fix a bug in the tree walker to make sure it doesn't go too far up the tree, and that it actually calls the hooks for the correct node.
+    * Enforce type normalisation, to make it easier for the generators
+    * Fix the tree walking algorithm so that it actually walks more than just the first child. Should now be able to cope with trees having lots of branches.
+    * Hoist certain node patterns, to make generating easier.
+    * Added ellipses support, and tidied a few bugs in the syntax tree output.
+    * Re-write of the syntax tree code, to tidy up the insertion (and deletion) logic using partial functions. This should make it easier to see what is going on (and therefore extend in the future). Hopefully this will also make the remaining bugs easier to find...
+    * Start of the re-write of the syntax node adding code.
+    * Change the end of paragraph regex to ignore 'blank' lines containing only whitespace. Makes it easier to copy and paste from existing markup.
+    * Basic support for code highlighting using the (modified) Ultraviolet engine.
+    * Add ability to use the acronym list from the master references
+    * Change the way type allocation works, to expose the tags attached to blocks.
+    * Add a tag for all blocks, and refine the type allocation a bit.
+    * Cleanup the HTML output a bit, and make it easier to do typographical changes if required.
+    * Pretty print the ToC lists.
+    * Added basic processing for lists. Added ToC generator for the HTML output.
+    * Remove the last remnants of the old parser.
+    * Better typography for the HTML generator.
+    * Change the null string detection code to make it more robust. Changed links so that they are now split by the parser, not the generator.
+    * Added recognises for em-dash and en-dash, and support for them in the HTML generator.
+    * Removed last_codepoint variable in favour of string_index, now that we need forward and reverse lookup.
+    * Added support for single and double quote blocks.
+    * Broken update for the quote blocks.
+    * Added HTML Tidy library for the HTML generator: this produces much nicer output more easily, and saves a lot of mucking about in the code for the sake of an external library and extra pass.
+    * Abstracted the tree walking logic into a separate class, using hooks to link back to the generator. The generator now work, and is much simpler. This should also allow additional generators to be written without much work.
+    * Largely working HTML generator, using the new AST. Also patched the nanoc filters to use the new generator.
+    * Split nodes for description lists.
+    * Cleaned up empty node processing, which clean up the AST generated. This should fix a few spurious features of the final output.
+    * First version integrated with Nanoc. Most bugs fixed, and basic parsing works.
+    * Re-wrote the high level block parser, and the Tree logic. Now require separate generators for the AST, but the AST is classically formed. New parser written for the top-level blocks (which are now distinct from in-line blocks).
+    * Added code to recognise quotation paragraphs.
+    * Fixed a bug in the link generator. Links should now be generated correctly.
+    * Be less aggressive about suppressing spaces that might be needed (PanDoc strip out empty strings for us anyway).
+    * Re-wrote the output to PanDoc as a string parser, rarther than an ad hoc collection of string replacements.
+    * Working version of the basic structural parser.
+    * Commit before re-work, changing to a tree instead of recursive blocks to avoid stack depth problems.
+    * Pause before another re-think.
+    * Pause before re-think.
+    * Pause before a re-think of the core algorithm.
+    * Added test file, showing most of the simple markup.
+    * First draft: basic outline of working emph and basic parsing infrastructure.
+

data/README.rdoc

@@ -0,0 +1,19 @@
+= Bayeux
+
+Description goes here.
+
+== Contributing to Bayeux
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 David Love. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,89 @@
+# Copyright (c) 2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+# encoding: utf-8
+
+###
+### Set-up. Actions to run before all tasks
+###
+
+## Use Bundler to make sure the gem environment is up-to-daterequire 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+###
+### Gemspec. Mangage the creation of the relevant gem and gemspec files. Most of this
+###          is delegated to Jeweler
+###
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "Bayeux"
+  gem.homepage = "http://github.com/dlove24/Bayeux"
+  gem.license = "MIT"
+  gem.summary = "Parsers and generators for the Bayeux long document markup"
+  gem.description = "The core parser for the Bayeux document markup language, optimised for long-form documents. Generators are also provided for HTML, LaTeX and PanDoc"
+  gem.email = "david@homeunix.org.uk"
+  gem.authors = ["David Love"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+###
+### Testing. Run the unit/system/integration tests
+###
+
+require 'rake/testtask'
+
+desc "Run all our tests"
+task :test do
+  Rake::TestTask.new do |t|
+    t.libs << "test"
+    t.pattern = "test/**/*_test.rb"
+    t.verbose = false
+  end
+end
+
+## Set testing as the default action
+task :default => :test
+
+###
+### Documentation. Generate/update the project documentation
+###
+
+## Use Yard to generate the documentations
+require 'yard'
+YARD::Rake::YardocTask.new
+
+###
+### Release. Additional actions to take when releasing the gem
+###
+
+## Additional actions for the release task
+task :before_release do
+  # Update the HISTORY file
+  `vclog history -f gnu  > HISTORY`
+end
+
+## Extend the default (Jeweler) 'release' task
+Rake::Task[:test].enhance(['before_release'])
+  

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bib/Modules.bib

@@ -0,0 +1,21 @@
+%% This BibTeX bibliography file was created using BibDesk.
+%% http://bibdesk.sourceforge.net/
+
+
+%% Created for David Love at 2011-04-27 12:22:27 +0100 
+
+
+%% Saved with string encoding Unicode (UTF-8) 
+
+
+
+@book{FitzGerald:Business,
+	Author = {Jerry FitzGerald and Alan Dennis},
+	Date-Added = {2011-04-26 10:49:01 +0100},
+	Date-Modified = {2011-04-26 10:50:21 +0100},
+	Edition = {9th Edition},
+	Isbn = {0-471-77116-3},
+	Publisher = {John Wiley {\&} Sons Inc},
+	Title = {Business Data Communications and Networking},
+	Year = {2007},
+	Bdsk-Url-1 = {http://www.amazon.com/Business-Communications-Networking-Jerry-FitzGerald/dp/0471771163?SubscriptionId=0JYN1NVW651KCA56C102&tag=techkie-20&linkCode=xm2&camp=2025&creative=165953&creativeASIN=0471771163}}

data/code/render/latex/active4d.render

@@ -0,0 +1,132 @@
+--- 
+name: Active4D
+line: 
+  begin: ""
+  end: "}}\\\\"
+tags: 
+- begin: \setlength{\fboxsep}{0ex}\colorbox[HTML]{ECF1FF}{\rule[-0.5ex]{0pt}{2.0ex}
+  end: "}"
+  selector: text.html source.active4d
+- begin: "{\\color[HTML]{000000}"
+  end: "}"
+  selector: text.xml
+- begin: "{\\color[HTML]{D33535}"
+  end: "}"
+  selector: comment.line
+- begin: "{\\color[HTML]{D33435}"
+  end: "}"
+  selector: comment.block
+- begin: "{\\color[HTML]{666666}"
+  end: "}"
+  selector: string
+- begin: "{\\color[HTML]{66CCFF}\\textbf{"
+  end: "}}"
+  selector: string.interpolated variable
+- begin: "{\\color[HTML]{A8017E}"
+  end: "}"
+  selector: constant.numeric
+- begin: "{"
+  end: "}"
+  selector: constant.character, constant.other
+- begin: "{\\color[HTML]{66CCFF}\\textbf{"
+  end: "}}"
+  selector: constant.other.date, constant.other.time
+- begin: "{\\color[HTML]{A535AE}"
+  end: "}"
+  selector: constant.language
+- begin: "{\\color[HTML]{6392FF}\\textbf{"
+  end: "}}"
+  selector: variable.other.local
+- begin: "{\\color[HTML]{0053FF}\\textbf{"
+  end: "}}"
+  selector: variable
+- begin: "{\\color[HTML]{0BB600}"
+  end: "}"
+  selector: variable.other.table-field
+- begin: "{\\color[HTML]{006699}\\textbf{"
+  end: "}}"
+  selector: keyword
+- begin: "{"
+  end: "}"
+  selector: keyword.operator
+- begin: "{\\color[HTML]{FF5600}"
+  end: "}"
+  selector: storage
+- begin: "{\\color[HTML]{21439C}"
+  end: "}"
+  selector: entity.name.type
+- begin: "{"
+  end: "}"
+  selector: entity.other.inherited-class
+- begin: "{\\color[HTML]{21439C}"
+  end: "}"
+  selector: entity.name.function
+- begin: "{"
+  end: "}"
+  selector: variable.parameter
+- begin: "{\\color[HTML]{7A7A7A}"
+  end: "}"
+  selector: meta.tag
+- begin: "{\\color[HTML]{016CFF}"
+  end: "}"
+  selector: entity.name.tag
+- begin: "{\\color[HTML]{963DFF}"
+  end: "}"
+  selector: entity.other.attribute-name
+- begin: "{\\color[HTML]{45AE34}\\textbf{"
+  end: "}}"
+  selector: support.function
+- begin: "{\\color[HTML]{B7734C}"
+  end: "}"
+  selector: support.constant
+- begin: "{\\color[HTML]{A535AE}"
+  end: "}"
+  selector: support.type, support.class
+- begin: "{\\color[HTML]{A535AE}"
+  end: "}"
+  selector: support.variable
+- begin: \setlength{\fboxsep}{0ex}\colorbox[HTML]{990000}{\rule[-0.5ex]{0pt}{2.0ex}\color[HTML]{FFFFFF}
+  end: "}"
+  selector: invalid
+- begin: \setlength{\fboxsep}{0ex}\colorbox[HTML]{656565}{\rule[-0.5ex]{0pt}{2.0ex}\color[HTML]{FFFFFF}
+  end: "}"
+  selector: meta.diff
+- begin: \setlength{\fboxsep}{0ex}\colorbox[HTML]{1B63FF}{\rule[-0.5ex]{0pt}{2.0ex}\color[HTML]{FFFFFF}
+  end: "}"
+  selector: meta.diff.range
+- begin: \setlength{\fboxsep}{0ex}\colorbox[HTML]{FF7880}{\rule[-0.5ex]{0pt}{2.0ex}\color[HTML]{000000}
+  end: "}"
+  selector: markup.deleted.diff
+- begin: \setlength{\fboxsep}{0ex}\colorbox[HTML]{98FF9A}{\rule[-0.5ex]{0pt}{2.0ex}\color[HTML]{000000}
+  end: "}"
+  selector: markup.inserted.diff
+- begin: "{\\color[HTML]{5E5E5E}"
+  end: "}"
+  selector: source.diff
+listing: 
+  begin: |
+    \newcolumntype{C}{>{\color[HTML]{000000}\columncolor[HTML]{FFFFFF}}l}
+    \newcolumntype{N}{>{\color[HTML]{000000}\columncolor[HTML]{BAD6FD}}l}
+    \begin{longtable}{NC}
+
+  end: |
+    \end{longtable}
+
+document: 
+  begin: |
+    \documentclass[a4paper,landscape]{article}
+    \usepackage{xcolor}
+    \usepackage{colortbl}
+    \usepackage{longtable}
+    \usepackage[left=2cm,top=1cm,right=3cm,nohead,nofoot]{geometry}
+    \usepackage[T1]{fontenc}
+    \usepackage[scaled]{beramono}
+    \begin{document}
+
+  end: |
+    \end{document}
+
+filter: "@escaped.gsub(/(\\$)/, '\\\\\\\\\\1').gsub(/\\\\(?!\\$)/, '$\\\\\\\\backslash$').gsub(/(_|\\{|\\}|&|\\#|%)/, '\\\\\\\\\\1').gsub(/~/, '\\\\textasciitilde ').gsub(/ /,'\\\\hspace{1ex}').gsub(/\\t| /,'\\\\hspace{3ex}').gsub(/\\\"/, \"''\").gsub(/(\\^)/,'\\\\\\\\\\1{}')"
+line-numbers: 
+  begin: \texttt{
+  end: "}&\\mbox{\\texttt{"