rake4latex 0.0.1 → 0.1.0

data/lib/rake4latex/template.rb

@@ -0,0 +1,60 @@
+#
+#Little helper to build the initial rakefile
+#
+
+
+#
+#Little helper to build the initial rakefile
+#
+module Rake4LaTeX
+#
+#Template for a basic rakefile
+#
+Template = <<Template
+require 'rake4latex'
+
+#Needed for some actions without a previous TeX-call
+task :basefile => 'testdocument.tex'
+
+file 'testdocument.pdf' => 'testdocument.tex' #prerequisite for a PDF-file
+file 'testdocument.dvi' => 'testdocument.tex' #prerequisite for a DVI-file
+
+#Force the compilation
+task :touch => 'testdocument.tex'
+
+#Define the default tasks
+#~ task :default => :touch  #Force the first TeX-call
+task :default => 'testdocument.pdf' #build the pdf
+#~ task :default => 'testdocument.dvi'  #build the dvi
+task :default => :statistic #Get an overview on errors and warnings
+task :default => :clean #delete helpfiles
+
+#Make the rakefile self-executable
+if $0 == __FILE__
+  app = Rake.application
+  app[:default].invoke  #start default tasks
+end
+Template
+
+  #~ rake4LaTeX.set_latexrunner_default(:maxruns, 1)
+  #~ rake4LaTeX.set_latexrunner_default(:loglevel, Log4r::DEBUG)
+  #~ rake4LaTeX.set_latexrunner_default(:texerrors_allowed, true)
+
+
+=begin rdoc
+Build atemplate for a rakefile.
+
+=end
+def self.template( basename = nil)
+  basename = basename.ext()
+  template = Template.dup
+  template.gsub!( /testdocument/, basename ) if basename
+  template
+end #self.template( filename = nil)
+
+end #Rake4LaTeX
+
+if $0 == __FILE__
+  require 'rake'
+  puts Rake4LaTeX.template('testdokument.pdf')
+end

data/lib/rake4latex/tex_statistic.rb

@@ -2,9 +2,12 @@
 Build a quick overview on the logs for TeX-runs
 =end
 
-
-require 'knut_yaml' #fixme
-
+begin
+  require 'knut_yaml'   #fixme
+rescue LoadError 
+  require 'yaml' 
+end
+module Rake4LaTeX
 class TeX_Statistic
   #Define the main file for the log-analyse.
   def initialize( filename )
@@ -273,6 +276,8 @@ class TeX_Statistic
 stat
   end
 end #TeX_Statistic
+end #Rake4LaTeX
+
 
 if $0 == __FILE__
   require 'rake'

data/lib/rake4latex_dvipdfm.rb

@@ -0,0 +1,40 @@
+=begin rdoc
+Special variant for rake4latex with ps2pdf
+=end
+
+#
+#Load the base functions and load subfiles.
+#
+require 'rake4latex/base'
+
+#
+#Define the pdf-creation via pdflatex
+#
+
+#~ desc "Build a pdf-file with pdfLaTeX"
+#~ rule '.pdf' => '.tex' do |t|
+  #~ runner =   LaTeXRunner.new( 
+    #~ :main_file => t.source,
+    #~ :program => :pdflatex,
+    #~ :dummy => nil
+    #~ )
+  #~ runner.execute  #Does all the work and calls the "post-prerequisites"
+#~ end
+
+desc "Build a pdf-file via dvipdfm."
+rule '.pdf' => '.dvi' do |t|
+  Rake4LaTeX::Logger.info("Call dvipdfm for <#{t.source}>")
+  cmd = Rake4LaTeX.build_cmd( 'dvipdfm', :filename => t.source )
+  
+  stdout, stderr = catch_screen_output{ 
+    sh cmd
+    #stdout -> empty
+    #stderr -> "ps2pdf testdocument.ps"
+    puts stdout
+    puts '==========='
+    puts stderr
+  }
+  if $? != 0
+    Rake4LaTeX::Logger.fatal("There where dvipdfm errors. \n#{stdout}")
+  end
+end

data/lib/rake4latex_lualatex.rb

@@ -0,0 +1,22 @@
+=begin rdoc
+Special variant for rake4latex with lualatex.
+=end
+
+#
+#Load the base functions and load subfiles.
+#
+require 'rake4latex/base'
+
+#
+#Define the pdf-creation via lualatex
+#
+
+desc "Build a pdf-file with luaLaTeX"
+rule '.pdf' => '.tex' do |t|
+  runner =   Rake4LaTeX::LaTeXRunner.new( 
+    :main_file => t.source,
+    :program => :lualatex,
+    :dummy => nil
+    )
+  runner.execute  #Does all the work and calls the "post-prerequisites"
+end

data/lib/rake4latex_pdflatex.rb

