diff options
| author | Jamis Buck <jamis@37signals.com> | 2005-01-09 15:04:16 +0000 |
|---|---|---|
| committer | Jamis Buck <jamis@37signals.com> | 2005-01-09 15:04:16 +0000 |
| commit | c51fa9fc3d7c0ec6f59bcaf3d352fae9325857e2 (patch) | |
| tree | fa6c5fdee64da937145d594348100b03225a4207 /doc/faq/faq.rb | |
| download | third_party-sqlite3-ruby-c51fa9fc3d7c0ec6f59bcaf3d352fae9325857e2.tar.gz third_party-sqlite3-ruby-c51fa9fc3d7c0ec6f59bcaf3d352fae9325857e2.tar.xz third_party-sqlite3-ruby-c51fa9fc3d7c0ec6f59bcaf3d352fae9325857e2.zip | |
Changed layout to support tagging and branching
Diffstat (limited to 'doc/faq/faq.rb')
| -rw-r--r-- | doc/faq/faq.rb | 177 |
1 files changed, 177 insertions, 0 deletions
diff --git a/doc/faq/faq.rb b/doc/faq/faq.rb new file mode 100644 index 0000000..13d29e4 --- /dev/null +++ b/doc/faq/faq.rb @@ -0,0 +1,177 @@ +#-- +# ============================================================================= +# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu) +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, +# this list of conditions and the following disclaimer. +# +# * Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# +# * The names of its contributors may not be used to endorse or promote +# products derived from this software without specific prior written +# permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE +# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# ============================================================================= +#++ + +require 'yaml' +require 'redcloth' + +def process_faq_list( faqs ) + puts "<ul>" + faqs.each do |faq| + process_faq_list_item faq + end + puts "</ul>" +end + +def process_faq_list_item( faq ) + question = faq.keys.first + answer = faq.values.first + + print "<li>" + + question_text = RedCloth.new(question).to_html.gsub( %r{</?p>},"" ) + if answer.is_a?( Array ) + puts question_text + process_faq_list answer + else + print "<a href='##{question.id}'>#{question_text}</a>" + end + + puts "</li>" +end + +def process_faq_descriptions( faqs, path=nil ) + faqs.each do |faq| + process_faq_description faq, path + end +end + +def process_faq_description( faq, path ) + question = faq.keys.first + path = ( path ? path + " " : "" ) + question + answer = faq.values.first + + if answer.is_a?( Array ) + process_faq_descriptions( answer, path ) + else + title = RedCloth.new( path ).to_html.gsub( %r{</?p>}, "" ) + answer = RedCloth.new( answer || "" ) + + puts "<a name='#{question.id}'></a>" + puts "<div class='faq-title'>#{title}</div>" + puts "<div class='faq-answer'>#{add_api_links(answer.to_html)}</div>" + end +end + +API_OBJECTS = [ "Database", "Statement", "ResultSet", + "ParsedStatement", "Pragmas", "Translator" ].inject( "(" ) { |acc,name| + acc << "|" if acc.length > 1 + acc << name + acc + } + ")" + +def add_api_links( text ) + text.gsub( /#{API_OBJECTS}(#(\w+))?/ ) do + disp_obj = obj = $1 + + case obj + when "Pragmas": disp_obj = "Database" + end + + method = $3 + s = "<a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/#{obj}.html'>#{disp_obj}" + s << "##{method}" if method + s << "</a>" + s + end +end + +faqs = YAML.load( File.read( "faq.yml" ) ) + +puts <<-EOF +<html> + <head> + <title>SQLite3/Ruby FAQ</title> + <style type="text/css"> + a, a:visited, a:active { + color: #00F; + text-decoration: none; + } + + a:hover { + text-decoration: underline; + } + + .faq-list { + color: #000; + font-family: vera-sans, verdana, arial, sans-serif; + } + + .faq-title { + background: #007; + color: #FFF; + font-family: vera-sans, verdana, arial, sans-serif; + padding-left: 1em; + padding-top: 0.5em; + padding-bottom: 0.5em; + font-weight: bold; + font-size: large; + border: 1px solid #000; + } + + .faq-answer { + margin-left: 1em; + color: #000; + font-family: vera-sans, verdana, arial, sans-serif; + } + + .faq-answer pre { + margin-left: 1em; + color: #000; + background: #FFE; + font-size: normal; + border: 1px dotted #CCC; + padding: 1em; + } + + h1 { + background: #005; + color: #FFF; + font-family: vera-sans, verdana, arial, sans-serif; + padding-left: 1em; + padding-top: 1em; + padding-bottom: 1em; + font-weight: bold; + font-size: x-large; + border: 1px solid #00F; + } + </style> + </head> + <body> + <h1>SQLite/Ruby FAQ</h1> + <div class="faq-list"> +EOF + +process_faq_list( faqs ) +puts "</div>" +process_faq_descriptions( faqs ) + +puts "</body></html>" |