[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: Re: Acronym proposal for DITA
Hi Richard, Many thanks for your feedback. We now plan to separate the 'id' from the acronym itself. Best Regards, AZ Richard Ishida wrote: > I just skimmed this, and thought I should point out a couple more things to > consider. Note that acronyms also change in translation, eg. NATO becomes > OTAN in Spanish. Another good reason to avoid using the acronym as the id. > > Also, it would be useful to search the public w3c html mailing lists (going > back a few years) for discussions about acronyms and abbreviations. Things > you'll find there include discussions about whether it makes sense to > separate out acronyms and abbreviations - ie. can people always decide which > is which. And Web Accessibility requirements that lean towards a need for a > pronunciation guide that is separate from the expanded form, eg. for > clarifying that CSAIL (Computer Science and Artificial Intelligence > Laboratory) is pronounced see-sail, not C.S.A.I.L. > > Hope that's some help, > RI > > ============ > Richard Ishida > Internationalization Lead > W3C (World Wide Web Consortium) > > http://www.w3.org/People/Ishida/ > http://www.w3.org/International/ > http://people.w3.org/rishida/blog/ > http://www.flickr.com/photos/ishida/ > > > >> -----Original Message----- >> From: Kara Warburton [mailto:KARA@CA.IBM.COM] >> Sent: 13 March 2007 12:27 >> To: Andrzej Zydron >> Cc: email@example.com; Bryan Schnabel; firstname.lastname@example.org; >> email@example.com; >> firstname.lastname@example.org; email@example.com; >> firstname.lastname@example.org; email@example.com; firstname.lastname@example.org; >> Howard.Schwartz; email@example.com; JoAnn Hackos; >> firstname.lastname@example.org; email@example.com; >> firstname.lastname@example.org; >> email@example.com; Carla Quinn >> Subject: Re: Acronym proposal for DITA >> >> Hi Andrzej, >> >> Using the acronym itself as the id attribute is not a good >> idea since it may not be unique. Many acronyms have multiple >> different expanded forms, even within the same domain. For >> instance, in computing, ACL can stand for both access control >> list, and application connectivity link. When you are dealing >> with multiple domains, there are likely to be more than two >> expanded forms. >> >> Also, how does this relate to the <term> element that already >> exists in DITA? An acronym is a type of term, so I would like >> to see these two items handled together somehow, such as >> through a "type" attribute on the <term> element, that >> attribute using one of the values in TBX-lite. >> >> Regards, >> >> Kara Warburton >> IBM LanguageWare & Terminology >> Team Lead, Language & Data Integration >> 905-413-2170 >> >> IBM terminology: http://w3.ibm.com/standards/terminology >> LanguageWare: http://languageware.redirect.webahead.ibm.com/ >> My blog: http://firstname.lastname@example.org >> >> >> >> >> Andrzej Zydron >> >> <azydron@xml-intl >> >> .com> >> To >> JoAnn Hackos >> >> 05/03/2007 07:25 >> <email@example.com> >> AM >> cc >> >> firstname.lastname@example.org >> rg, email@example.com, >> >> firstname.lastname@example.org, Bryan >> Schnabel >> >> <email@example.com>, >> >> firstname.lastname@example.org, >> >> email@example.com, >> firstname.lastname@example.org, >> >> email@example.com, >> >> firstname.lastname@example.org, >> email@example.com, >> firstname.lastname@example.org, >> >> "Howard.Schwartz" >> >> >> <Howard.Schwartz@trados.com>, >> email@example.com, >> >> >> firstname.lastname@example.org >> om, Kara >> >> >> Warburton/Toronto/IBM@IBMCA, >> >> email@example.com >> >> Subject >> Acronym proposal >> >> >> >> >> >> >> >> >> >> >> >> >> >> >> >> >> >> Hi Everyone, >> >> Acronyms are ubiquitous in technical documentation. Although >> there are similarities between acronyms and the glossaries, >> from the localization and presentation point of view acronyms >> are a special case. Acronyms need to be expanded in the first >> encounter within a printed document. In electronic published >> documents acronym definitions can also be made available in >> the form of a hyper link or 'tool tip' mechanism. >> >> For translation, acronym definitions need to be presented in >> the nominative case, without any inflection. The best way of >> doing this using an automated mechanism is to place the >> definition of the acronym in parentheses immediately >> following the first occurrence of the acronym, e.g. >> >> Your vehicle is fitted with an ABS (Anti-lock Braking System) >> and 4WD (Four Wheel Drive). >> >> My recommendation is to create an <acronym> element that can >> occur anywhere within PCDATA. The acronym will have an 'id' >> attribute that will be the acronym itself, e.g. <acronym >> id="ABS"/>. The <acronym> element will be resolved via a >> conref attribute to the full acronym text, e.g. <acronym >> id="ABS" conref="aconyms.dita#abs"/>. The entry in the >> aconyms.dita file will be: >> >> <acronym name="abs">Anti-lock Break System</acronym> >> >> At compose time, when you are putting together the >> publication you can print the full form the first time >> around, but in parentheses to get around any potential >> problems when translating into inflected languages: >> >> <p>The <acroym id="ABS" conref="aconyms.dita#abs"/> facility >> will prevent the car from skidding.</p> >> >> This will be published as: >> >> The ABS (Anti-lock Break System) facility will prevent the >> car from skidding. >> >> This is in reverse to what would normally be printed, e.g. >> >> Anti-lock Break System (ABS) >> >> But this is perfectly acceptable and gets around translation >> problems with inflected languages. >> >> Best Regards, >> >> AZ >> >> >> -- >> >> >> email - firstname.lastname@example.org >> smail - c/o Mr. A.Zydron >> PO Box 2167 >> Gerrards Cross >> Bucks SL9 8XF >> United Kingdom >> Mobile +(44) 7966 477 181 >> FAX +(44) 1753 480 465 >> www - http://www.xml-intl.com >> >> This message contains confidential information and is >> intended only for the individual named. If you are not the >> named addressee you may not disseminate, distribute or copy >> this e-mail. Please notify the sender immediately by e-mail >> if you have received this e-mail by mistake and delete this >> e-mail from your system. >> E-mail transmission cannot be guaranteed to be secure or >> error-free as information could be intercepted, corrupted, >> lost, destroyed, arrive late or incomplete, or contain >> viruses. The sender therefore does not accept liability for >> any errors or omissions in the contents of this message which >> arise as a result of e-mail transmission. If verification is >> required please request a hard-copy version. Unless >> explicitly stated otherwise this message is provided for >> informational purposes only and should not be construed as a >> solicitation or offer. >> >> >> >> >> >> > -- email - email@example.com smail - c/o Mr. A.Zydron PO Box 2167 Gerrards Cross Bucks SL9 8XF United Kingdom Mobile +(44) 7966 477 181 FAX +(44) 1753 480 465 www - http://www.xml-intl.com This message contains confidential information and is intended only for the individual named. If you are not the named addressee you may not disseminate, distribute or copy this e-mail. Please notify the sender immediately by e-mail if you have received this e-mail by mistake and delete this e-mail from your system. E-mail transmission cannot be guaranteed to be secure or error-free as information could be intercepted, corrupted, lost, destroyed, arrive late or incomplete, or contain viruses. The sender therefore does not accept liability for any errors or omissions in the contents of this message which arise as a result of e-mail transmission. If verification is required please request a hard-copy version. Unless explicitly stated otherwise this message is provided for informational purposes only and should not be construed as a solicitation or offer.