Feature #235

default charset of rdoc

Added by Kazuhiro NISHIYAMA over 3 years ago. Updated 10 months ago.

[ruby-core:17652]
Status:Closed Start date:07/08/2008
Priority:Normal Due date:12/24/2008
Assignee:Yui NARUSE % Done:

0%
Category:M17N
Target version:1.9.1 Release Candidate

Description

I think that default charset of rdoc should be 'utf-8'.
The current default 'iso-8859-1' is not useful, because it can not include characters in Japanese and/or other languages, and not supported by ruby(1.8.x) interpreter.

Related issues

related to ruby-trunk - Bug #143: rdoc and magic comment Closed 06/12/2008
related to ruby-trunk - Feature #928: RDoc encoding conversion Rejected 12/26/2008

History

#1
Updated by Martin Dürst over 3 years ago

Not sure sending this directly to this list is the right thing to do,
but I fully agree.

Regards,   Martin.

At 20:36 08/07/08, Kazuhiro NISHIYAMA wrote:
>Issue #235 has been reported by Kazuhiro NISHIYAMA.
>
>----------------------------------------
>Feature #235: default charset of rdoc
>http://redmine.ruby-lang.org/issues/show/235
>
>Author: Kazuhiro NISHIYAMA
>Status: Open
>Priority: Normal
>Assigned to: 
>Category: 
>Target version: 
>
>
>I think that default charset of rdoc should be 'utf-8'.
>The current default 'iso-8859-1' is not useful, because it can not include 
>characters in Japanese and/or other languages, and not supported by 
>ruby(1.8.x) interpreter.
>
>
>----------------------------------------
>You have received this notification because you have either subscribed to 
>it, or are involved in it.
>To change your notification preferences, please click here: 
>http://redmine.ruby-lang.org/my/account


#-#-#  Martin J. Du"rst, Assoc. Professor, Aoyama Gakuin University
#-#-#  http://www.sw.it.aoyama.ac.jp       mailto:duerst@it.aoyama.ac.jp

#2
Updated by Yui NARUSE over 3 years ago

Ruby M17N 的には、デフォルトはUS-ASCIIで、magic commentを書いてくださいですかね。
rdocって今メンテナどなたなんだろう。

#3
Updated by Koichi Sasada over 3 years ago

Who's task?

Kazuhiro NISHIYAMA wrote:
> Issue #235 has been reported by Kazuhiro NISHIYAMA.
> 
> ----------------------------------------
> Feature #235: default charset of rdoc
> http://redmine.ruby-lang.org/issues/show/235
> 
> Author: Kazuhiro NISHIYAMA
> Status: Open
> Priority: Normal
> Assigned to: 
> Category: 
> Target version: 
> 
> 
> I think that default charset of rdoc should be 'utf-8'.
> The current default 'iso-8859-1' is not useful, because it can not include characters in Japanese and/or other languages, and not supported by ruby(1.8.x) interpreter.
> 
> 
> ----------------------------------------
> You have received this notification because you have either subscribed to it, or are involved in it.
> To change your notification preferences, please click here: http://redmine.ruby-lang.org/my/account
> 


-- 
// SASADA Koichi at atdot dot net

#4
Updated by Eric Hodel over 3 years ago

  • Assignee set to Eric Hodel

#5
Updated by Yui NARUSE over 3 years ago

  • Category set to M17N
  • Assignee deleted (Eric Hodel)
Sorry, I wrote last message in Japanese,

Spec should be following,

* the default encoding of rdoc should be US-ASCII (as the default of source encoding)
* rdoc should recognize magic comment and use it as the encoding of the document.
* if conflict encoding because of partial document or something,
  raise Exception.

#6
Updated by Yui NARUSE over 3 years ago

  • Assignee set to Eric Hodel

#7
Updated by Martin Dürst over 3 years ago

I agree with Yui for the input encoding. The default for output should be UTF-8, however.
An exception should be raised if the actual encoding and the declared encoding on input
don't agree. An exception should not be raised if data from two or more input documents
in different encodings is combined.

#8
Updated by Yuki Sonoda over 3 years ago

There are two more tasks.

* An exception should be raised?  (I think it should)
* Who does this do? Naruse?

#9
Updated by Yui NARUSE over 3 years ago

  • Assignee changed from Eric Hodel to Yui NARUSE
  • An exception should be raised? (I think it should)
of course, the exception is maybe Encoding::IllegalByteSequence
* Who does this do? Naruse?
i do.

#10
Updated by Eric Hodel over 3 years ago

Default output encoding of RDoc is UTF-8 now (soon to be committed to trunk).

Unfortunately no conversion to UTF-8 is currently performed.  I lack experience to do this properly.

#11
Updated by Yuki Sonoda over 3 years ago

  • Target version set to 1.9.0-5

#12
Updated by Yuki Sonoda about 3 years ago

  • Target version changed from 1.9.0-5 to 1.9.1 Release Candidate

#13
Updated by Yuki Sonoda about 3 years ago

  • Due date set to 12/24/2008

#14
Updated by Yuki Sonoda about 3 years ago

  • Status changed from Open to Closed
I created a new issue for encoding conversion in RDoc. (Feature #928)

Also available in: Atom PDF