[PATCH] RDoc: preserve special chars in <tt> Was: Re: bug in rdoc?

< ^ > P N |<>|^_>< --- | ~ ...Help
------art_136252_11179512.1161037060633
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

On 10/16/06, Wybo Dekker <wybo / servalys.nl> wrote:
>
>
> Jan Svitok wrote:
> > On 10/16/06, Morton Goldberg <m_goldberg / ameritech.net> wrote:
> >> On Oct 16, 2006, at 7:10 AM, Wybo Dekker wrote:
> >>
> >> > -- The following example, is taken from the rdoc documentation.
> >> > For the long options, it converts -- into  &#8212; (a long hyphen)
> >> > instead of two separate hyphens with some whitespace in between.
> >> > (see www.servalys.nl/ doc/index.html for the output)
> >> >
> >> > in rdoc
> >> >
> >> > <tt>--output</tt> <i>name [, name]</i>::
> >> >     specify the name of one or more output files. If multiple
> >> >     files are present, the first is used as the index.
> >> >
> >> > <tt>--quiet:</tt>:: do not output the names, sizes, byte counts,
> >> >                     index areas, or bit ratios of units as
> >> >                     they are processed.
> >> >
> >> > ЯЕ
> >> >
> >> > Is this a bug in rdoc?
> >>
> >> No, it's a feature.
> >>
> >> Back in the old days, when people typed on typewriters, which didn't
> >> have an em-dash (what you call a long hyphen) key, two hyphens were
> >> used to indicate an em-dash. Since the ASCII character set doesn't
> >> have em-dash, this convention is carried over to rdoc.
> >>
> >> Why does this bother you?
> >
> > Because it's not clearly visible that one must type two dashes there.
> > The solution would be to not convert special chars in <tt></tt> blocks
>
> I agree!

Attached is a patch that implements this (special chars are preserve
inside tt tags). I don't know much about RDoc internal, so please
check it. I added a simple unit test, as well. I couldn't manage CVS
to includeit with others, so it's attached separately.

------art_136252_11179512.1161037060633
Content-Type: text/x-patch; name=rdoc-tt.patch; charset=ANSI_X3.4-1968
Content-Transfer-Encoding: base64
X-Attachment-Id: f_etdfdg1q
Content-Disposition: attachment; filename="rdoc-tt.patch"

