themedoc 0.1 → 0.2

data/README.md

@@ -1,6 +1,28 @@
 % themedoc
 % theming pandoc
 
+# Bugs and problems
+
+## Open
+
+* Should see why it doesn't run rb 1.8
+   * Needs mostly testing
+   * Perhaps we need to push some stuff to separate files
+* propagate exit code
+    - don't forget cleanup
+    - propagate pandocs stderr
+* implement version
+
+## Closed
+
+* no theme given use default html
+* Should deal with missing extension and assume markdown input
+* Default theme should use pdflate
+* Message that states output file
+* list of themes
+* Snippets for before and after body
+
+
 # Features
 
 * Support different themes for pandoc
@@ -13,6 +35,12 @@
 
 # Getting started
 
+## Installation
+
+    gem install themedoc
+
+## Usage
+
 To `use themedoc's` default theme use the following incantation to
 create a pdf:
 

data/bin/themedoc

@@ -90,8 +90,21 @@ class Theme
     end
 
 
-    def header
-        @map['header']
+    def include(region_name)
+        unless @map['include']
+            return nil
+        end
+        @map['include'][region_name]
+
+    end
+
+
+    def before_body
+        @map['before-body']
+    end
+
+    def after_body
+        @map['after-body']
     end
 
     def parameters
@@ -104,9 +117,30 @@ class Theme
 
 end
 
+
+
 class CommandLineParser
     attr_reader :opts, :theme, :theme_path, :input_file_name
 
+    def initialize
+            home = `(cd; pwd)`
+            @theme_base_path = home.strip+"/.themedoc"
+    end
+
+    def load_theme(name)
+            @theme_path = @theme_base_path + "/" + name
+            @theme = Theme.new(YAML.load_file(theme_path + "/theme.yml"))
+            return @theme
+    end
+
+    def list_themes
+            puts "Available themes"
+            puts "----------------"
+            theme_names = `(cd #{@theme_base_path}; ls)`.split(/\n/)
+            theme_descriptions = theme_names.map{|n| load_theme(n)}
+            puts theme_names.zip(theme_descriptions).map{|t| t[0] + " => " + t[1].to_s}.join("\n")
+    end
+
     def parse()
         theme_index=ARGV.index("--theme") || ARGV.index("-t");
 
@@ -115,15 +149,21 @@ class CommandLineParser
                 throw "No theme value provided"
             end
             theme_name = ARGV[theme_index + 1 ]
-            home = `(cd; pwd)`
-            @theme_path = home.strip+"/.themedoc/#{theme_name}"
-            @theme = Theme.new(YAML.load_file(theme_path + "/theme.yml"))
+            load_theme(theme_name)
+        end
+
+        default_theme = false;
+        if (!@theme)
+            load_theme("default-html")
+            default_theme = true;
         end
 
         theme = @theme
 
+
         @opts = Trollop::options do
             opt :theme, "Theme to be used", :type => String, :short => 't'
