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 95486 - I18N - README in the sample application cannot be localized
Summary: I18N - README in the sample application cannot be localized
Status: RESOLVED WONTFIX
Alias: None
Product: obsolete
Classification: Unclassified
Component: visualweb (show other bugs)
Version: 5.x
Hardware: All All
: P3 blocker (vote)
Assignee: Ch Nguyen
URL:
Keywords: I18N
Depends on:
Blocks:
 
Reported: 2007-02-13 23:50 UTC by bugbridge
Modified: 2008-09-11 21:54 UTC (History)
3 users (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 bugbridge 2007-02-13 23:50:14 UTC
Original status: 5-Cause Known; Suggested Status: NEW

Original Target Release: mako_dev; Suggested Target Milestone : Dev

These items should be added to the Keywords: I18N

Description:
When selecting the JAAS Authentication project in the New Project wizard,
the following description appears.

    Be sure to review the README.txt file in the <project-dir>/web/ directory.

If users need to read the README.txt, I think that it would better to translate it.

This is my idea to transalte the README.
- Translate the README.html file, not READNE.txt
  If we translate the text file, we need to provide the text files for all
supportd locales.
- Put English and localized README files in rave2.0/docs/
  If we can do it, the localized README does not need to be included in the
sample project.
- Change "<project-dir>/web/ directory" to "<install-dir>/rave2.0/docs/ directory"
  in the above rescription.
- If needed, translate the README files in other project

Evaluation:
This will be fixed for Mako. Updating to 5 Cause known for dashboard reasons.
Comment 1 _ potingwu 2007-02-22 23:22:23 UTC
Sample Application is not high-priority task for next release.
Comment 2 Ken Frank 2007-08-21 15:51:20 UTC
there is a process for doing this now provided by nb team; 

here is some info - contact John C. and Tomas Pavek for more info:

f you have a readme that goes along with the samples, you can use the mechanism implemented in usersguide/j2sesamples/
for opening the readme as an HTML file in the external browser rather than as a text file in the source editor. From
Tomas Pavek:

What sample apps do you mean? The mechanism is implemented in usersguide/j2seexamples module - so if you add some new
app to this module, it will be easy for you. Otherwise you'd need to copy the code from
J2SESampleProjectIterator.instantiate.

The readme html file can be stored anywhere a url can point to (e.g. in NB installation under nb6.0/docs - which is
ide/welcome/release/docs in cvs). Then you need a .url file to hold the url. The .url file stays in the j2seexamples
module and is registered via mf-layer.xml. Just take a look at how the GUI examples url file is registered in
cvs/usersguide/j2seexamples/src/org/netbeans/modules/java/examples/resources/mf-layer.xml

Please send Tomas questions if you're unsure about how to do this. 

### questions I asked about this wrt i18n:

- is this setup so that localized html files will be found if there is a .url file
in the localized jar of the module pointing to the localize one ?
(be sure to add these .url files to the l10n.list)

- if so, will the localized jars live next to the en one, but with name
filename_<localename>.html ?
(assuming here the html files will not be in the sample zip but in actual
nb installed product, since will be a problem for localized if need to
live in sample zip.)

- as is mentioned the file should be an html one and not a .txt one,
since for localizations for ja and zh, since there are some sub locales
that have different encodings, there is no one encoding that can be handled
by a text file but there is one meta charset tag that will work so that just
one localized html file per locale is needed.

- could there be added to the sample wiki page a column that notes, for each sample,  the
name of the sample readme html file and where they are going to live in nb ?
this info will help with i18n testing besides helping translators later.

ken.frank@sun.com
Comment 3 _ jbisso 2007-09-29 14:57:40 UTC
Assigning to Mark for reassignment.
Comment 4 Peter Zavadsky 2008-09-11 21:07:01 UTC
In visualweb.samples.bundled are now some readme.html (no readme.txt to be used in the samples itself, only one for the
module description, which is not to be i18n-ized). Please, let us know whether this issue applied to the readme.html.
Thanks.
Comment 5 Ken Frank 2008-09-11 21:33:26 UTC
I think this one can be closed.

I don't think its required that the readme of a sample be
translatable even though that would be good.

But from past discussions/issues seems it was not an easily done
process - since i think the sample just gets unzipped when its
created ?  but would have to know what locale it was in and then
invoke the localized one that would need to be in a separate
localized jar/zip, since could not be in the en one.

java makes this easy, and nb does have code that shows template
descriptors and of course olh based on locale, but not yet for
such sample readmes.

some modules have the html file loose, not in jar, and they have implemented
that when user in a locale for which its been xlated, the localzied one will
show - see nb6.5/docs GUIExamples.html

ken.frank@sun.com
Comment 6 Peter Zavadsky 2008-09-11 21:54:55 UTC
OK, thanks. I pass this to components, since there is the issue, but also I close it, since at this moment those are not
developed further (the woodstock ones, which are used in the samples).