Editors Overview

Content Editor

Use the Content Editor to simultaneously collaborate on DITA topics and maps.

Overview

Figure 1. Content Editor.

The following example shows a map opened in the Content Editor.

Map and topics open in the content editor

Toolbar

The toolbar enables you to perform common typographic and DITA-related actions.

Figure 2. Content Editor Toolbar
Content editor toolbar

Context Menu

The context menu appears when you right-click the content in the Content Editor, and it shows the available options given your cursor location in the content.

Right-click context menu

Quick Insert Menu

The quick insert menu enables you to quickly insert a DITA element in a valid position. You can open the menu by pressing Ctrl > Enter (Windows) or Cmd > Enter (Mac) or clicking the plus icon in the editor.

Figure 3. Quick Insert Menu
Element quick insert menu
Tip: The elements that display in the quick insert menu are context-sensitive. The arrows indicate where and what element will be inserted. Vertical arrows indicate that a new element will be inserted above or below the current element. Horizontal arrow indicates that a new element will be inserted as a child of the current element. To change the element suggestion mode, use the Insert drop-down menu and select Before , After or Intelligently.

Keyboard Shortcuts

Heretto CCMS enables you to quickly perform common actions by using keyboard shortcuts. You can access the keyboard shortcut list by clicking the keyboard icon in the toolbar.

Footer

When you hover over an element in the structure bar at the bottom of the Content Editor, the element will be highlighted and a curved arrow will point to it. If you click an element in the structure bar, Heretto CCMS gives you options for interacting with that element, such as removing it, moving it up or down in the topic, or inserting a new element before or after.

Figure 4. Footer
Footer context menu and element arrows

Content Editor - Editing Modes

Use the Content Editor in one of four different modes, each of which offers increased ability to interact with a topic.

Viewing
Viewing mode is read-only. In viewing mode, you can only see a topic's content but cannot leave comments or make changes to the content.
Commenting
Commenting mode enables you to leave comments on the content in a topic, but you cannot change any of the source content or suggest changes directly.
Suggesting
Suggesting mode enables you to leave inline, tracked changes, which can be accepted or rejected. Heretto CCMS underlines suggested additions and strikes through suggested deletions. Each user's suggestions appear in a different color.
Editing
Editing mode provides full editing privileges. Editing mode provides users the ability to add elements, attributes, and content. Any content added or changes you make while in editing mode are immediately part of the source content.

Content Editor - Tags

Use different tags modes to see and interact with the elements that are present in your content.

Tag Modes

In the Content Editor, you can switch between different tag modes by clicking the gear icon and using the Tags drop-down menu.

tags drop-down menu
The Full Tags With Attributes, Full Tags, and Short Tags modes enable you to:
  • Select elements by clicking tags
  • Drag and drop tags
    drag and drop tags
  • Drag and drop tags between different Content Editor

    In the following example, the ul tag is being dragged and dropped from one browser window to another browser window.

    Dragging and dropping an unordered list from one browser window to another
    Tip: If you drag-and-drop an element with an ID attribute assigned (for example from a warehouse topic), you can decide if you want to paste the element or create a content reference (conref).
  • Replace an element with another element by using the Tag context menu
    Context menu button for replacing an element
  • Unwrap an element by using the Tag context menu
    Context menu button for unwrapping an element

Tags Off

In the Tags Off mode, the Content Editor does not show tags for DITA elements.

Figure 5. Tags Off
Tags off view in the content editor

Short Tags

In the Short Tags mode, the Content Editor shows generic indicators for the presence of DITA elements.

Figure 6. Short Tags
Short tags, small left and right-facing triangles, view in the content editor

Full Tags

In the Full Tags mode, the Content Editor shows descriptive tags for DITA elements.

Figure 7. Full Tags
Full tags view in the content editor, showing the full element names

Full Tags With Attributes

In the Full Tags With Attributes mode, the Content Editor shows descriptive tags for DITA elements along with the attributes assigned to these elements.

Figure 8. Full Tags With Attributes
Full tags with element attributes in the content editor

Content Editor - Text Placeholders

Disabling text placeholders makes the editing area less busy.

In the Content Editor, you can show or hide text placeholders for common elements by clicking the gear icon and selecting Text Placeholders.

