xDoc i18n base language HTML placed in wrong directory

[Lance Bader <ld...@gmail.com>]

I'm willing to believe I'm wrong, but if the base langague is xx, shouldn't
the generated HTML be placed in ${maven.docs.dest}/xx?

Consider this scenario.

- Assume that there are number of files that are copied, not generated from
XML source, including images, style sheets, Javadoc, and code templates.

- The base language source files contain relative URLs to these files.

- The team who translates the base language source files are only changing
the text between the tags.  They are not changing relative URLs.  Even if
they understand URLs, they don't know which relative URLs must be modified.

- For each supported language yy, the generated HTML is placed in ${
maven.docs.dest}/yy.  If the base language xx is placed in ${maven.docs.dest}
instead of ${maven.docs.dest}/xx, all of the relative URLs that reference
files that are not generated by the xDoc plugin must be different for the
base language and the other languages.

Of course, for me, it is much more pleasing to see all the supported
languages, including the base language, appear in parallel directory trees
where the name of the root is the ISO language code.  However, if my sense
of aesthetics and symmetry is blinding me a better solution, I will just
have to ignore my senses.

Lance

Re: xDoc i18n base language HTML placed in wrong directory

[Lukas Theussl <lt...@apache.org>]

Lance Bader wrote:
> No, I double checked my prototype web site.  If a directory does not contain
> any xdoc source files (like images or styles in my structure), it is copied
> to the base directory but not the language directories.  Maybe this is a
> defect?

This should be fixed in the current 1.10-SNAPSHOT of the xdoc plugin:
http://jira.codehaus.org/browse/MPXDOC-177

-Lukas


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org

Re: xDoc i18n base language HTML placed in wrong directory

[David Sag <ds...@epo.org>]

Lance Bader wisely said:
"Automatic redirection based on browser locale is a good idea for a 
consumer
site but our multi-lingual users are aggravated if they have to change the
browser's locale in order to view a particular language.  A multi-lingual
front page allowing quick choices to a particular version is much
preferred."

as an expat aussie living in europe i couldn't agree more.  try buying 
anything from the apple store in the netherlands as an english speaker - 
it's insanity. i am happy for sites to pick up the country from the 
browser (or ip number) but they should always allow the user to select 
their preferred language.

that's my 2cents (ie my euro 0.01421512) worth

Kind regards,
Dave Sag 




 

"Lance Bader" <ld...@gmail.com> wrote on 01-03-2006 15:58:42:

> No, I double checked my prototype web site.  If a directory does not 
contain
> any xdoc source files (like images or styles in my structure), it is 
copied
> to the base directory but not the language directories.  Maybe this is a
> defect?
> 
> Better yet, use the value specified as the base language, ${
> maven.xdoc.locale.default}, if specified explicitly rather than left
> unspecified, in the root of docs.
> 
> Automatic redirection based on browser locale is a good idea for a 
consumer
> site but our multi-lingual users are aggravated if they have to change 
the
> browser's locale in order to view a particular language.  A 
multi-lingual
> front page allowing quick choices to a particular version is much
> preferred.
> 
> Lance
> 
> On 2/27/06, Arnaud HERITIER <ah...@gmail.com> wrote:
> >
> > I think that user resources (images, ..) are copied in each language
> > directory and in the top directory.
> > We put the default language in the root of the documentation because 
we
> > didn't know what to add in the root of the docs without it ?
> > A default home page with links for all documentations ? It's not very 
nice
> > for a project homepage.
> > What I prefered was to have a redirection page which move the user to 
the
> > default language subdirectory.
> > But how to do that ? It's not really standard to use the meta tag
> > "refresh".
> >
> > Arnaud
> >
> > On 2/27/06, Lance Bader <ld...@gmail.com> wrote:
> > >
> > > I'm willing to believe I'm wrong, but if the base langague is xx,
> > > shouldn't
> > > the generated HTML be placed in ${maven.docs.dest}/xx?
> > >
> > > Consider this scenario.
> > >
> > > - Assume that there are number of files that are copied, not 
generated
> > > from
> > > XML source, including images, style sheets, Javadoc, and code 
templates.
> > >
> > > - The base language source files contain relative URLs to these 
files.
> > >
> > > - The team who translates the base language source files are only
> > changing
> > > the text between the tags.  They are not changing relative URLs. 
Even
> > if
> > > they understand URLs, they don't know which relative URLs must be
> > > modified.
> > >
> > > - For each supported language yy, the generated HTML is placed in ${
> > > maven.docs.dest}/yy.  If the base language xx is placed in ${
> > > maven.docs.dest}
> > > instead of ${maven.docs.dest}/xx, all of the relative URLs that
> > reference
> > > files that are not generated by the xDoc plugin must be different 
for
> > the
> > > base language and the other languages.
> > >
> > > Of course, for me, it is much more pleasing to see all the supported
> > > languages, including the base language, appear in parallel directory
> > trees
> > > where the name of the root is the ISO language code.  However, if my
> > sense
> > > of aesthetics and symmetry is blinding me a better solution, I will 
just
> > > have to ignore my senses.
> > >
> > > Lance
> > >
> > >
> >
> >

