site/content/css/uv/active4d.css
site/content/css/uv/all_hallows_eve.css
site/content/css/uv/amy.css
site/content/css/uv/blackboard.css
site/content/css/uv/brilliance_black.css
site/content/css/uv/brilliance_dull.css
site/content/css/uv/cobalt.css
site/content/css/uv/dawn.css
site/content/css/uv/eiffel.css
site/content/css/uv/espresso_libre.css
site/content/css/uv/idle.css
site/content/css/uv/iplastic.css
site/content/css/uv/lazy.css
site/content/css/uv/mac_classic.css
site/content/css/uv/magicwb_amiga.css
site/content/css/uv/pastels_on_dark.css
site/content/css/uv/slush_poppies.css
site/content/css/uv/spacecadet.css
site/content/css/uv/sunburst.css
site/content/css/uv/twilight.css
site/content/css/uv/zenburnesque.css
site/content/images/icons/contact.png
site/content/images/icons/contribute.png
site/content/images/icons/download.png
site/content/images/icons/faq.png
site/content/images/icons/manual.png
site/content/images/icons/roadmap.png
site/content/manual/executable.txt
@@ -41,7 +41,7 @@ opts = OptionParser.new do |opts|
options[:tex] = true
end
- opts.on('-i PATH', '--install PATH', "Install as plugin into Rails/Merb app at PATH") do |path|
+ opts.on('-i PATH', '--install PATH', "Install as plugin into Rails app at PATH") do |path|
unless Dir[plugins = File.join(path, 'vendor/plugins')].any?
STDERR.puts "Could not find application at #{path}"
exit 1
bin/rtex
@@ -5,11 +5,6 @@ filter:
- textile
---
-
-h2. Version 2.0 Branch
-
-This is the Rails 2 compatible branch, includes the standalone @rtex@ executable, and is maintained by "Bruce Williams":http://codefluency.com (github: "bruce":http://github.com/bruce, email: _bruce at codefluency dot com_).
-
-h2. Version 1.0 Branch (Rails 1 compatible)
-
-This is the Rails 1 compatible branch and is maintained by Wiebe Cazemier (@contact info pending@).
\ No newline at end of file
+| *Branch* | *Details* | *Maintainer* | *Contact* |
+| v2 | Supports Rails 2 | "Bruce Williams":http://codefluency.com | GitHub: "bruce":http://github.com/bruce, E-Mail: _bruce at codefluency dot com_ |
+| v1 | Supports Rails 1 | "Wiebe Cazemier":http://www.halfgaar.net | E-Mail: _wiebe at halfgaar dot net_ |
\ No newline at end of file
site/content/contact/index.txt
@@ -55,20 +55,35 @@ dt { font-weight: normal; }
margin: 0;
}
+pre.dawn span.EmbeddedSource {
+ background: none;
+}
+
+#menu { list-style: none; padding: 0; margin: 0; }
+#menu li {
+ padding-left: 24px;
+ line-height: 26px;
+ vertical-align: middle;
+}
+
+#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| %>
+.<%= type %> { background: url(/images/icons/<%= type %>.png) center left no-repeat; }
+<% end %>
+
+td { padding: 4px; }
+
pre {
font-family: monospace;
background: <%= @page.color['box-bg'] %>;
padding: 1em;
font-size: 1.1em;
+ overflow: auto;
}
em { background: none; }
-hr {
- background: <%= @page.color['highlight'] %>;
- color: <%= @page.color['highlight'] %>;
-}
-
#menu {
padding: 1em;
height: 100%;
@@ -76,7 +91,7 @@ hr {
font-family: "Georgia", "Times New Roman", serif;
}
-#release { height: 20px; padding: 0 0 0 1em; background: #e6e6e6; }
+#release { height: 20px; padding: 4px; margin-bottom: 1em; border: 1px #e6e6e6 solid; border-bottom: 1px #ccc solid; }
#release * {
line-height: 20px;
vertical-align: middle;
@@ -87,6 +102,16 @@ hr {
margin-right: 1em;
}
+/* =============== */
+/* = BREADCRUMBS = */
+/* =============== */
+
+.breadcrumbs { list-style: none; padding: 0; margin: 0; height: 40px; }
+.breadcrumbs li { display: inline; padding: 0; margin: 0; }
+.breadcrumbs li:before { content: "> "; }
+.breadcrumbs li:first-child:before { content: ""; }
+.breadcrumbs li:last-child { color: #aaa; font-family: "Georgia", "Times New Roman"; font-style: italic; }
+
/* Tables
* --------------------------------------------------------------------- */
table {
@@ -110,6 +135,8 @@ p.title {
margin-bottom: 0.75em;
}
+#footer { color: #aaa; font-style: italic; padding: 4px; border-top: 1px #e6e6e6 solid; }
+#footer { text-align: center; }
#header p.title { font-size: 3em; line-height: 1; margin-bottom: 0.5em; }
/* EOF */
site/content/css/site.css
@@ -20,7 +20,7 @@ Unstable code is available on the RTeX project's "GitHub page":http://github.com
h2. License
-Use it, change it, charge for it, give credit (more details below).
+RTeX is released under the MIT License. Portions of RTeX found in @vendor/@ are redistributed for dependency purposes and include their own copyright and licensing information.
<pre id='license'>
(The MIT License)
site/content/download/index.txt
@@ -1,4 +1,6 @@
---
+title: Home Page
+homepage: true
filter:
- erb
- textile
@@ -7,4 +9,6 @@ h2. Welcome
RTeX is a Ruby library (and web framework plugin) used to generate PDF documents on-the-fly using the "LaTeX typesetting system":http://www.latex-project.org/.
-RTeX is maintained by Bruce Williams (creator, maintaining the v2, Rails 2 compatible branch) and Wiebe Cazemier (maintaining the v1, Rails 1 compatible branch). See the "contact":/contact page to reach them.
+Get started with the "Manual":/manual (it's still a bit short, but it's something)!
+
+RTeX is maintained by Bruce Williams (creator, maintaining the v2 branch) and Wiebe Cazemier (maintaining the v1 branch). See the "Development Roadmap":/roadmap and "Contribution":/contribution pages if you're interested in tracking development, and feel free to "contact":/contact us if you have any questions.
site/content/index.txt
@@ -1,7 +1,7 @@
---
title: RTeX Manual
extension: html
-distry: true
+dirty: true
filter:
- erb
- textile
@@ -12,7 +12,7 @@ This is a _growing_ set of documentation; please bear with us as it is expanded!
h2. Topics
<ol>
- <% @pages.find(:limit => :all, :in_directory => 'manual', :sort_by => :position) do |p| %>
+ <% @pages.find(:limit => :all, :in_directory => 'manual', :order_by => :position) do |p| %>
<% next if p == @page %>
<li><a href='<%= p.url %>'><%= p.title %></a></li>
<% end %>
site/content/manual/index.txt
@@ -7,13 +7,21 @@ filter:
- textile
---
+h2(#latex). Installing LaTeX
+
+First, you'll need LaTeX. I recommend "the official site":http://www.latex-project.org/ftp.html for more details.
+
+h3. Configuration
+
+You'll need to make sure @pdflatex@ and @latex@ are available in your @PATH@ environment variable (or equivalent). If using RTeX "as a Rails plugin":/manual/rails.html, make sure they're in @PATH@ for the Rails process owner.
+
h2(#gem). Installing the RTeX Rubygem
The easiest (and recommended) way to install RTeX is by using "Rubygems":http://rubygems.org.
sudo gem install rtex
-The standalone executable, @rtex@, should not be available. For information on using the standalone executable, see the "RTeX Executable":/manual/rtex_executable page.
+The standalone executable, @rtex@, should not be available. For information on using the standalone executable, see the "RTeX Executable":/manual/executable.html page.
h2(#rails). Installing the Rails plugin
site/content/manual/install.txt
@@ -1,15 +1,13 @@
---
-title: RTeX as a Rails plugin
+title: Using RTeX as a Rails plugin
extension: html
-position: 2
+position: 3
filter:
- erb
- textile
---
-RTeX can be used as a "Template Handler," similar to "HAML":http://haml.hamptoncatlin.com/ or "Markaby":http://markaby.rubyforge.org/, but with PDFs being output.
-
-_Please note that much of this information is also available within @README_RAILS.rdoc@ inside the RTeX gem (and plugin, once installed into an app)._
+RTeX can be used as a "Template Handler," similar to "HAML":http://haml.hamptoncatlin.com/ or "Markaby":http://markaby.rubyforge.org/, but generating PDFs.
h2. Rails Version Dependency
@@ -30,43 +28,38 @@ With the following:
h4. app/controllers/items_controller.rb
-<pre>
-<notextile>
+<% uv :lang => 'ruby', :theme => 'dawn' do %>
def index
@items = Item.find(:all)
end
-</notextile>
-</pre>
+<% end %>
h4. app/views/items/index.pdf.rtex
-<pre>
-<notextile>
+<% uv :lang => 'latex' do %>
\section*{Items}
\begin{itemize}
- <%= render :partial => @items %>
+ <quote-erb><%= render :partial => @items %></quote-erb>
\end{itemize}
-</notextile>
-</pre>
+<% end %>
h4. app/views/items/_item.pdf.rtex
-<pre>
-<notextile>
- \item <%=l item.name %> \\
-</notextile>
-</pre>
+<% uv :lang => 'latex' do %>
+ \item <quote-erb><%=l item.name %></quote-erb> \\
+
+<% end %>
+
+Note the @l@ (or @latex_escape@) helper used above. It escapes LaTeX command sequences (similar to how @h@ escapes HTML in normal Rails views).
h4. app/layouts/application.pdf.rtex
-<pre>
-<notextile>
+<% uv :lang => 'latex' do %>
\documentclass[12pt]{article}
\begin{document}
- <%= yield %>
+ <quote-erb><%= yield %></quote-erb>
\end{document}
-</notextile>
-</pre>
+<% end %>
If you hit @http://the.server.url/items.pdf@, you end up with a nice PDF listing of items.
@@ -82,7 +75,16 @@ Note you can set certain options for RTeX by passing additional options to @rend
<dt>@:processor@</dt><dd>The executable used for final generation (default: @'pdflatex'@); note this must currently produce a PDF file.</dd>
<dt>@:shell_redirect@</dt><dd>Additional string to be tacked onto system calls, generally used to redirect STDERR to keep logs clean, ie @'> /dev/null 2>&1'@) (default @nil@)</dd>
<dt>@:tmpdir@</dt><dd>The temporary directory to use (default @RAILS_ROOT/tmp@)
-</dl>
+</dl>
+
+h4. Example
+
+<% uv :lang => 'ruby' do %>
+ def index
+ @items = Item.find(:all)
+ render :filename => 'item-listing.pdf'
+ end
+<% end %>
site/content/manual/rails.txt
@@ -8,8 +8,11 @@ filter:
Here are some basic guidelines on the list of features and target releases.
-* Support for merb: 2.1
-* Support for sinatra: 2.1
-* Add queuing/offload support for asynchronous processing/notification: ?
+| *Feature* | *Target Release* |
+| 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 |
+| "Sinatra":http://sinatrarb.com plugin support | 2.2 |
+| Built-in Queuing/Offload for asynchronous processing | TBD |
Have more ideas? "Contact":/contact us.
\ No newline at end of file
site/content/roadmap/index.txt
@@ -16,7 +16,7 @@ filter: erb
<link rel="stylesheet" href="/css/blueprint/print.css" type="text/css" media="print" />
<!-- CodeRay syntax highlighting CSS -->
- <link rel="stylesheet" href="/css/coderay.css" type="text/css" />
+ <link rel="stylesheet" href="/css/uv/<%= UV_THEME %>.css" type="text/css" />
<!-- Homepage CSS -->
<link rel="stylesheet" href="/css/site.css" type="text/css" media="screen, projection" />
@@ -24,7 +24,7 @@ filter: erb
<body>
<div id='legacy'>
- <p><strong>RTeX has been updated for Rails 2.</strong> If you're looking for the v1 branch (Rails 1 compatible) RTeX documentation, <a href='/v1'>go here</a>.
+ <p><strong>RTeX has been updated for Rails 2.</strong> The v1 branch (supporting Rails 1) is available <a href='http://rubyforge.org/scm/?group_id=2471'>from Subversion at Rubyforge</a>.
</div>
<div class="container">
@@ -40,24 +40,24 @@ filter: erb
<a href='/download'><%= stable_version %></a>
</dd>
</dl>
- <% if @page.title %>
+ <% if !@page.homepage && @page.title %>
+ <%= breadcrumbs(@page) %>
<h1><%= @page.title %></h1>
<% end %>
- <%= @content %>
+ <div id='content'><%= @content %></div>
</div>
<ul id='menu' class="column span-5 append-2 last">
- <li><a href='/faq'>FAQ</a></li>
- <li><a href='/download'>Download</a></li>
- <li><a href='/manual'>Manual</a></li>
- <li><a href='/roadmap'>Development Roadmap</a></li>
- <li><a href='/contribute'>Contribute!</a></li>
- <li><a href='/contact'>Contact</a></li>
+ <li class='faq'><a href='/faq'>FAQ</a></li>
+ <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='contribute'><a href='/contribute'>Contribute!</a></li>
+ <li class='contact'><a href='/contact'>Contact</a></li>
</ul>
<div class="column span-20 prepend-2 append-2 first last" id="footer">
- <hr/>
- <p>This website was created with <a href="http://webby.rubyforge.org">Webby</a></p>
+ <p>RTeX is © 2006-2008 <a href='/contact'>Bruce Williams, Wiebe Cazemier</a>, released under the MIT License.<br/>This website was created with <a href="http://webby.rubyforge.org">Webby</a>, with icons from <a href='http://www.pinvoke.com/'>pinvoke</a>.</p>
</div>
</div>
site/layouts/default.rhtml
@@ -1,3 +1,5 @@
+try_require 'uv'
+require 'hpricot'
require File.dirname(__FILE__) << "/../../lib/rtex/version"
def stable_version
@@ -6,4 +8,23 @@ def stable_version
else
RTeX::Version::STRING
end
-end
\ No newline at end of file
+end
+
+UV_THEME = 'dawn'
+
+::Webby.site.uv = { :theme => UV_THEME }
+
+Webby::Filters.register :erb do |input, cursor|
+ b = cursor.renderer.get_binding
+ replaced = {}
+ input.gsub!(/<quote-erb>(.*?)<\/quote-erb>/) do |match|
+ key = "(quote-erb_#{match.object_id})"
+ highlighted = Hpricot(Uv.parse($1, "xhtml", 'html_rails', false, UV_THEME))
+ source = highlighted.at('pre > span.EmbeddedSource').inner_html
+ replaced[key] = source
+ key
+ end
+ replaced.inject(ERB.new(input, nil, '-').result(b)) do |result, (key, value)|
+ result.sub(key, value)
+ end
+end
site/lib/variables.rb
@@ -1,2 +1,3 @@
Extracted from instiki, http://www.instiki.org
-Copyright (c) David Heinemeier Hansson, Ruby License
\ No newline at end of file
+Copyright (c) David Heinemeier Hansson, Ruby License
+
vendor/instiki/LICENSE
743635b21adcd72a5ab267785e24486cea6922e5
Bruce Williams
bruce@codefluency.com
http://github.com/bruce/rtex/commit/c0c6351af73badd62780bda6e6b6467e48e361fb
c0c6351af73badd62780bda6e6b6467e48e361fb
2008-04-23T23:38:50-07:00
2008-04-23T23:38:50-07:00
Build out syntax highlighting, examples, prep for release
8c284a66dc6ceca30b196d042d107bcd012c2edc
Bruce Williams
bruce@codefluency.com