[I18N] Chinese (Simplified) Localization for Capella Documentation - Technical Approach Discussion

[luotianyiismywife]

Hi team,

I'd like to contribute a Chinese (Simplified) translation for the Capella documentation, starting with the User Manual.

Questions

1. MediaWiki vs HTML relationship

I noticed both .mediawiki and .html files exist in org.polarsys.capella.ui.doc:

• Which is the source format?
• How do I convert MediaWiki to HTML? (Ant build? Maven/Tycho?)

2. How to contribute

What is the preferred approach for localization?

• Create a NLS fragment plugin (org.polarsys.capella.ui.doc.nl_zh)?
• Or another method?

Any guidance would be appreciated. I can start with a proof-of-concept once the technical approach is confirmed.

Thanks!

[pdulth]

Hi ,

Thanks for your contribution.

I would go the easiest way to do it for now, and if later it requires to create some additional features, fragments, it can be done later by moving your files.

For the help

All the documentation is located in the doc folder under several plugins.
https://github.com/eclipse-capella/capella/tree/master/doc/plugins

You right, there is two files, the mediawiki and the html that is generated from the mediawiki file.
To generate them, there is a build.xml file located at the root of each plugins, allowing to generate the html.
It just need to be run through eclipse (https://github.com/eclipse-capella/capella/wiki/Development-How-To#generate-html-documentation) and will generate all the html at once for the current plugin.

You can add your translated files in a new nl folder, like below.

(don't forget to embed it by double clicking on build.properties file and check the checkbox in the "Binary Build")

When launched with -nl=fr, it will load the fr help.

e.g.

---

For the UI

Most of strings are externalized to *.properties files.

If you add a new one aside, it will load it.

I just tried to add french localization on views:

• messages_fr.properties aside the messages.properties

• plugin_fr.properties aside the plugin.properties