papyrus 0.0.1 → 0.0.2.beta1

data/HISTORY.rdoc

@@ -0,0 +1,19 @@
+= History of Papyrus
+
+This file describes the most important changes made to Papyrus between
+two releases. For a comprehensive list, see the 
+{source archive}[http://devel.pegasus-alpha.eu/projects/papyrus/repository].
+
+Bug fixes are written in <i>italic</i>, important changes in
+<b>bold</b>.
+
+== 0.0.2
+
+* Much more stable now!
+* <b>Added commandline option <tt>--append-source</tt></b>
+* <b>Added commandline option <tt>--inputencoding</tt></b>
+* <i>Fixed an encoding problem on Windows</i>
+* <b>Switched to XeTeX as the underlying engine instead of
+  pdfLaTeX</b>
+* Fixed handling of verbatim text inside headings and description
+  lists

data/README.rdoc

@@ -14,7 +14,27 @@ cross-reference facilities).
   Version 1.9.2 or greater required.
 * RDoc[http://github.com/rdoc/rdoc], the Ruby documentation tool, version 3.9 or greater.
 * The generator uses LaTeX[http://latex-project.org] to generate the PDF files
-  (pdfLaTeX, to be exact), so you’ll need this as well. LaTeX2e required.
+  (XeLaTeX, to be exact), so you’ll need this as well. LaTeX2e required.
+* In addition to LaTeX itself, the following LaTeX packages need to be
+  installed:
+  * fontspec
+  * xunicode
+  * textcomp
+  * eurosym
+  * lastpage
+  * geometry
+  * fancyhdr
+  * fancyvrb
+  * longtable
+  * xcolor
+  * titlesec
+  * titletoc
+  * hyperref
+  If any of these is missing, you'll get that obscure
+    Invoking xelatex failed with exitstatus 1!
+  message. To see which was the cause for this error, you can
+  pass the <tt>--debug</tt> option to RDoc as in:
+    rdoc -f papyrus --debug WHATEVERYOUWANTTODOCUMENT
 
 == Installation
 
@@ -27,6 +47,7 @@ If you prefer to be on the bleeding edge, clone the sourcecode
 repository and build the gem yourself:
 
   $ git clone http://git.pegasus-alpha.eu/papyrus.git
+  $ git checkout devel
   $ rake gem
   # gem install --local --pre pkg/papyrus-x.y.z
 
@@ -68,8 +89,8 @@ The PDF generator adds some commandline options to RDoc, namely:
   you may turn them off via <tt>--no-show-pages</tt>. Defaults
   to true.
 [<tt>--latex-command</tt>]
-  If your pdfLaTeX’s executable for whatever reason isn’t named
-  +pdflatex+ (the default), you can set the name here.
+  If your XeLaTeX’s executable for whatever reason isn’t named
+  +xelatex+ (the default), you can set the name here.
 [<tt>--babel-lang</tt>]
   If you write your documentation in a language other than English,
   this option may be interesting for you. It specified the option(s)
@@ -80,8 +101,10 @@ The PDF generator adds some commandline options to RDoc, namely:
 
 == Web pages
 
-* The project is hosted here: http://redmine.pegasus-alpha.eu/projects/papyrus
-* Report bugs at: http://redmine.pegasus-alpha.eu/projects/papyrus/issues
+* The project is hosted here: http://devel.pegasus-alpha.eu/projects/papyrus
+* Report bugs at: http://devel.pegasus-alpha.eu/projects/papyrus/issues
+* The Git repository can be seen here: http://devel.pegasus-alpha.eu/projects/papyrus/repository
+* The Git repository is mirrored to GitHub: https://github.com/Quintus/Papyrus
 
 == Known Problems
 
@@ -89,6 +112,27 @@ The PDF generator adds some commandline options to RDoc, namely:
   This is a technical restriction as the complex references this
   template creates confuse LaTeX when used in that places.
 
+== When it crashes
+
+Before you report a bug against Papyrus (see above) you should
+check wheather it's really Papyrus' fault or your setup's. 
+Installing LaTeX can be a tricky task, so make sure everything
+is where it ought to be. You should also try to run rdoc with the
+<tt>--debug</tt> option which will turn on RDoc's and Papyrus'
+debug mode. Using this can cause masses of output, so be prepared.
+Usually you'll find something like
+
+  ! LaTeX error: ...
+
+somewhere in the output--this will tell you what went wrong.
+
+If you're sure you've found some misbehaviour in Papyrus (which
+is totally legit as we're all human beings that tend to make
+mistakes) use the bugtracker pointed to above and include the
+output of a debug run along with your Ruby and RDoc version. 
+Please also attach a description on what you did and (if useful)
+what you expected Papyrus to do.
+
 == Author
 
 This software was written by Marvin Gülker for the German company
@@ -129,4 +173,11 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 As soon as Ruby 1.9.3 final is out, this will be licensed under GPLv3.
 Just in case you wonder why it isn’t that yet, Ruby’s license is at the
 moment not compatible with the GPLv3, but with the upcomming 1.9.3 release, 
-Ruby switches to a BSD-style license which allows this.
+Ruby switches to a BSD-style license which allows this.
+
+=== Font license
+
+The fonts included by Papyrus are copyrighted by Philipp H. Poll
+(http://linuxlibertine.sf.net) and licensed under the Open Font
+license. See the OFL.txt file in the data/fonts directory for more
+information.

data/VERSION.txt

@@ -1 +1 @@
-0.0.1
+0.0.2-beta1

data/data/fonts/OFL.txt

@@ -0,0 +1,98 @@
+This Font Software is Copyright (c) 2003-2006, Philipp H. Poll (http://linuxlibertine.sf.net/).
+All Rights Reserved.
+
+"Linux Libertine" is a Reserved Font Name for this Font Software.
+
+This Font Software is licensed under the SIL Open Font License, Version 1.0.
+No modification of the license is permitted, only verbatim copy is allowed.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.0 - 22 November 2005
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of cooperative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide an open
+framework in which fonts may be shared and improved in partnership with
+others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and sold with any software provided that the font
+names of derivative works are changed. The fonts and derivatives,
+however, cannot be released under any other type of license.
+
+DEFINITIONS
+"Font Software" refers to any and all of the following:
+	- font files
+	- data files
+	- source code
+	- build scripts
+	- documentation
+
+"Reserved Font Name" refers to the Font Software name as seen by
+users and any other names as specified after the copyright statement.
+
+"Standard Version" refers to the collection of Font Software
+components as distributed by the Copyright Holder.
+
+"Modified Version" refers to any derivative font software made by
+adding to, deleting, or substituting -- in part or in whole --
+any of the components of the Standard Version, by changing formats
+or by porting the Font Software to a new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Standard or Modified Versions, may be sold by itself.
+
+2) Standard or Modified Versions of the Font Software may be bundled,
+redistributed and sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s), in part or in whole, unless explicit written permission is
+granted by the Copyright Holder. This restriction applies to all 
+references stored in the Font Software, such as the font menu name and
+other font description fields, which are used to differentiate the
+font from others.
+
+4) The name(s) of the Copyright Holder or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed using this license, and may not be distributed
+under any other license.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

data/data/main.tex.erb

@@ -34,9 +34,8 @@
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \usepackage[<%= babel_lang %>]{babel} %Hyphenation, etc.
-\usepackage[utf8]{inputenc} %Input encoding: UTF-8
-\usepackage[T1]{fontenc} %Output encoding: T1
-\usepackage{lmodern} %Pretty fonts for T1
+\usepackage{fontspec} %XeTeX font selsection made easy
+\usepackage{xunicode} %Correct unicode characters (for searching, etc.)
 \usepackage{textcomp} %Useful things like \textdegree
 \usepackage[official]{eurosym} %Official \euro symbol
 \usepackage{lastpage} %Get a reference on the last page
@@ -46,13 +45,12 @@
 \usepackage{longtable}
 %\usepackage{amsmath} %For math
 %\usepackage{amsfonts} %Math fonts
-%\usepackage[retainorgcmds]{IEEEtrantools} %For equations
-%\usepackage{listings} %Syntax hightlighting
+\usepackage{listings} %Syntax hightlighting
 \usepackage{xcolor} %Colored text
 %\usepackage{graphicx} %Graphics
 \usepackage{titlesec} %Easily define new heading styles
 \usepackage{titletoc} %For telling LaTeX where to put the new headings in the TOC
-\usepackage[unicode=true,pdftex]{hyperref} %For hyperlinks
+\usepackage[xetex]{hyperref} %For hyperlinks
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 % General information
@@ -139,6 +137,30 @@
 \setlength{\headheight}{14.5pt} %Otherwise LaTeX complains
 \renewcommand{\headrulewidth}{0.4pt}
 
+% fontspec
+\setmainfont[Path = <%= FONT_DIR %>/,
+UprightFont       = *_R,
+BoldFont          = *_RB,
+ItalicFont        = *_RI,
+%SmallCapsFont     = *_aS, %This gives "Metric (TFM) file or installed font not found."
+BoldItalicFont    = *_RBI]{LinLibertine}
+
+\setsansfont[Path = <%= FONT_DIR %>/,
+UprightFont       = *_R,
+BoldFont          = *_RB,
+ItalicFont        = *_RI,
+SmallCapsFont     = *_aS,
+BoldItalicFont    = *_aBL]{LinBiolinum} % Yes, I know, but there is no
+                                        % _RBI for Biolinum
+
+% lstlistings
+\lstset{
+  basicstyle=\ttfamily\small,       %Monospaced sourecode, small
+  showstringspaces=false,           %Suppress marking spaces in strings
+  keywordstyle=\color{olive},       %Green keywords
+  commentstyle=\itshape\color{gray} %Grey and italic comments
+}
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 % Document start
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -179,8 +201,33 @@
 \clearpage
 
 \section{Class and module reference}
-<% @classes_and_modules.each do |mod| %>
+%<% @classes_and_modules.each do |mod| %>
   \input{<%= render_module(mod) %>}\clearpage %Always start a new page for a new class/module
-<% end %>
+%<% end %>
+
+%<% if @options.append_source %>
+  \appendix
+  \section{Sourcecode}
+  
+  Following is the sourcode of all the methods that have been
+  documented, sorted as follows:
+  
+  \begin{enumerate}
+  \item Classes and modules are sorted alphabetically.
+  \item Class/module methods go before instance methods.
+  \item The methods are sorted alphabetically.
+  \end{enumerate}
+  
+% <% @classes_and_modules.each do |mod| %>
+    \subsection{<%= mod.latexized(:full_name) %>}
+
+%   <% mod.method_list.sort.each do |meth| %>
+      \method{<%= meth.latexized(:pretty_name) %>}
+      \begin{lstlisting}[language=<%= meth.c_function ? "c" : "ruby" %>]
+      <%= meth.tokens_to_s rescue "NOT FOUND" %>
+      \end{lstlisting}
+%   <% end %>
+% <% end %>
+%<% end %>
 
 \end{document}

data/data/module.tex.erb

@@ -53,7 +53,7 @@
 %  <% consts.each do |const| %>
 \label{<%= const.latex_label %>}%
 \small{\code{<%= const.latexized :name %>}} & %
-\small{\code{<%= const.latexized_value %>}} & %
+\small{\code{<%= const.latexized_value.delete("\n") %>}} & %
 <%= const.description %> \\
 & & \\ %Empty row for readability
 %  <%  end %>

data/lib/rdoc/generator/latex_markup.rb

@@ -28,6 +28,22 @@
 #would therefore take precedence during method lookup.
 module RDoc::Generator::LaTeX_Markup
 
+  #Special escapes to be used inside the hyperref labels
+  #(hyperref doesn't accept the normal escapes correctly
+  #or not at all (in case of _ -> \_). A hash of form:
+  #  "char" => "escape"
+  LABEL_ESCAPE = {
+    "#" => ":INST:",
+    "%" => ":perc:",
+    "^" => ":xor:",
+    "&" => ":amp:",
+    "_" => ":und:",
+    "~" => ":tilde:",
+    "[" => ":rbracket:",
+    "]" => ":lbracket:",
+    "=" => ":equal:"
+  }.freeze
+  
   #Create an unique label for this CodeObject.
   #==Return value
   #A string (hopefully) uniquely identifying this CodeObject. Intended for
@@ -36,9 +52,9 @@ module RDoc::Generator::LaTeX_Markup
   #[PapyrusError] +self+ isn’t a CodeObject (→ Context::Section).
   def latex_label
     case self
-    when RDoc::Context then "class-module-#{full_name}"
-    when RDoc::MethodAttr then "method-attr-#{full_name.gsub('#', '+')}" # '#' doesn’t work in references
-    when RDoc::Constant then "const-#{parent.full_name}::#{name}"
+    when RDoc::Context then "class-module-#{label_escape(full_name)}"
+    when RDoc::MethodAttr then "method-attr-#{label_escape(full_name)}"
+    when RDoc::Constant then "const-#{label_escape(parent.full_name)}::#{label_escape(name)}"
     else
       raise(RDoc::Generator::Papyrus::PapyrusError, "Unrecognized token: #{self.inspect}!")
     end
@@ -73,6 +89,7 @@ module RDoc::Generator::LaTeX_Markup
 
     @formatter = RDoc::Markup::ToLaTeX_Crossref.new(self.kind_of?(RDoc::Context) ? self : @parent, #Thanks to RDoc for this
                                                     current_heading_level,
+                                                    RDoc::RDoc.current.options.inputencoding,
                                                     RDoc::RDoc.current.options.show_hash,
                                                     RDoc::RDoc.current.options.show_pages,
                                                     RDoc::RDoc.current.options.hyperlink_all)
@@ -93,6 +110,19 @@ module RDoc::Generator::LaTeX_Markup
       0
     end
   end
+
+  private
+
+  #Uses the LABEL_ESCAPE hash to replace all necessary characters
+  #in +str+ and returns the result.
+  def label_escape(str)
+    res = str.dup
+    LABEL_ESCAPE.each_pair do |char, esc|
+      res.gsub!(char, esc)
+    end
+    res
+  end
+  
 end
 
 #FIXME:

data/lib/rdoc/generator/papyrus.rb

@@ -72,17 +72,22 @@ class RDoc::Generator::Papyrus
   #Description displayed in RDoc’s help.
   DESCRIPTION = "PDF generator based on LaTeX"
 
+  #Root directory of this project.
+  ROOT_DIR = Pathname.new(__FILE__).dirname.parent.parent.parent
+  
   #The version number.
-  VERSION = Pathname.new(__FILE__).dirname.parent.parent.parent.join("VERSION.txt").read.chomp.freeze
+  VERSION = ROOT_DIR.join("VERSION.txt").read.chomp.freeze
   
   #Directory where the LaTeX template files are stored.
-  TEMPLATE_DIR = Pathname.new(__FILE__).dirname.expand_path.join("..", "..", "..", "data")
+  DATA_DIR = ROOT_DIR + "data"
+  #Directory where the internal fonts are stored.
+  FONT_DIR = DATA_DIR + "fonts"
   #The main file’s ERB template.
-  MAIN_TEMPLATE = ERB.new(TEMPLATE_DIR.join("main.tex.erb").read)
+  MAIN_TEMPLATE = ERB.new(File.open(DATA_DIR.join("main.tex.erb"), "r:UTF-8"){|f| f.read})
   #The ERB template for a single file.
-  RDOC_FILE_TEMPLATE = ERB.new(TEMPLATE_DIR.join("rdoc_file.tex.erb").read)
+  RDOC_FILE_TEMPLATE = ERB.new(File.open(DATA_DIR.join("rdoc_file.tex.erb"), "r:UTF-8"){|f| f.read})
   #The ERB template for a single class or module.
-  MODULE_TEMPLATE = ERB.new(TEMPLATE_DIR.join("module.tex.erb").read)
+  MODULE_TEMPLATE = ERB.new(File.open(DATA_DIR.join("module.tex.erb"), "r:UTF-8"){|f| f.read})
 
   #Basename of the main resulting LaTeX file. The path is prepended
   #later as it’s a temporary directory.
@@ -91,32 +96,6 @@ class RDoc::Generator::Papyrus
   #temporary directory.
   MAIN_FILE_RESULT_BASENAME = "main.pdf"
 
-  #Creates a new instance of this class. Automatically called by RDoc.
-  #There shouldn’t be any need for you to call this.
-  #==Parameter
-  #[options] RDoc passes the current RDoc::Options instance here.
-  #==Return value
-  #The newly created instance.
-  def initialize(options)
-    #The requiring of the rest of the library *must* be placed here,
-    #because otherwise it’s loaded during RDoc’s discovering process,
-    #effectively eliminating the possibility to generate anything
-    #other than LaTeX output due to the overwrites the
-    #RDoc::Generator::LaTeX_Markup module does.
-    require_relative "../markup/to_latex_crossref"
-    require_relative "latex_markup"
-    
-    @options = options
-    @output_dir = Pathname.pwd.expand_path + @options.op_dir
-    #The following variable is used to generate unique filenames.
-    #During processing the ERB templates, many files are created and
-    #accidentally creating two files with the same name, effectively
-    #overwriting the previous one, should be avoided. Hence, this
-    #little number is prepended to generated filenames (except the
-    #main file).
-    @counter = 0
-  end
-
   class << self
 
     #Called by RDoc during option processing. Adds commandline
@@ -128,19 +107,34 @@ class RDoc::Generator::Papyrus
       #Define the methods to get and set the options
       options.extend(RDoc::Generator::Papyrus::Options)
 
+      options.option_parser.separator ""
+      options.option_parser.separator "Papyrus generator options:"
+      options.option_parser.separator ""
+
       #Define the options themselves
-      options.option_parser.on("--[no-]show-pages", "(pdf_latex) Enables or disables page", "numbers following hyperlinks (default true).") do |val|
+      options.option_parser.on("--[no-]show-pages", "Enables or disables page", "numbers following hyperlinks (default true).") do |val|
         debug("Found --show-pages: #{val}")
         options.show_pages = val
       end
-      options.option_parser.on("--latex-command=VALUE", "(pdf_latex) Sets the command to run", "LaTeX (defaults to '#{RDoc::Generator::Papyrus::Options::DEFAULT_LATEX_COMMAND}')") do |val|
+      options.option_parser.on("--latex-command=VALUE", " Sets the command to run", "LaTeX (defaults to '#{RDoc::Generator::Papyrus::Options::DEFAULT_LATEX_COMMAND}')") do |val|
         debug("Found --latex-command: #{val}")
         options.latex_command = val
       end
-      options.option_parser.on("--babel-lang=VALUE", "(pdf_latex) Sets the language option", "for babel (defaults to '#{RDoc::Generator::Papyrus::Options::DEFAULT_BABEL_LANG}')") do |val|
+      options.option_parser.on("--babel-lang=VALUE", "Sets the language option", "for babel (defaults to '#{RDoc::Generator::Papyrus::Options::DEFAULT_BABEL_LANG}')") do |val|
         debug("Found --babel-lang: #{val}")
         options.babel_lang = val
       end
+
+      options.option_parser.on("--inputencoding", "Sets the encoding used for the input files.", "Defaults to '#{RDoc::Generator::Papyrus::Options::DEFAULT_INPUT_ENCODING}'.") do |val|
+        debug("Found --inputencoding: #{val}")
+        options.inputencoding = val
+      end
+
+      options.option_parser.on("--[no-]append-source",
+                               "If set, the sourcecode of all methods is included", 
+                               "as an appendix (warning: HUGE PDF", 
+                               "files can be the result! Default: false."){|val| options.append_source = val}
+
     end
 
     private
@@ -158,6 +152,32 @@ class RDoc::Generator::Papyrus
 
   end
 
+  #Creates a new instance of this class. Automatically called by RDoc.
+  #There shouldn’t be any need for you to call this.
+  #==Parameter
+  #[options] RDoc passes the current RDoc::Options instance here.
+  #==Return value
+  #The newly created instance.
+  def initialize(options)
+    #The requiring of the rest of the library *must* be placed here,
+    #because otherwise it’s loaded during RDoc’s discovering process,
+    #effectively eliminating the possibility to generate anything
+    #other than LaTeX output due to the overwrites the
+    #RDoc::Generator::LaTeX_Markup module does.
+    require_relative "../markup/to_latex_crossref"
+    require_relative "latex_markup"
+    
+    @options = options
+    @output_dir = Pathname.pwd.expand_path + @options.op_dir
+    #The following variable is used to generate unique filenames.
+    #During processing the ERB templates, many files are created and
+    #accidentally creating two files with the same name, effectively
+    #overwriting the previous one, should be avoided. Hence, this
+    #little number is prepended to generated filenames (except the
+    #main file).
+    @counter = 0
+  end
+
   #Called by RDoc after parsing has happened in order to generate the output.
   #This method takes the input of RDoc::TopLevel objects and tranforms
   #them by means of the RDoc::Markup::ToLaTeX_Crossref class into LaTeX
@@ -173,8 +193,10 @@ class RDoc::Generator::Papyrus
     debug("Found #{@rdoc_files.count} toplevels ending in .rdoc that will be processed")
     if @options.main_page #nil if not set, no main page
       main_index = @rdoc_files.index{|t| t.full_name == @options.main_page}
-      @rdoc_files.unshift(@rdoc_files.slice!(main_index))
-      debug("Main page is #{@rdoc_files.first.name}")
+      if main_index #nil if invalid main_page given
+        @rdoc_files.unshift(@rdoc_files.slice!(main_index))
+        debug("Main page is #{@rdoc_files.first.name}")
+      end
     end
 
     #Get the class, module and methods lists, sorted alphabetically by their full names
@@ -229,8 +251,10 @@ class RDoc::Generator::Papyrus
     #Remove the temporary directory (this is *not* done if invoking LaTeX
     #failed, as the #latex method throws an exception. This is useful for
     #debugging the generated LaTeX files)
-    debug("Removing temporary directory")
-    temp_dir.rmtree unless @options.dry_run
+    unless $DEBUG_RDOC
+      debug("Removing temporary directory")
+      temp_dir.rmtree unless @options.dry_run
+    end
   end
 
   private
@@ -321,7 +345,7 @@ class RDoc::Generator::Papyrus
   #a \hyperref to it if possible. Otherwise just returns +obj+.
   def superclass_string(obj)
     if obj.kind_of?(String)
-      obj
+      RDoc::Markup::ToLaTeX.new.escape(obj) #HACK, \verb doesn't do the trick here
     else
       hyperref(obj.latex_label, obj.latexized(:full_name))
     end
@@ -333,6 +357,7 @@ class RDoc::Generator::Papyrus
     table_str = ""
     table_str << "\\small"
     table_str << "\\begin{longtable}{l|l|l|l|l|l}\n"
+    #table_str << "\\begin{longtable}{p{0.1666\\textwidth}|p{0.1666\\textwidth}|p{0.1666\\textwidth}|p{0.1666\\textwidth}|p{0.1666\\textwidth}|p{0.1666\\textwidth}}\n"
     table_str << "  \\bfseries Name & \\bfseries p & \\bfseries Name & \\bfseries p & \\bfseries Name & \\bfseries p \\\\\n"
     table_str << "  \\hline\n"
     table_str << "\\endhead\n"

data/lib/rdoc/generator/papyrus/options.rb

@@ -35,12 +35,15 @@ module RDoc
         #The default command invoked when running LaTeX.
         #Overriden by the <tt>--latex-command</tt> commandline
         #option.
-        DEFAULT_LATEX_COMMAND = "pdflatex"
+        DEFAULT_LATEX_COMMAND = "xelatex"
 
         #The default language option passed to the LaTeX +babel+
         #package.
         DEFAULT_BABEL_LANG = "english"
         
+        #The default encoding for the <tt>--inputencoding</tt> option.
+        DEFAULT_INPUT_ENCODING = "UTF-8"
+
         #Wheather or not to show page numbers in square
         #brackets behind any cross-reference made. Useful
         #if one is sure that the documentation won’t be printed
@@ -77,7 +80,33 @@ module RDoc
         def babel_lang=(val)
           @babel_lang = val
         end
+
+        #The encoding assumed for *all* the input files. Defautls to "UTF-8".
+        def inputencoding
+          @inputencoding ||= DEFAULT_INPUT_ENCODING
+        end
+
+        #Setter for the #inputencoding value.
+        def inputencoding=(val)
+          @inputencoding = val
+        end
+
+        #Wheather or not to include the methods' sourcecode in the
+        #PDF file in form of an appendix. I highly recommand you to
+        #not do this as the bigger a project grows, the thicker the
+        #resulting PDF will be. Furthermore printing the PDF would
+        #resulting in printing the sourcecode which is nonsense as
+        #you're better off directly looking into the sourcecode files
+        #with your favourite editor where you can edit them.
+        def append_source
+          @append_source ||= false
+        end
         
+        #Stter for the #append_source value.
+        def append_source=(val)
+          @append_source = val
+        end
+
       end
 
     end

data/lib/rdoc/markup/to_latex.rb

@@ -26,7 +26,7 @@ require "rdoc/markup/inline"
 
 #This is an RDoc Converter/Formatter that turns the RDoc
 #markup into LaTeX code. It’s intended for use with
-#the RDoc::Generator::PDF_LaTeX class, but if you like you
+#the RDoc::Generator::Papyrus class, but if you like you
 #can use it on it’s own (but note this class absolutely
 #depends on RDoc’s parser). To use it, you first have
 #to instanciate this class, and then call the #convert method
@@ -176,6 +176,15 @@ class RDoc::Markup::ToLaTeX < RDoc::Markup::Formatter
                     "\\subparagraph*{%s}",       #Needed??
                     "%s", "%s", "%s", "%s", "%s", "%s"].freeze #Everything below is just ignored.
 
