tobias-codex 1.0.3

data/History.txt

@@ -0,0 +1,18 @@
+== 1.0.3 2008-05-22
+
+* Support for user defined filters
+	* The functionality is in added file lib/codex/filters/filter.rb 
+* Included WebTeX filter
+	* Added ritex >= 0.1 as dependency
+* Syntax highlighter is a filter now
+	* Syntax highlighter stuff from content.rb is now in lib/codex/filters/code_filter.rb
+* Added some slides elaborating on this to the templates
+
+== 1.0.2 2008-05-20
+
+* Add rubigen 1.3.2 to dependency list as its used for codex generator
+
+== 1.0.0 2008-05-19
+
+* 1 major enhancement:
+  * Initial release

data/LICENSE.txt

@@ -0,0 +1,29 @@
+This source tree contains a mixture of original material and other people's work. In particular,
+it contains Syntax Highlighting code from http://code.google.com/p/syntaxhighlighter/ and
+the S5 package from http://meyerweb.com/eric/tools/s5/. Both of these packages carry their own licenses,
+and the conditions in this file do not apply to these packages.
+
+The following terms apply to the original code in this source tree:
+
+Copyright (c) 2008 Dave Thomas
+
+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/Manifest.txt

@@ -0,0 +1,105 @@
+History.txt
+LICENSE.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+app_generators/codex/USAGE
+app_generators/codex/codex_generator.rb
+app_generators/codex/templates/Rakefile
+app_generators/codex/templates/bin/build_all.rb
+app_generators/codex/templates/bin/postprocess_all.rb
+app_generators/codex/templates/bin/pressie.rb
+app_generators/codex/templates/code/control/basic_continuation.rb
+app_generators/codex/templates/code/control/cc_throw_catch.rb
+app_generators/codex/templates/code/control/closure_continuation.rb
+app_generators/codex/templates/code/control/closure_continuation_2.rb
+app_generators/codex/templates/code/graphviz/graph.dot
+app_generators/codex/templates/dp.SyntaxHighlighter/CSS.html
+app_generators/codex/templates/dp.SyntaxHighlighter/CSharp.html
+app_generators/codex/templates/dp.SyntaxHighlighter/CollapseCode.html
+app_generators/codex/templates/dp.SyntaxHighlighter/Cpp.html
+app_generators/codex/templates/dp.SyntaxHighlighter/CrashTest.html
+app_generators/codex/templates/dp.SyntaxHighlighter/Delphi.html
+app_generators/codex/templates/dp.SyntaxHighlighter/FirstLine.html
+app_generators/codex/templates/dp.SyntaxHighlighter/Index.html
+app_generators/codex/templates/dp.SyntaxHighlighter/Java.html
+app_generators/codex/templates/dp.SyntaxHighlighter/JavaScript.html
+app_generators/codex/templates/dp.SyntaxHighlighter/NoControls.html
+app_generators/codex/templates/dp.SyntaxHighlighter/NoGutter.html
+app_generators/codex/templates/dp.SyntaxHighlighter/PHP.html
+app_generators/codex/templates/dp.SyntaxHighlighter/Python.html
+app_generators/codex/templates/dp.SyntaxHighlighter/Ruby.html
+app_generators/codex/templates/dp.SyntaxHighlighter/SQL.html
+app_generators/codex/templates/dp.SyntaxHighlighter/Scripts/clipboard.swf
+app_generators/codex/templates/dp.SyntaxHighlighter/Scripts/shBrushCSharp.js
+app_generators/codex/templates/dp.SyntaxHighlighter/Scripts/shBrushCpp.js
+app_generators/codex/templates/dp.SyntaxHighlighter/Scripts/shBrushCss.js
+app_generators/codex/templates/dp.SyntaxHighlighter/Scripts/shBrushDelphi.js
+app_generators/codex/templates/dp.SyntaxHighlighter/Scripts/shBrushJScript.js
+app_generators/codex/templates/dp.SyntaxHighlighter/Scripts/shBrushJava.js
+app_generators/codex/templates/dp.SyntaxHighlighter/Scripts/shBrushPhp.js
+app_generators/codex/templates/dp.SyntaxHighlighter/Scripts/shBrushPython.js
+app_generators/codex/templates/dp.SyntaxHighlighter/Scripts/shBrushRuby.js
+app_generators/codex/templates/dp.SyntaxHighlighter/Scripts/shBrushSql.js
+app_generators/codex/templates/dp.SyntaxHighlighter/Scripts/shBrushVb.js
+app_generators/codex/templates/dp.SyntaxHighlighter/Scripts/shBrushXml.js
+app_generators/codex/templates/dp.SyntaxHighlighter/Scripts/shCore.js
+app_generators/codex/templates/dp.SyntaxHighlighter/Scripts/shCore.uncompressed.js
+app_generators/codex/templates/dp.SyntaxHighlighter/ShowColumns.html
+app_generators/codex/templates/dp.SyntaxHighlighter/SmartTabs.html
+app_generators/codex/templates/dp.SyntaxHighlighter/Styles/SyntaxHighlighter.css
+app_generators/codex/templates/dp.SyntaxHighlighter/Styles/TestPages.css
+app_generators/codex/templates/dp.SyntaxHighlighter/Templates/Test.dwt
+app_generators/codex/templates/dp.SyntaxHighlighter/VB.html
+app_generators/codex/templates/dp.SyntaxHighlighter/XML.html
+app_generators/codex/templates/filters/example_filter.rb
+app_generators/codex/templates/html/all.html
+app_generators/codex/templates/readme.txt
+app_generators/codex/templates/slides/basics.slides
+app_generators/codex/templates/slides/building.slides
+app_generators/codex/templates/slides/example.slides
+app_generators/codex/templates/slides/graphviz.slides
+app_generators/codex/templates/slides/including_code.slides
+app_generators/codex/templates/slides/including_tex.slides
+app_generators/codex/templates/slides/metadata.yml
+app_generators/codex/templates/slides/table_of_contents.slides
+app_generators/codex/templates/slides/user_defined.slides
+app_generators/codex/templates/ui/default/blank.gif
+app_generators/codex/templates/ui/default/bodybg.gif
+app_generators/codex/templates/ui/default/framing.css
+app_generators/codex/templates/ui/default/iepngfix.htc
+app_generators/codex/templates/ui/default/opera.css
+app_generators/codex/templates/ui/default/outline.css
+app_generators/codex/templates/ui/default/pretty.css
+app_generators/codex/templates/ui/default/print.css
+app_generators/codex/templates/ui/default/s5-core.css
+app_generators/codex/templates/ui/default/slides.css
+app_generators/codex/templates/ui/default/slides.js
+bin/codex
+codex.gemspec
+config/hoe.rb
+config/requirements.rb
+lib/codex.rb
+lib/codex/content.rb
+lib/codex/filter.rb
+lib/codex/filters/code_filter.rb
+lib/codex/filters/graphviz_filter.rb
+lib/codex/filters/ritex_filter.rb
+lib/codex/pressie.rb
+lib/codex/version.rb
+lib/stylesheets/pressie.css
+lib/stylesheets/print.css
+lib/stylesheets/ruby.png
+script/console
+script/destroy
+script/generate
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_codex.rb
+test/test_codex_generator.rb
+test/test_filter.rb
+test/test_generator_helper.rb
+test/test_helper.rb

