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 116041 - I18N - need olh and other web docs about new project and filel encoding features
Summary: I18N - need olh and other web docs about new project and filel encoding features
Status: VERIFIED FIXED
Alias: None
Product: usersguide
Classification: Unclassified
Component: Code (show other bugs)
Version: 6.x
Hardware: Sun All
: P3 blocker (vote)
Assignee: Troy Giunipero
URL:
Keywords: I18N
Depends on:
Blocks:
 
Reported: 2007-09-19 17:24 UTC by Ken Frank
Modified: 2008-03-06 20:42 UTC (History)
1 user (show)

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-19 17:24:20 UTC
am filing this here since its affects all parts of ide, no matter what project or file type or other functionality.

This is not at all related to translations or translated bits; this is visible to any user running in any locale.

This is about the new project and file encoding features for nb6.

I am maintaining a doc on it that is collected info from developers who implemented it, and it could be used
as background for olh and other docs, like nb wiki docs or faq.

I can send you latest version of it; even for being on nb wiki it needs editing, but even if not,
I'm not able to transform the html its written in, into wiki markup that looks ok. And i'm not
able to enter it in wiki markup format.

that is, nb wiki, unlike internal wikis, does not recognize html code.
Comment 1 Patrick Keegan 2007-09-19 17:34:27 UTC
Troy, could you look at this?
Comment 2 John Jullion-ceccarelli 2007-09-20 10:11:41 UTC
Setting target milestone and decreasing priority, IMO doesn't meet P2. We will take the info in the doc that Ken has
provided and integrate it in the OLH and on the wiki for NB60.
Comment 3 Ken Frank 2007-09-22 17:26:18 UTC
in the document about this sent separately, I added this section, and I think its important to emphasize these thoughts
since being able to change project encoding at some point does not mean that all files created before the change will
be processed ok, and these points can be important for user's understanding.

IMPORTANT NOTE

    
     * User must keep in mind that if they have a project that has had its encoding property changed, so that files with
other encodings can be used, that compiling and running the project may not succeed, since the java compiler needs to be
passed an encoding value, and there can only be one such value.  The ide or java does not do encoding detection of files.

     * This could apply to projects whose encoding property is not changed, but if files like jsp, xml and html files
encoding tags are changed, since besides the encoding value used for runtime, the encoding tag affects how file is
viewed internally during designtime, like in editor, debugger, etc.

ken.frank@sun.com
Comment 4 Ken Frank 2007-10-05 19:39:41 UTC
adding fix-in-60 staus whiteboard advisory as per qe policy.

I don't understand why this kind of info would not be needed for sure; am already seeing misunderstandings
about the topics mentioned in various mails and reports.

ken.frank@sun.com
Comment 5 Ken Frank 2007-10-09 17:20:16 UTC
added the following important info to the doc I  had sent - we need to clarify to user that there is no separate
option for setting the project encoding; it can only be done by changing the encoding of an existing project:


    *  There is not a separate option in the ide options or other sections for setting the project encoding property; it
can only be set to something different than default by changing the encoding of an existing project.
    * If that existing project is created so that there is non ascii or multibyte in the project name, path or class or
package names, then when if the encoding of that project is changed, then those characters might not be valid anymore;
to avoid needing to do this, one can
          o create the project not using non ascii characters, then after changing the encoding, use renaming and
refactoring to change the items that need to have non ascii as part of their names; this will not work however for the
project path leading up to the project itself
          o create a project that won't be used; change its encoding, then create a new project; in this case, non ascii
can be used in the names of project paths and files.


    *
Comment 6 Ken Frank 2007-10-22 17:02:54 UTC
I suggest review of all olh content related to encodings to make sure its still accurate
for nb6, since the new feq implementations might have changed some rules or details
or that new info might need to be added;see the doc on feq I sent to John.

I searched in olh with word encoding and found several areas that might need to be looked at:

1. sections on jsp encodings

2. compilation options about encoding

3. the Setting Character Encoding section; I don't know if its
current or past (since it mentions character encoding of a project 
which is new for nb6, but it does not seem correct:

a. by default, ide does not save files in system  default char encoding,
if we are talking about projects, but uses utf-8.

b. ide encoding settings, again if we are talking about
projets, apply to more than just source editor
and do apply to compilation

c. change enc for a file - this does not exist for java
files anymore; and other files like jsp, xml, html - some
have a writeable enc property, some dont.

see the doc mentioned here and below for more info on this.

4. somewhere else in help but cant remember where it
talks about being able to set encoding property of a specific
java file - that is not in nb6.

ken.frank@sun.com
Comment 7 Ken Frank 2007-11-07 16:32:47 UTC
want to suggest in this section of project feq and/or in section
about freeform projects, that some mention that in using
the new project from existing sources (with or without ant),
that one panel has the encoding choices there -- in which user can choose
the encoding of the files that are in this already existing project --
and then that encoding becomes the encoding prop for this newly
created project.

this is different from the normal new project wizards - no such choice is
done; the current global view of project encoding is used

I have seen in a couple of user comments that when they created a freeform project
there was no choice in project encoding props of any encodings, and I think it was
because they had not made a choice in wizard when creating the project.

I'm not clear on details of this;developers would know but since the whole
project encoding things are new for nb6, seems like mention of this freeform encoding
choice/rules in its wizard could be helpful.

ken.frank@sun.com
Comment 8 Ken Frank 2007-11-12 18:30:24 UTC
here is update of nb project types that don't show
encoding project property in the project props dialog

1. uml projects (but is supposed to use the global feq values)

2. enterprise application - am assuming it uses global feq values

3. c/c++ projects - don't know if it uses global feq or not

4. netbeans module projects - it uses utf-8 encoding for the project
in any case.

ken.frank@sun.com
Comment 9 Troy Giunipero 2008-01-09 13:33:10 UTC
I have made updates and changes to the following pages in OLH:

'About Project Encodings' and 'About File Encodings' have been updated to reflect the new way NB 6 deals with encoding.

To my knowledge, Ken Ganfield has updated content dealing with JSP, XML and generic file encoding topics.

Furthermore, wiki pages have been created for the maintenance of more in-depth information:

   * http://wiki.netbeans.org/wiki/view/FaqI18nProjectEncoding
   * http://wiki.netbeans.org/wiki/view/FaqI18nChangeProjectEncodingImpact
   * http://wiki.netbeans.org/wiki/view/FaqI18nFileEncodingQueryObject

I'd suggest that if there's nothing amiss in the OLH, any new content should be added to the wiki.

Am setting this issue as resolved for now; Ken, if there's any outstanding issues that haven't been resolved, please
feel free to reopen and/or contact me directly.

thanks,
troy
Comment 10 Ken Frank 2008-03-06 20:42:33 UTC
verified; sorry for taking so long to do this.

All is as Troy mentions and IMO its done very well both for the olh
and the wiki faq pages !

ken.frank@sun.com