Message:

  A new issue has been created in JIRA.

---------------------------------------------------------------------
View the issue:
  http://jira.codehaus.org/browse/MPXDOC-109

Here is an overview of the issue:
---------------------------------------------------------------------
        Key: MPXDOC-109
    Summary: Support doc in several languages
       Type: New Feature

     Status: Open
   Priority: Major

 Original Estimate: 2 weeks
 Time Spent: Unknown
  Remaining: 2 weeks

    Project: maven-xdoc-plugin
   Versions:
             1.7

   Assignee: Jason van Zyl
   Reporter: Eirik Maus

    Created: Mon, 14 Jun 2004 10:40 AM
    Updated: Mon, 14 Jun 2004 10:40 AM

Description:
I just run into a problem with some software we develop with maven that is going to be 
used by various minorities: They don not only want the user interface to be in their 
own language, but also the documentation (user manual etc). 

The documentation is (of course) written using xdoc. The problem is: there is no 
decent way to have multiple versions of the same document hierarchy using the xdoc 
plugin. 

Some discussion led to the following set of "requirements" (wishes) for functionality:

1: 
Localization should not be mandatory, but should be supported by the standard xdocs 
plugin using the standard goals. Enabling/disabling localization should be possible 
using a property. 

2:  
Localized documentation should be modelled somewhat similar to localized property sets 
for applications in Java. No need to reinvent the wheel. We suggest adapting the 
ISO-standard 2-by-2+x letter naming conventions for property files on to the xdocs 
directory: 
- xdocs  : contains "default" version of files
- xdocs.la_CN_va contains info for 
 - - language "la", 
 - - country "CN", 
 - - variant "va": any number of letters, such as "trad"
Examples:
- xdocs : default documents
- xdocs.fr_CA : Documentation in Canadian french 
- xdocs.fr_FR : Doc in French French
- xdocs.se_NO : Doc for North-Sami in Norway
- xdocs.de_DE_platt : Hamburg-area "plattdyts" (Platt-Deutch german)



3: 
If a document isn't translated (exists in xdocs but not in xdocs.la_CN) the default 
version should be used. Perhaps a warning should be inserted at the top (but there are 
practical issues here related to a possible translation of the message). 


4:
It should be possible to override navigation.xml with localized labels somehow. 


5:
When localization is used, a second "language bar" should be inserted in the pages 
below the data bar, containing miniature flags that link to the languages that are 
available for the given document. The flags are provided by the editor, as a file:
- xdocs.la_CN/flag.gif
The flag for "default" is provided by the plugin (and perhaps also some for popular 
languages such as japanese etc). 



This should be possible to implement with only a "sensible" amount of change. 




---------------------------------------------------------------------
JIRA INFORMATION:
This message is automatically generated by JIRA.

If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa

If you want more information on JIRA, or have a bug to report see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to