Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [platform-help-dev] Re: NLS and Eclipse help system

The description is given as a tree to show the structure. What you would
see on the disk given

   plugins/yourplugin/nl/zh/CN/
   plugins/yourplugin/nl/zh/TW/

is

plugins/yourplugin/nl/zh/CN
                                                                /TW

zh would have 2 subdirectories.

Thanks,

-----------------------------------
Peter Manahan
WebSphere Tools
Build/Install and
Product Architecture
------------------------------------
manahan@xxxxxxxxxx


                                                                                                                                       
                    Jennifer                                                                                                           
                    Calder/Toronto/IBM@IBMCA        To:     platform-help-dev@xxxxxxxxxxx                                              
                    Sent by:                        cc:                                                                                
                    platform-help-dev-admin@e       Subject:     [platform-help-dev] Re: NLS and Eclipse help system                   
                    clipse.org                                                                                                         
                                                                                                                                       
                                                                                                                                       
                    06/06/2002 11:13 AM                                                                                                
                    Please respond to                                                                                                  
                    platform-help-dev                                                                                                  
                                                                                                                                       
                                                                                                                                       



Hi -

A belated reply to this series...
So, if I understand this correctly, for R2 we'll place translated tocs and
docs into our plugins with a directory structure like this (in order of
priority, first to last)

   plugins/yourplugin/nl/<language>/<country>/
   plugins/yourplugin/nl/<language>/
   plugins/yourplugin/nl/
   plugins/yourplugin/

and I'm left wondering what to do with files that have been translated to
the same language, different country... For example, if I've got
Traditional Chinese and Simplified Chinese files, I'd think the help system
would expect a first priority structure like

   plugins/yourplugin/nl/zh/CN/
   plugins/yourplugin/nl/zh/TW/

but that wouldn't work - two directories named 'zh' at the same level....


Jennifer Calder, Toronto AIM Information Development, IBM Canada Toronto
Lab

external:
e-mail: jcalder@xxxxxxxxxx
Phone: 905-413-3917 / Tie Line: 8-969-3917

internal:
Office: D1/266, Address: D1/010/8200/MKM
Notes: Jennifer Calder/Toronto/IBM@IBMCA
Sametime Connect: jcalder@xxxxxxxxxx
Sametime e-meeting: Jennifer Calder/Toronto/IBM
URL: http://w3.torolab.ibm.com/~jcalder/


|--------+------------------------------------->
|        |          platform-help-dev-request@e|
|        |          clipse.org                 |
|        |          Sent by:                   |
|        |          platform-help-dev-admin@ecl|
|        |          ipse.org                   |
|        |                                     |
|        |                                     |
|        |          04/11/2002 12:05 PM        |
|        |          Please respond to          |
|        |          platform-help-dev          |
|        |                                     |
|--------+------------------------------------->
  >
----------------------------------------------------------------------------------------------------------|

  |
|
  |      To:     platform-help-dev@xxxxxxxxxxx
|
  |      cc:
|
  |      Subject:     platform-help-dev digest, Vol 1 #34 - 6 msgs
|
  |
|
  |
|
  >
----------------------------------------------------------------------------------------------------------|




Send platform-help-dev mailing list submissions to
           platform-help-dev@xxxxxxxxxxx

To subscribe or unsubscribe via the World Wide Web, visit
           http://dev.eclipse.org/mailman/listinfo/platform-help-dev
or, via email, send a message with subject or body 'help' to
           platform-help-dev-request@xxxxxxxxxxx

You can reach the person managing the list at
           platform-help-dev-admin@xxxxxxxxxxx

When replying, please edit your Subject line so it is more specific
than "Re: Contents of platform-help-dev digest..."


Today's Topics:

   1. NLS and Eclipse help system (Erik Hennum)
   2. Re: NLS and Eclipse help system (konradk@xxxxxxxxxx)
   3. Re: NLS and Eclipse help system (Erik Hennum)
   4. Re: NLS and Eclipse help system (konradk@xxxxxxxxxx)
   5. Re: NLS and Eclipse help system (manahan@xxxxxxxxxx)
   6. Re: NLS and Eclipse help system (birsan@xxxxxxxxxx)

--__--__--

Message: 1
To: platform-help-dev@xxxxxxxxxxx
From: "Erik Hennum" <ehennum@xxxxxxxxxx>
Date: Wed, 10 Apr 2002 10:50:04 -0700
Subject: [platform-help-dev] NLS and Eclipse help system
Reply-To: platform-help-dev@xxxxxxxxxxx

