Editors Overview
Content Editor
Use the Content Editor to simultaneously collaborate on DITA topics and maps.
Toolbar
The toolbar enables you to perform common typographic and DITA-related actions.
Context Menu
The context menu appears when you right-click the content in the Content Editor.
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 (Windows) or (Mac) or clicking the plus icon.
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, Heretto CCMS highlights that element and a flying arrow pointing to the element. 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 list.
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.
- 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.
- Select elements by clicking tags
- Drag and drop tags
- Drag and drop tags between different Content EditorTip: 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
- Unwrap an element by using the Tag context menu
Tags Off
In the Tags Off mode, the Content Editor does not show tags for DITA elements.
Short Tags
In the Short Tags mode, the Content Editor shows generic indicators for the presence of DITA elements.
Full Tags
In the Full Tags mode, the Content Editor shows descriptive tags for DITA elements.
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.
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.
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.
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.
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.
Topic Merge Icon
You can merge changes in individual topics from branch to branch using the topic merge icon.
Source Editor Icon
You can click the angle bracket icon to pop open a topic's DITA source code editor over the Heretto CCMS editor. The topic's source code shows on the left and the rendered editor view shows on the right.
Resource Information Icon
The resource information icon opens up the Resource Viewer Pane where you can view information about and interact with a particular resource. The Resource Viewer Pane includes helpful information, such as a link to the file's location in the content library, and enables you to quickly navigate to the resource manager.
Commit Changes Icon
Heretto CCMS automatically saves any change you make. If you want to force-create a revision for a particular topic, you can manually create one by clicking the commit changes icon. The commit changes window will open over the topic for which you are creating a revision. When you do this, you can change the status of the topic and leave a comment about the commit.
Collaborative Lock Icon
The collaborative lock icon provides a way of seeing how many users are collaborating on a topic. When you are the only user in a topic, the icon shows one individual and is green.
When multiple users are collaborating on a topic, the icon changes to multiple users and adds a number below the icon indicating the number of collaborators.
If you click and hold on the icon, a pop-up opens with the names of all collaborators.
Content Editor - Prolog Elements
Toggle
In the Content Editor, you can show or hide the entire prolog by clicking the gear icon and selecting Show Prolog. This action completely hides the prolog from 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.
Content Editor - Alt Text Elements
In the Content Editor, you can show or hide alt elements by clicking the gear icon and selecting Show 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.
Content Editor - Section Indicators
In the Content Editor, you can show or hide section indicators by clicking the gear icon and selecting Section Indicators.
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.
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 with Conditional Content Views.
@audience="userTesting".Views
The Content Editor can show conditional content in different ways.
By default, conditional content displays in the same way as non-conditional content.
Grayed out conditional content is less prominent than regular content.
Hidden conditional content does not display in the Content Editor. Hover over a conditional content indicator to see the hidden conditional content.
Content Editor - Review Tab
Use the Review tab to quickly review documents.
Operation
All comments for an opened resource, whether that's a single topic or a large DITA map, show in the Review tab. Comments are front-loaded, which means you no long need to scroll through a large map to find topics that have comments, and they are grouped by the topic they are attached to.
Heretto CCMS stores all comments, past and present, for a topic. You can access all current and archived comments 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
Operation
The list of attributes that shows is context-sensitive. By default, the list of attributes contains attributes that are available to apply to the element where your cursor is located.
Content Editor - Outline Tab
Operation
The structure that shows in the Outline tab is dependent on the type of topic you have open. The structure is also customizable. So if you have custom document types with restricted structures, the structure that shows will mirror your document types and only allow users to insert elements that fit within your custom structures.
The elements that are present in a topic show in dark blue, while the elements that are available to add show in light blue. The element where your cursor is currently located is green, giving you a quick visual reference for where you are currently working in the structure.
The Outline tab also shows text preview for any element containing content.
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.
- Show Elements Toggle
- Enables you to show or hide advanced DITA elements like a data element or a reltable element.
- Element Names Toggle
- Enables you to hide element names, show shortened element names, or show full element names.
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.
Source Editor - Map XML Code
Heretto CCMS enables you to edit the map XML source in the Source Editor.
You click Save to save your changes and close the Edit Source window.
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.
You can click Save to save the file and preview your changes. You can also click Save & Close to save the file and get back to the Content Editor.
Source Editor - OpenAPI Code
Heretto CCMS enables you to edit the OpenAPI code saved in a JSON file in the Source Editor.
Source Editor - Markdown Code
Heretto CCMS enables you to edit the Markdown code in the Source Editor.
Markdown Code
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.
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.
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).
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.
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.
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 (Windows) or (Mac) to open the 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.
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.
Imagine that you want to focus on a particular section element in a concept topic. You can collapse irrelevant elements to limit distractions and increase readability. The following example shows a concept topic with some elements collapsed.
Map Editor
You can use the Map Editor to edit DITA maps.
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 Map Editor.
Context Menu
Right-clicking an element in the Map Editor pane opens the context menu, enabling you to edit the elements in the map.
You can use the context menu to do the following:
- Edit topic
- Opens the topic in the Content Editor.
- Edit element attributes
- Opens the Edit Properties window to edit the attributes of the selected element.
- Edit element XML
- Opens the Edit Source window to edit the element 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 child elements of the selected element.
- Collapse all nodes
- Hides all child elements of the selected element.