From: Eric Hodel <drbrain@...7.net>
Date: 2004-09-11T14:38:22+09:00
Subject: RDoc Formatter Simple Mode

--k7W93gQNhKgsYkEv
Content-Type: multipart/mixed; boundary="dClnwdpHIAy5TST4"
Content-Disposition: inline


--dClnwdpHIAy5TST4
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

For rbot's ri module I needed a more compact ri format than plain to
avoid flooding the bot off the server.  I added a 'simple' format that
strips out extra newlines and reduces lines to just their labels.  When
combined with a really large line width, the formatter is perfect for
use in an IRC bot.

--=20
Eric Hodel - drbrain@segment7.net - http://segment7.net
All messages signed with fingerprint:
FEC2 57F1 D465 EB15 5D6E  7C11 332A 551C 796C 9F04


--dClnwdpHIAy5TST4
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename="rdoc_simple_formatter.patch"
Content-Transfer-Encoding: quoted-printable

Index: ri_formatter.rb
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /src/ruby/lib/rdoc/ri/ri_formatter.rb,v
retrieving revision 1.11
diff -u -9 -p -r1.11 ri_formatter.rb
--- ri_formatter.rb	24 Mar 2004 19:17:13 -0000	1.11
+++ ri_formatter.rb	11 Sep 2004 05:17:36 -0000
@@ -1,22 +1,23 @@
 module RI
   class TextFormatter
=20
     def TextFormatter.list
-      "plain, html, bs, ansi"
+      "plain, html, bs, ansi, simple"
     end
=20
     def TextFormatter.for(name)
       case name
-      when /plain/i then TextFormatter
-      when /html/i  then HtmlFormatter
-      when /bs/i    then OverstrikeFormatter
-      when /ansi/i  then AnsiFormatter
+      when /plain/i  then TextFormatter
+      when /html/i   then HtmlFormatter
+      when /bs/i     then OverstrikeFormatter
+      when /ansi/i   then AnsiFormatter
+      when /simple/i then SimpleFormatter
       else nil
       end
     end
=20
     attr_reader :indent
    =20
     def initialize(options, indent)
       @options =3D options
       @width   =3D options.width
@@ -585,15 +586,57 @@ module RI
         print("</#{code}>")
     end
=20
     def escape(str)
       str.
           gsub(/&/n, '&amp;').
           gsub(/\"/n, '&quot;').
           gsub(/>/n, '&gt;').
           gsub(/</n, '&lt;')
+    end
+
+  end
+
+  ##################################################
+ =20
+  # This formatter reduces extra lines for a simpler output.
+  # It improves way output looks for tools like IRC bots.
+
+  class SimpleFormatter < TextFormatter
+
+    ######################################################################
+
+    # No extra blank lines
+
+    def blankline
+    end
+
+    ######################################################################
+
+    # Display labels only, no lines
+
+    def draw_line(label=3Dnil)
+      unless label.nil? then
+        bold_print(label)=20
+        puts
+      end
+    end
+
+    ######################################################################
+
+    # Place heading level indicators inline with heading.
+
+    def display_heading(text, level, indent)
+      case level
+      when 1
+        puts "=3D " + text.upcase
+      when 2
+        puts "-- " + text
+      else
+        print indent, text, "\n"
+      end
     end
=20
   end
 end
=20
=20

--dClnwdpHIAy5TST4--

--k7W93gQNhKgsYkEv
Content-Type: application/pgp-signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.2 (FreeBSD)

iD8DBQFBQo9LMypVHHlsnwQRAnXvAKDdR1nqez0DSiQ/YznlZ/i772+kQQCfe/WC
eX/JbuLvscqlotp7aKfkrC4=
=j+qw
-----END PGP SIGNATURE-----

--k7W93gQNhKgsYkEv--