Hi, Ecliptans:

Can someone explain or provide an information resource for the Eclipse NLS
subdirectory structure within the documentation plugin directory?

From the org.eclipse.core.runtime.Plugin source code, it looks similar to
the following:

   eclipse
      plugins
         documentationPlugin
            nl
               languageIdentifier1
                  localized content files
               languageIdentifier2
                  localized content files

Is that right?

What would the language identifiers be?  It looks like a language
identifiers can have multiple components, which are separated by
underscores in the identifier and represented with subdirectories in the
plugin.


Thanks in advance,


Erik Hennum
ehennum@xxxxxxxxxx



--__--__--

Message: 2
Subject: Re: [platform-help-dev] NLS and Eclipse help system
To: platform-help-dev@xxxxxxxxxxx
Cc: platform-help-dev@xxxxxxxxxxx,
           platform-help-dev-admin@xxxxxxxxxxx
From: konradk@xxxxxxxxxx
Date: Wed, 10 Apr 2002 14:31:32 -0400
Reply-To: platform-help-dev@xxxxxxxxxxx

Hi,

In Eclipse 1.0 content files could reside in one of the following
directories(I will use Simplified Chinese in the example).  I list them in
the order that they are searched:
plugins/yourplugin/nl/zh_CN/
plugins/yourplugin/nl/zh/
plugins/yourplugin/nl/   - this will usually not have any files
plugins/yourplugin/ - this will usually have English files to be default to

In Eclipse 2.0 it is changing to:
plugins/yourplugin/nl/zh/CN/
plugins/yourplugin/nl/zh/
plugins/yourplugin/nl/   - this will usually not have any files
plugins/yourplugin/ - this will usually have English files to be default to

And for the documentation content html files, you should have them all
zipped into one file called doc.zip.  You would probably save this zip as
plugins/yourplugin/nl/zh_CN/doc.zip

Konrad Kolosowski
Eclipse Help System




                    Erik

                    Hennum/Oakland/IBM@IBMUS        To:
platform-help-dev@xxxxxxxxxxx
                    Sent by:                        cc:

                    platform-help-dev-admin@e       Subject:
[platform-help-dev] NLS and Eclipse help system
                    clipse.org



                    04/10/2002 01:50 PM

                    Please respond to

                    platform-help-dev






Hi, Ecliptans:

Can someone explain or provide an information resource for the Eclipse NLS
subdirectory structure within the documentation plugin directory?

From the org.eclipse.core.runtime.Plugin source code, it looks similar to
the following:

   eclipse
      plugins
         documentationPlugin
            nl
               languageIdentifier1
                  localized content files
               languageIdentifier2
                  localized content files

Is that right?

What would the language identifiers be?  It looks like a language
identifiers can have multiple components, which are separated by
underscores in the identifier and represented with subdirectories in the
plugin.


Thanks in advance,


Erik Hennum
ehennum@xxxxxxxxxx


_______________________________________________
platform-help-dev mailing list
platform-help-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/platform-help-dev




--__--__--

Message: 3
Subject: Re: [platform-help-dev] NLS and Eclipse help system
To: platform-help-dev@xxxxxxxxxxx
From: "Erik Hennum" <ehennum@xxxxxxxxxx>
Date: Wed, 10 Apr 2002 13:47:31 -0700
Reply-To: platform-help-dev@xxxxxxxxxxx


Hi, Konrad:

Thanks for the explanation.  I have two followup questions.

First, just to confirm, the localization scheme for zipped
documentation is the same as for unzipped, right?  That is,
the example for Eclipse version 2 would replace the
underscore in the locale identifier with a directory
separator, as in:

plugins/yourplugin/nl/zh/CN/doc.zip

Second, in the "infocenter" Eclipse scenario, is there
any provision for clients with different locales connecting
to a single Eclipse web server?  Could a client use
a query parameter to set the locale in a session
variable on the server?


Regards,


Erik Hennum
ehennum@xxxxxxxxxx





                      Konrad

                      Kolosowski/Toronto/IBM@I        To:
platform-help-dev@xxxxxxxxxxx
                      BMCA                            cc:
platform-help-dev@xxxxxxxxxxx, platform-help-dev-admin@xxxxxxxxxxx
                      Sent by:                        Subject:  Re:
[platform-help-dev] NLS and Eclipse help system
                      platform-help-dev-admin@

                      eclipse.org



                      04/10/2002 11:31 AM

                      Please respond to

                      platform-help-dev