+  #LaTeX heading commands for headings with an optional
+  #argument to change the TOC entry. Just reach till level 4,
+  #because lower headings don’t show up in the TOC at all.
+  LATEX_OPT_HEADINGS = [nil,
+                        "\\section[%s]{%s}",
+                        "\\subsection[%s]{%s}",
+                        "\\subsubsection[%s]{%s}",
+                        "\\subsubsubsection[%s]{%s}"
+                        ]
   #Characters that need to be escaped for LaTeX and their
   #corresponding escape sequences. Note the order if important,
   #otherwise some things (especiallaly \ and {}) are escaped
@@ -190,7 +199,7 @@ class RDoc::Markup::ToLaTeX < RDoc::Markup::Formatter
     /(?<!textbackslash){/  => "\\{",
     /(?<!textbackslash{)}/ => "\\}",
     /_/     => "\\textunderscore{}",
-    /\.{3}/ => "\\ldots",
+    /\.{3}/ => "\\ldots{}",
     /~/     => "\\~",
     /©/     => "\\copyright{}",
     /LaTeX/ => "\\LaTeX{}"
@@ -222,10 +231,11 @@ class RDoc::Markup::ToLaTeX < RDoc::Markup::Formatter
   #==Remarks
   #Some lines of this method have their origin in the RDoc project. See
   #the code for more details.
-  def initialize(heading_level = 0, markup = nil)
+  def initialize(heading_level = 0, inputencoding = "UTF-8", markup = nil)
     super(markup)
     
     @heading_level = heading_level
+    @inputencoding = "UTF-8"
     @result = ""
     @list_in_progress = nil
     
@@ -235,7 +245,7 @@ class RDoc::Markup::ToLaTeX < RDoc::Markup::Formatter
 
     #Add definitions for inline markup
     add_tag(:BOLD, "\\textbf{", "}")
-    add_tag(:TT, "\\texttt{", "}")
+    add_tag(:TT, "\\verb~", "~")
     add_tag(:EM, "\\textit{", "}")
   end
   
@@ -255,12 +265,12 @@ class RDoc::Markup::ToLaTeX < RDoc::Markup::Formatter
 
   #Adds par’s text plus newline to the result.
   def accept_paragraph(par)
-    @result << to_latex(par.text) << "\n"
+    @result << to_latex(enc(par.text)) << "\n"
   end
 
   #Puts ver’s text between \begin{verbatim} and \end{verbatim}
   def accept_verbatim(ver)
-    @result << "\\begin{Verbatim}\n" << ver.text.chomp << "\n\\end{Verbatim}\n"
+    @result << "\\begin{Verbatim}\n" << enc(ver.text).chomp << "\n\\end{Verbatim}\n"
   end
 
   #Adds a \rule. The rule’s height is <tt>rule.weight</tt> pt, the
@@ -284,11 +294,14 @@ class RDoc::Markup::ToLaTeX < RDoc::Markup::Formatter
   #Adds \item[label_if_necessary].
   def accept_list_item_start(item)
     if item.label
+      #Verbatim inside list labels is dangerous!
+      hsh = save_verbs(enc(item.label))
+      @result << hsh[:save_verbs]
       
       if @list_in_progress == :NOTE
-        @result << "\\item[#{to_latex_suppress_crossref(item.label)}:] " #Newline done by ending paragraph
+        @result << "\\item[#{hsh[:save_inline]}:] " #Newline done by ending paragraph
       else
-        @result << "\\item[#{to_latex_suppress_crossref(item.label)}] " #Newline done by ending paragraph
+        @result << "\\item[#{hsh[:save_inline]}] " #Newline done by ending paragraph
       end
     else
       @result << "\\item " #Newline done by ending method
@@ -310,7 +323,22 @@ class RDoc::Markup::ToLaTeX < RDoc::Markup::Formatter
 
   #Adds a fitting \section, \subsection, etc. for the heading.
   def accept_heading(head)
-    @result << sprintf(LATEX_HEADINGS[@heading_level + head.level], to_latex_suppress_crossref(head.text)) << "\n"
+    #Verbatim text inside headings is one of LaTeX’s ways to hell.
+    #We need to take special care of this by means of fancyvrb’s
+    #\SaveVerb command plus suppressing the verbatim inside the TOC.
+    hsh = save_verbs(enc(head.text))
+    
+    if hsh[:save_verbs].empty?
+      @result << sprintf(LATEX_HEADINGS[@heading_level + head.level], hsh[:save_inline]) << "\n"
+    else #OK, some fool must have verbatim in the heading...
+      @result << hsh[:save_verbs]
+      heading = LATEX_OPT_HEADINGS[@heading_level + head.level]
+      if heading
+        @result << sprintf(heading, hsh[:plain_inline], hsh[:save_inline]) << "\n"
+      else #Heading not in TOC
+        @result << sprintf(LATEX_HEADINGS[@heading_level + head.level], hsh[:save_inline]) << "\n"
+      end
+    end
   end
 
   #Writes the raw thing as-is into the document. 
@@ -326,14 +354,18 @@ class RDoc::Markup::ToLaTeX < RDoc::Markup::Formatter
   #Called for each plaintext string in a paragraph by
   #the #convert_flow method called in #to_latex.
   def convert_string(str)
-    escape(str)
+    if in_tt?
+      enc(str)
+    else
+      escape(enc(str))
+    end
   end
   
   #Method copied from RDoc project and slightly modified.
   #
   #Handles hyperlinks of form {text}[url] and text[url].
   def handle_special_TIDYLINK(special)
-    text = special.text
+    text = enc(special.text)
 
     return escape(text) unless text =~ /\{(.*?)\}\[(.*?)\]/ or text =~ /(\S+)\[(.*?)\]/
 
@@ -367,7 +399,7 @@ class RDoc::Markup::ToLaTeX < RDoc::Markup::Formatter
   #as #to_latex, except it’ll never rely on subclasses such
   #as ToLaTeX_Crossref.
   def to_latex_suppress_crossref(item)
-    RDoc::Markup::ToLaTeX.new(@heading_level).instance_eval do
+    RDoc::Markup::ToLaTeX.new(@heading_level, @inputencoding).instance_eval do
       convert_flow(@am.flow(item))
     end
   end
@@ -394,6 +426,47 @@ class RDoc::Markup::ToLaTeX < RDoc::Markup::Formatter
       "\\url{#{url}}"
     end
   end
+
+  #Finds all \verb commands in +text+ and replaces them with
+  #fancyvrb’s super-secure \SaveVerb-\UseVerb mechanism. Returns
+  #a hash of form
+  #  {:save_verbs => str1, :save_inline => str2, :plain_inline => str3}
+  #where the :save_inline string contains \UseVerb commands
+  #making use of the \SaveVerb commands issued in the
+  #:save_verbs string (the latter being empty if no replacements
+  #were made). If replacements were made, :save_verbs ends in a
+  #newline character.
+  #
+  #+text+ is automatically markup up, but without cross-references,
+  #because where \verb is fragile, cross-references usually are as well.
+  #
+  #:plain_inline contains the marked-up string with all \verb commands
+  #just removed and replaced with their (LaTeX-escaped) text.
+  def save_verbs(text)
+    @save_verb_index ||= 0 #Variable just used for this method
+    saves  = ""
+    inline = to_latex_suppress_crossref(text)
+
+    save_inline = inline.gsub(/\\verb~(.*?)~/) do
+      saves << "\\SaveVerb{verb#{@save_verb_index}}~#$1~\n"
+      str = "\\protect\\UseVerb{verb#{@save_verb_index}}"
+      @save_verb_index += 1
+      str #for gsub
+    end
+
+    {:save_verbs => saves, :save_inline => save_inline, :plain_inline => inline.gsub(/\\verb~(.*?)~/){escape($1)}}
+  end
+
+  #Takes +str+, makes a copy and forces the copy to the previously
+  #given @inputencoding. Then encodes the string into UTF-8 and returns it.
+  #
+  #This method exists, since RDoc always assumes the system encoding and
+  #assignes that to the strings passed to the visitor.
+  def enc(str)
+    s = str.dup
+    s.force_encoding(@inputencoding)
+    return s if @inputencoding == "UTF-8"
+    s.encode("UTF-8")
+  end
   
 end
-

data/lib/rdoc/markup/to_latex_crossref.rb

@@ -56,8 +56,8 @@ class RDoc::Markup::ToLaTeX_Crossref < RDoc::Markup::ToLaTeX
   #The newly created instance.
   #==Example
   #  f = RDoc::Markup::ToLaTeX_Crossref.new(a_rdoc_toplevel, false)
-  def initialize(context, heading_level = 0, show_hash = false, show_pages = true, hyperlink_all = false, markup = nil)
-    super(heading_level, markup)
+  def initialize(context, heading_level = 0, inputencoding = "UTF-8", show_hash = false, show_pages = true, hyperlink_all = false, markup = nil)
+    super(heading_level, inputencoding, markup)
 
     @context           = context
     @show_hash         = show_hash
@@ -107,16 +107,16 @@ class RDoc::Markup::ToLaTeX_Crossref < RDoc::Markup::ToLaTeX
     #we won’t resolve all-lowercase words (which may be false
     #positives not meant to be a reference).
     if !@hyperlink_all and special.text =~ /^[a-z]+$/
-      return escape(special.text)
+      return escape(enc(special.text))
     end
 
-    make_crossref(special.text)
+    make_crossref(enc(special.text))
   end
 
   #Adds handling of encountered <tt>rdoc-ref</tt> links
   #to the HYPERLINK handler of the ToLaTeX formatter.
   def handle_special_HYPERLINK(special)
-    return make_crossref($') if special.text =~ /^rdoc-ref:/
+    return make_crossref($') if enc(special.text) =~ /^rdoc-ref:/
     super
   end
   

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: papyrus
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2.beta1
+  prerelease: 6
 platform: ruby
 authors:
 - Marvin Gülker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-17 00:00:00.000000000Z
+date: 2011-10-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &15986840 !ruby/object:Gem::Requirement
+  requirement: &28407160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.9.1
   type: :runtime
   prerelease: false
-  version_requirements: *15986840
+  version_requirements: *28407160
 - !ruby/object:Gem::Dependency
   name: hanna-nouveau
-  requirement: &15986360 !ruby/object:Gem::Requirement
+  requirement: &28406740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15986360
+  version_requirements: *28406740
 description: ! 'Papyrus is a PDF generator plugin for RDoc based on LaTeX. It
 
   allows you to turn your project''s documentation into a nice PDF file
@@ -47,15 +47,27 @@ extra_rdoc_files:
 - README.rdoc
 - COPYING
 files:
-- data/module.tex.erb
 - data/main.tex.erb
 - data/rdoc_file.tex.erb
-- lib/rdoc/markup/to_latex.rb
+- data/fonts/LinBiolinum_RB.otf
+- data/fonts/LinBiolinum_RI.otf
+- data/fonts/LinLibertine_RB.otf
+- data/fonts/LinBiolinum_R.otf
+- data/fonts/LinLibertine_RBI.otf
+- data/fonts/OFL.txt
+- data/fonts/LinLibertine_R.otf
+- data/fonts/LinBiolinum_aS.otf
+- data/fonts/LinLibertine_RI.otf
+- data/fonts/LinBiolinum_aBL.otf
+- data/fonts/LinLibertine_aS.otf
+- data/module.tex.erb
 - lib/rdoc/markup/to_latex_crossref.rb
-- lib/rdoc/discover.rb
-- lib/rdoc/generator/papyrus/options.rb
+- lib/rdoc/markup/to_latex.rb
 - lib/rdoc/generator/latex_markup.rb
 - lib/rdoc/generator/papyrus.rb
+- lib/rdoc/generator/papyrus/options.rb
+- lib/rdoc/discover.rb
+- HISTORY.rdoc
 - README.rdoc
 - VERSION.txt
 - COPYING
@@ -78,13 +90,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements:
 - ! '(pdf)LaTeX2e: For the actual PDF generation.'
 rubyforge_project: 
-rubygems_version: 1.8.8
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: PDF generator plugin for RDoc, based on LaTeX