@@ -0,0 +1,22 @@
+=begin rdoc
+Special variant for rake4latex with pdflatex.
+=end
+
+#
+#Load the base functions and load subfiles.
+#
+require 'rake4latex/base'
+
+#
+#Define the pdf-creation via pdflatex
+#
+
+desc "Build a pdf-file with pdfLaTeX"
+rule '.pdf' => '.tex' do |t|
+  runner =   Rake4LaTeX::LaTeXRunner.new( 
+    :main_file => t.source,
+    :program => :pdflatex,
+    :dummy => nil
+    )
+  runner.execute  #Does all the work and calls the "post-prerequisites"
+end

data/lib/rake4latex_ps2pdf.rb

@@ -0,0 +1,27 @@
+=begin rdoc
+Special variant for rake4latex with ps2pdf
+=end
+
+#
+#Load the base functions and load subfiles.
+#
+require 'rake4latex/base'
+
+#
+#Define the pdf-creation via dvips ps2dvi
+#
+desc "Build a pdf-file via ps2dvi"
+rule '.pdf' => '.ps' do |t|
+  Rake4LaTeX::Logger.info("Call ps2pdf for <#{t.source}>")
+  cmd = Rake4LaTeX.build_cmd( 'ps2pdf', :filename => t.source )
+  
+  stdout, stderr = catch_screen_output{ 
+    sh cmd
+    #stdout -> empty
+    #stderr -> "ps2pdf testdocument.ps"
+  }
+  if $? != 0
+    Rake4LaTeX::Logger.fatal("There where ps2pdf errors. \n#{stdout}")
+  end
+end
+

data/lib/rake4latex_xelatex.rb

@@ -0,0 +1,22 @@
+=begin rdoc
+Special variant for rake4latex with xelatex.
+=end
+
+#
+#Load the base functions and load subfiles.
+#
+require 'rake4latex/base'
+
+#
+#Define the pdf-creation via xelatex
+#
+
+desc "Build a pdf-file with xeLaTeX"
+rule '.pdf' => '.tex' do |t|
+  runner =   Rake4LaTeX::LaTeXRunner.new( 
+    :main_file => t.source,
+    :program => :xelatex,
+    :dummy => nil
+    )
+  runner.execute  #Does all the work and calls the "post-prerequisites"
+end

data/license.txt

