codex 1.0.2 → 1.1.0

data/{lib → app_generators/codex/templates/assets}/stylesheets/pressie.css

@@ -11,7 +11,7 @@ div.slide code {
     
 div.dp-highlighter
 {
-	font-family: "Gill Sans", "Consolas", "Courier New", Courier, mono;
+	font-family: "Monaco", "Consolas", "Courier New", Courier, mono;
 	font-size: 100%;
 	background-color: white;
 	overflow: auto;
@@ -147,14 +147,17 @@ div#slide0 h1, div.title h1 {
 }
 
 /* code layout */
-div.code-large {
+div.code-superlarge {
 	font-size: 150% !important;
 	line-height: 1.6em !important;
 }
-
+div.code-large {
+	font-size: 90% !important;
+	line-height: 2em !important;
+}
 
 div.code-normal {
-	font-size: 90% !important;
+	font-size: 75% !important;
 	line-height: 2em !important;
 }
 
@@ -163,7 +166,7 @@ div.code-normal li {
 }
 
 div.code-small {
-	font-size: 75% !important;
+	font-size: 50% !important;
 	line-height: 2em !important;
 }
 
@@ -172,7 +175,7 @@ div.code-small li {
 }
 
 div.code-tiny {
-	font-size: 50% !important;
+	font-size: 40% !important;
 	line-height: 2em !important;
 }
 
@@ -191,6 +194,6 @@ div.code-supertiny li {
 
 .caption {
     color: #448;
-    font-family: Gil Sans;
+    font-family: Gill Sans;
     font-size:   70%;
 }

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

@@ -1,6 +1,6 @@
 # We're passed a file containing hyperlinks to the HTML
-# (ie, table_con_contents.slides)
-# and contruct all.slides from it
+# (ie, table_con_contents.textile)
+# and contruct all.textile from it
 require 'yaml'
 
 def usage(msg = nil)
@@ -21,7 +21,7 @@ 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") }.
+                grep(/^\*.*:(.*)\.html/) { File.join(BASE, "content", "#{$1}.textile") }.
                 map {|name| File.read(name) }
 
 File.open(op_name, "w") do |op|
@@ -43,5 +43,6 @@ File.open(op_name, "w") do |op|
 
   contents.each do |content|
     op.puts content.sub(/h1/, 'h1(slide0)').sub(/__END__.*/m, '')
+    op.puts "\n\n"
   end
 end

data/app_generators/codex/templates/code/graphviz/graph.dot

@@ -0,0 +1,13 @@
+digraph test123 {
+	a -> b -> c;
+	a -> {x y};
+	b [shape=box];
+	c [label="hello\nworld",color=blue,fontsize=24,
+	fontname="Palatino-Italic",fontcolor=red,style=filled];
+	a -> z [label="hi", weight=100];
+	x -> z [label="multi-line\nlabel"];
+	edge [style=dashed,color=red];
+	b -> x;
+	{rank=same; b x}
+}
+

data/app_generators/codex/templates/{slides → config}/metadata.yml

@@ -2,3 +2,4 @@ title:     The Codex Presentation System
 author:    Dave Thomas  
 company:   The Pragmatic Programmers, LLC
 copyright: 2008 Dave Thomas
+date:      <%= Date.today.strftime("%B %d, %Y") %>

data/app_generators/codex/templates/content/basics.textile

@@ -0,0 +1,42 @@
+h1. The Basics
+
+h1. Content and Code
+
+* Content is created using "Textile markup":http://www.textism.com/tools/textile/
+* Code is written as normal source files
+* Content can embed parts of the source files
+* It's all processed into an HTML-based presentation
+  
+
+h1. Presentation Metadata
+
+* Required file @config/metadata.yml@
+
+:code config/metadata.yml
+
+h1. Where Stuff Goes
+
+* Create your content in @content/xxx.textile@
+* Write code under @code/xxx@
+* Build the files @html/xxx.html@ by running @Rake@
+
+
+h1. @.textile@ files
+
+* Each @.textile@ file is a separate chunk of the presentation
+* The first @h1.@ heading is the banner page for that chunk
+* Each subsequent @h1.@ starts a new slide
+* Using @h1(slide0).@ will create a title slide, like the first slide in every file
+
+
+h1. Table of Contents
+
+<div style="width:40%; float:right;">
+:code content/table_of_contents.textile[class=code-tiny]
+</div>
+
+<div style="width:58%">
+* You can divide your material into segments, each in a separate @xxx.textile@ file
+* Then create @content/table_of_contents.textile@, eg:
+</div>
+

data/app_generators/codex/templates/{slides/building.slides → content/building.textile}

@@ -2,11 +2,11 @@ h1. Building and Displaying HTML Slides
 
 h1. Building HTML Slides
 
-* Given an individual section in @slides/xxx.slides@
+* Given an individual section in @content/xxx.textile@
 
     @rake html/xxx.html@
     
-* If you've created a @slide/table_of_contents.slides@, build the whole presentation with
+* If you've created a @content/table_of_contents.textile@, build the whole presentation with
 
     @rake all@
     

data/app_generators/codex/templates/{slides/example.slides → content/example.textile}

@@ -77,4 +77,5 @@ h1. Continuations.
 
 But...
 
-* They'll impress your friends
+* They'll impress your friends
+

data/app_generators/codex/templates/content/graphviz.textile

@@ -0,0 +1,35 @@
+h1. Graphviz plugin
+
+h1. Inline graphviz
+
+You can embed graphviz code to generate graphs
+:inlinecode
+:inlinegraphviz [engine=neato]
+graph test123 {
+	a -- b -- c;
+	a -- {x y};
+	x -- c [w=10.0];
+	x -- y [w=5.0,len=3];
+}
+:endinlinegraphviz
+:end
+
+:inlinegraphviz 
+graph test123 {
+	a -- b -- c;
+	a -- {x y};
+	x -- c [w=10.0];
+	x -- y [w=5.0,len=3];
+}
+:end
+
+h1. File based graphviz
+
+It is also possible to process graphviz from a given file:
+
+:inlinecode
+:graphviz code/graphviz/graph.dot
+:end
+
+:graphviz code/graphviz/graph.dot
+

data/app_generators/codex/templates/{slides/including_code.slides → content/including_code.textile}

@@ -57,10 +57,13 @@ h1. Override Code Language and/or CSS Class
 :endinlinecode
        
 * can appear in any order
-* @lang=@<em>anything supported by SyntaxHighlighter</em> 
-** look in @dp.SyntaxHighlighter/Scripts@)
-* @class=code-large | code-normal | code-small | code-tiny | code-supertiny@
-                                                                                  
+* @lang=@<em>anything supported by SyntaxHighlighter</em>
+** Defaults to @ruby@
+** @cpp | csharp | css | delphi | java | jscript | php | python | ruby | sql | vb | xml@ 
+** look in @assets/dp.SyntaxHighlighter@
+* @class=code-superlarge | code-large | code-normal | code-small | code-tiny | code-supertiny@
+
+                                                                               
 h1. Embedding Code Inline
 
 :inlinecode
@@ -72,8 +75,8 @@ h1. Embedding Code Inline
 
 * @:inlinecode@ optionally takes @lang=xxx@ and @class=xx@     
 
-:inlinecode
- :inlinecode lang=ruby
+:inlinecode[class=code-large]
+ :inlinecode[lang=ruby class=code-large]
     puts "Hello World!"
  :endinlinecode
 :endinlinecode 

data/app_generators/codex/templates/content/including_tex.textile

@@ -0,0 +1,32 @@
+h1. Including TeX math formulas in slides
+
+h1. Including TeX (WebTeX) math formula in slides
+
+Everything line between :inlinetex and :endlinetex is treated as a TeX math formula
+
+*Example:*
+
+:inlinecode
+:inlinewebtex
+\alpha\beta\gamma
+:endinlinewebtex
+:end
+
+*Result:*
+
+:inlinewebtex
+\alpha\beta\gamma
+:end
+
+h1. Ritex and WebTex
+
+WebTeX is an adapation of the TeX math syntax which is designed for web page display.
+
+Ritex is a nice little gem used to generate MathML from from WebTeX.
+
+Ressources:
+* "The WebTeX documentation":http://stuff.mit.edu/afs/athena/software/webeq/currenthome/docs/webtex/toc.html
+* "The Ritex documentation":http://ritex.rubyforge.org/
+
+The flipside is that MathML doesn't always display properly in browsers :-(
+

data/app_generators/codex/templates/{slides/table_of_contents.slides → content/table_of_contents.textile}

@@ -12,3 +12,12 @@ h1. Creating Slideshows
 h1. An Example     
 
 * "Some Sample Slides":example.html
+
+h1. Extra filters
+
+* "The Ritex filter":including_tex.html
+* "The Graphviz filter":graphviz.html
+
+h1. Customization
+
+* "User defined stuff":user_defined.html

data/app_generators/codex/templates/content/user_defined.textile

@@ -0,0 +1,83 @@
+h1. User-defined filters and post processors
+
+h1(slide0). User-defined filters
+
+Create your own tags
+
+h1. User-defined filters
+
+* Allow you to create your own @filters@ and @tags@
+* They go in the @filters/@ directory
+* There already is an example filter there
+
+h1. Example filter
+
+<div style="width: 50%; float: right">
+
+:code filters/example_filter.rb[class=code-small]
+
+</div>
+
+<div style="width: 49%">
+
+* Declare a class which inherits from @Codex::Filter@
+** Set the tag you wish to use
+** Implement @filter_inline(text,args)@ 
+** Implement @filter_single(args)@
+** You can omit filter_single if you just want it to load a file and parse it through filter_inline
+
+</div>
+
+It's _that_ simple.
+
+h1. Using your filter
+
+You can now use your tags in your slides:
+
+:inlinecode
+ :inlinetest
+  Reverse this text
+ :endinlinetest
+:endinlinecode
+
+The result is:
+
+:inlinetest
+Reverse this text
+:endinlinetest
+
+
+h1(slide0). User defined Post Processors
+
+Make your own changes to the slides after they are built
+
+h1. User defined Post Processors
+
+* Allow you to alter the generated HTML to your content
+* You can use an HTML parser such as "Hpricot":http://github.com/whymirror/hpricot to make complex modifications or @String#gsub@ to make simple changes
+* They go in the @post_processors/@ directory
+* There are sample Post Processors defined in this directory
+
+h1. How to create your own Post Processor
+
+<div style="width: 50%; float: right">
+
+:code post_processors/upcase_titles.rb[class=code-tiny]
+
+</div>
+
+<div style="width: 49%">
+
+* Declare a class which inherits from @Codex::PostProcessor@
+* Run the @register@ class method on top of the class declaration (commented in the example)
+* Implement @process()@ 
+* Manipulate the @html@ string variable. Whatever is held in @html@ will be passed on to the slides parser (and maybe to other Post Processors).
+
+</div>
+
+h1. Using the example
+
+* Simply uncomment @# register@ and regenerate the slides using @rake@ (you may need to delete the old @.html@ files in @html/@)
+* You will see that all titles are now in UPCASE.
+* If you want to control the order that Post Processors are applied, name their files incrementally (ex.: @01_process_code.rb@, @02_process_text.rb@, etc)
+

data/app_generators/codex/templates/filters/example_filter.rb

@@ -0,0 +1,13 @@
+# This is _my_ example filter. Define your own ;-)
+
+class TestFilter < Codex::Filter
+  tag :test
+
+  def filter_inline(text,args)
+    text.reverse
+  end
+
+  def filter_single(args)
+    args.reverse
+  end
+end

data/app_generators/codex/templates/post_processors/change_code_urls.rb

@@ -0,0 +1,16 @@
+# This is a sample post processor. It will change the links to 
+# the code samples from the TextMate specific "txmt://open?url=File:///(...)"
+# to the general "File:///(...)", which will also work in Linux or Windows
+# browsers without any hacking.
+#
+# PostProcessors have to subclass Codex::PostProcessor and 
+# overwrite the #process. You can then edit the @html variable, 
+# which holds the content of the parsed slides in HTML.
+class ChangeCodeURLs < Codex::PostProcessor
+  # Uncomment the next line to activate this post processor:
+  # register
+  def process
+    # it will
+    @html = @html.gsub(/href="txmt:\/\/open\?url=/, "href=")
+  end
+end

data/app_generators/codex/templates/post_processors/upcase_titles.rb

@@ -0,0 +1,15 @@
+# This is a sample post processor. It will convert all 
+# slide titles to upper case.
+# PostProcessors have to subclass Codex::PostProcessor
+# and overwrite the #process. You can then edit the @html 
+# variable, which holds the content of the parsed slides
+# in HTML.
+class UpcaseTitles < Codex::PostProcessor
+  # Uncomment the next line to activate this post processor:
+  # register
+  def process
+    @html = @html.gsub(/(<h1[^<>]*>)([^<>]*)(<\/h1>)/) do |match| 
+      "#{$1}#{$2.upcase}#{$3}"
+    end
+  end
+end