Hi,

In Eclipse 1.0 content files could reside in one of the following
directories(I will use Simplified Chinese in the example).  I list them in
the order that they are searched:
plugins/yourplugin/nl/zh_CN/
plugins/yourplugin/nl/zh/
plugins/yourplugin/nl/   - this will usually not have any files
plugins/yourplugin/ - this will usually have English files to be default to

In Eclipse 2.0 it is changing to:
plugins/yourplugin/nl/zh/CN/
plugins/yourplugin/nl/zh/
plugins/yourplugin/nl/   - this will usually not have any files
plugins/yourplugin/ - this will usually have English files to be default to

And for the documentation content html files, you should have them all
zipped into one file called doc.zip.  You would probably save this zip as
plugins/yourplugin/nl/zh_CN/doc.zip

Konrad Kolosowski
Eclipse Help System




                    Erik

                    Hennum/Oakland/IBM@IBMUS        To:
platform-help-dev@xxxxxxxxxxx
                    Sent by:                        cc:

                    platform-help-dev-admin@e       Subject:
[platform-help-dev] NLS and Eclipse help system
                    clipse.org



                    04/10/2002 01:50 PM

                    Please respond to

                    platform-help-dev






Hi, Ecliptans:

Can someone explain or provide an information resource for the Eclipse NLS
subdirectory structure within the documentation plugin directory?

From the org.eclipse.core.runtime.Plugin source code, it looks similar to
the following:

   eclipse
      plugins
         documentationPlugin
            nl
               languageIdentifier1
                  localized content files
               languageIdentifier2
                  localized content files

Is that right?

What would the language identifiers be?  It looks like a language
identifiers can have multiple components, which are separated by
underscores in the identifier and represented with subdirectories in the
plugin.


Thanks in advance,


Erik Hennum
ehennum@xxxxxxxxxx


_______________________________________________
platform-help-dev mailing list
platform-help-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/platform-help-dev



_______________________________________________
platform-help-dev mailing list
platform-help-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/platform-help-dev





--__--__--

Message: 4
Subject: Re: [platform-help-dev] NLS and Eclipse help system
To: platform-help-dev@xxxxxxxxxxx
Cc: platform-help-dev@xxxxxxxxxxx,
           platform-help-dev-admin@xxxxxxxxxxx
From: konradk@xxxxxxxxxx
Date: Wed, 10 Apr 2002 18:14:13 -0400
Reply-To: platform-help-dev@xxxxxxxxxxx

Eric,

Yes.  The localization scheme for zipped documentation is the same as for
unzipped.  The zip would be in plugins/yourplugin/nl/zh/CN/doc.zip

In the infocenter scenario (only, not when just launchin help from
Eclipse), help uses request.getLocale() as a mechanism on deciding which
language is to be served to the user.
If you want to override the locale that the user's browser sends, you are
free to do it.  Servers has different mechanisms that allow to do this.
For example in Tomcat 4, you can define a filter that will massage the
query as you like, before it gets to the web application.  You could define
a URL paths for each language.  They would all point to the same infocenter
application, but would have a filter set a Locale on a query differently.

Konrad Kolosowski
Eclipse Help System



--__--__--

Message: 5
Subject: Re: [platform-help-dev] NLS and Eclipse help system
To: platform-help-dev@xxxxxxxxxxx
Cc: platform-help-dev@xxxxxxxxxxx,
           platform-help-dev-admin@xxxxxxxxxxx
From: manahan@xxxxxxxxxx
Date: Wed, 10 Apr 2002 19:08:33 -0400
Reply-To: platform-help-dev@xxxxxxxxxxx


Just a quick question. Since docs can get to be kind of big are fragments
also an option for adding NL documentation or must "plugins" be used?
Otherwise you'd have to

1) ship all the translated docs if you believe  the plugins are units
atomic units (which according to the update manager I believe they are) .
2) or only install pieces of plugins which doesn't make sense I think.

For WSAD I believe the docs are quite large (around 10-20 meg per lang if i
remember correctly) That's kind of a large footprint if we ship 9
languages. A 100+ megabytes plugin seems unwieldy :-).



Thanks,

-----------------------------------
Peter Manahan
WebSphere Tools
Build/Install and
Product Architecture
------------------------------------
manahan@xxxxxxxxxx



                    Konrad

                    Kolosowski/Toronto/IBM@IB       To:
platform-help-dev@xxxxxxxxxxx
                    MCA                             cc:
platform-help-dev@xxxxxxxxxxx,
                    Sent by:
platform-help-dev-admin@xxxxxxxxxxx
                    platform-help-dev-admin@e       Subject:     Re:
[platform-help-dev] NLS and Eclipse help system
                    clipse.org



                    10/04/2002 06:14 PM

                    Please respond to

                    platform-help-dev






Eric,

Yes.  The localization scheme for zipped documentation is the same as for
unzipped.  The zip would be in plugins/yourplugin/nl/zh/CN/doc.zip

In the infocenter scenario (only, not when just launchin help from
Eclipse), help uses request.getLocale() as a mechanism on deciding which
language is to be served to the user.
If you want to override the locale that the user's browser sends, you are
free to do it.  Servers has different mechanisms that allow to do this.
For example in Tomcat 4, you can define a filter that will massage the
query as you like, before it gets to the web application.  You could define
a URL paths for each language.  They would all point to the same infocenter
application, but would have a filter set a Locale on a query differently.

Konrad Kolosowski
Eclipse Help System


_______________________________________________
platform-help-dev mailing list
platform-help-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/platform-help-dev





--__--__--

Message: 6
Subject: Re: [platform-help-dev] NLS and Eclipse help system
To: platform-help-dev@xxxxxxxxxxx
From: birsan@xxxxxxxxxx
Date: Wed, 10 Apr 2002 21:25:27 -0400
Reply-To: platform-help-dev@xxxxxxxxxxx

Yes, fragments are fine.
Help uses the platform API's to find NL directories, so you can deploy
translated docs in the same places you would deploy translated
properties/jars/etc.

-Dorian





                    Peter

                    Manahan/Toronto/IBM@IBMCA       To:
platform-help-dev@xxxxxxxxxxx

                    Sent by:                        cc:
platform-help-dev@xxxxxxxxxxx, platform-help-dev-admin@xxxxxxxxxxx

                    platform-help-dev-admin@e       Subject:     Re:
[platform-help-dev] NLS and Eclipse help system
                    clipse.org



                    04/10/2002 07:08 PM

                    Please respond to

                    platform-help-dev







Just a quick question. Since docs can get to be kind of big are fragments
also an option for adding NL documentation or must "plugins" be used?
Otherwise you'd have to

1) ship all the translated docs if you believe  the plugins are units
atomic units (which according to the update manager I believe they are) .
2) or only install pieces of plugins which doesn't make sense I think.

For WSAD I believe the docs are quite large (around 10-20 meg per lang if i
remember correctly) That's kind of a large footprint if we ship 9
languages. A 100+ megabytes plugin seems unwieldy :-).



Thanks,

-----------------------------------
Peter Manahan
WebSphere Tools
Build/Install and
Product Architecture
------------------------------------
manahan@xxxxxxxxxx



                    Konrad

                    Kolosowski/Toronto/IBM@IB       To:
platform-help-dev@xxxxxxxxxxx
                    MCA                             cc:
platform-help-dev@xxxxxxxxxxx,
                    Sent by:
platform-help-dev-admin@xxxxxxxxxxx
                    platform-help-dev-admin@e       Subject:     Re:
[platform-help-dev] NLS and Eclipse help system
                    clipse.org



                    10/04/2002 06:14 PM

                    Please respond to

                    platform-help-dev






Eric,

Yes.  The localization scheme for zipped documentation is the same as for
unzipped.  The zip would be in plugins/yourplugin/nl/zh/CN/doc.zip

In the infocenter scenario (only, not when just launchin help from
Eclipse), help uses request.getLocale() as a mechanism on deciding which
language is to be served to the user.
If you want to override the locale that the user's browser sends, you are
free to do it.  Servers has different mechanisms that allow to do this.
For example in Tomcat 4, you can define a filter that will massage the
query as you like, before it gets to the web application.  You could define
a URL paths for each language.  They would all point to the same infocenter
application, but would have a filter set a Locale on a query differently.

Konrad Kolosowski
Eclipse Help System


_______________________________________________
platform-help-dev mailing list
platform-help-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/platform-help-dev




_______________________________________________
platform-help-dev mailing list
platform-help-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/platform-help-dev





--__--__--

_______________________________________________
platform-help-dev mailing list
platform-help-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/platform-help-dev


End of platform-help-dev Digest



_______________________________________________
platform-help-dev mailing list
platform-help-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/platform-help-dev





Back to the top