codex 1.0.2 → 1.1.0

data/History.txt

@@ -1,3 +1,34 @@
+== 1.1 2009-10-10
+
+* A new directory organization for the project files (brandon)
+	* The slides source now go in content/
+	* assets/ will now hold all support files used by the slide's html (javascript, css, etc)
+	* templates/ will hold the html template for the slides (see below)
+* Support for multiple template languages (brandon)
+	* The slide content files now end with a template language extension (such as .textile or .markdown)
+	* New template handlers can be define in lib/codex/template_handler.rb
+* metadata.yml now goes in config/ so it won't be parsed as a slide, due to the new template handler functionality (bernardo)
+* Support for a master ERB layout for the .html files (brandon)
+	* The layout goes in templates/layout.erb
+* You can now use "edge" codex by git cloning the codex source into vendor/codex, inside a codex project dir (brandon)
+* Support for user defined post processors (bernardo)
+	* System wide post processors go in lib/codex/post_processors
+	* bin/postprocess_all.rb moved to a post processor
+	* The division of the slides by h1. now implemented in a post processor (brandon)
+	* Functionality defined in lib/codex/post_processor.rb
+* Now using the Monaco fixed width font to display code (bernardo)
+* Fixed a few other tiny show stopper bugs and makes everything ready for a new tested gem release (bernardo) 
+
+== 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

data/Manifest.txt

@@ -2,86 +2,102 @@ History.txt
 LICENSE.txt
 Manifest.txt
 PostInstall.txt
+README.rdoc
 README.txt
 Rakefile
 app_generators/codex/USAGE
 app_generators/codex/codex_generator.rb
 app_generators/codex/templates/Rakefile
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/CSS.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/CSharp.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/CollapseCode.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Cpp.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/CrashTest.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Delphi.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/FirstLine.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Index.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Java.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/JavaScript.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/NoControls.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/NoGutter.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/PHP.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Python.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Ruby.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/SQL.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Scripts/clipboard.swf
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Scripts/shBrushCSharp.js
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Scripts/shBrushCpp.js
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Scripts/shBrushCss.js
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Scripts/shBrushDelphi.js
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Scripts/shBrushJScript.js
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Scripts/shBrushJava.js
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Scripts/shBrushPhp.js
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Scripts/shBrushPython.js
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Scripts/shBrushRuby.js
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Scripts/shBrushSql.js
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Scripts/shBrushVb.js
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Scripts/shBrushXml.js
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Scripts/shCore.js
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Scripts/shCore.uncompressed.js
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/ShowColumns.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/SmartTabs.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Styles/SyntaxHighlighter.css
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Styles/TestPages.css
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/Templates/Test.dwt
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/VB.html
+app_generators/codex/templates/assets/dp.SyntaxHighlighter/XML.html
+app_generators/codex/templates/assets/stylesheets/pressie.css
+app_generators/codex/templates/assets/stylesheets/print.css
+app_generators/codex/templates/assets/stylesheets/ruby.png
+app_generators/codex/templates/assets/ui/default/blank.gif
+app_generators/codex/templates/assets/ui/default/bodybg.gif
+app_generators/codex/templates/assets/ui/default/framing.css
+app_generators/codex/templates/assets/ui/default/iepngfix.htc
+app_generators/codex/templates/assets/ui/default/opera.css
+app_generators/codex/templates/assets/ui/default/outline.css
+app_generators/codex/templates/assets/ui/default/pretty.css
+app_generators/codex/templates/assets/ui/default/print.css
+app_generators/codex/templates/assets/ui/default/s5-core.css
+app_generators/codex/templates/assets/ui/default/slides.css
+app_generators/codex/templates/assets/ui/default/slides.js
 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/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/code/graphviz/graph.dot
+app_generators/codex/templates/config/metadata.yml
+app_generators/codex/templates/content/basics.textile
+app_generators/codex/templates/content/building.textile
+app_generators/codex/templates/content/example.textile
+app_generators/codex/templates/content/graphviz.textile
+app_generators/codex/templates/content/including_code.textile
+app_generators/codex/templates/content/including_tex.textile
+app_generators/codex/templates/content/table_of_contents.textile
+app_generators/codex/templates/content/user_defined.textile
+app_generators/codex/templates/filters/example_filter.rb
 app_generators/codex/templates/html/all.html
+app_generators/codex/templates/post_processors/change_code_urls.rb
+app_generators/codex/templates/post_processors/upcase_titles.rb
 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/including_code.slides
-app_generators/codex/templates/slides/metadata.yml
-app_generators/codex/templates/slides/table_of_contents.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
+app_generators/codex/templates/templates/layout.erb
 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/post_processor.rb
