site/content/images/icons/api.png @@ -1,9 +1,8 @@ = RTeX: TeX/PDF Generation for Ruby -Project homepage: http://rtex.rubyforge.org +Project homepage (FAQ, manual, documentation, contact info): http://rtex.rubyforge.org -Please file comments and bug reports at http://rubyforge.org/projects/rtex -(in the Forum and the Tracker, respectively). +Source repository at: http://github.com/bruce/rtex == Dependencies README.rdoc @@ -12,6 +12,9 @@ PROJ.libs = %w[] PROJ.ruby_opts = [] PROJ.test_opts = [] +PROJ.rdoc_main = 'README.rdoc' +PROJ.rdoc_include.push 'README.rdoc', 'README_RAILS.rdoc' + PROJ.description = "LaTeX preprocessor for PDF generation; Rails plugin" PROJ.summary = PROJ.description Rakefile @@ -4,25 +4,29 @@ require 'document' require 'version' module RTeX - + + # Load code to initialize RTeX for framework def self.framework(name) require File.dirname(__FILE__) << "/rtex/framework/#{name}" framework = ::RTeX::Framework.const_get(name.to_s.capitalize) framework.setup end + def self.filters #:nodoc: + @filters ||= {} + end + def self.basic_layout #:nodoc: "\\documentclass[12pt]{article}\n\\begin{document}\n<%= yield %>\n\\end{document}" end + # Define a processing filter + # call-seq: + # filter(:name) { |text_to_transform| ... } # => result def self.filter(name, &block) filters[name.to_s] = block end - def self.filters #:nodoc: - @filters ||= {} - end - filter :textile do |source| require File.dirname(__FILE__) << '/../vendor/instiki/redcloth_for_tex' RedClothForTex.new(source).to_tex lib/rtex.rb @@ -16,12 +16,17 @@ module RTeX class GenerationError < ::StandardError; end class ExecutableNotFoundError < ::StandardError; end + # Default options + # [+:preprocess+] Are we preprocessing? Default is +false+ + # [+:preprocessor+] Executable to use during preprocessing (generating TOCs, etc). Default is +latex+ + # [+:shell_redirect+] Option redirection for shell output (eg, +"> /dev/null 2>&1"+ ). Default is +nil+. + # [+:tmpdir+] Location of temporary directory (default: +Dir.tmpdir+) def self.options @options ||= { :preprocessor => 'latex', :preprocess => false, :processor => 'pdflatex', - # Option redirection for shell output (eg, set to '> /dev/null 2>&1' ) + # :shell_redirect => nil, # Temporary Directory :tempdir => Dir.tmpdir @@ -37,13 +42,15 @@ module RTeX end end - def source(binding=nil) + # Get the source for the entire + def source(binding=nil) #:nodoc: @source ||= wrap_in_layout do filter @erb.result(binding) end end - def filter(text) + # Process through defined filter + def filter(text) #:nodoc: return text unless @options[:filter] if (process = RTeX.filters[@options[:filter]]) process[text] @@ -52,7 +59,8 @@ module RTeX end end - def wrap_in_layout + # Wrap content in optional layout + def wrap_in_layout #:nodoc: if @options[:layout] ERB.new(@options[:layout]).result(binding) else @@ -60,19 +68,23 @@ module RTeX end end + # Generate PDF from + # call-seq: + # to_pdf # => PDF in a String + # to_pdf { |filename| ... } def to_pdf(binding=nil, &file_handler) process_pdf_from(source(binding), &file_handler) end - def processor + def processor #:nodoc: @processor ||= check_path_for @options[:processor] end - def preprocessor + def preprocessor #:nodoc: @preprocessor ||= check_path_for @options[:preprocessor] end - def system_path + def system_path #:nodoc: ENV['PATH'] end @@ -80,6 +92,7 @@ module RTeX private ####### + # Verify existence of executable in search path def check_path_for(command) unless FileTest.executable?(command) || system_path.split(":").any?{ |path| FileTest.executable?(File.join(path, command))} raise ExecutableNotFoundError, command @@ -87,6 +100,7 @@ module RTeX command end + # Basic processing def process_pdf_from(input, &file_handler) Tempdir.open(@options[:tempdir]) do |tempdir| prepare input @@ -103,7 +117,7 @@ module RTeX end end - def process! #:nodoc: + def process! unless `#{processor} --interaction=nonstopmode '#{source_file}' #{@options[:shell_redirect]}` raise GenerationError, "Could not generate PDF using #{processor}" end lib/rtex/document.rb @@ -2,12 +2,14 @@ module RTeX module Escaping + # Escape text using +replacements+ def escape(text) replacements.inject(text) do |corpus, (pattern, replacement)| corpus.gsub(pattern, replacement) end end + # List of replacements def replacements @replacements ||= [ [/([{}])/, '\\\1'], lib/rtex/escaping.rb @@ -1,8 +1,8 @@ module RTeX - module Framework + module Framework #:nodoc: - module Merb + module Merb #:nodoc: # TODO lib/rtex/framework/merb.rb @@ -1,8 +1,8 @@ require 'tempfile' module RTeX - module Framework - module Rails + module Framework #:nodoc: + module Rails #:nodoc: def self.setup RTeX::Document.options[:tempdir] = File.expand_path(File.join(RAILS_ROOT, 'tmp')) lib/rtex/framework/rails.rb @@ -2,7 +2,7 @@ require 'fileutils' module RTeX - class Tempdir + class Tempdir #:nodoc: def self.open(parent_path=RTeX::Document.options[:tempdir]) tempdir = new(parent_path) lib/rtex/tempdir.rb @@ -63,12 +63,10 @@ module RTeX [@major, @minor, @tiny] end - MAJOR = 1 - MINOR = 99 + MAJOR = 2 + MINOR = 0 TINY = 0 - DESCRIPTION = '2.0 Preview 1' - # The current version as a Version instance CURRENT = new(MAJOR, MINOR, TINY) # The current version as a String lib/rtex/version.rb @@ -68,7 +68,7 @@ pre.dawn span.EmbeddedSource { #content dl dt { font-weight: normal; background: #e6e6e6; padding: 4px; margin-top: 0.5em; margin-bottom: 0.25em; } -<% %w(contact contribute download faq manual roadmap).each do |type| %> +<% %w(contact contribute download faq manual roadmap api).each do |type| %> .<%= type %> { background: url(/images/icons/<%= type %>.png) center left no-repeat; } <% end %> site/content/css/site.css @@ -9,7 +9,6 @@ filter: Here are some basic guidelines on the list of features and target releases. | *Feature* | *Target Release* | -| _API documentation_ | 2.0 | | Loading of custom filters by @rtex@ executable | 2.1 | | Access to LaTeX filters from plugins | 2.1 | | "Merb":http://merbivore.com plugin support | 2.2 | site/content/roadmap/index.txt @@ -52,6 +52,7 @@ filter: erb <li class='download'><a href='/download'>Download</a></li> <li class='manual'><a href='/manual'>Manual</a></li> <li class='roadmap'><a href='/roadmap'>Development Roadmap</a></li> + <li class='api'><a href='/api'>API Docs</a></li> <li class='contribute'><a href='/contribute'>Contribute!</a></li> <li class='contact'><a href='/contact'>Contact</a></li> </ul> site/layouts/default.rhtml 4c3a42bdcd10d2af8f4c19b8db22b6b0b08c9719 Bruce Williams bruce@codefluency.com http://github.com/bruce/rtex/commit/44c8101c353ff577d1e1501b334c016c6d754ced 44c8101c353ff577d1e1501b334c016c6d754ced 2008-05-06T19:41:25-07:00 2008-05-06T19:41:25-07:00 Cleanup docs for 2.0 release 6849c60a594404f48f61be1ea732fc8f0361a9cd Bruce Williams bruce@codefluency.com