@@ -0,0 +1,15 @@
+%% rake4latex
+%% Copyright 2010 Knut Lickert
+%
+% This work may be distributed and/or modified under the
+% conditions of the LaTeX Project Public License, either version 1.3
+% of this license or (at your option) any later version.
+% The latest version of this license is in
+%   http://www.latex-project.org/lppl.txt
+% and version 1.3 or later is part of all distributions of LaTeX
+% version 2005/12/01 or later.
+%
+% This work has the LPPL maintenance status `maintained'.
+% 
+% The Current Maintainer of this work is Knut Lickert.
+%

data/readme.html

@@ -4,15 +4,14 @@
 	Dir:		C:/usr/Script/rake4latex
 	Creator:	rakefile_rake4latex.rb
 	Target:		readme.html
-	2010/01/03 21:19:00
+	2010/01/08 19:25:32
 	
 	Generation-Info-End
 -->
 <!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN">
 <html>
 <head ></head>
-<body ><h1 >rake4latex: TeX-Build-Tool</h1>
-<h2 >Introduction</h2>
+<body ><h1 >rake4latex: TeX-Build-Tool 0.1.0==Introduction</h1>
 <p >
 This file contains definitions to build a rakefile for LaTeX-documents.  
 </p>
@@ -42,13 +41,52 @@ A not-so minimal rakefile looks like this:
   end
 </pre>
 <p >
-You can generate this template with:  
+You can generate a rakefile template with: require 'rake4latex' puts Rake4LaTeX.template( [basename] )  
+</p>
+<h3 >call_rake4latex.rb</h3>
+<p >
+When you think, your project is too small to create a rakefile, then try call_rake4latex.rb.  
+</p>
+<p >
+call_rake4latex.rb is a small programm where you can control rake4latex from your shell.  
+</p>
+<p >
+Example:  
+</p>
+<pre>
+  call_rake4latex.rb my_file
+  call_rake4latex.rb -e my_file
+</pre>
+<h3 >rake4latex as lib in your application</h3>
+<p >
+You can use rake4latex as a lib inside your application.  
+</p>
+<p >
+Example:  
 </p>
 <pre>
   require 'rake4latex'
-  puts Rake4LaTeX.template( [basename] )
+  task :touch   =&gt; 'testdocument.tex'
+  task :runtex =&gt; [:touch, 'testdocument.pdf', :clean]
+  Rake.application[:runtex].invoke
+  #~ task :basefile =&gt; 'testdocument.pdf'
+  #~ Rake.application[:clean].invoke
 </pre>
-<h2 >Multiple runs</h2>
+<h2 >Document creation</h2>
+<p >
+rake4latex defines the tasks and rules to build documents with LaTeX.  
+</p>
+<p >
+pdf can be created in different ways. rake4latex uses pdflatex, but there are other rake-profile to  create your pdf in different ways:  
+</p>
+<ul >
+<li > rake4latex_dvipdfm.rb  </li>
+<li > rake4latex_lualatex.rb  </li>
+<li > rake4latex_pdflatex.rb  </li>
+<li > rake4latex_ps2pdf.rb  </li>
+<li > rake4latex_xelatex.rb  </li>
+</ul>
+<h3 >Multiple runs</h3>
 <p >
 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
@@ -144,14 +182,6 @@ The rake process to generate the document is independent of any  package. But so
 <li > supertabular  </li>
 <li > splitindex (splitindex is replaced by internal routines)  </li>
 </ul>
-<p >
-Untested packages:  
-</p>
-<ul >
-<li > glossary  </li>
-<li > multiind/index (not planned to check, please use splitindex or inform me
-about your need)  </li>
-</ul>
 <h2 >Adding new tasks</h2>
 <h3 >Normal tasks</h3>
 <p >
@@ -208,29 +238,46 @@ See also section 'Multiple runs'
 </p>
 <h2 >Known Bugs and Problems</h2>
 <ul >
-<li >Only pdflatex/xelatex/lualatex/latex to create the target, no ps-files, no ps2pdf.  <ul >
-<li >Intended for the next release  </li>
+<li > Two runs for new documents, when only one is needed.  </li>
 </ul>
-</li>
-<li > Two runs for new documents, when only one is needed.<br />
- 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.  <ul >
+<p >
+ 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.  
+</p>
+<ul >
 <li > No plan to solve it. Not a big problem, and why you need a rakefile for such simple
 tex-files?  </li>
 </ul>
-</li>
-<li > No usage of kpsewhich<br />
- LaTeXDependencies#get_dependecies checks dependecies only relative to  the file location. kpsewhich is not used.  <ul >
+<ul >
+<li > No usage of kpsewhich. LaTeXDependencies#get_dependecies checks dependecies only relative to  the file location. kpsewhich is not used.  <ul >
 <li > Would be nice escpecially for BibTeX and scan for \bibliography{xxx}  </li>
 <li > Low priority  </li>
 </ul>
 </li>
 </ul>
+<h3 >Packages with problems</h3>
+<p >
+There are additional packages requiring additonal runs.  
+</p>
+<ul >
+<li > glossaries (glossary based on makeindex)  - support not planned.  </li>
+<li > multiind/index (multiple index) - support not planned.  Please use splitindex or inform me about your need.  </li>
+</ul>
 <h2 >Version History</h2>
 <p >
 0.0.1 2010-01-03  
 </p>
 <ul >
-<li > First release  </li>
+<li > First release published at gemcutter <a href = "http://gemcutter.org/gems/rake4latex" >http://gemcutter.org/gems/rake4latex</a> </li>
+</ul>
+<p >
+0.0.2 2010-01-04  
+</p>
+<ul >
+<li > rubyforge project rake4latex: <a href = "http://rubyforge.org/projects/rake4latex/" >http://rubyforge.org/projects/rake4latex/</a> </li>
+<li > Add support dvips + ps2pdf (and dvipdfm, xelatex, lualatex)  </li>
+<li > Configurable programm settings (rake4latex.yaml)  </li>
+<li > Define a caller call_rake4latex  </li>
+<li > Support of gloss.sty  </li>
 </ul>
 </body>
 </html>

data/readme.txt

@@ -1,11 +1,8 @@
 
 
-rake4latex: TeX-Build-Tool
+rake4latex: TeX-Build-Tool 0.1.0==Introduction
     ------------------------------
 
-Introduction
-      ------------------------------
-
 This file contains definitions to build a rakefile for LaTeX-documents.  
 
 A not-so minimal rakefile looks like this:  
@@ -30,13 +27,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] )  
+
+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'
-  puts Rake4LaTeX.template( [basename] )
+  task :touch   => 'testdocument.tex'
+  task :runtex => [:touch, 'testdocument.pdf', :clean]
+  Rake.application[:runtex].invoke
+  #~ task :basefile => 'testdocument.pdf'
+  #~ Rake.application[:clean].invoke
 
-Multiple runs
+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
@@ -114,11 +145,6 @@ The rake process to generate the document is independent of any  package. But so
 -  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)  
-
 Adding new tasks
       ------------------------------
 
@@ -170,17 +196,31 @@ 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
+-  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}  
+-  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  
 
+Packages with problems
+        ------------------------------
+
+There are additional packages requiring additonal runs.  
+-  glossaries (glossary based on makeindex)  - support not planned.  
+-  multiind/index (multiple index) - support not planned.  Please use splitindex or inform me about your need.  
+
 Version History
       ------------------------------
 
 0.0.1 2010-01-03  
--  First release  
+-  First release published at gemcutter http://gemcutter.org/gems/rake4latex (http://gemcutter.org/gems/rake4latex) 
+
+0.0.2 2010-01-04  
+-  rubyforge project rake4latex: http://rubyforge.org/projects/rake4latex/ (http://rubyforge.org/projects/rake4latex/) 
+-  Add support dvips + ps2pdf (and dvipdfm, xelatex, lualatex)  
+-  Configurable programm settings (rake4latex.yaml)  
+-  Define a caller call_rake4latex  
+-  Support of gloss.sty