Enable the linguistic review process

The linguistic review process removes the translate="no" attribute from auto-translated text when preparing the localization kit.

Note: For this procedure to work, the auto-translation feature must be enabled.
The linguistic review process works as follows:
  1. The user runs the Prepare Localization Kit command on localized content that is in Localization:review.
  2. The DITA CMS looks up the linguisticreview.xml file, which lists the elements that should keep the translate="no" attribute (for example, <codeblock> elements).
  3. The DITA CMS prepares the localization kit and removes the translate="no" attribute from all elements, except for those in the linguisticreview.xml file.
Note: The linguistic review process is supported in the sequential and node-based localization methods only.
Here is a summary of the steps required to enable the linguistic review process:
  • Set the appropriate access rights to the Prepare Localization Kit command and API method in the accessrights.xml file.
  • Add the linguistic review process to the accessrights.xml file.
  • Add the elements that should not be reviewed by localizations (i.e., they should have the translate="no" attribute) in the linguisticReview.xml file. The translate="no" attribute will be removed from every element that is not in the file.

To enable the linguistic review process:

  1. Open the TEXTML Administration perspective by clicking the TEXTML Administration shortcut on the tool bar. If the shortcut is not displayed, follow these steps:
    1. Select Window > Open Perspective > Other
    2. Click TEXTML Administration.
    3. Click OK.
  2. In the TEXTML Administration view, double-click the server. If your server is not displayed in the view, you must add it to the view.
  3. When the Connect as dialog opens, type your username and password and click OK.
  4. Double-click the name of your docbase to open a connection to the Content Store.
  5. Locate the accessrights.xml file in the repository's /system/conf collection.
  6. Check out and open accessrights.xml with a text editor.
  7. Configure the access rights to the Prepare Localization Kit command:
    1. Look for the line that starts as follows:
      <method name="Prepare kit" 
    2. If the <status>Localization:review</status> status is not configured for maps, add it.

      For example:

      <current>
         <type name="map">
            <statuses>
               <status>Localization:tb translated</status>
               <status>Localization:in translation</status>
               <status>Localization:review</status>
            </statuses>
         </type>
         <type name="topic">
            <statuses>
               <status>Localization:tb translated</status>
               <status>Localization:in translation</status>
            </statuses>
         </type>
      </current>
    3. Look for the line that starts as follows:
      <method name="prepareLocalizationPackage_api" 
    4. If the <status>Localization:review</status> status is not configured for maps, add it.

      For example:

      <current>
         <type name="*">
            <statuses>
               <status>Localization:tb translated</status>
               <status>Localization:in translation</status>
               <status>Localization:review</status>
      
            </statuses>
         </type>
      </current>
  8. Add the linguistic review process to the accessrights.xml file:
    1. Locate the following line:
      <!-- ********************** API METHODS DO NOT MODIFY ********************** -->
    2. Just before this line, add the following <method> code to set access rights for the linguistic review process:
         <!-- Linguistic Review -->
         <method name="LinguisticReview" type="api">
            <notify enabled="false"/>
            <conditionset operator="any">
               <condition>
                  <current>
                     <type name="topic">
                        <statuses>
                           <status>Localization:review</status>
                        </statuses>
                     </type>
                     <type name="map">
                        <statuses>
                           <status>Localization:review</status>
                        </statuses>
                     </type>
                  </current>
                  <users>
                     <groups>
                        <group name="Everyone"/>
                     </groups>
                  </users>
               </condition>
            </conditionset>
         </method>
  9. Save, close, and check in the accessrights.xml file.
  10. Locate the linguisticReview.xml file in the repository's /system/conf collection.
  11. Check out and open linguisticReview.xml with a text editor.
  12. Add new <class> elements to specify the classes of any elements that you do not want translated.

    To find an element's class, select the element in your XML editor and view its attributes. For example, to add <codeblock> to the list of elements not to translate, add the following line:

    <class name="+topic/pre pr-d/codeblock "/>

    Be sure to preserve the initial - or + as well as the trailing space before the closing quotes.

  13. Save, close, and check in the linguisticReview.xml file.
  14. Inform users of the changes.
    The changes will be applied automatically once users close and then reopen their DITA CMS. Users can also apply the changes without restarting their DITA CMS by clicking DITA CMS > Synchronize Configuration.