Creating specialized configuration files to use specialization locally

Description of how to c onfigure your specialized DTD in XMetaL.

Before you begin

Before you begin, the user that runs XMetaL needs to have the necessary rights to:
  • Create, move and overwrite files in the Program Files\XMetaL folder
  • Create, move, overwrite and delete subfolders in the Program Files\XMetaL folder

About this task

Instead of using the Tools > Select Specialized DITA DTD... menu in XMetaL to configure your specialized DTD on every client, you can synchronize the files from the SDL LiveContent Architect server. The configuration files are stored on the server in the folder $Web\Author\ASP\ClientConfig\XMetaL\{XMetaLVersion}-CRCL\Editor\DITA\XACS.

To configure your specialized DTD in XMetaL, you need to create some additional files.

Procedure

  1. On the server, navigate to the folder $Web\Author\ASP\ClientConfig\XMetaL\{XMetaLVersion}-CRCL\Editor\DITA\XACS
  2. Make a copy of the folder depending on your specialization
    • If you specialized from topic, task, reference, concept, ditabase etc, copy thelearningPlan folder and paste in the same folder.
    • If you specialized from map, copy the learningMap folder and paste in the same folder.
    • If you specialized from bookmap, copy the learningBookmap folder and paste in the same folder.
  3. Rename the folder you pasted to {yourDTDName}. E.g. for machineAssembly.dtd we copy learningPlan and rename it to machineAssembly
  4. Browse to the {yourDTDName} folder and rename the first part of all files before the underscore from learningPlan_* to {yourDTDName}_*. Note that depending on the specialization, you will have all "*_ditabase.*" files or all "*_map.*" files or all "*_bookmap.*" files.
    For example, for machineAssembly.dtd, we will have a folder Editor\DITA\XACS\machineAssembly with: 
    	* machineAssembly_ditabase.css 
    	* machineAssembly_ditabase.ctm 
    	* machineAssembly_ditabase.dtd 
    	* machineAssembly_ditabase.mcr 
    	* machineAssembly_ditabase.tbr 
    	* machineAssembly_ditabase_structure.css 
    	* machineAssembly_ditabase-specialized.css 
  5. Open each file in this folder in a text editor (for example, notepad) and replace all occurrences in the file of {nameOfDTDYouCopied} to {yourDTDName}
    For example, for machineAssembly.dtd:
       * File "machineAssembly_ditabase.css": changed one occurrence of learningPlan ("learningPlan_ditabase..." to "machineAssembly_ditabase...")
       * File "machineAssembly_ditabase.ctm": found no occurrences of learningPlan
       * File "machineAssembly_ditabase.dtd": replaced multiple occurrences of "learningPlan" by "machineAssembly"
       * File "machineAssembly_ditabase.mcr": found no occurrences of learningPlan
       * File "machineAssembly_ditabase.tbr": found no occurrences of learningPlan
       * File "machineAssembly_ditabase_structure.css": found no occurrences of learningPlan
       * File "machineAssembly_ditabase-specialized.css": found no occurrences of learningPlan
  6. Adjust the path to the actual DTD in {yourDTDName}_ditabase.dtd.
    In the example, for machineAssembly.dtd: V:\InfoShare\Website\Author\ASP\DocTypes\dita-specialized\1.2\machineAssembly\machineAssembly.dtd
  7. Open the file Editor\DITA\XACS\{yourDTDName}\{yourDTDName}_*.dtd and search for DITA_OT_DTD. You should find something like ../../DITA_OT_DTD/dita-oasis/1.2/learning/dtd/learningPlan.dtd. Remove everything after ../../DITA_OT_DTD/ and insert everything that comes after ...\ASP\DocTypes\ in the full path of your DTD.
    In the example for the machineAssembly.dtd, it should read:
       <!ENTITY % xmdita_machineAssembly PUBLIC "-//XMETAL//SHELL DTD DITA machineAssembly//EN" "../../DITA_OT_DTD/dita-specialized/1.2/machineAssembly/machineAssembly.dtd"> %xmdita_machineAssembly;