DITA translatability   best practices                   Brought to you by                   @Fantpmas                     ...
Yamagata Europe We write                            I support We translate                    I know XML We do the layout ...
Use DITAs internationalisation attributes              xml:lang                       dir              translate      They...
Use the translate attribute to make everyone                        YES = YES                        NO = NO Dont mention ...
Use the xml:lang attribute to identify language           <section id="Magritte" xml:lang="fr">             <title>Consign...
Use the dir attribute for LTR/RTL contentThe title is "<term dir="rtl" xml:lang="ar">!‫مفتاح معايير الويب‬‎ /term>" in Ara...
Tag your terminology                        And I mean it!••••••••••••••••••••                www.yamagata-europe.com
Key benefits          Important terminology is identified             Ability to lock / unlock terms              Automati...
Click <uicontrol>Configure</uicontrol>.                   Configure the options to your wish.Press <uicontrol class="Windo...
Use the conref attribute wisely       Or it will come back to haunt you••••••••••••••••••••              www.yamagata-euro...
Use conrefs for complete sentences     <result>The suspect is apprehended.</result>                       <postreq><note c...
Avoid using conrefs for common nounsUsing a <keyword conref=”tools.dita#tools/Crowbar”/>, remove the Dragon               ...
Resolve or flatten conrefs prior to translation••••••••••••••••••••                www.yamagata-europe.com
Write stand-alone units of text            Not only great for re-use, but              Translators will      you••••••••••...
Traditional book order is gone••••••••••••••••••••              www.yamagata-europe.com
Mind the spaces  Click·<uicontrol>Start·</uicontrol>to·shut·down.Druk·op·<uicontrol>Start</uicontrol>om·af·te·sluiten.   •...
Provide reference material••••••••••••••••••••              www.yamagata-europe.com
Annotate where needed              Do it for your own sanity              but also for the translators••••••••••••••••••••...
<!- - Some mumbo jumbo legacy code, dont touch or universe will implode - -> <draft-comment author="EBP" disposition="comp...
Conclusions DITA provides excellent mechanisms to remove doubt               Be careful with conrefs                      ...
Upcoming SlideShare
Loading in...5
×

DITA translatability best practices

646

Published on

DITA is not only great for technical writing, it’s great for translation too. Amongst other things, DITA provides great mechanisms to instruct translators on what to translate and what not. It also provides a clear way to tag terminology.
However, there are some pitfalls to be aware of like excessive use of conrefs.

Published in: Technology, Business
0 Comments
1 Like
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total Views
646
On Slideshare
0
From Embeds
0
Number of Embeds
0
Actions
Shares
0
Downloads
13
Comments
0
Likes
1
Embeds 0
No embeds

No notes for slide

DITA translatability best practices

  1. 1. DITA translatability best practices Brought to you by @Fantpmas from @YamagataEurope•••••••••••••••••••• www.yamagata-europe.com
  2. 2. Yamagata Europe We write I support We translate I know XML We do the layout I know RegEx We print I know tools We package & ship I manage QA Distiller We create software I troubleshoot•••••••••••••••••••• www.yamagata-europe.com
  3. 3. Use DITAs internationalisation attributes xml:lang dir translate Theyre in there for a friggin reason•••••••••••••••••••• www.yamagata-europe.com
  4. 4. Use the translate attribute to make everyone YES = YES NO = NO Dont mention <term translate="no">Project X</term> to my mom.•••••••••••••••••••• www.yamagata-europe.com
  5. 5. Use the xml:lang attribute to identify language <section id="Magritte" xml:lang="fr"> <title>Consignes de sécurité</title> <p id="A">Danger, ceci nest pas une pipe</p>•••••••••••••••••••• www.yamagata-europe.com
  6. 6. Use the dir attribute for LTR/RTL contentThe title is "<term dir="rtl" xml:lang="ar">!‫مفتاح معايير الويب‬‎ /term>" in Arabic. <‎ •••••••••••••••••••• www.yamagata-europe.com
  7. 7. Tag your terminology And I mean it!•••••••••••••••••••• www.yamagata-europe.com
  8. 8. Key benefits Important terminology is identified Ability to lock / unlock terms Automatic term extraction Automatic quality control•••••••••••••••••••• www.yamagata-europe.com
  9. 9. Click <uicontrol>Configure</uicontrol>. Configure the options to your wish.Press <uicontrol class="Windows">Select</uicontrol> to browse to the file. Choose <uicontrol class ="QA Distiller">Select</uicontrol> to add a file.•••••••••••••••••••• www.yamagata-europe.com
  10. 10. Use the conref attribute wisely Or it will come back to haunt you•••••••••••••••••••• www.yamagata-europe.com
  11. 11. Use conrefs for complete sentences <result>The suspect is apprehended.</result> <postreq><note conref=”reuse.dita#reusablephrases/ReadRights”/> </postreq>•••••••••••••••••••• www.yamagata-europe.com
  12. 12. Avoid using conrefs for common nounsUsing a <keyword conref=”tools.dita#tools/Crowbar”/>, remove the Dragon spacecraft from the ISS. Adding <keyword conref=”servers.dita#servers/Fileserver”/>s is easy. Big no no•••••••••••••••••••• www.yamagata-europe.com
  13. 13. Resolve or flatten conrefs prior to translation•••••••••••••••••••• www.yamagata-europe.com
  14. 14. Write stand-alone units of text Not only great for re-use, but Translators will you•••••••••••••••••••• www.yamagata-europe.com
  15. 15. Traditional book order is gone•••••••••••••••••••• www.yamagata-europe.com
  16. 16. Mind the spaces Click·<uicontrol>Start·</uicontrol>to·shut·down.Druk·op·<uicontrol>Start</uicontrol>om·af·te·sluiten. •••••••••••••••••••• www.yamagata-europe.com
  17. 17. Provide reference material•••••••••••••••••••• www.yamagata-europe.com
  18. 18. Annotate where needed Do it for your own sanity but also for the translators•••••••••••••••••••• www.yamagata-europe.com
  19. 19. <!- - Some mumbo jumbo legacy code, dont touch or universe will implode - -> <draft-comment author="EBP" disposition="completed">This section deals with our other top-secret project</draft-comment> <note type="other">This stuff is important as this is the abstract sent to our CEO (and he has no sense of humour)</note> •••••••••••••••••••• www.yamagata-europe.com
  20. 20. Conclusions DITA provides excellent mechanisms to remove doubt Be careful with conrefs KISS•••••••••••••••••••• www.yamagata-europe.com
  1. A particular slide catching your eye?

    Clipping is a handy way to collect important slides you want to go back to later.

×