rake4latex 0.0.1 → 0.1.0

data/{lib/call_rake4latex.rb → call_rake4latex.rb}

@@ -18,6 +18,7 @@ search path for executable files.
 =end
 
 require 'rake4latex'
+#~ Dir.chdir('lib'){ require 'rake4latex' }
 require 'optparse'
 
 #Anlegen des Parsers
@@ -30,7 +31,7 @@ opts.separator "call_rake4latex testdocument.pdf"
 opts.separator "  Create testdocument.pdf via pdflatex"
 opts.separator "  Starts only if testdocument.tex is newer then testdocument.pdf."
 opts.separator ""
-opts.separator "call_rake4latex -f testdocument"
+opts.separator "call_rake4latex -e testdocument"
 opts.separator "  Touch 'testdocument.tex' (set the modification date)"
 opts.separator "  Create testdocument.pdf via pdflatex"
 opts.separator ""
@@ -44,23 +45,29 @@ TASK_AFTER_TeX = []
 PARSE_MESSAGES = true
 
 
+#
+#fixme: format
 =begin
 Shortcuts
 =end
-opts.on('-f', "--force", "Force an initial TeX-run") { |v|
-  TASK_BEFORE_TeX << :force
+opts.on('-e', "--enforce", "Enforce an initial TeX-run") { |v|
+  TASK_BEFORE_TeX << :enforce
+}
+
+opts.on('-f', "--format FORMAT", "Set the format for TeX-run (pdflatex, xelatex, lualatex)") { |v|
+  Rake4LaTeX.set_latexrunner_default(:program, v.to_sym)
 }
 
 #
 #fixme:
 #Warum gibt es immer einen TeX-Lauf mit dieser Option?
 #
-opts.on('-d', '--dep', "--dependecies", "Build dependecies") { |v|
+opts.on('--dep', "--dependecies", "Build dependecies (rakefile recommended)") { |v|
   TASK_BEFORE_TeX << :dependecies
 }
 opts.on("-i", "--ignore", "--ignore-error", "Allow LaTeX errors") { |v|
   puts "Allow LaTeX errors"  if PARSE_MESSAGES
-  Rake.application.set_latexrunner_default(:texerrors_allowed, true)
+  Rake4LaTeX.set_latexrunner_default(:texerrors_allowed, true)
 }
 
 opts.on("-s", "--statistic", "Show the statistic after TeX-run") { |v|
@@ -102,13 +109,17 @@ LaTeXRunner-options
 #
 opts.on("--maxrun MAXRUN", "Maximum MAXRUN TeX calls") { |v|
   puts "Set maximum TeX-Runs #{v.inspect}"  if PARSE_MESSAGES
-  Rake.application.set_latexrunner_default(:maxruns, v.to_i)
+  Rake4LaTeX.set_latexrunner_default(:maxruns, v.to_i)
   #~ LaTeXRunner::DEFAULT_SETTINGS[:maxruns] = 
 }
 
 opts.on("-l", "--loglevel LEVEL", "Log Level for the logger (1=debug, 2=info(default), 3=warn 4=error)") { |v|
   puts "Set loglevel to #{v.inspect}"  if PARSE_MESSAGES
-  Rake.application.set_latexrunner_default(:loglevel, v.to_i)
+  Rake4LaTeX.set_latexrunner_default(:loglevel, v.to_i)
+}
+
+opts.on("-v", "--version", "Version") { |v|
+  puts "Rake4LaTeX-Caller Version #{Rake4LaTeX::VERSION}" 
 }
 
 
@@ -119,10 +130,10 @@ begin
   ARGV.each{|arg|
     target = arg.ext('pdf')
     puts "Define target #{target}"
-    set4clean(arg)
+    Rake4LaTeX.set4clean(arg)
     TASK_BEFORE_TeX.each{|task|
     case task
-      when :force
+      when :enforce
         puts "Force an initial TeX-run (touch #{target.ext('tex')})" if PARSE_MESSAGES
         task (:touch => target.ext('tex'))
         task (:default => :touch)
@@ -139,6 +150,7 @@ begin
       end
     }
     task( :default => target )
+    puts "call_rake4latex tries to generate #{target}"
   }  
 rescue OptionParser::MissingArgument, OptionParser::InvalidOption => err
 	puts "Error:\t#{err}"

data/lib/rake4latex.rb

@@ -24,11 +24,47 @@ A not-so minimal rakefile looks like this:
     app[:default].invoke
   end
 
-You can generate this template with:
+You can generate a rakefile template with:
   require 'rake4latex'
   puts Rake4LaTeX.template( [basename] )
 
-==Multiple runs
+===call_rake4latex.rb
+When you think, your project is too small to create a rakefile,
+then try call_rake4latex.rb.
+
+call_rake4latex.rb is a small programm where you can control
+rake4latex from your shell.
+
+Example:
+  call_rake4latex.rb my_file
+  call_rake4latex.rb -e my_file
+
+===rake4latex as lib in your application
+
+You can use rake4latex as a lib inside your application.
+
+Example:
+  require 'rake4latex'
+  task :touch   => 'testdocument.tex'
+  task :runtex => [:touch, 'testdocument.pdf', :clean]
+  Rake.application[:runtex].invoke
+  #~ task :basefile => 'testdocument.pdf'
+  #~ Rake.application[:clean].invoke
+
+==Document creation
+rake4latex defines the tasks and rules to build documents with LaTeX.
+
+pdf can be created in different ways.
+rake4latex uses pdflatex, but there are other rake-profile to 
+create your pdf in different ways:
+* rake4latex_dvipdfm.rb
+* rake4latex_lualatex.rb
+* rake4latex_pdflatex.rb
+* rake4latex_ps2pdf.rb
+* rake4latex_xelatex.rb
+
+
+===Multiple runs
 One of the problems with writing a Makefile for LaTeX is that often latex needs
 to be run more than once on the same file, before obtaining the final output.
 Moreover, every LaTeX package may require other runs basing on different conditions
@@ -89,7 +125,7 @@ BibTeX depends on two files:
 You can define the dependecies of bib-file in your rakefile:
   file 'testdocument.pdf' => 'testdocument.bib'
   file 'testdocument.bbl' => 'testdocument.bib'
-You need both definietions.
+You need both definitions.
 The pdf-dependecy is needed to start a new TeX-run, 
 The bbl-dependecy is needed to start a new BibTeX-run.
 
@@ -104,15 +140,19 @@ The following tools are supported by rake4latex:
 The rake process to generate the document is independent of any 
 package.
 But some packages requires additional TeX-runs.
+
 The following packages are tested and work fine:
 * minitoc
 * longtable
 * supertabular
-* splitindex (splitindex is replaced by internal routines)
 
-Untested packages:
-* glossary
-* multiind/index (not planned to check, please use splitindex or inform me about your need)
+For the following packages exists special solutions:
+* splitindex (splitindex is replaced by internal routines) 
+  http://www.ctan.org/tex-archive/macros/latex/contrib/splitindex/
+* gloss (glossary based on bibTeX) 
+  http://www.ctan.org/tex-archive/macros/latex/contrib/gloss/
+* rail (creating rail-diagramms)
+  http://www.ctan.org/tex-archive/support/rail/
 
 ==Adding new tasks
 ===Normal tasks
@@ -165,196 +205,89 @@ We need a modified pre-check, if the BibTeX-call is necessary:
 See also section 'Multiple runs'
 
 ==Known Bugs and Problems
-*Only pdflatex/xelatex/lualatex/latex to create the target,
-  no ps-files, no ps2pdf.
-**Intended for the next release
-* Two runs for new documents, when only one is needed.\\
-After the first run, the aux-file is created,
-so rake4latex detect a reason to rerun.
-Solution would be to make a log-file analyse.
-** No plan to solve it.
-  Not a big problem, and why you need a rakefile for such simple tex-files?
-* No usage of kpsewhich\\
+* Two runs for new documents, when only one is needed.
+
+  After the first run, the aux-file is created,
+  so rake4latex detect a reason to rerun.
+  Solution would be to make a log-file analyse.
+  * No plan to solve it.
+    Not a big problem, and why you need a rakefile for such simple tex-files?
+    
+* No usage of kpsewhich.
+
   LaTeXDependencies#get_dependecies checks dependecies only relative to 
   the file location.
   kpsewhich is not used.
-** Would be nice escpecially for BibTeX and scan for \bibliography{xxx}
-** Low priority
-
-=end
-
-<<weiter
-fixmes
-== weiterer Aufbau rake abh�ngigkeiten
-- glossary
-rule '.glo' => '.aux' '.glo' do |t|
-(glossaries?)
-
-==task statistic/log-analyse
+  * Would be nice escpecially for BibTeX and scan for \bibliography{xxx}
+  * Low priority
 
-==application::texrunner als array?
+===Packages with problems
+There are additional packages requiring additonal runs.
 
-Rake.template(basename) erzeugt rakefile
-  app = Rake.application
-  #~ app.set_latexrunner_default(:maxruns, 1)
-  #~ app.set_latexrunner_default(:loglevel, Log4r::DEBUG)
-  #~ app.set_latexrunner_default(:texerrors_allowed, true)
-  app[:default].invoke
+* glossaries (glossary based on makeindex)  - support not planned.
+* multiind/index (multiple index) - support not planned. 
+  Please use splitindex or inform me about your need.
+* rail (rail syntax diagramms) - see tests, the rakefile includes the solution.
 
-rail �berarbeiten
 
-Compilierungswege dvi -> ps -> pdf
 
-prob:
-wie erkennen ob 
-- dvi2ps + ps2pdf
-- dvipdfm
-
-weiter
-
-
-#~ ==Problems
-#~ * the action which checks for changed references causes a second latex invocation
-  #~ every time the .aux file changes. 
-  #~ I don't know enough of the contents of the
-  #~ .aux file to parse it, but I need to base the decision on it, because messages
-  #~ such as "rerun to get cross-references right" in the latex log file aren't
-  #~ reliable (for example, the when the hyperref package is used, they aren't
-  #~ produced)
-
-require 'log4r'
-#Create a dummy-Logger to define the constants Log4r::DEBUG...
-
-Log4r::Logger.new("test")
-#~ gem 'rake', '=0.8.7'
-require 'rake'
-require 'md5'
-
-class Rake::Application
-=begin rdoc
-Sets a default option for the LaTeXRunner.
-
-The options are stored and used for new LaTeXRunners.
-
-Example:
-  app.set_latexrunner_default(:loglevel, Log4r::DEBUG)
-
-You could also access LaTeXRunner::DEFAULT_SETTINGS directly.
-But with this method you get also a check if the option exists.
 =end
-  def set_latexrunner_default( key, option )
-    if ! LaTeXRunner::DEFAULT_SETTINGS.keys.include?(key)
-      raise ArgumentError, "Undefined key #{key.inspect} for LaTeXRunner" unless @latexrunner
-      @latexrunner.logger.warn("Undefined key #{key.inspect} for LaTeXRunner")
-    end
-    LaTeXRunner::DEFAULT_SETTINGS[key] = option
-  end
-=begin rdoc
-Get the related actual LaTeXRunner.
-=end
-  attr_reader :latexrunner
-=begin rdoc
-Define a LaTeXRunner.
 
-This LaTeXRunner may be used via Rake#application#latexrunner to get the logger.
-=end
-  def latexrunner=( latexrunner )
-    raise ArgumentError, "LaTeXRunner is no LaTeXRunner but #{t.class}" unless latexrunner.is_a?(LaTeXRunner)
-    if @latexrunner
-      @latexrunner.logger.warn( "LaTeXRunner replaced by other runner")
-    end
-    @latexrunner = latexrunner
-    @latexrunner.logger.debug( "Set LaTeXRunner #{@latexrunner.main_file} as default runner in Rake::Application")
-  end
-end #Rake::Application
-
-=begin rdoc
-Define the files to be deleted with clean and clobber.
-
-There is no global definition to delete all files, 
-only the help file for the selected basename is taken.
-
-Helpfiles for splitindex are not added. You can do it manual:
-  CLEAN.add("testdocument-*") #splitidx-helpfiles
-
-This method is called by task 'basename'
-=end
-def set4clean( basename )
-  #fixme splitindex-dateien
-  FileList["#{basename.ext('*')}"].each do |file|
-    #Set the cleaning actions      
-    case file
-      when /\.(tex)\Z/
-      when /\.(aux|log|out|toc|lot|lof|nav|snm)\Z/
-        CLEAN.include(file)    
-      when /\.(maf|ptc\d*|mtc\d*|stc\d*)\Z/ #minitoc
-        CLEAN.include(file)    
-      when /\.(ilg|idx|ind)\Z/  #Index-Files
-        CLEAN.include(file)    
-      when /\.(blg|bbl)\Z/  #BibTeX-Files
-        CLEAN.include(file)    
-      when /\.(rai|rao|RAO)\Z/  #Rail-Files
-        CLEAN.include(file)    
-      when /\.(dvi|pdf|ps)\Z/
-        CLOBBER.include(file)              
-      else
-        #~ @logger.warn("Unknown help file #{file}")
-    end
-  end
-  CLEAN.uniq!
-  CLOBBER.uniq!
-end
-
-=begin rdoc
-Define a task to be executed after each TeX run.
-
-The task name is added to LaTeXRunner::Post_Prerequisites.
-LaTeXRunner#run_latex_once will loop on all tasks in LaTeXRunner::Post_Prerequisites.
-=end
-def tex_postrule(*args, &block)
-  #~ rules = rule(*args, &block)
-  Rake::Task.create_rule(*args, &block)  #@rules << [pattern, deps, block]
-  #
-  if args.size == 1 #normal rule without arguments
-    LaTeXRunner::Post_Prerequisites << args.first.keys.first
-  else  #rule with arguments (args.last is a hash with :needs)
-    LaTeXRunner::Post_Prerequisites << args.first
-  end
-end
-=begin rdoc
-Define a procedure to decide, if the post process should be 
-called.
-
-The task name is added to LaTeXRunner::Post_Prerequisites_check.
-LaTeXRunner#run_latex_once will loop on all tasks in LaTeXRunner::Post_Prerequisites_check.
-
-The block will be called with a hash, the block must accept this one parameter.
+<<weiter
+fixmes
+- glossaries
 
-Inside the block you have access to:
-* :task: The task for which you test.
-* :checksums: the checksums of the files before the TeX-run.
-* :logger: the logger of the related task
+task statistic/log-analyse ausbauen.
+task pack unpack logarchive
+weiter
 
-The block must return false or the reason for a call (e.g. "testdocument.aux changed")
+#
+#Load the base functions and load subfiles.
+#
+require 'rake4latex/base'
 
-Example: See BibTeX-definition.
-=end
-def tex_postrule_check(rulename, &block)
-  raise "No block for postrule_check #{rulename}" unless block_given?
-  raise "Wrong number of arguments for postrule_check #{rulename}" unless block.arity == 1
-  LaTeXRunner::Post_Prerequisites_check[rulename] ||= [] << block
+#
+#Define the pdf-creation via pdflatex
+#
+#This definition maust be first.
+#If not, the way via ps2pdf would be the default.
+desc "Build a pdf-file with pdfLaTeX"
+rule '.pdf' => '.tex' do |t|
+  runner =   Rake4LaTeX::LaTeXRunner.new( 
+    :main_file => t.source,
+    #~ :program => :pdflatex, #Take the default
+    :dummy => nil
+    )
+  runner.execute  #Does all the work and calls the "post-prerequisites"
 end
 
 #
-#Load the sub-files
+#Define the pdf-creation via dvips ps2dvi
+#
+#To get the pdf via dvips and ps2dvi you must build the dependecies
+# file testfile.ps => testfile.tex
+# file testfile.pdf => testfile.ps
 #
-require 'rake4latex/clean'  #modified rake/clean
-require 'rake4latex/latexrunner'
-require 'rake4latex/latexdependencies'
-require 'rake4latex/splitindex'
-require 'rake4latex/rules'
-require 'rake4latex/tex_statistic'
-require 'rake4latex/template'
+#If you define 
+# file testfile.pdf => testfile.tex
+#you get the way via pdflatex.
+#
+#Or you take rake4latex_ps2pdf
+#
+desc "Build a pdf-file via ps2dvi"
+rule '.pdf' => '.ps' do |t|
+  t.application.latexrunner.logger.info("Call ps2pdf for <#{t.source}>")  if t.application.latexrunner
+  cmd = Rake4LaTeX.build_cmd( 'ps2pdf', :filename => t.source )
+
+  stdout, stderr = catch_screen_output{ 
+    sh "ps2pdf #{t.source}"
+    #stdout -> empty
+    #stderr -> "ps2pdf testdocument.ps"
+  }
+  if $? != 0
+    t.application.latexrunner.logger.fatal("There where ps2pdf errors. \n#{stdout}")
+  end
+end
 
 
 #Do some development tests

data/lib/rake4latex/base.rb

@@ -0,0 +1,205 @@
+=begin rdoc
+Base definitions of rake4latex.
+This file must be loaded by all specific rake4file-variants.
+=end
+
+
+#~ gem 'rake', '=0.8.7'
+require 'rake'
+require 'md5'
+require 'log4r' #1.0.5
+
+module Rake4LaTeX
+  VERSION = '0.1.0'
+  
+  #With this creation we define the constants Log4r::DEBUG...
+  Logger = Log4r::Logger.new("LaTeXRunner")
+  Logger.outputters = Log4r::StdoutOutputter.new('log_stdout')
+
+=begin rdoc
+Sets a default option for the LaTeXRunner.
+
+The options are stored and used for new LaTeXRunners.
+
+Examples:
+  Rake4LaTeX.set_latexrunner_default(:maxruns, 1)
+  Rake4LaTeX.set_latexrunner_default(:loglevel, Log4r::DEBUG)
+  Rake4LaTeX.set_latexrunner_default(:program, xelatex)
+  Rake4LaTeX.set_latexrunner_default(:texerrors_allowed, true)
+
+You could also access LaTeXRunner::DEFAULT_SETTINGS directly.
+But with this method you get also a check if the option exists.
+=end
+  def self.set_latexrunner_default( key, option )
+    if ! LaTeXRunner::DEFAULT_SETTINGS.keys.include?(key)
+      raise ArgumentError, "Undefined key #{key.inspect} for LaTeXRunner" unless @latexrunner
+      Rake4LaTeX::Logger.warn("Undefined key #{key.inspect} for LaTeXRunner") if Rake4LaTeX::Logger.warn?
+    end
+    LaTeXRunner::DEFAULT_SETTINGS[key] = option
+    case key
+      when :program
+      if LaTeXRunner::PROGRAMS.keys.include?( option.to_sym )
+        LaTeXRunner::DEFAULT_SETTINGS[key] = option.to_sym
+      else
+        Rake4LaTeX::Logger.warn("Undefined programm #{option.inspect} for LaTeXRunner") if Rake4LaTeX::Logger.warn?
+      end
+    end
+  end
+  
+=begin rdoc
+Load the Programs with parameters for Rake4LaTeX.build_cmd.
+
+Each program is a Hash:
+  program:
+    cmd: shell-cmd
+    parameters:
+      value: value as textstring
+      name: name of the parameter
+      value_key: key of the value, must be given to Rake4LaTeX.build_cmd
+      optional: flag, if the parameter is optional.
+      space_separated: between name and value is a space.
+=end
+
+#fixme: incremental reading: global + local overwrites
+  [
+    "#{File.dirname(__FILE__)}/rake4latex.yaml",
+    #ocra-settings:
+    #a src\lib\rake4latex\rake4latex.yaml    
+    #a lib\ruby\gems\1.8\gems\rake4latex-0.1.0\lib\rake4latex\base.rb    
+    "#{File.dirname(__FILE__)}/../../../../../../../../src/lib/rake4latex/rake4latex.yaml",  #for ocra-version (exe)
+  ].each{| setting_file |
+    if File.exist?(setting_file)
+      Programms = YAML.load(File.read(setting_file))
+      break
+    end
+  }
+  if ! defined? Programms
+    raise "No program settings found"
+  end
+
+
+=begin rdoc
+Build the command line to call a tool.
+
+Bases is the configuration in Programms.
+
+'parameters' contains the parameters for the call.
+The keys must fit to the settings in Rake4LaTeX::Programms .
+=end
+  def self.build_cmd( programm, parameters = {} )
+    
+    configuration = Programms[programm]
+    if ! configuration
+      Rake4LaTeX::Logger.fatal( "No configuration for #{programm.inspect}") if Rake4LaTeX::Logger.fatal?
+      return false
+    end
+    
+    cmd = configuration['cmd'].dup
+    configuration['parameters'].each{ | parameter |
+      cmd << " #{parameter['value']}" if parameter['value']
+      if parameter['value_key']
+        if parameters[parameter['value_key']]
+          cmd << " "
+          cmd << "#{parameter['name']}" if parameter['name']
+          cmd << " " if parameter['space_separated']
+          cmd << "#{parameters[parameter['value_key']]}"
+        else
+          if ! parameter['optional'] and Rake4LaTeX::Logger.error?
+            Rake4LaTeX::Logger.error( "Parameter #{parameter['value_key'].inspect} missing to execute #{programm}") 
+          end
+        end
+      end
+    }#configuration['parameters']
+  
+    cmd
+  end
+=begin rdoc
+Define the files to be deleted with clean and clobber.
+
+There is no global definition to delete all files, 
+only the help file for the selected basename is taken.
+
+Helpfiles for splitindex are not added. You can do it manual:
+  CLEAN.add("testdocument-*") #splitidx-helpfiles
+
+This method is called by task 'basename'
+=end
+  def self.set4clean( basename )
+    #fixme splitindex-dateien
+    FileList["#{basename.ext('*')}"].each do |file|
+      #Set the cleaning actions      
+      case file
+        when /\.(tex)\Z/
+        when /\.(aux|log|out|toc|lot|lof|nav|snm)\Z/
+          CLEAN.include(file)
+        when /\.(maf|ptc\d*|mtc\d*|stc\d*)\Z/ #minitoc
+          CLEAN.include(file)
+        when /\.(ilg|idx|ind)\Z/  #Index-Files
+          CLEAN.include(file)
+        when /\.(blg|bbl)\Z/  #BibTeX-Files
+          CLEAN.include(file)
+        when /\.(rai|rao|RAO)\Z/  #Rail-Files
+          CLEAN.include(file)
+        when /\.(dvi|pdf|ps)\Z/
+          CLOBBER.include(file)              
+        else
+          #~ @logger.warn("Unknown help file #{file}")
+      end
+    end
+    CLEAN.uniq!
+    CLOBBER.uniq!
+  end #set4clean
+
+end #Rake4LaTeX
+
+
+=begin rdoc
+Define a task to be executed after each TeX run.
+
+The task name is added to LaTeXRunner::Post_Prerequisites.
+LaTeXRunner#run_latex_once will loop on all tasks in LaTeXRunner::Post_Prerequisites.
+=end
+def tex_postrule(*args, &block)
+  #~ rules = rule(*args, &block)
+  Rake::Task.create_rule(*args, &block)  #@rules << [pattern, deps, block]
+  #
+  if args.size == 1 #normal rule without arguments
+    Rake4LaTeX::LaTeXRunner::Post_Prerequisites << args.first.keys.first
+  else  #rule with arguments (args.last is a hash with :needs)
+    Rake4LaTeX::LaTeXRunner::Post_Prerequisites << args.first
+  end
+end
+=begin rdoc
+Define a procedure to decide, if the post process should be 
+called.
+
+The task name is added to LaTeXRunner::Post_Prerequisites_check.
+LaTeXRunner#run_latex_once will loop on all tasks in LaTeXRunner::Post_Prerequisites_check.
+
+The block will be called with a hash, the block must accept this one parameter.
+
+Inside the block you have access to:
+* :task: The task for which you test.
+* :checksums: the checksums of the files before the TeX-run.
+* :logger: the logger of the related task
+
+The block must return false or the reason for a call (e.g. "testdocument.aux changed")
+
+Example: See BibTeX-definition.
+=end
+def tex_postrule_check(rulename, &block)
+  raise "No block for postrule_check #{rulename}" unless block_given?
+  raise "Wrong number of arguments for postrule_check #{rulename}" unless block.arity == 1
+  Rake4LaTeX::LaTeXRunner::Post_Prerequisites_check[rulename] ||= [] << block
+end
+
+#
+#Load the sub-files
+#
+require 'rake4latex/clean'  #modified rake/clean
+require 'rake4latex/latexrunner'
+require 'rake4latex/latexdependencies'
+require 'rake4latex/splitindex'
+require 'rake4latex/rules'
+require 'rake4latex/tex_statistic'
+require 'rake4latex/template'