rbbeamer 0.5.4 → 0.5.5

data/README.md

@@ -61,13 +61,14 @@ rbbeamer compiles .rbt-files into .tex-files. If you want to create your PDF, yo
 
 rbbeamer ist a script written in [Ruby][ruby]. You need a running Ruby-Installation (tested: 1.9.3, 2.0.0p0), most modern operating systems include one. rbbeamer ist developed and tested under Linux - it should run under MAC OS/X and Windows too - but I didn' t test it until now. Drop me a mail if you have additional info.
 
-Creating pictures you will need *graphviz* in your path
+Creating pictures you will need *graphviz* in your path.
 ### Commands
 
-Commands start with a "#" as first char in a line. Every line not starting with # is ignored (so a blank as the first char means: this is a comment). You can use this to specify additional informations not shown on slide or just to decativate a command for testing purposes. The end of a command is defined by line break or seperator-char (default: |)
+Commands start with a "#" as first char in a line. Every line not starting with # is ignored (so a blank as the first char means: this is a comment). You can use this to specify additional informations not shown on slide or just to deactivate a command for testing purposes. The end of a command is defined by line break or seperator-char (default: |)
 
     #sd|<Title Of Presentation> | <Author> | <Date> [ | sources]
-start definition-command: Defines a titlepage with three entities. If you want to use citations with biblatex, just give a fourth option with name of .bib-file (specify without extension), i.e. `#sd| My Title Of Presentation | John Doe | April 2013 | sources`
+start definition-command: Defines a titlepage with three entities. If you want to use citations with biblatex, just give a fourth option with name of .bib-file (specify without extension), i.e. `#sd| My Title Of Presentation | John Doe | April 2013 | sources`. 
+rbbeamer will then try to include a file named `sources.bib`.
 
     #toc [| Agenda | <DEPTH>]
 Table-Of-Content: includes a TOC-page based on defined sections and subsections. Optional: you can specify a title (default: Agenda) and a depth for building TOC (default: 1).
@@ -128,6 +129,9 @@ Using [Graphviz][graphviz]-package you can include pictures into your presentati
     #input|<filename>
 If you have large presentations, sometimes it is easier to use different source-files for different parts. Using `input`-command you can include another .rbt-file into your presentation (and yes, this one also can input a third one and so on).
 
+    #attn
+Using #attn one can mark some slides as very important. This mark is an red triangle at lower left corner (on handouts) or a small blue dot at same corner (on slides, it is only a signal for your talk). 
+
 ### Commandline Options
 Starting rbbeamer at least you will have to specify your .rbt-file to compile. But beside this you can specify a lot of options. Try option `--help` or `-x` to see a short description.
 
@@ -138,6 +142,7 @@ Starting rbbeamer at least you will have to specify your .rbt-file to compile. B
             --handout, -h:   build a handout (no animations in pdf, add _handout
                              to filename)
           --theme, -t <s>:   Beamer-Theme to use (see Beamer-Doc for more info)
