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 18865 - Move info on localization and branding to API documentation
Summary: Move info on localization and branding to API documentation
Status: STARTED
Alias: None
Product: platform
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 3.x
Hardware: All All
: P3 blocker (vote)
Assignee: Geertjan Wielenga
URL: http://www.netbeans.org/i18n/
Keywords: I18N
Depends on:
Blocks:
 
Reported: 2001-12-20 12:04 UTC by Jesse Glick
Modified: 2012-06-19 16:14 UTC (History)
2 users (show)

See Also:
Issue Type: TASK
Exception Reporter:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Jesse Glick 2001-12-20 12:04:38 UTC 
It seems that much of the page referenced above is really part of the APIs and
deserves to be included in their documentation, rather than a page floating on
the website. Of course some of what is there is not official specifications of
how the IDE must behave, but I think the content can be separated into:

1. how NbBundle and localization and branding work technically

2. unsupported but currently true aspects of how to package localized/branded
resources (locale/ JARs etc.)

3. other conventions specific to the NetBeans project, e.g. #NOI18N marker in
bundles, not controlled by the APIs

4. tips and techniques, e.g. bundle debugging mode, or the how-to on localizing
manifests

Probably 1. should be in APIs marked as official, 2. as unofficial, 3. left
where it is (but linked to from the APIs for convenience), 4. perhaps put in
APIs as unofficial info or perhaps left where it is but linked to.

At a minimum, the existing page should be linked to from the list of "Other
Documents" in the APIs summary page, so people know it exists.
Comment 1 Jesse Glick 2002-02-08 12:55:35 UTC 
Don't forget that info on branding of layers and especially using mask
files is nearly hidden ATM.
Comment 2 jcatchpoole 2002-03-20 18:53:46 UTC 
FYI : 

Due to the website redesign, i18n docs have moved to a new location :

  http://www.netbeans.org/devhome/docs/i18n/

Any problems pls contact webmaster@netbeans.org
Comment 3 Marek Grummich 2002-07-22 11:24:36 UTC 
Set target milestone to TBD
Comment 4 Marek Grummich 2002-07-22 11:27:30 UTC 
Set target milestone to TBD
Comment 5 Jesse Glick 2002-08-05 15:27:00 UTC 
Also document mistakes such as these:

ResourceBundle bundle = ResourceBundle.getBundle(...);
bundle.getString("KEY");
// should have used NbBundle which permits branding

Icon i = new ImageIcon(Class.getResource("ide.gif"));
// should have used nbresloc:/.../ide.gif
// or NbBundle.findLocalizedResource

<folder name="Templates">
     <file name="Something.java" url="Something.java.tmpl">
         <attr name="template" boolvalue="true"/>
         <!-- using an unlocalized name here -->
         <!-- should have used SystemFileSystem.localizingBundle -->
     </file>
</folder>
Comment 6 Jesse Glick 2003-02-06 16:07:42 UTC 
Did a physical move, still working on precise edits.
Comment 7 Jesse Glick 2003-02-24 19:32:09 UTC 
Also need to mention org.openide.awt.Mnemonics.
Comment 8 Jesse Glick 2003-03-19 00:15:41 UTC 
The rest will have to wait.