2009-06-16 11 views
1

Je vais utiliser les commentaires XML pour documenter une API d'extensibilité d'une application, mais je n'ai trouvé aucune référence pour utiliser plusieurs langues ou n'importe quel moyen de localiser ces fichiers. Je voudrais utiliser sandcastle ou tout autre outil (ABD ...?), Mais je ne sais pas où placer les commentaires XML traduits, je ne sais pas si je devrais utiliser le même schéma XML, etc ...Xml Commentaires Localisation

Avez-vous une expérience à ce sujet?

Répondre

1

Créez un fichier XML (utilisez-vous un schéma?) Qui contient les commentaires en tant qu'éléments avec des attributs xml: lang identifiant chacun d'entre eux.

Vous pouvez ensuite utiliser XSLT ou XQuery pour créer des versions dans des langues spécifiques à la demande, ou au moins permettre au lecteur de le faire.

C'est plus difficile à faire si vous utilisez, mais si vous utilisez ce qui précède, votre XSLT ou XQuery pourrait effectivement générer un autre fichier avec les commentaires dans la langue cible.

Espérons que cela aide.

+0

ok, cela aide! Mais j'ai un "fichier de documentation xml" original de l'API, supposons que ce soit en anglais. Si je copie le fichier et le traduit, il sera désynchronisé rapidement! – QbProg

+0

C'est pourquoi vous voulez garder toutes les traductions au même endroit. Mais les traductions qui se désynchronisent posent un problème, à moins que tous ceux qui conservent le fichier connaissent toutes les langues - ou soient très disciplinés ou doivent adhérer à des processus spécifiques. – lavinio

1

Cela vous semble être un bon cas pour écrire une extension d'éditeur avec Visual Studio 2010. Le nouvel éditeur rend cela très pratique, et ils publient beaucoup d'exemples de cela. Cependant, comme l'ont indiqué les autres réponses, vous devrez d'abord déterminer ce que vous devez accomplir. Vous devrez peut-être extraire les commentaires modifiés dans un fichier, puis informer quelqu'un de démarrer votre processus de localisation sur les modifications. Vous n'allez probablement pas effectuer de localisation automatique, mais vous pouvez probablement automatiser le processus en rassemblant les commentaires modifiés, en les envoyant pour être localisés, puis en incorporant les documents traduits dans votre documentation une fois qu'ils sont traduits.