Figure 9. Enabled Text Placeholders
Content editor showing gray placeholder text in empty elements
Figure 10. Disabled Text Placeholders
Content editor view with gray placeholder text removed

Content Editor - Topic Toolbars

Hiding topic toolbars, provides a streamlined document view.

Topic Toolbars Toggle

In the Content Editor, you can show or hide topic toolbars by clicking the gear icon and selecting Topic Toolbars.

Gear icon, which provides users a way to configure the content editor's display modes

Status Selector

The status selector enables you to manually change the status of a topic. For example, you can change a status from In Progress to Approved status.
The file status selector in the content editor expanded to show available file statuses

Open In New Window Icon

If there's a topic you're working on that would be helpful to have open in a window by itself, click the pop out icon in the upper right of the topic. Heretto CCMS opens the topic in a new browser tab.

The content editor showing the topic toolbar's open in a new window icon

Topic Merge Icon

You can merge changes in individual topics from branch to branch using the topic merge icon.

The content editor showing the topic toolbar's topic merge button for merging topic changes into another branch
Note: By default, merging/replacing topics is disabled and the Topic Merge/Replace icon is hidden. To enable this feature, contact a Customer Success Manager.

Source Editor Icon

You can click the angle bracket icon to pop open a topic's DITA source code editor over the Content Editor. The topic's source code shows on the left and the rendered editor view shows on the right.

The source editor opened after clicking the angle bracket icon, showing the XML code on the left and styled editor on the right
Note: When editing in the source code, your changes will not show in the rendered view until you save your changes. When the source editor is open, you cannot edit in the rendered view.

Resource Information Icon

The resource information icon opens up the Resource Details Drawer where you can view information about and interact with a particular resource. The Resource Details Drawer includes helpful information, such as a link to the file's location in the content library, and enables you to access the resource manager.

The opened up resource viewer pane, which gives detailed information about a topic

Content Editor - Prolog Elements

A prolog typically displays author information, critical dates, keywords, and other important metadata. It can also contain a resource ID element that is crucial for creation of contextual help.

Toggle

In the Content Editor, you can show the prolog by clicking the gear icon and selecting Show Prolog. Deselecting it hides the prolog from the Content Editor.

The toolbar's gear icon showing the available options for customizing the content editor

Collapse and Expand Prolog

You can collapse and expand the prolog content by pressing the Collapse/Expand Prolog (+) or (-) button. This action minimizes the prolog rather than completely removing it from the Content Editor.

Figure 11. Expanded Prolog
The content editor shows an expanded prolog at the top of a document. The blue minus icon in the top left lets the user collapse the prolog.
Figure 12. Collapsed Prolog
A collapsed prolog in the content editor showing a blue plus icon, indicating that there is more information present and the prolog can be expanded to show it.

Content Editor - Alt Text Elements

You use alt elements to describe images. Inserting alt elements makes your content more accessible to visually impaired users.

In the Content Editor, you can show or hide alt elements by clicking the gear icon and selecting Show Alt Text.

The toolbar's gear icon showing the list of available customizations for the content editor, one of which is a check box for showing or hiding alt text in the editor
A screenshot of the content editor showing some example alt text

Content Editor - Smooth View

Enabling Smooth View removes breaks between topics and provides a streamlined, long-form document experience.

In the Content Editor, you can show or hide space between topics by clicking the gear icon and selecting Smooth View.

The toolbar's gear icon showing the list of available customizations for the content editor
The Content Editorwith the in-document toolbar hidden and smooth view enabled, collapsing the space between documents

Content Editor - Section Indicators

Section indicators are light gray bars that inform you about the presence of sections within a topic. Turning section indicators off provides you with a streamlined, long-form document experience.

In the Content Editor, you can show or hide section indicators by clicking the gear icon and selecting Section Indicators.

The toolbar's gear icon showing the list of available customizations for the content editor
The Content Editor with section indicators turned off, hiding the gray section outlines and placeholder text

Content Editor - Outline Placeholders

Outline placeholder elements enable you to quickly insert the elements that are common to a given topic type.

In the Content Editor, you can show or hide outline placeholders for common elements by clicking the gear icon and selecting Outline Placeholders.

Figure 13. Context Element Placeholder.

In the following example, a choice element placeholder appears inside a step element.

The Content Editor shows that the choice element can be inserted inside the step element, using a plus sign and a dashed line around the text to indicate that the element isn't yet inserted

