Changeset 102

Timestamp:

01/31/2007 01:32:30 (22 months ago)

Author:

why

Message:

• Rakefile: generate RDoc with the README at front.
  
• README: a bit more initial comments.
  

Location:

trunk

Files:

• README (modified) (4 diffs)
• Rakefile (modified) (3 diffs)

trunk/README

@@ -13 +13 @@
 works.
 
+== An Overview
+
+Let's clear up what Hpricot is.
+
+# Hpricot is *a standalone library*.  It requires no other libraries.  Just Ruby!
+# While priding itself on speed, Hpricot *work hard to sort out bad HTML* and
+  pays a small penalty in order to get that right.  So that's slightly more important
+  to me than speed.
+# *If you can see it in Firefox, then Hpricot should parse it.*  That's
+  how it should be!  Let me know the minute it's otherwise.
+# Primarily, Hpricot is used for reading HTML and tries to sort out troubled
+  HTML by having some idea of what good HTML is.  Some people still like to use
+  Hpricot for XML reading, but *remember to use the Hpricot::XML() method* for that!
+
 == The Hpricot Kingdom
 
@@ -21 +35 @@
 * http://code.whytheluckystiff.net/svn/hpricot/trunk is the main Subversion
   repository for Hpricot.  You can get the latest code there.
+* http://code.whytheluckystiff.net/doc/hpricot is the home for the latest copy of
+  this reference.
 * See COPYING for the terms of this software. (Spoiler: it's absolutely free.)
 
@@ -39 +55 @@
 candidate build here:
 
-  $ gem install hpricot --source code.whytheluckystiff.net
+  $ gem install hpricot --source http://code.whytheluckystiff.net
 
 The development gem is usually in pretty good shape actually.  You can also
@@ -241 +257 @@
 *Also, :fixup_tags is canceled out by the :xml option.*  This is because :fixup_tags makes assumptions based how HTML is
 structured.  Specifically, how tags are defined in the XHTML 1.0 DTD.
-
-== Digging Around for More Handy Methods
-
-If you're looking around for more helpful methods to 

trunk/Rakefile

@@ -8 +8 @@
 
 NAME = "hpricot"
-REV = File.read(".svn/entries")[/committed-rev="(\d+)"/, 1] rescue nil
+REV = `svn info`[/Revision: (\d+)/, 1] rescue nil
 VERS = ENV['VERSION'] || "0.4" + (REV ? ".#{REV}" : "")
 CLEAN.include ['ext/hpricot_scan/*.{bundle,so,obj,pdb,lib,def,exp}', 'ext/hpricot_scan/Makefile', 
                '**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', 'The Hpricot Reference', '--main', 'README', '--inline-source']
 
 desc "Does a full compile, test run"
@@ -43 +44 @@
 Rake::RDocTask.new do |rdoc|
     rdoc.rdoc_dir = 'doc/rdoc'
-    # rdoc.options += RDOC_OPTS
-    # rdoc.template = "extras/flipbook_rdoc.rb"
+    rdoc.options += RDOC_OPTS
     rdoc.main = "README"
-    rdoc.title = "Hpricot Documentation"
     rdoc.rdoc_files.add ['README', 'CHANGELOG', 'COPYING', 'lib/**/*.rb']
 end
@@ -56 +55 @@
         s.platform = Gem::Platform::RUBY
         s.has_rdoc = true
+        s.rdoc_options += RDOC_OPTS
         s.extra_rdoc_files = ["README", "CHANGELOG", "COPYING"]
         s.summary = "a swift, liberal HTML parser with a fantastic library"