+            opt :list_themes, "List available themes"
             opt :debug, "Do not remove temp files"
             if (theme)
                 theme.parameters.each{|param|
@@ -132,12 +172,20 @@ class CommandLineParser
             end
         end
 
-        Trollop::die :theme, "theme must be specified" if !@opts[:theme]
+        if (@opts[:list_themes])
+            list_themes
+            exit
+        end
+
+        if (default_theme)
+            puts "No theme provided - using default-html"
+        end
 
         if (ARGV.length == 0)
             throw "No input file specified"
         end
 
+
         @input_file_name = ARGV[0]
     end
 end
@@ -164,8 +212,14 @@ parser.parse()
 
 theme = parser.theme
 
-output_file_name = parser.input_file_name().gsub(/.md$/, "." +theme.target_extension)
-header_snippet_name = "." + parser.input_file_name() + ".header"
+if (/\.[^.]*$/ =~ parser.input_file_name())
+    output_file_name = parser.input_file_name().gsub(/\.[^.]*$/, "." +theme.target_extension)
+else
+    output_file_name = parser.input_file_name() + "." + theme.target_extension
+end
+
+puts "Writing output to #{output_file_name}"
+
 
 pandoc_opts = theme.pandoc_opts
 pandoc_vars = theme.pandoc_vars
@@ -179,16 +233,22 @@ pandoc_opts["output"] = output_file_name
 `ln -fs #{parser.theme_path}/resources .resources`
 
 template_parameters = {}
-theme.template_parameters
-    .map{|param| param['name']}
+theme.template_parameters \
+    .map{|param| param['name']} \
     .each{|p_name| template_parameters[p_name]=parser.opts[p_name.to_sym]}
 
+regions = ["in-header", "before-body", "after-body"]
+
+regions.each{|region_name|
+    snippet_file_name= "." + parser.input_file_name() + "." + region_name
+    if (theme.include(region_name))
+        region_content = Mustache.render(theme.include(region_name), template_parameters);
+        File.open(snippet_file_name, "w+") { |f| f << region_content}
+        pandoc_opts['include-' + region_name]=snippet_file_name
+    end
+}
+
 
-if (theme.header)
-    header = Mustache.render(theme.header, template_parameters);
-    File.open(header_snippet_name, "w+") { |f| f << header}
-    pandoc_opts['include-in-header']=header_snippet_name
-end
 
 pandoc=Pandoc.new(pandoc_opts, pandoc_vars, parser.input_file_name)
 pandoc.run
@@ -199,6 +259,8 @@ if (parser.opts[:debug])
 end
 
 `rm .resources`
-`rm -f #{header_snippet_name}`
-
+regions.each{|region_name|
+    snippet_file_name= "." + parser.input_file_name() + "." + region_name
+    `rm -f #{snippet_file_name}`
+}
 

data/themedoc.gemspec

@@ -3,7 +3,7 @@ Gem::Specification.new do |s|
   s.summary      = 'themedoc is a theming frontend for pandoc'
   s.description  = 'themedoc is a theming frontend for pandoc that allows grouping
                     parameters, extra resources and output snippets into named themes'
-  s.version      = '0.1'
+  s.version      = '0.2'
   s.platform     = Gem::Platform::RUBY
 
   s.files        = ['bin/themedoc']

data/themes/default-html/theme.yml

@@ -1,4 +1,4 @@
-description: Template for formal TWDE reports
+description: Template for html reports
 
 target-extension: html
 

data/themes/default-xelatex/theme.yml

@@ -0,0 +1,54 @@
+description: Template for pdf reports using xelatex
+
+target-extension: pdf
+
+pandoc-opts:
+    toc: true
+    standalone: true
+    self-contained: true
+    latex-engine: xelatex
+    number-sections: true
+
+pandoc-vars:
+    lang: english
+    graphics: true
+    documentclass: scrartcl
+
+parameters:
+    - name: title-header
+      type: string
+      target: template
+      desc: Header for the title page
+
+    - name: "no-toc"
+      type: bool
+      target: option-override
+      desc: suppress table of contents
+      original-name: toc
+      inverted: true
+
+    - name: lang
+      type: string
+      desc: language of the document, e.g. english or german
+      target: variable-override
+
+
+include:
+    in-header: |
+            {{=<% %>=}}
+            \usepackage{xltxtra,fontspec,xunicode}
+            \titlehead{<%title-header%>}
+            \setmainfont{Garamond}
+            %\setromanfont[Numbers=Uppercase]{Georgia}
+            \KOMAoptions{titlepage=true,abstract=false}
+            \publishers{
+                \Oldincludegraphics[height=18ex]{.resources/logo.png}
+                \vspace{3ex}
+            }
+
+    before-body: |
+                 Here the body doth start.
+
+    after-body:  |
+                 The body ends here.
+

data/themes/default/theme.yml

@@ -1,4 +1,4 @@
-description: Template for formal TWDE reports
+description: Default template for pdf with table of contents and numbered sections
 
 target-extension: pdf
 
@@ -6,13 +6,13 @@ pandoc-opts:
     toc: true
     standalone: true
     self-contained: true
-    latex-engine: xelatex
+    latex-engine: pdflatex
     number-sections: true
 
 pandoc-vars:
     lang: english
-    graphics: true
-    documentclass: scrartcl
+    #graphics: true
+    documentclass: article
 
 parameters:
     - name: title-header
@@ -33,15 +33,7 @@ parameters:
       target: variable-override
 
 
-header: |
-        {{=<% %>=}}
-        \usepackage{xltxtra,fontspec,xunicode}
-        \titlehead{<%title-header%>}
-        \setmainfont{Garamond}
-        %\setromanfont[Numbers=Uppercase]{Georgia}
-        \KOMAoptions{titlepage=true,abstract=false}
-        \publishers{
-            \Oldincludegraphics[height=18ex]{.resources/logo.png}
-            \vspace{3ex}
-        }
+include:
+    in-header: |
+               {{=<% %>=}}
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: themedoc
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-24 00:00:00.000000000Z
+date: 2012-08-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &2152721800 !ruby/object:Gem::Requirement
+  requirement: &2157178460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152721800
+  version_requirements: *2157178460
 - !ruby/object:Gem::Dependency
   name: mustache
-  requirement: &2152721360 !ruby/object:Gem::Requirement
+  requirement: &2157178020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152721360
+  version_requirements: *2157178020
 description: ! "themedoc is a theming frontend for pandoc that allows grouping\n                    parameters,
   extra resources and output snippets into named themes"
 email: ''
@@ -48,6 +48,8 @@ files:
 - themedoc.gemspec
 - themes/default-html/resources/default.css
 - themes/default-html/theme.yml
+- themes/default-xelatex/resources/logo.png
+- themes/default-xelatex/theme.yml
 - themes/default/resources/logo.png
 - themes/default/theme.yml
 homepage: https://github.com/fleipold/themedoc