Episode 16 Putting DITA Localization into Practice Su-Laine Yeo, Solutions Consultant in 37 minutes
Agenda <ul><li>What’s new at JustSystems </li></ul><ul><li>How to set up, how to manage files </li></ul><ul><li>Guidelines...
What’s New <ul><li>OASIS has officially released the  DITA 1.2 specification </li></ul><ul><li>Patch available for McAfee ...
Why DITA for localization? <ul><li>Desktop publishing takes minutes, not days, per language </li></ul><ul><li>Topic-orient...
How it all works <ul><li>Parallel folder systems for each language </li></ul>English: French:
Use the xml:lang attribute <ul><li><map xml:lang = “fr-fr”> </li></ul><ul><li><title>Guide de l’utilisateur</title> </li><...
How it all works (cont’d) <ul><li>Identical structural markup in each language </li></ul><topic xml:lang =  &quot;en-us&qu...
How it all works (cont’d) <ul><li>Publishing system produces production-quality output automatically </li></ul><ul><li>Pub...
LOCALIZATION-FRIENDLY WRITING
Use elements, not attributes <ul><li>Some translation software does not allow translating attribute values </li></ul><ul><...
Inline elements <ul><li>Remove extra spaces </li></ul><ul><li>Use semantic elements </li></ul>
Images: Using numbered callouts
Images: Using SVG <ul><li>Lets you use text within callouts </li></ul><ul><li>Send the SVG file to the translator to have ...
Index markers and glossary entries <ul><li>For Japanese and Chinese, use <index-sort-as> elements </li></ul><ul><li>If nee...
Identify what not to translate <ul><li>Tell translators what types of elements should not be translated, e.g. <codeblock> ...
LOCALIZATION AND REUSE
Conditional text and conref <ul><li>Languages often require words in a sentence to “agree” with words which come before or...
WORKING WITH TRANSLATORS
Rule #1 <ul><li>Your translator MUST work in DITA XML </li></ul>Picture: Fir0002
Use XLIFF <ul><li>XML Localization Interchange File Format </li></ul><ul><li>Packages all topic and map files into a singl...
Watch “white space” <ul><li>White space (“pretty printing”) makes XML easier to read in Plain Text View, but can confuse t...
Checklist: Communicating  with your translator <ul><li>Give XSD/DTD files to your translator </li></ul><ul><li>Which attri...
Clean content in, clean content out <ul><li>You: </li></ul><ul><li>fix validation errors </li></ul><ul><li>fix broken link...
TOOLS
Select localization-friendly tools <ul><li>All tools must be Unicode-compliant </li></ul><ul><li>Authoring tools must supp...
Consider tools for controlled language
Tools will need configuration <ul><li>In publishing tools: </li></ul><ul><li>Generated text strings </li></ul><ul><li>Font...
DITA Open Toolkit (Version 1.5) <ul><li>Methods for customizing the toolkit vary by output format (e.g. PDF vs. HTML) </li...
Heads-up: Font issues <ul><li>In PDF output, the default behaviour is for text to  not  appear </li></ul><ul><li>Only char...
Summary <ul><li>Potentially huge cost and time savings </li></ul><ul><ul><li>Enables simultaneous shipping </li></ul></ul>...
Further reading <ul><li>“ Using DITA for Successful Localization”: http://na.justsystems.com/whitepapers.php </li></ul>
<ul><li>Global Presence </li></ul><ul><ul><li>1,000 employees, ‘07 revenues of $110M </li></ul></ul><ul><ul><li>HQ in Japa...
Global Customers Automotive Aerospace Publishing Other High-Tech Financial
Upcoming SlideShare
Loading in …5
×

Putting DITA Localization into Practice

2,598 views

Published on

Using the DITA XML standard can bring enormous improvements in the efficiency of localizing documentation. Some organizations report efficiency gains of 30-50% over traditional desktop publishing systems, and use the savings to expand further into global markets. This session gives a practical set of steps and guidelines for delivering your content smoothly and quickly in multiple languages. We will cover how to mark up content, how localization affects reuse, how to work with translators, and issues in generating localized deliverables. You'll learn about the big picture of how translation works in DITA, what steps you need to include in your process in order to get high-quality results, and exactly how to avoid common pitfalls that tend to make localization tricky.

