This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 117062 - I18N - clarify about encodings and use of multibyte in docs or olh
Summary: I18N - clarify about encodings and use of multibyte in docs or olh
Status: VERIFIED FIXED
Alias: None
Product: usersguide
Classification: Unclassified
Component: Ruby (show other bugs)
Version: 6.x
Hardware: Sun All
: P2 blocker (vote)
Assignee: Gail Chappell
URL:
Keywords: I18N
Depends on:
Blocks:
 
Reported: 2007-09-28 18:45 UTC by Ken Frank
Modified: 2007-10-24 19:28 UTC (History)
0 users

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Ken Frank 2007-09-28 18:45:14 UTC
due to the ruby/rails used in nb6, there is not a lot of i18n or encoding support
and this had led already to some confusion with users.

Thus think it can be helpful if olh or rel notes and/or faq could
mention some things about this.

Here is some text that might be used as a starting point, based on some emails with Tor and others or from info
in various i18n issues on ruby module.

--------------------------------------------------------------------------

 NetBeans Ruby and Rails functionality related to use of multibyte or extended
 ascii characters.


This note is meant to explain about the limitations on the use of multibyte or 
extended ascii in the Ruby and Rails supported by Netbeans. 
Netbeans itself does not prohibit the use of multibyte in ruby or rails project 
and file names, and in file contents where it could be data or values. 

However, in general, Ruby and Rails themselves do not support the use of extended ascii or
multibyte. And this can be seen by doing ruby or rails commands or operations
from the command line outside of NetBeans.


Some guidelines for Ruby:

	- Ruby identifiers are consist of a-zA-Z0-9_ ( english basic alphabetic 
	characters only, decimal digits, and the underscore character
	- Ruby class name and module names are constants. They should begin with 
	upper case letters ([A-Z]).


Since NetBeans file and project names are used as a basis for names of ruby and
rails files that will be processed
by ruby and rails compiler and other programs, it means use of multibyte
and extended ascii in ruby and rails project  and file names and contents 
should be avoided.



As part of netbeans ruby and rails functionality, in the creation of a
ruby or rails project or file, a check is done to see if a Ruby name is
"safe" ([a-zA-Z0-9_]) 
and if not, will generate warnings (but not errors) in the create project dialogs
(for Ruby and Rails projects), in the new file dialog (for classes, modules,
tests), and in the Rename refactoring "new name" dialog.


Thus its not supported to use other characters than the safe ones mentioned
above in names of NetBeans ruby and rails project, files, class, variables,
methods, controllers, and other parts.
This includes creating tests and generating rdocs.
Comment 1 Gail Chappell 2007-10-08 18:14:33 UTC
I will add this information to the Ruby FAQ at:

http://wiki.netbeans.org/wiki/view/RubyFAQ
Comment 2 Gail Chappell 2007-10-10 19:57:04 UTC
I've created an FAQ at:

http://wiki.netbeans.org/wiki/view/RubyFAQ
Comment 3 Ken Frank 2007-10-24 19:28:33 UTC
verified.