Example domain specialization: Localization

A domain specialization often defines phrase-level element types, as opposed to a topic specialization, which defines a whole new hierarchy of elements. A specialized localization domain provides your users with the ability to manage translated content.

You must add your DTDs to the system configuration, and you must make all the described changes to your DTD plugin, master-catalog.xml, and other applicable files. See Creating a custom DTD plugin in the system configuration.
CCMS Desktop uses a specialized Localization domain. This domain consists of one attribute, @ixia_locid, which uniquely identifies segments for localization. CCMS Desktop includes a system trigger that adds this attribute to nearly all elements when an object gets released.

If you integrate your own DTDs into CCMS Desktop, you need to integrate the Localization domain into them. If you do not, you cannot release locked objects because the CMS cannot add the @ixia_locid that it requires.

To integrate a localization domain specialization:

  1. Check out and open your DTD.
  2. Scroll to the DOMAIN ATTRIBUTE DECLARATIONS section.
  3. Choose one of the following actions:
    • For DITA 1.2 deployments, add the following lines:
      <!ENTITY % localizationAtt-d-dec 
        PUBLIC "-//IXIA//ENTITIES DITA Localization Domain//EN" 
               "../../com.ixiasoft.dita.dtd/dtd/localizationDomain.ent"
      >%localizationAtt-d-dec;
    • For DITA 1.3 deployments, add the following lines:
      <!ENTITY % localizationAtt-d-dec
        PUBLIC "-//IXIA//ENTITIES DITA Localization Domain//EN" 
               "../../com.ixiasoft.dita13.dtd/dtd/localizationDomain.ent"
      >%localizationAtt-d-dec;
  4. Add the following lines.
    Note: The identified path assumes your DTD is part of a custom DTD plugin and you followed the prerequisites to include the proper relative path. If you do not follow its recommendations, you must edit this path so that it correctly reflects the relative path between your DTD and the localizationDomain.ent file.
  5. Scroll to the DOMAIN ATTRIBUTE EXTENSIONS section.
  6. Add %localization-loc-d-attribute; to the list of base attribute extensions.
    For example, if this is the only extension to the base attribute, add the following lines:
    <!ENTITY % base-attribute-extensions
            "%localization-loc-d-attribute;"                          >

    If there are already extensions to the base attribute, then the end result might look something like this, with the new extension added at the end of the list.

    <!ENTITY % base-attribute-extensions 
               "%region-d-attribute;
                %module-d-attribute;
                %localization-loc-d-attribute;"                          >
  7. Scroll to the DOMAINS ATTRIBUTE OVERRIDE section.
  8. Add &localization-loc-d-att; to the list of included domains.
    <!ENTITY included-domains 
                    "&concept-att;
                     &glossentry-att;
                     &glossgroup-att;
                     &reference-att;
                     &task-att;
                     &hi-d-att;
                     &ut-d-att;
                     &indexing-d-att;
                     &hazard-d-att;
                     &abbrev-d-att;
                     &pr-d-att;
                     &sw-d-att;
                     &ui-d-att;
                     &taskbody-constraints;
                     &localization-loc-d-att;"
    >
  9. Save, close, and check in your DTD.
  10. To add the specialization to IXIA CCMS Output Generator, take the following actions:
    1. Copy the entire com.company.dtd plugin folder into the %OutputGenDir%/data/%OT_Dir%/plugins folder, overwriting the previous copy.

      Depending on your CCMS Output Generator configuration, the DITA-OT path might vary.

    2. Run the integrator to integrate the plugin.
The localization domain is ready and your users can now localize and release translated content.