Login
Home CMS Documentation Home CMS 10 DITA Processing Pipeline Initial DITA Configuration DITA Administration DITA Map Manager DITA Aliases Aliased DITA Asset Updates

Aliased DITA Asset Updates

When DITA content contains new changes, the corresponding alias structures automatically update after check-in to reflect these changes in the Site Tree structure. The update syncs the changes while maintaining the original DITA alias IDs.

DITA content changes may alter alias structures when the CMS syncs them. Examples of DITA content changes that affect alias structures include:

  • DITA element or attribute changes in the DITA map collection.

    If users make changes to DITA elements or attributes in the DITA map structure, the aliases may update to reflect these changes.

    See Aliased DITA Elements and   for details.

  • File name, file title, or navigation title changes.

    If the DITA asset title changes that the corresponding alias name uses, then the alias update will reflect this change in the Site Tree.

  • The addition, rearrangement, or deletion of file references or map group elements within the DITA map structure.

    If users add, reorder, or remove topic references from the DITA map structure, then the alias structure update will reflect these changes in the Site Tree. If the DITA map contains new aliases after the update, then the system generates IDs for the new aliases.

  • Document type refactoring on DITA files.

    If users refactor a DITA asset to a new document type, then the Toggle Content Subtype Information tool reflects the document type change of the DITA asset in the Assets Tree and the correlating alias in the Site Tree.

    For example, let's say a user refactors a DITA task topic to a DITA concept topic and then checks in the changes. When the alias update syncs the changes and the user selects the Toggle Content Subtype Information button, then the DITA alias displays as a concept instead of a task in the Site Tree.

    See Aliased DITA Types for details.

Version Notes: CMS 10.6.378+ vs. CMS 10.6.308–10.6.342
Alias update functionality differs between CMS 10.6.378+ and CMS 10.6.308–10.6.342.

  • 10.6.492: Only aliases marked for publishing targets display in the Site Tree.

    If the Site Tree does not display an alias structure, verify that the aliased DITA asset root is marked to the target selected in the Site Tree publishing target filter.

    CMS 10.6.378+: Alias structures are updated based on the DITA map's latest checked-in content version and versions marked to publishing targets. Additionally, any publish marking changes made to DITA content will trigger alias updates.

    To toggle between alias structure differences per publishing target, select the publishing target in the Site Tree target drop-down list.

  • CMS 10.6.308–10.6.342: Aliases are only updated based on the current version of the DITA map structure. If you mark an older version of the DITA map structure, the alias structure will not account for the map dependencies in that version.

See CMS DITA Versioning Functionality for more details about these changes.

CMS Actions and Alias Updates

Certain CMS actions will update the version of the alias structures or their publish marking statuses. Review the actions to see how they will affect your aliases if you use them.

Site Tree Context Menu

ActionDescription
Check In > AliasChecks in and updates aliases to display any name changes, dependency additions, removals, and hierarchy adjustments in the latest checked-in version. These updates are reflected in the in the Site Tree and Alias Management tab when the latest checked-in version of the aliased DITA asset is marked to the publishing target.
Check In > Alias and Children""
Check In > Page and ChildrenChecks in site content items, site folders, and aliased DITA assets, creating a new content version. The aliases within this scope are updated to display name changes, dependency additions, removals, and hierarchy adjustments in the latest checked-in version. These updates are reflected in the in the Site Tree and Alias Management tab when the latest checked-in version of the aliased DITA asset is marked to the publishing target.
Note
When aliases are checked in via this action:
  • Checked-out aliases do not change color when they are checked in via this action. They remain blue instead of turning to black. Black indicates they are checked in.
  • If the version of the alias marked to the publishing target is not the latest version, you may see the alias tree updates to the checked-in latest version instead of maintaining the display of the version marked to the publishing target. For example, if the older version of the alias has a different name, the name in the latest version displays in the Site Tree.
  • Aliases are only checked in if this action is used on the direct parent content item or folder of the aliases. If the action is used on an ancestor higher than the parent, the aliases will not be affected by this action.

Refresh the alias structure in the Site Tree so the tree will accurately reflect the checked-out/in status and alias version for the publishing target in the tree.

Undo Checkout > Alias
Check Out > Page and ChildrenChecks out site content items, site folders, aliased DITA assets.
Note
When aliases are checked out via this action:
  • If the version of the alias marked to the publishing target is not the latest version, you may see the alias tree updates to the checked-in latest version instead of maintaining the display of the version marked to the publishing target. For example, if the older version of the alias has a different name, the name in the latest version displays in the Site Tree.
  • Aliases are only checked out if this action is used on the direct parent content item or folder of the aliases. If the action is used on an ancestor higher than the parent, the aliases will not be affected by this action.

Refresh the alias structure in the Site Tree so the tree will reflect the correct checked-out/in status and alias version for the publishing target in the tree.

Mark for Publish > AliasMarks and updates aliases for publish to display any name changes, dependency additions, removals, and hierarchy adjustments in the version marked for publish. These updates are reflected in the in the Site Tree and Alias Management tab for the publishing target.
Note
The Site Tree context menu does not provide a Mark for Publish > Alias and Children option. You can only mark aliases for publish individually.
Mark for Publish > Page and ChildrenMarks site content items, site folders, and aliased DITA assets to the latest checked-in version for publish.
Warning
While the aliases within this scope become marked, the newly marked aliases do not display in the Site Tree and Alias Management tab for the publishing target. The CMS does not trigger the alias tracking system to update to reflect these publish marking changes.

If you use this action and the scope includes aliases, ensure you update the publishing marking directly via the root alias map or that you check out/in the root alias and children to the publishing target. This will trigger the Site Tree and Alias Management tab to display the latest checked-in version of the aliases marked to the publishing target. If you do not do this follow-up work, your aliases will be out of sync with alias management. You may encounter conflicts when publishing this content to the target.

Unmark from Publish > AliasUnmarks site content items, site folders, and aliased DITA assets to the latest checked-in version from publish. The newly unmarked aliases become hidden from the Site Tree and Alias Management tab for the publishing target.
Troubleshooting
  • The Site Tree context menu does not provide a Mark for Publish > Alias and Children option. You can only mark aliases for publish individually.
  • If ancestor/parent aliases are unmarked and child aliases are marked in alias structures, marked alias children will not display in Site Tree and Alias Management tab for the publishing target until you mark the ancestor/parent aliases.
Unmark from Publish > Page and ChildrenUnmarks site content items, site folders, and aliased DITA assets to the latest checked-in version from publish.
Warning
While the aliases within this scope become unmarked, the newly unmarked aliases remain in the Site Tree and Alias Management tab for the publishing target. The CMS does not trigger the alias tracking system to update to reflect these publish marking changes.

If you use this action and the scope includes aliases, ensure you update the publishing marking directly via the root alias map or that you check out/in the root alias and children to the publishing target. This will trigger the Site Tree and Alias Management tab to remove the aliases unmarked from the publishing target. If you do not do this follow-up work, your aliases will be out of sync with alias management. You may encounter conflicts when publishing this content to the target.

Site Toolbar

ActionDescription
Mark for Publish > Page and Children
Unmark from Publish > Page and Children

Asset Tree Context Menu

ActionDescription
Check In
Check In > Folder and Children
Mark for Publish
Mark Descendant Assets for Publish
Unmark from Publish
Unmark Descendant Assets from Publish
Add to Workflow
Advance

Asset Toolbar

ActionDescription
Check In
Mark for Publish
Unmark from Publish
Add to Workflow
Advance

Map Details

ActionDescription
Check In
Check Out
Mark for Publish
Unmark from Publish