Re: xDoc i18n base language HTML placed in wrong directory

[Lance Bader <ld...@gmail.com>]

No, I double checked my prototype web site.  If a directory does not contain
any xdoc source files (like images or styles in my structure), it is copied
to the base directory but not the language directories.  Maybe this is a
defect?

Better yet, use the value specified as the base language, ${
maven.xdoc.locale.default}, if specified explicitly rather than left
unspecified, in the root of docs.

Automatic redirection based on browser locale is a good idea for a consumer
site but our multi-lingual users are aggravated if they have to change the
browser's locale in order to view a particular language.  A multi-lingual
front page allowing quick choices to a particular version is much
preferred.

Lance

On 2/27/06, Arnaud HERITIER <ah...@gmail.com> wrote:
>
> I think that user resources (images, ..) are copied in each language
> directory and in the top directory.
> We put the default language in the root of the documentation because we
> didn't know what to add in the root of the docs without it ?
> A default home page with links for all documentations ? It's not very nice
> for a project homepage.
> What I prefered was to have a redirection page which move the user to the
> default language subdirectory.
> But how to do that ? It's not really standard to use the meta tag
> "refresh".
>
> Arnaud
>
> On 2/27/06, Lance Bader <ld...@gmail.com> wrote:
> >
> > I'm willing to believe I'm wrong, but if the base langague is xx,
> > shouldn't
> > the generated HTML be placed in ${maven.docs.dest}/xx?
> >
> > Consider this scenario.
> >
> > - Assume that there are number of files that are copied, not generated
> > from
> > XML source, including images, style sheets, Javadoc, and code templates.
> >
> > - The base language source files contain relative URLs to these files.
> >
> > - The team who translates the base language source files are only
> changing
> > the text between the tags.  They are not changing relative URLs.  Even
> if
> > they understand URLs, they don't know which relative URLs must be
> > modified.
> >
> > - For each supported language yy, the generated HTML is placed in ${
> > maven.docs.dest}/yy.  If the base language xx is placed in ${
> > maven.docs.dest}
> > instead of ${maven.docs.dest}/xx, all of the relative URLs that
> reference
> > files that are not generated by the xDoc plugin must be different for
> the
> > base language and the other languages.
> >
> > Of course, for me, it is much more pleasing to see all the supported
> > languages, including the base language, appear in parallel directory
> trees
> > where the name of the root is the ISO language code.  However, if my
> sense
> > of aesthetics and symmetry is blinding me a better solution, I will just
> > have to ignore my senses.
> >
> > Lance
> >
> >
>
>

Re: xDoc i18n base language HTML placed in wrong directory

[Arnaud HERITIER <ah...@gmail.com>]

I think that user resources (images, ..) are copied in each language
directory and in the top directory.
We put the default language in the root of the documentation because we
didn't know what to add in the root of the docs without it ?
A default home page with links for all documentations ? It's not very nice
for a project homepage.
What I prefered was to have a redirection page which move the user to the
default language subdirectory.
But how to do that ? It's not really standard to use the meta tag "refresh".

Arnaud

On 2/27/06, Lance Bader <ld...@gmail.com> wrote:
>
> I'm willing to believe I'm wrong, but if the base langague is xx,
> shouldn't
> the generated HTML be placed in ${maven.docs.dest}/xx?
>
> Consider this scenario.
>
> - Assume that there are number of files that are copied, not generated
> from
> XML source, including images, style sheets, Javadoc, and code templates.
>
> - The base language source files contain relative URLs to these files.
>
> - The team who translates the base language source files are only changing
> the text between the tags.  They are not changing relative URLs.  Even if
> they understand URLs, they don't know which relative URLs must be
> modified.
>
> - For each supported language yy, the generated HTML is placed in ${
> maven.docs.dest}/yy.  If the base language xx is placed in ${
> maven.docs.dest}
> instead of ${maven.docs.dest}/xx, all of the relative URLs that reference
> files that are not generated by the xDoc plugin must be different for the
> base language and the other languages.
>
> Of course, for me, it is much more pleasing to see all the supported
> languages, including the base language, appear in parallel directory trees
> where the name of the root is the ISO language code.  However, if my sense
> of aesthetics and symmetry is blinding me a better solution, I will just
> have to ignore my senses.
>
> Lance
>
>