+lib/codex/post_processors/01_slides_processor.rb
+lib/codex/post_processors/02_add_title_slides.rb
 lib/codex/pressie.rb
+lib/codex/rake/codextask.rb
+lib/codex/template_handler.rb
 lib/codex/version.rb
-lib/stylesheets/pressie.css
-lib/stylesheets/print.css
-lib/stylesheets/ruby.png
 script/console
 script/destroy
 script/generate
@@ -89,7 +105,12 @@ setup.rb
 tasks/deployment.rake
 tasks/environment.rake
 tasks/website.rake
-test/test_codex.rb
+test/codex/post_processor/test_add_title_slides_processor.rb
+test/codex/post_processor/test_post_processors.rb
+test/codex/post_processor/test_slides_processor.rb
+test/codex/rake/test_codextask.rb
+test/codex/test_pressie.rb
+test/codex/test_template_handler.rb
 test/test_codex_generator.rb
-test/test_generator_helper.rb
+test/test_filter.rb
 test/test_helper.rb

data/Rakefile

@@ -1,3 +1,5 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
 require 'config/requirements'
 require 'config/hoe' # setup Hoe + all gem configuration
 

data/app_generators/codex/codex_generator.rb

@@ -24,16 +24,17 @@ class CodexGenerator < RubiGen::Base
       # Create stubs
       m.template_copy_each %w[Rakefile]
       m.template_copy_each "html/all.html"
-      %w[basics building example including_code table_of_contents].each do |slide|
-        m.file_copy_each "slides/#{slide}.slides"
+      %w[basics building example including_code including_tex table_of_contents user_defined graphviz].each do |template|
+        m.file_copy_each "content/#{template}.textile"
       end
-      m.file_copy_each "slides/metadata.yml"
-      %w[build_all postprocess_all pressie].each do |bin|
+      m.template_copy_each "config/metadata.yml"
+      %w[build_all].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",
@@ -46,14 +47,22 @@ class CodexGenerator < RubiGen::Base
         "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
+      ].each do |syntax|
+        m.file_copy_each "assets/dp.SyntaxHighlighter/#{syntax}"
+      end
+      ["pressie.css", "print.css", "ruby.png"].each do |asset|
+        m.file_copy_each "assets/stylesheets/#{asset}"
+      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
-
+        "pretty.css", "print.css", "s5-core.css", "slides.css", "slides.js"
+      ].each do |asset|
+        m.file_copy_each "assets/ui/default/#{asset}"
+      end
+      m.template_copy_each "filters/example_filter.rb"
+      ["change_code_urls.rb", "upcase_titles.rb"].each do |asset|
+        m.file_copy_each "post_processors/#{asset}"
+      end
+      m.file_copy_each "templates/layout.erb"
 
       m.dependency "install_rubigen_scripts", [destination_root, 'codex'],
         :shebang => options[:shebang], :collision => :force
@@ -65,8 +74,8 @@ class CodexGenerator < RubiGen::Base
   protected
     def banner
       <<-EOS
-Creates a Codex presentations.
-Codex is imple tool for creating source-code intensive presentations and courses
+Creates a Codex presentation.
+Codex is simple tool for creating source-code intensive presentations and courses
 
 USAGE: #{spec.name} name
 EOS
@@ -93,14 +102,20 @@ EOS
     # Installation skeleton.  Intermediate directories are automatically
     # created so don't sweat their absence here.
     BASEDIRS = %w(
+      assets/dp.SyntaxHighlighter/Scripts
+      assets/dp.SyntaxHighlighter/Styles
+      assets/dp.SyntaxHighlighter/Templates
+      assets/stylesheets
+      assets/ui/default
       bin
       code/control
-      html
-      dp.SyntaxHighlighter/Scripts
-      dp.SyntaxHighlighter/Styles
-      dp.SyntaxHighlighter/Templates
+      code/graphviz
+      config
+      content
+      filters
+      html/images
       script
-      slides
-      ui/default
+      post_processors
+      templates
     )
-end
+end

data/app_generators/codex/templates/Rakefile

@@ -1,54 +1,15 @@
-SLIDES_DIR = 'slides/'
-HTML_DIR   = 'html/'
-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, 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
-
-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
+APP_ROOT = File.dirname(__FILE__) unless defined?(APP_ROOT)
+require 'rubygems'
+if File.exist?("#{APP_ROOT}/vendor/codex")
+  $:.unshift "#{APP_ROOT}/vendor/codex/lib"
+else
+  gem 'codex'
+end
+require 'codex/rake/codextask'
+Codex.root = APP_ROOT
+
+Codex::Rake::CodexTask.new do |c|
+  # c.content_dir = 'content'
+  # c.output_dir  = 'html'
+  # c.metadata    = "config/metadata.yml"
 end