Published in: Technology
  • Be the first to comment

  • Be the first to like this

Putting DITA Localization into Practice

  1. 1. Episode 16 Putting DITA Localization into Practice Su-Laine Yeo, Solutions Consultant in 37 minutes
  2. 2. Agenda <ul><li>What’s new at JustSystems </li></ul><ul><li>How to set up, how to manage files </li></ul><ul><li>Guidelines for writing </li></ul><ul><li>Choosing and working with translators </li></ul><ul><li>Choosing tools </li></ul><ul><li>What things will take more time than you think </li></ul>
  3. 3. What’s New <ul><li>OASIS has officially released the DITA 1.2 specification </li></ul><ul><li>Patch available for McAfee Antivirus conflict: See http://forums.xmetal.com and search for “McAfee” </li></ul>
  4. 4. Why DITA for localization? <ul><li>Desktop publishing takes minutes, not days, per language </li></ul><ul><li>Topic-oriented structure enables incremental translation </li></ul><ul><li>Reuse leads to less content to translate </li></ul><ul><li>Time savings enable simultaneous shipping </li></ul><ul><li>Efficiency gains of up to 30-50% </li></ul><ul><li>Makes it possible to deliver in more languages </li></ul>
  5. 5. How it all works <ul><li>Parallel folder systems for each language </li></ul>English: French:
  6. 6. Use the xml:lang attribute <ul><li><map xml:lang = “fr-fr”> </li></ul><ul><li><title>Guide de l’utilisateur</title> </li></ul><ul><li>… </li></ul><ul><li></map> </li></ul>
  7. 7. How it all works (cont’d) <ul><li>Identical structural markup in each language </li></ul><topic xml:lang = &quot;en-us&quot; > ... <note type = “attention&quot; > Watch your step as you disembark. </note> ... </topic> <topic xml:lang = “fr-fr&quot; > ... <note type = “attention&quot; > A ttention à la marche en descendant du train. </note> ... </topic>
  8. 8. How it all works (cont’d) <ul><li>Publishing system produces production-quality output automatically </li></ul><ul><li>Publishing system adjusts output for each language </li></ul>Avertissement: A ttention à la marche en descendant du train. Attention: Watch your step as you disembark.
  9. 9. LOCALIZATION-FRIENDLY WRITING
  10. 10. Use elements, not attributes <ul><li>Some translation software does not allow translating attribute values </li></ul><ul><li>Examples: </li></ul><ul><ul><li><image> alt text </li></ul></ul><ul><ul><li><map> title </li></ul></ul>
  11. 11. Inline elements <ul><li>Remove extra spaces </li></ul><ul><li>Use semantic elements </li></ul>
  12. 12. Images: Using numbered callouts
  13. 13. Images: Using SVG <ul><li>Lets you use text within callouts </li></ul><ul><li>Send the SVG file to the translator to have callouts translated </li></ul>
  14. 14. Index markers and glossary entries <ul><li>For Japanese and Chinese, use <index-sort-as> elements </li></ul><ul><li>If needed, specialize DITA to create a <glossary-sort-as> element type </li></ul>
  15. 15. Identify what not to translate <ul><li>Tell translators what types of elements should not be translated, e.g. <codeblock> </li></ul><ul><li>On most elements, you can set ‘translate = “no”’ </li></ul>
  16. 16. LOCALIZATION AND REUSE
  17. 17. Conditional text and conref <ul><li>Languages often require words in a sentence to “agree” with words which come before or after </li></ul><ul><ul><li>E.g. “a” vs “an” in English </li></ul></ul><ul><li>Conditionalize only whole sentences </li></ul><ul><li>Use conref only for whole sentences and proper nouns such as product names </li></ul>
  18. 18. WORKING WITH TRANSLATORS
  19. 19. Rule #1 <ul><li>Your translator MUST work in DITA XML </li></ul>Picture: Fir0002
  20. 20. Use XLIFF <ul><li>XML Localization Interchange File Format </li></ul><ul><li>Packages all topic and map files into a single file for easier back-and-forth </li></ul>
  21. 21. Watch “white space” <ul><li>White space (“pretty printing”) makes XML easier to read in Plain Text View, but can confuse translation memory systems </li></ul><ul><li>Turn off automatic insertion of white space if needed: </li></ul><ul><ul><li>Tools > Macros </li></ul></ul><ul><ul><li>DITA Configuration: Turn OFF Pretty-Printing </li></ul></ul>
  22. 22. Checklist: Communicating with your translator <ul><li>Give XSD/DTD files to your translator </li></ul><ul><li>Which attribute values should be translated? </li></ul><ul><ul><li>Typically, “navtitle” and nothing else </li></ul></ul><ul><li>What shouldn’t be translated?: </li></ul><ul><ul><li>List of element types </li></ul></ul><ul><ul><li>Use of “translate” attribute </li></ul></ul><ul><li>Who will set the xml:lang attribute? </li></ul>
  23. 23. Clean content in, clean content out <ul><li>You: </li></ul><ul><li>fix validation errors </li></ul><ul><li>fix broken links </li></ul><ul><li>remove extra spaces </li></ul><ul><li>Translator: </li></ul><ul><li>sends you the same markup you sent them </li></ul>
  24. 24. TOOLS
  25. 25. Select localization-friendly tools <ul><li>All tools must be Unicode-compliant </li></ul><ul><li>Authoring tools must support localization-friendly markup: </li></ul><ul><ul><li>“ xml:lang” attribute </li></ul></ul><ul><ul><li>“ translate” attribute </li></ul></ul><ul><ul><li>no junk that will confuse translation memory </li></ul></ul>
  26. 26. Consider tools for controlled language
  27. 27. Tools will need configuration <ul><li>In publishing tools: </li></ul><ul><li>Generated text strings </li></ul><ul><li>Fonts (especially for non-Latin alphabets) </li></ul><ul><li>Index sorting rules </li></ul><ul><li>Page sizes </li></ul><ul><li>Help system buttons, tabs, menus </li></ul><ul><li>Experts are useful! </li></ul>
  28. 28. DITA Open Toolkit (Version 1.5) <ul><li>Methods for customizing the toolkit vary by output format (e.g. PDF vs. HTML) </li></ul><ul><li>Methods for identifying the language vary </li></ul><ul><li>Some strings files have poor translations, and/or contain English </li></ul>Picture: ZeroOne
  29. 29. Heads-up: Font issues <ul><li>In PDF output, the default behaviour is for text to not appear </li></ul><ul><li>Only characters from explicitly declared ranges will appear </li></ul>
  30. 30. Summary <ul><li>Potentially huge cost and time savings </li></ul><ul><ul><li>Enables simultaneous shipping </li></ul></ul><ul><li>The main things to get right are: </li></ul><ul><ul><li>Writers follow guidelines for localization-friendly writing </li></ul></ul><ul><ul><li>Translators work directly in XML </li></ul></ul><ul><ul><li>Translators know what to translate </li></ul></ul><ul><ul><li>Time is allocated to DITA Open Toolkit configuration </li></ul></ul>
  31. 31. Further reading <ul><li>“ Using DITA for Successful Localization”: http://na.justsystems.com/whitepapers.php </li></ul>
  32. 32. <ul><li>Global Presence </li></ul><ul><ul><li>1,000 employees, ‘07 revenues of $110M </li></ul></ul><ul><ul><li>HQ in Japan; Corporate Offices in Vancouver and London; Sales Offices Worldwide </li></ul></ul><ul><li>Our Experience </li></ul><ul><ul><li>Established in 1979 </li></ul></ul><ul><ul><li>Market leader with over 2,500 customers </li></ul></ul><ul><li>Our Expertise </li></ul><ul><ul><li>Global provider of office productivity, information management, consumer & enterprise software </li></ul></ul><ul><ul><li>Framework for XML-based content creation, integration, visualization and delivery </li></ul></ul><ul><li>Our Credibility </li></ul><ul><ul><li>eContent 100 member in 2009 </li></ul></ul><ul><ul><li>KMWorld Trend-Setting Product Award 2009 </li></ul></ul><ul><ul><li>KM World “100 Companies that Matter” 2010 </li></ul></ul>About JustSystems 2,500 Customers, Marquee Brands
  33. 33. Global Customers Automotive Aerospace Publishing Other High-Tech Financial

×