data/PostInstall.txt

@@ -0,0 +1,5 @@
+
+To create new presentations:
+	
+		codex path/to/presentation/folder
+		

data/README.txt

@@ -0,0 +1,34 @@
+= Codex
+
+http://github.com/pragdave/codex
+
+Note: this version (http://github.com/tobias/codex) differs from
+pragdave's version by allowing repetition of the previous slide.
+
+== Description
+
+This is a remarkably trivial package that makes simply HTML-based presentations from
+a set up source files written using Textile. It's designed to help when creating
+slides that contain lots of code, as it allows code to be embedded from external source files. 
+This means that the code that you embed can come from running (and tested) programs.
+
+The code in the resulting slides is syntax highlighted, and is hyperlinked to the original
+source file, allowing that file to be brought up in Textmate.
+
+== Requirements
+
+* make sure you have Ruby 1.8.6 installed and RubyGems
+
+== Installation
+
+		gem install codex
+
+== Usage
+
+* type 'rake all' in the same directory as this README file
+* open html/all.html
+
+== License
+
+See the file LICENSE.txt for details on how this all may be used.
+

data/Rakefile

@@ -0,0 +1,6 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/app_generators/codex/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/app_generators/codex/codex_generator.rb

@@ -0,0 +1,109 @@
+class CodexGenerator < RubiGen::Base
+
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+
+  default_options :author => nil
+
+  attr_reader :name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = File.expand_path(args.shift)
+    @name = base_name
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory ''
+      BASEDIRS.each { |path| m.directory path }
+
+      # Create stubs
+      m.template_copy_each %w[Rakefile]
+      m.template_copy_each "html/all.html"
+      %w[basics building example including_code including_tex table_of_contents user_defined graphviz].each do |slide|
+        m.file_copy_each "slides/#{slide}.slides"
+      end
+      m.file_copy_each "slides/metadata.yml"
+      %w[build_all postprocess_all pressie].each do |bin|
+        m.file_copy_each "bin/#{bin}.rb"
+      end
+      %w[basic_continuation cc_throw_catch closure_continuation closure_continuation_2].each do |code|
+        m.file_copy_each "code/control/#{code}.rb"
+      end
+      m.file_copy_each "code/graphviz/graph.dot"
+      ["CollapseCode.html", "Cpp.html", "CrashTest.html", "CSharp.html", "CSS.html",
+        "Delphi.html", "FirstLine.html", "Index.html", "Java.html", "JavaScript.html",
+        "NoControls.html", "NoGutter.html", "PHP.html", "Python.html", "Ruby.html",
+        "ShowColumns.html", "SmartTabs.html", "SQL.html",
+        "VB.html", "XML.html",
+        "Scripts/clipboard.swf", "Scripts/shBrushCpp.js", "Scripts/shBrushCSharp.js",
+        "Scripts/shBrushCss.js", "Scripts/shBrushDelphi.js", "Scripts/shBrushJava.js",
+        "Scripts/shBrushJScript.js", "Scripts/shBrushPhp.js", "Scripts/shBrushPython.js",
+        "Scripts/shBrushRuby.js", "Scripts/shBrushSql.js", "Scripts/shBrushVb.js",
+        "Scripts/shBrushXml.js", "Scripts/shCore.js", "Scripts/shCore.uncompressed.js",
+        "Styles/SyntaxHighlighter.css", "Styles/TestPages.css",
+        "Templates/Test.dwt"
+        ].each do |syntax|
+          m.file_copy_each "dp.SyntaxHighlighter/#{syntax}"
+        end
+      ["blank.gif", "bodybg.gif", "framing.css", "iepngfix.htc", "opera.css", "outline.css",
+        "pretty.css", "print.css", "s5-core.css", "slides.css", "slides.js"].each do |asset|
+          m.file_copy_each "ui/default/#{asset}"
+        end
+      m.template_copy_each "filters/example_filter.rb"
+
+      m.dependency "install_rubigen_scripts", [destination_root, 'codex'],
+        :shebang => options[:shebang], :collision => :force
+
+      m.readme 'readme.txt'
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a Codex presentations.
+Codex is imple tool for creating source-code intensive presentations and courses
+
+USAGE: #{spec.name} name
+EOS
+    end
+
+    def add_options!(opts)
+      opts.separator ''
+      opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+
+    # Installation skeleton.  Intermediate directories are automatically
+    # created so don't sweat their absence here.
+    BASEDIRS = %w(
+      bin
+      code/control
+      code/graphviz
+      html/images
+      dp.SyntaxHighlighter/Scripts
+      dp.SyntaxHighlighter/Styles
+      dp.SyntaxHighlighter/Templates
+      script
+      slides
+      filters
+      ui/default
+    )
+end

data/app_generators/codex/templates/Rakefile

@@ -0,0 +1,59 @@
+SLIDES_DIR = 'slides/'
+HTML_DIR   = 'html/'
+IMG_DIR    = 'html/images/'
+ALL_HTML   = File.join(HTML_DIR, "all.html")
+
+METADATA = File.join(SLIDES_DIR, "metadata.yml")
+
+Dir.chdir(SLIDES_DIR) { SRC = FileList['*.slides']; SRC.resolve }
+
+OUTPUT = []
+
+SRC.each do |file_name|
+  slide_file = File.join(SLIDES_DIR, file_name)
+  html_file = File.join(HTML_DIR, file_name.ext('.html'))
+  OUTPUT << html_file
+  desc "Build #{html_file} from #{slide_file}"
+  file html_file => [HTML_DIR, slide_file] do
+    sh "ruby bin/pressie.rb #{METADATA} #{slide_file} > #{html_file}"
+  end
+end
+
+desc "Build the HTML slides from all the files slides/*.slides files"
+task :default => OUTPUT
+
+desc "Build all slides based on the contents of slides/table_of_contents.slides"
+task :all => [ 'tmp/', HTML_DIR, IMG_DIR, ALL_HTML, :remove_tmp ]
+
+task ALL_HTML => 'tmp/almost_all.html' do
+  sh "ruby bin/postprocess_all.rb tmp/almost_all.html >#{ALL_HTML}"
+end
+
+task 'tmp/almost_all.html' => 'tmp/almost_all.slides' do
+  sh "ruby bin/pressie.rb #{METADATA} tmp/almost_all.slides >tmp/almost_all.html"
+end
+
+task 'tmp/almost_all.slides' => OUTPUT do
+  sh "ruby bin/build_all.rb #{METADATA} slides/table_of_contents.slides tmp/almost_all.slides"
+end
+
+file "tmp/" do
+  mkdir "tmp"
+end
+
+file "html/" do
+  mkdir "html"
+end
+
+file "html/" do
+  mkdir "html/images"
+end
+
+task :remove_tmp do
+  FileUtils.rm_rf("tmp")
+end
+
+desc "Remove all work products—slides and temporary files"
+task :clean => :remove_tmp do
+  FileUtils.rm_rf HTML_DIR
+end

data/app_generators/codex/templates/bin/build_all.rb

@@ -0,0 +1,47 @@
+# We're passed a file containing hyperlinks to the HTML
+# (ie, table_con_contents.slides)
+# and contruct all.slides from it
+require 'yaml'
+
+def usage(msg = nil)
+  STDERR.puts "#{__FILE__}  metadata contents output"
+  if msg
+    STDERR.puts
+    STDERR.puts msg
+  end
+  exit 1
+end
+
+BASE = File.join(File.dirname(__FILE__), "..")
+
+metadata_name = ARGV.shift || usage("Missing metadata")
+contents_name = ARGV.shift || usage("Missing table of contents file name")
+op_name       = ARGV.shift || usage("Missing output file name")
+
+metadata = YAML.load_file(metadata_name)
+
+contents = File.readlines(contents_name).
+                grep(/^\*.*:(.*)\.html/) { File.join(BASE, "slides", "#{$1}.slides") }.
+                map {|name| File.read(name) }
+
+File.open(op_name, "w") do |op|
+
+  op.puts "h1. #{metadata['title']}\n\n"
+  op.puts "bq. #{metadata['author']}\n\n"
+
+  op.puts "h1. Contents\n\n"
+
+  op.puts %{<div style="font-size: 70%">\n\n}
+
+  contents.each do |content|
+    content =~ /h1.\s+(.*)/
+    STDERR.puts $1
+    op.puts "* #{$1}\n\n"
+  end
+
+  op.puts "</div>\n\n"
+
+  contents.each do |content|
+    op.puts content.sub(/h1/, 'h1(slide0)').sub(/__END__.*/m, '')
+  end
+end

data/app_generators/codex/templates/bin/postprocess_all.rb

@@ -0,0 +1,5 @@
+content = File.read(ARGV[0])
+
+content = content.gsub(/<div class="slide">\s+<h1 class="slide0"/m, %{<div class="title slide">\n<h1})
+
+puts content

data/app_generators/codex/templates/bin/pressie.rb

@@ -0,0 +1,10 @@
+base = File.join(File.dirname(__FILE__), "..")
+$: << File.join(base, "lib")
+
+require 'rubygems'
+require "codex"
+
+# Load user defined filters
+Dir.glob(Dir.pwd + "/filters/*.rb").each { |f| require f }
+
+Codex::Pressie::process