+   --handoutcolor, -n <s>:   Colortheme for printing handouts (try DOVE to save ink) (default: default)
                              (default: Luebeck)
           --babel, -b <s>:   Language-option for babel-Package (default: english)
         --backend, -a <s>:   Backend for biblatex setting up references (default:
@@ -153,13 +158,16 @@ Starting rbbeamer at least you will have to specify your .rbt-file to compile. B
                --help, -x:   Show all options (this page)
 
 
-### Config-directory
-During startup rbbeamer tries to find config-dir (Linux: `~/.rbbeamer`). If it doesn't exist, it will be created. You can save some files used by a myjority of your presentations in this dir (i.e. logo-files, bibtex-sources). rbbeamer tries to find this files in this dir, if you didn't specify another directory. In my case, I store my bibtex-sourcefile with all entries I usually cite from in this dir. So I don't have to bother with copies of this file in different directories.
+### Global Config-directory
+During startup rbbeamer tries to find config-dir (Linux: `~/.rbbeamer`). If it doesn't exist, it will be created. You can save some files used by a majority of your presentations in this dir (i.e. logo-files, bibtex-sources). rbbeamer tries to find this files in this dir, if you do not specify another directory. In my case, I store my bibtex-sourcefile with all entries I usually cite from in this dir. So I don't have to bother with copies of this file in different directories.
+
+### Local Config-directory
+In some cases you will prefer configs on a per-project basis. You can now use an additional config-file named `.rbbeamer.conf` in your working dir (where your `rbt-files` are stored. In this file you change perhaps your logo-file to a different one only used in this project. At startup rbbeamer will read global config file first and then tries to read a local config file in your working dir, which will overrule global settings.
 
 ### rbbeamer.conf 
 Nearly all options regarding rbbeamer can be specified in command-line. But most times you don' t change your options. So ist is easier to use a config-file to save them. During startup rbbeamer sets all options to default values. If it finds rbbeamer.conf, options are overriden by those specified in config-file. If you also specified options in command-line, these values will override the former ones.
 
-To create your config-file, just specify all options needed for your work and add `--writeconfigfile (or -w)`. rbbeamer will then create a config (Linux: `~/.rbbeamer/rbbeamer.conf`) to save all options within. Next time just start rbbeamer and specify your .rbt-file. Thats it. You can edit your config-file with any editor.
+To create your global config-file, just specify all options needed for your work and add `--writeconfigfile (or -w)`. rbbeamer will then create a config (Linux: `~/.rbbeamer/rbbeamer.conf`) to save all options within. Next time just start rbbeamer and specify your .rbt-file. Thats it. You can edit your config-file with any editor.
 
     handout = false
     pdf = true
@@ -172,6 +180,7 @@ To create your config-file, just specify all options needed for your work and ad
     logo = rbb_logo
     addpackage =
     theme = Luebeck
+    handoutcolor = dove
     latexpath = 
     latexbinary = pdflatex
     backend = bibtex

data/bin/rbbeamer

@@ -23,11 +23,12 @@ require 'parseconfig.rb'
 require 'open3'
 require 'pathname'
 
-Version = "0.5.4 (2013-05-16)"
+Version = "0.5.5 (2014-02-21)"
 
 sep = '|' # seperator-string to split different parts of a line / command
 SAVESEP = '<-saveThisAsSeperatorForLaterUse->'
 Defaulttheme = 'Luebeck'
+Defaulthandoutcolor = 'default' #'dove'
 DefaultLanguage = 'english'
 Backend = 'bibtex'
 Logofile = 'logo'  # should be .png or .jpg or ...
@@ -77,6 +78,7 @@ intro = <<-'EOF'
 \usepackage{eurosym}
 \usepackage[style=authortitle,backend=/<-KVAR-TBR->/]{biblatex} 
 \usetheme{/<-KVAR-TBR->/}
+\usecolortheme{/<-KVAR-TBR->/}
 \usepackage{tikz}
 \usetikzlibrary{shapes,arrows}
 /<-KVAR-TBR->/
@@ -91,17 +93,32 @@ intro = <<-'EOF'
 \definecolor{red}{rgb}{0.99,0.25,0.5}
 \definecolor{blue}{rgb}{0.1,0.25,0.95}
 \definecolor{green}{rgb}{0.1,0.95,0.1}
-% Usage: \cellcolor{hellgruen}
+% Usage: \cellcolor{grey}
+% placing marks on some pages
+\usepackage{textpos}
+\newcommand{\attn}{
+\mode<handout>{
+\begin{textblock}{1}(-1,6.5)
+\begin{tikzpicture}
+        \draw[line width=2pt,color=red] (7,0)--(8,0)--(7.5,1)--cycle; % triangle on handouts
+\end{tikzpicture}	
+\end{textblock}	
+}
+\mode<beamer>{
+\begin{textblock}{1}(-1,8.5)
+\begin{tikzpicture}
+	\draw[line width=2pt,color=red] (7,0)--(7.1,0); % small dot on slides
+\end{tikzpicture}	
+\end{textblock}
+}
+}
+
 \begin{document}
 \title[{\makebox[.45\paperwidth]{/<-KVAR-TBR->/\hfill%
        \insertframenumber/\inserttotalframenumber}}]{/<-KVAR-TBR->/} 
 \titlegraphic{\includegraphics[height=1.5cm]{/<-LOGOFILE->/}}
 \author{/<-KVAR-TBR->/}
 \date{/<-KVAR-TBR->/} 
-%\setbeamerfont{parent A}{size=\Large}
-%\setbeamerfont{parent B}{size=\small}
-%\setbeamerfont{parent B}{size=\footnotesize}
-%\setbeamerfont{parent Z}{size=\normalsize}
 \logo{\pgfimage[height=0.7cm]{/<-LOGOFILE->/}}
 \frame [plain]{
   \titlepage   
@@ -173,7 +190,7 @@ end
 
 #######################################################################################
 
-fname = File.basename(__FILE__)
+fprgname = File.basename(__FILE__)
 firstname = File.basename(__FILE__,'.*')
 pathname = File.dirname(File.expand_path(__FILE__))
 pathname_lib = Pathname.new(pathname).parent.to_s + '/lib'
@@ -182,20 +199,23 @@ homedir = Dir.home + '/'
 # Config-dir will be:
 ccfg_dir = homedir + '.' + firstname
 Dir.mkdir(ccfg_dir) unless Dir.exists?(ccfg_dir)
-# Configfile will be:
+# global Configfile will be:
 ccfg = ccfg_dir + '/' + firstname + '.conf'
+# additional Configfile could be stored in our working dir as hidden file
+ccfga = '.' + firstname + '.conf'
 
 opts = Trollop::options do
   opt :seperator, "use this pattern as seperator", :type => :string, :default => sep
   opt :logo, "Logo-File (without extension) for slides", :type => :string, :short => 'o', :default => Logofile
   opt :pdf, "Start pdflatex after creating tex-file", :default => false
   opt :handout, "build a handout (no animations in pdf, add _handout to filename)", :default => false
-  opt :theme, "Beamer-Theme to use (see Beamer-Doc for more info)", :type => :string, :default => 'luebeck'
+  opt :handoutcolor, "Colortheme for printing handouts (try DOVE to save ink)", :type => :string, :short => 'n', :default =>  Defaulthandoutcolor
+  opt :theme, "Beamer-Theme to use (see Beamer-Doc for more info)", :type => :string, :default => Defaulttheme
   opt :babel, "Language-option for babel-Package", :type => :string, :short => 'b', :default => DefaultLanguage
   opt :backend, "Backend for biblatex setting up references", :type => :string, :default => Backend
   opt :addpackage, "add latex-packages (i.e. [myoption=true]{testpackage},{otherpackage})", :type => :string, :short => 'a', :default => ''
   opt :configfile, "Use this file as configfile", :short => "c", :default => ccfg
-  opt :deleteworkfiles, "Delete work-files from pdflatex: "+delLatexFiles.join(','), :default => false
+  opt :deleteworkfiles, "Delete workfiles after producing pdf: "+delLatexFiles.join(','), :default => false
   opt :writeconfigfile, "write default config into #{ccfg} (overwrite)", :default => false
   opt :debug, "Start in debugging mode", :default => false
   opt :debugpdf, "Show latex-output during compilation", :default => false
@@ -211,6 +231,7 @@ cfg[:deleteworkfiles] = false
 cfg[:debug] = false
 cfg[:debugpdf] = false
 cfg[:seperator] = sep
+cfg[:handoutcolor] = Defaulthandoutcolor
 cfg[:babel] = DefaultLanguage
 cfg[:logo] = pathname_lib + '/' + Logofile
 cfg[:addpackage] = ''
@@ -220,15 +241,27 @@ cfg[:latexbinary] = DefaultLatexBinary
 cfg[:backend] = Backend
 cfg[:license] = false
 
+#read global Configfile if present:
 if File.exists?(ccfg)
   # Reading Config-File
-  ccfgexist = "  (File exists)"
+  ccfgexist = "  (Global Configfile exists)"
   config = ParseConfig.new(ccfg)
   cfg.keys.each do |k|
     cfg[k] = config[k.to_s] if config.get_params().include?(k.to_s)
   end
 else
-  ccfgexist = "  (File doesn't exist)"
+  ccfgexist = "  (Global Configfile doesn't exist)"
+end
+#read project Configfile if present (these specification will overrule global ones):
+if File.exists?(ccfga)
+  # Reading Config-File
+  ccfgexistL = "  (Local Configfile exists)"
+  config = ParseConfig.new(ccfga)
+  cfg.keys.each do |k|
+    cfg[k] = config[k.to_s] if config.get_params().include?(k.to_s)
+  end
+else
+  ccfgexistL = "  (Local Configfile doesn't exist)"
 end
 
 # Reading options from commandline:
@@ -292,7 +325,6 @@ if ARGV.size <= 0
 end
 
 raise "Please specify only one rbt-file: " + ARGV.join(', ') if ARGV.size > 1
-# puts "Zu bearbeiten: "+ARGV.join(', ')
 filename = sanitize_path(ARGV.first)
 fbasename = File.basename(filename,'.rbt')
 fbasename += '_handout' if cfg[:handout]
@@ -314,6 +346,7 @@ end
 lines.map!{|l| l.gsub(Regexp.new(Regexp.escape('\\'+sep)),SAVESEP)}
 # Any graphviz-pics?
 fh = 1
+fname = ''  # will store our pic-filename
 0.step(lines.size-1) do |n|
   line = lines[n]
   sp = line.split(sep).reverse
@@ -394,9 +427,8 @@ numsfi.reverse!
 textfi.reverse!
 counter = 1 
 
-# only for testing purposes: File.open('ftest.txt','w'){|f| lines.each{|x| f.puts x}}
 File.open(fn,'w') do |out|
-  out.puts "% File created by #{fname}, Version #{Version}"
+  out.puts "% File created by #{fprgname}, Version #{Version}"
   out.puts "% File created at #{Time.now}"
   out.puts "% DO NOT CHANGE MANUALLY, FILE WILL BE OVERWRITTEN\n% "
   counter = 1    # Start every frame empty; after first click first item will appear
@@ -462,7 +494,7 @@ File.open(fn,'w') do |out|
       vorspann = intro_beamer
       vorspann.gsub!('%','/PROZENT!/')
       vorspann.gsub!('/<-KVAR-TBR->/','%s')
-      vorspann = vorspann % [opt_handout,cfg[:babel],cfg[:backend],cfg[:theme],addpackage,bibline,Titel,Titel,Autor,Datum]
+      vorspann = vorspann % [opt_handout,cfg[:babel],cfg[:backend],cfg[:theme],cfg[:handoutcolor],addpackage,bibline,Titel,Titel,Autor,Datum]
       vorspann.gsub!('/<-LOGOFILE->/',cfg[:logo])
       vorspann.gsub!('/PROZENT!/','%')
       out.puts vorspann
@@ -550,6 +582,8 @@ File.open(fn,'w') do |out|
     when '#Fx'
       out.puts '\end{frame}'
       counter = 1
+    when '#attn'  # mark this slide as important (handout)
+      out.puts '\attn'
     else
       raise "(RBB) Error, don't know this command: " + code
     end

data/changes.txt

@@ -1,3 +1,11 @@
+0.5.5:
+ added a solution to marke some slides as very important (see #attn in documentation)
+ modified helptext
+ Configfile .rbbeamer in your config-dir is now called Global Configfile. You can use 
+ a second configfile (local configfile) in every working dir, where you specify special configs
+ only used in this project (perhaps a special logo).
+ Fixed a problem determining the filename of running instance when creating the .tex-file.
+
 0.5.4:
 added new command #bi,#Bi and #bd,#Bd for blocks with itemize or description elements (see Readme)
 added a .chomp after reading a line from rbt-file before processing content
@@ -6,8 +14,10 @@ changes in Latex-header:
  added package colortbl with some colordefs
  added package eurosym
  added new fontsize (Fontvi for tables)
+
 0.5.3:
 fixed a problem in section #{| : Did not restore sep-symbols in tables
+
 0.5.2:
 added error-message in case of missing #fx-frametitle
 fixed problem using #{| to include additional frames

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbbeamer
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-16 00:00:00.000000000 Z
+date: 2014-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &83159470 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *83159470
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: parseconfig
-  requirement: &83159210 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +37,12 @@ dependencies:
         version: 1.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *83159210
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.2
 description: Helps you building beamer-presentations
 email: rbbeamer@gmail.com
 executables:
@@ -67,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: rbbeamer is a preprocessor script for latex-beamer