XML provides tags around content that can be read by downstream routines to apply formatting. For example, <p> [paragraph] indicates that a new paragraph has started and the publishing routines can create a line break, if desired. In the localization industry, <p> is called an “external” tag because it is not inside the content. External tags differ from “internal” tags such as <b> [bold] or <i> [italics] which are used…
The “xml:lang” attribute specifies the language of the element content. The “xml:lang” attribute can be specified on every element in the DITA content model. When no value for “xml:lang” is supplied, the default value of English is assumed.
Tip: Ensure the “xml:lang” attribute is available on the root level
The “xml:lang” attribute must always be present at the root level…
DITA Maps are used to assemble topics into a topic hierarchy for print, Web, Help, or any other deliverable. DITA Maps are thus the backbone for content reuse in DITA. By creating two separate DITA Maps that reference the same topic, two different deliverables can be created.
DITA Maps can contain text that might require translation. The title of the DITA Map, for example, might need to be translated as it is used on…
In DITA, it is sometimes impossible to find and use an appropriate XML element to alert the translator that special treatment of a word is required. Make sure terms like company name or product name are defined in a terminology database that can be accessed by the translators, and provide them indications whether or not the words should be translated.
Tip: Use of terminology tools such as SDL MultiTerm in the translation…
In the past, it has been common practice for writers using desktop publishing tools to insert index tags anywhere in the content, by selecting a word and then applying an index marker on that word.
The process for creating index terms in DITA is handled differently than in traditional desktop publishing applications. When a word or phrase is enclosed in the <indexterm> tag in DITA, it is no longer recognized as part of…
Keyrefs and conrefs are one very powerful way how DITA can achieve higher levels of reuse and manage more product variations in an automated way.
Essentially, a keyref or conref is a placeholder that is filled dynamically with relevant content at the time of publication. The benefit is that the same document with small variations can be produced in an automated fashion. For example, a keyref or conref can be used to identify…
In the next series of posts, I will describe a number of best practices to simplify the localization of DITA files. If you ignore these best practices, it can be quite risky and cause significant headaches in the translation process.
Tip: Do not apply conditions to single words or terms; instead apply conditions to a paragraph or sentence
One of the powerful capabilities of DITA is the ability to apply conditions to content…
People, by nature, don’t like repetitive tasks. Even worse repetitive tasks will often lead to humans making mistakes: someone forgets to copy a file, someone forgets to set a setting. To manage growth and taking cost out while managing your IT landscape, automation will be key. It will improve accountability, efficiency and predictability, while reducing cost, variability and risk.
Our team has been working hard…
I was lucky enough to speak at the CMS / NA 2016 Conference and since this is the premier conference for companies who use DITA and a CCMS, I thought I'd do a recap for the SDL Knowledge Center community. Let me just recap with some highlights and a list of the hot topics. Here we go.
Highlights
When I joined SDL in 2014, after having worked for years at the intersection of content management and globalization, I quickly discovered that SDL’s go-to person for a strategic view of the world of structured content is Chip Gettinger, VP of Solutions. Chip travels the country guiding top companies on turning their global content strategy goals into realities, and speaking at content events with the best and brightest…
Translate