PyByZG9jLXR0LnBhdGNoCj8gdGVzdC9UZXN0VG9IdG1sLnJiCkluZGV4OiBzaW1wbGVfbWFya3Vw
L3RvX2h0bWwucmIKPT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09
PT09PT09PT09PT09PT09PT09PT09PQpSQ1MgZmlsZTogL3NyYy9ydWJ5L2xpYi9yZG9jL21hcmt1
cC9zaW1wbGVfbWFya3VwL3RvX2h0bWwucmIsdgpyZXRyaWV2aW5nIHJldmlzaW9uIDEuMQpkaWZm
IC1wIC11IC0xIC1yMS4xIHRvX2h0bWwucmIKLS0tIHNpbXBsZV9tYXJrdXAvdG9faHRtbC5yYgkx
IERlYyAyMDAzIDA3OjEyOjQ4IC0wMDAwCTEuMQorKysgc2ltcGxlX21hcmt1cC90b19odG1sLnJi
CTE2IE9jdCAyMDA2IDIyOjAwOjUxIC0wMDAwCkBAIC0yMiwyICsyMiw2IEBAIG1vZHVsZSBTTQog
ICAgICAgaW5pdF90YWdzCisgICAgICAKKyAgICAgICMgQGluX3R0IC0gdHQgbmVzdGVkIGxldmVs
cyBjb3VudAorICAgICAgIyBAdHRfYml0IC0gY2FjaGUKKyAgICAgIEBpbl90dCwgQHR0X2JpdCA9
IDAsIFNNOjpBdHRyaWJ1dGUuYml0bWFwX2Zvcig6VFQpCiAgICAgZW5kCkBAIC0xNTQsMiArMTU4
LDMgQEAgbW9kdWxlIFNNCiAgICAgICAgICAgcmVzIDw8IGFubm90YXRlKHRhZy5vbikKKyAgICAg
ICAgICBAaW5fdHQgKz0gMSBpZiB0dD8odGFnKQogICAgICAgICBlbmQKQEAgLTE2NCwyICsxNjks
MyBAQCBtb2R1bGUgU00KICAgICAgICAgaWYgYXR0cl9tYXNrICYgdGFnLmJpdCAhPSAwCisgICAg
ICAgICAgQGluX3R0IC09IDEgaWYgdHQ/KHRhZykKICAgICAgICAgICByZXMgPDwgYW5ub3RhdGUo
dGFnLm9mZikKQEAgLTE2OSwyICsxNzUsMTIgQEAgbW9kdWxlIFNNCiAKKyAgICAjIGFyZSB3ZSBj
dXJyZW50bHkgaW5zaWRlIDx0dD4gdGFncz8KKyAgICBkZWYgaW5fdHQ/CisgICAgICBAaW5fdHQg
PiAwCisgICAgZW5kCisgICAgCisgICAgIyBpcyArdGFnKyBhIDx0dD4gdGFnPworICAgIGRlZiB0
dD8odGFnKQorICAgICAgICB0YWcuYml0ID09IEB0dF9iaXQKKyAgICBlbmQKKyAgICAKICAgICBk
ZWYgY29udmVydF9mbG93KGZsb3cpCkBAIC0xOTAsNCArMjA2LDEyIEBAIG1vZHVsZSBTTQogICAg
IGRlZiBjb252ZXJ0X3N0cmluZyhpdGVtKQotICAgICAgQ0dJLmVzY2FwZUhUTUwoaXRlbSkuCisg
ICAgICAgICAgIyBsZWF2ZSBzcGVjaWFsIGNoYXJzIGludGFjdCBpbnNpZGUgPHR0PiB0YWdzCisg
ICAgICAgICAgaW5fdHQ/ID8gY29udmVydF9zdHJpbmdfc2ltcGxlKGl0ZW0pIDogY29udmVydF9z
dHJpbmdfZmFuY3koaXRlbSkKKyAgICBlbmQKKyAgICAKKyAgICBkZWYgY29udmVydF9zdHJpbmdf
c2ltcGxlKGl0ZW0pCisgICAgICBDR0kuZXNjYXBlSFRNTChpdGVtKQorICAgIGVuZAogICAgICAg
CisgICAgZGVmIGNvbnZlcnRfc3RyaW5nX2ZhbmN5KGl0ZW0pCisgICAgICBjb252ZXJ0X3N0cmlu
Z19zaW1wbGUoaXRlbSkuCiAgICAgICAKSW5kZXg6IHRlc3QvQWxsVGVzdHMucmIKPT09PT09PT09
PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09
PQpSQ1MgZmlsZTogL3NyYy9ydWJ5L2xpYi9yZG9jL21hcmt1cC90ZXN0L0FsbFRlc3RzLnJiLHYK
cmV0cmlldmluZyByZXZpc2lvbiAxLjEKZGlmZiAtcCAtdSAtMSAtcjEuMSBBbGxUZXN0cy5yYgot
LS0gdGVzdC9BbGxUZXN0cy5yYgkxIERlYyAyMDAzIDA3OjEyOjQ5IC0wMDAwCTEuMQorKysgdGVz
dC9BbGxUZXN0cy5yYgkxNiBPY3QgMjAwNiAyMjowMDo1MSAtMDAwMApAQCAtMiArMiwyIEBAIHJl
cXVpcmUgJ1Rlc3RQYXJzZS5yYicKIHJlcXVpcmUgJ1Rlc3RJbmxpbmUucmInCityZXF1aXJlICdU
ZXN0VG9IdG1sLnJiJwo------art_136252_11179512.1161037060633
Content-Type: application/x-ruby; name=TestToHtml.rb
Content-Transfer-Encoding: base64
X-Attachment-Id: f_etdfedwc
Content-Disposition: attachment; filename="TestToHtml.rb"

cmVxdWlyZSAidGVzdC91bml0IgoKJDoudW5zaGlmdCAiLi4vLi4vLi4iCgpyZXF1aXJlICJyZG9j
L21hcmt1cC9zaW1wbGVfbWFya3VwL3RvX2h0bWwiCgpjbGFzcyBUZXN0VG9IdG1sIDwgVGVzdDo6
VW5pdDo6VGVzdENhc2UKCiAgTW9ja0ZyYWdtZW50ID0gU3RydWN0Lm5ldyg6dHh0KQogIAogIENP
UFkgPSAiJiMxNjk7IgogIE5EQVNIID0gIiYjODIxMjsiCiAgCiAgZGVmIHNldHVwCiAgICBAYW0g
PSBTTTo6QXR0cmlidXRlTWFuYWdlci5uZXcKICAgIEB0aCA9IFNNOjpUb0h0bWwubmV3CiAgZW5k
CgogIGRlZiBmb3JtYXQodHh0KQogICAgQHRoLnN0YXJ0X2FjY2VwdGluZwogICAgQHRoLmFjY2Vw
dF9wYXJhZ3JhcGgoQGFtLCBNb2NrRnJhZ21lbnQubmV3KHR4dCkpCiAgICBAdGguZW5kX2FjY2Vw
dGluZwogIGVuZAogIAogIGRlZiB0ZXN0X3R0X2Zvcm1hdHRpbmcKICAgIGFzc2VydF9lcXVhbCAi
PHA+XG48dHQ+LS08L3R0PiAje05EQVNIfSA8dHQ+KGMpPC90dD4gI3tDT1BZfVxuPC9wPlxuIiwg
Zm9ybWF0KCI8dHQ+LS08L3R0PiAtLSA8dHQ+KGMpPC90dD4gKGMpIikKICAgIGFzc2VydF9lcXVh
bCAiPHA+XG48Yj4je05EQVNIfTwvYj5cbjwvcD5cbiIsIGZvcm1hdCgiPGI+LS08L2I+IikKICBl
bmQKCmVuZAo------art_136252_11179512.1161037060633--