Content Editor - Conditional Content

Heretto CCMS enables you to decide how, or if, profiled content appears in the Content Editor.

Overview

When you are authoring content it's helpful to see all the content in a topic. Reviewers, however, may prefer to see only the content that meets a specific condition. You can configure how the conditional content appears in the Content Editor by selecting different options in the Conditional View Settings.

Figure 14. Conditional Content.
The following example shows a piece of conditional content profiled for @audience="userTesting".
Tip: Clicking a conditional content indicator opens the Conditional View Settings Window.
The content editor showing the green, in-document bars and diagonal text that indicates the presence of conditional processing attributes
Figure 15. Conditional View Settings Window
Conditional View Setting Window

Views

The Content Editor can show conditional content in different ways.

Figure 16. Show Conditional Content.

By default, conditional content displays in the same way as non-conditional content.

Default view for conditional content is to display it the same way as non-conditional content.
Figure 17. Grayed Conditional Content.

Grayed out conditional content is less prominent than regular content.

Grayed out conditional content mode makes the content less prominent.
Figure 18. Hidden Conditional Content.

Hidden conditional content does not display in the Content Editor. Hover over a conditional content indicator to see the hidden conditional content.

A short video showcasing how the hidden conditional content is displayed when you hover over the conditional content indicator.

Content Editor - Review Tab

Use the Review tab to quickly review documents.

Interface

Figure 19. Review Tab with Active Comments and Suggestions
This image shows the Review Tab with a couple of unresolved comments and suggestions.

Operation

All comments and suggestions for an opened resource, whether it be a single topic or a large DITA map, show in the Review tab. They are front-loaded and easily accessible. Clicking on a comment or a suggestion will take you to the place in the document where that that suggestion has been made. They are also grouped by the topic they are attached to.

Heretto CCMS stores all tracked changes, past and present, for a topic. You can access all current and archived comments and suggestions in the Review tab by clicking either Current or Archived.

Content Editor - Attributes Tab

Use the Attributes tab to access a list of attributes you can apply to elements in a topic.

Interface

Figure 20. Attributes Tab
Open attributes tab.

Operation

The list of attributes is context-sensitive. By default, the list contains attributes that can be applied to the element where your cursor is located.

Content Editor - Map Tree

Heretto CCMS enables you to customize the Map Tree pane appearance.

Overview

You can adjust the following Map Tree appearance settings.

Icons Toggle
Enables you to show or hide icons associated with different DITA elements in a map.
Video showcases how you can toggle icons on and off in the map tree pane
Show Elements Toggle
Enables you to show or hide advanced DITA elements like a data element or a reltable element.
Video showcases how you can choose between showing all elements or just the Table of Content elements.
Element Names Toggle
Enables you to hide element names, show shortened element names, or show full element names.
A video showcases how you hide all element names and how to switch to shortened element names and full element names.

Map Tree Pane

You can use the Map Tree Pane in the Content Editor to edit DITA maps.

Interface
Figure 21. Map Tree Pane
A map tree pane.
Operation

Heretto CCMS automatically saves a document any time there is a change to the file. You do not need to manually save any resource that's open in the Content Editor.

Context Menu
Right-clicking an element in the map tree opens the context menu, enabling you to edit the elements in the map.
Figure 22. Map Tree Context Menu
Right-clicking on an element in a map tree opens the map tree Context Menu.

You can use the context menu to do the following:

Open topic
Opens the topic in the Content Editor in a separate window.
Copy share URL

Copies the element's URL that you can share with other users in order to direct them to the element's location.

Edit element XML
Opens the Edit Source window to edit the element's XML.
Show file in Content Manage
Opens the content library and highlights the selected file.
Remove element
Removes the element from the map.
Append element
Inserts an available map element as a child of the selected element.
Insert element before
Inserts an available map element before the selected element.
Insert element after
Inserts an available map element after the selected element.
Expand all nodes
Displays all elements in the map tree.
Collapse all nodes
Hides all elements in the map tree.

Source Editor

To help you navigate the code, the Source Editor colors syntax and indicates your cursor position with a gray line in the scroll bar.

Important: If multiple users collaborate on a resource, Heretto CCMS places a collaboration lock on the topic and the XML code is not editable.

Source Editor - Map XML Code

Heretto CCMS enables you to edit the map XML source in the Source Editor.

Figure 23. Map Source Editor.

You click Save to save your changes and close the Edit Source window.

Source Editor Window is open and shows a simple map structure.

Source Editor - Topic XML Code

The Source Editor enables you to edit the topic XML source side-by-side with the user-friendly editor rendering.

Figure 24. Topic Source Editor.

You can click Save to save the file and preview your changes. You can also click Save & Close to save the file and go back to the Content Editor. You can also click Cancel and go back to the Content Editor without saving the changes.

Source Editor Window is open and shows the source code for a simple concept topic.

Source Editor - OpenAPI Code

Heretto CCMS enables you to edit the OpenAPI code saved in a JSON file in the Source Editor.

Figure 25. OpenAPI Code Editor
OpenAPI in the Source Editor

Source Editor - Markdown Code

Heretto CCMS enables you to edit the Markdown code in the Source Editor.

Markdown Code

Figure 26. Markdown Code Editor
Markdown code opened in the Source Editor.

Source Editor - XML Code Validation

The Source XML Invalid window appears if Heretto CCMS detects that something is wrong with the XML code that you edited.

Figure 27. Invalid XML Notification
Source Code Validation window warns the user that the changes they introduced resulted in validation errors.
We recommend fixing the invalid XML files immediately because they may result in severe publishing errors. The Invalid XML code is indicated by a red underline and a red rectangle in the scroll bar.

If you plan to fix the invalid XML code later and you don't want to lose your changes, you can save the invalid XML code. Heretto CCMS notifies you about invalid XML files by displaying the Invalid File icon in the content library.

Source Editor - XML Code Autocompletion

Heretto CCMS suggests and automatically completes new XML elements for you.

You can quickly add an XML element by starting to enter the XML element code and selecting the relevant option from the Autocomplete menu. In the following example, the <se was typed and the Autocomplete menu suggested to insert a section element.

Figure 28. Autocomplete Menu
Source Editor Autocomplete Menu lets the user choose what element they want to insert; in this case it suggests the section element.

In the following example, the section element was selected from the Autocomplete menu. Heretto CCMS automatically closes the XML elements for you (in this example, the </section> closing tag was added).

Figure 29. Autocompleted XML Element
After the user selected the section element from the Autocompletion Menu the closing tag was automatically inserted..
Important: If this feature is disabled for your organization, contact your Customer Success Manager.

Source Editor - XML Code Formatting

When you edit the XML code, it may become disorganized because you focus on writing and not formatting the code.

The following example shows a slightly disorganized piece of code in the Source Editor.

Figure 30. Non-Formatted XML Code
Source Editor showcases an example of a disorganized code.

You can make your code more readable by clicking the Format the source icon. This makes Heretto CCMS automatically indent and position the code for you. It is useful if you don't want to waste your time on formatting the code on your own. The following example shows a code that was automatically formatted by Heretto CCMS.

Figure 31. Formatted XML Code
Source Editor showcases an example of formatted, organized code.

Source Editor - Find and Replace Code

The Source Editor enables you to quickly find and replace code.

Find and Replace

With your cursor placed in the editor, you can press Ctrl > F (Windows) or Cmd > F (Mac) to open the Find dialog.

Figure 32. Find Dialog
Find dialog.

You can set the search to:

  • Match case
  • Match whole words
  • Analyze a part of the file
  • Use regular expression

You can replace your search results with a particular expression. To do so, in the Find dialog, you click the Toggle Replace mode icon that expands it to the Find and Replace dialog.

Figure 33. Find and Replace Dialog
Find and replace dialog.

You can replace all search results at once or do it one by one. All search results are highlighted.

Source Editor - Collapse and Expand Code

Some XML files may be very complex, especially if you view their source. Heretto CCMS enables you to collapse and expand elements in the Source Editor.

Collapsing some code parts enables you to focus on a given part of the code. By default, all elements are expanded when you open a file in the Source Editor. The following example shows a concept topic with every element expanded.

Figure 34. Expanded Elements
An example of a concept topic opened in the Source Editor with all elements expanded.

Imagine that you want to focus only on the first section element in this concept topic. You can collapse irrelevant elements to limit distractions and increase readability. The following example shows the same concept topic with some elements collapsed, in this case the second section element.

Figure 35. Collapsed Element
A concept topic opened in Source Editor with the second section element collapsed.