Know the Editor features id176NC500V5Z
This section walks you through the various features that are available in the Editor. We can divide the Editor into the following sections or areas:
The following subsection cover in details the various sections of the Editor.
Header bar
The header bar is the top bar of the Editor that displays the 51黑料不打烊 Experience Manager logo (or a Unified Shell if you are using the Unified Shell as your Experience Manager Guides UI). When you select the logo, it directs you to the Experience Manager Navigation page.
Use the Expand icon in the toolbar to hide the header bar and maximize the content area. To restore the standard view, select Exit the expanded view.
Tab bar
The Tab bar is at the top of the Editor鈥檚 interface and it provides access to the following features:
Tabs
Displays the currently opened topics in the Editor as file tabs. You can have multiple topics opened at the same time, which are displayed in their respective tabs in the tab bar. By default, you can view the file titles in the tabs. As you hover over a file, you can view the file title and the file path as a tooltip.
Selecting the file tab opens a context menu featuring Save as new version, Copy, Locate in, Add to, Properties, Split, Download as PDF, and Close options.
Save all
Saves the changes you have made in all opened topics. If you have multiple topics opened in the Editor, selecting Save all or using the Ctrl+S shortcut keys saves all documents in one click. You do not have to individually save each document.
AI Assistant
A powerful, AI-driven tool designed to enhance your productivity through smart help and authoring features. It brings together two robust AI features 鈥 Authoring and Help 鈥 into the Experience Manager Guides interface, enabling you to author content and access information from Experience Manager Guides documentation faster and more efficiently.
Expand view: Allows you to expand the page view using the Expand icon. In this view, the header bar containing the 51黑料不打烊 Experience Manager logo, is hidden. This maximizes the content space for editing. To return to the standard view, use the Exit the expanded view icon.
More actions: Allows you to navigate to the Assets and Settings.
The Assets option takes you to a destination based on your setup:
-
Cloud Services: If you are using Cloud Services, selecting the Assets option takes you to the AEM Navigation page.
-
On-premise Software: If you are using 51黑料不打烊 Experience Manager Guides (4.2.1 and later), selecting the Assets option takes you to your current file path in the Assets UI.
The Settings option is available only for administrators and folder profile administrators, and allows configuring the following settings:
-
General: The General settings allow you to configure the dictionary to use with the Editor. This tab contains four sections: Spell check, Condition, Authoring, and Citations .
-
Spell check: There are two options 鈥 AEM spell check and Browser spell check. By default, the editor uses the Browser spell check feature, wherein the spell-check is performed using the browser鈥檚 in-built dictionary. You can switch to AEM spell check to use 51黑料不打烊 Experience Manager鈥檚 dictionary, which can also be customized to add your custom word list. For more information about customizing AEM dictionary, view Customize AEM鈥檚 default dictionary section in the Install and configure 51黑料不打烊 Experience Manager Guides as a Cloud Service.
-
Condition
-
Highlight conditional text in the Author view: Select this to highlight the conditional text in the author view. The conditional content is highlighted using the color defined for the condition.
-
Validate with condition attributes: Select this to allow the validation of the values defined for the attributes. This prevents you from adding any incorrect value.
-
Show key with the title in the Subject Scheme panel: Select this to show the keys along with titles in the subject scheme. If you do not select this option only the titles are shown. For example, here the keys 鈥榦s鈥, 鈥榓udience鈥, and 鈥榦ther鈥 are also shown along with titles.
-
Show subject scheme in the Conditions panel: Select this to view a subject scheme in the conditions panel. If you deselect this, the defined conditions are shown in the conditions panel.
-
-
Authoring
- Enable Replace All: Select this to view the Replace All icon in the Find and replace panel.
-
Citations
Change the style of citations. Choose the citation style from the drop-down you want to use in your project. For more details, view Change citation styles. -
AI Assistant
Select this to enable the AI Assistant feature in the Experience Manager Guides. Unselect to disable the feature.
-
Panels: This setting controls the panels that are shown in the left and right panels of the Editor and Map console. You can toggle the button to show or hide the desired panel.
You can also define the order in which the features present in panels are displayed. To change the default order of the available features in the panels, select the dotted bars to drag and drop the feature tabs at the desired location. A feature can also be moved from the More section to the main section of a panel, and vice versa as per the requirement. Once re-ordered, the features appear in the same sequence in the respective right and left panel.
A maximum of eight panels can be displayed at a time. Any changes made to the panel settings are applied immediately.
-
Elements list: As an administrator, you can control the list of elements that an author can insert into a file and also define the display name for the element. The Elements list setting allows you to specify the element鈥檚 name as per DITA specifications and a label that you want to use instead of the DITA defined element name:
In the above screenshot, the p
element has been given a label of Paragraph, and codeblock
is given a label of Code Block along with some other elements鈥 If you select the Use only above elements option, then only the valid elements (at current insertion point) from this list will be shown in the Insert element dialog box.
In the following screenshot, only 3 out of 4 configured elements from the previous screenshot are shown in the current context:
-
Attributes list: Similar to the elements list, you can control the list of attributes and their display names to be displayed in the attributes list of an element. In the following screenshot, only 3 attributes have been configured to be shown in an element鈥檚 attribute list:
With this setting, when you try to add an attribute to an element, you only view the list of attributes configured in the list.
-
Colors: Displays a list of pre-configured background colors for Conditions. Users can select a background color when applying a condition to a topic. As an administrator, you can also create and add custom background colors to the list. To add a new color, enter the desired name in the Color Name field, choose a custom color, and select the + icon. The custom color will appear at the end of the color list.
-
Publish profiles: This contains the Profiles that can be used to publish the Knowledge Base output. You can create a new profile for a target knowledge base. For example, Salesforce or ServiceNow.
-
Create a Salesforce profile
Prerequisites
-
Create a connected app for Salesforce. For more details, refer to .
-
While configuring the connected app ensure the following:
-
Specify the callback.
URL: http://<server name>:<port>/bin/dxml/thirdparty/callback/salesforce
-
Select the following OAuth Scopes:
- Full access (full)
- Select Manage user data via APIs (api)
-
Once the app is configured, Salesforce provides a Consumer Key and Consumer Secret. These can be used to create the Salesforce profile.
-
-
To create a Salesforce profile, select the Salesforce Knowledge Base from the Server type dropdown. Enter a profile Name. In the Site URL, enter the consumer site you would use to publish the output and then add the Consumer Key and Consumer Secret provided by the Salesforce consumer site. Then, Validate and Save the newly created profile.
note note NOTE To configure a proxy for Salesforce in Experience Manager Guides, use Apache HTTP Components Proxy Configuration in AEM. Learn how to . -
Create a ServiceNow profile
Prerequisites
Configure the ServiceNow server to upload the assets.
-
Connect to the ServiceNow server.
-
Navigate to System Properties > Security.
-
Uncheck the following option:
This property must be set to activate MIME type checking for uploads (All versions Eureka and up). Enables (true) or disbles (false) mime type validation for the file attachments. File extensions configured via glide.attachment.extensions will be checked for MIME type during upload.
-
Select Save.
Once you have configured the app, create the ServiceNow profile.
-
-
To create a profile, select the ServiceNow Knowledge Base from the Server type dropdown. Enter a profile Name. In the ServiceNow URL, enter the consumer site you would use for publishing the output and then add the Username and Password provided by the ServiceNow consumer site. Then, Validate and Save the newly created profile.
After you validate, you can select the Publish Profile in the output presets of a DITA Map and use it to generate the output to the Salesforce or ServiceNow server that you have chosen.
Learn more about the Knowledge Base output preset.
-
-
Validation: This tab contains options to configure the Schematron validations in the Editor. You can enable the following features:
-
Run validation check before saving the file: Select this to run Schematron validations using the selected Schematron file(s) before any save operation. You can add a Schematron file by selecting the + icon. The selected Schematron file(s) are listed.
note note NOTE The selected Schematron file(s) will persist for the selected folder profile. This prevents the users from saving any file which breaks a rule defined in the selected Schematron file(s). If this is not selected the file will not be validated before saving the changes.
-
Allow all users to add schematron files in validation panel: Select this to allow the users to add any Schematron file in the Validation panel of the Editor. This allows the users to add Schematron files and then validate the topics against the Schematron file. If this is not selected, the option to add schematron file Add Schematron File button is not available to the users in the Validation panel of the Editor.
-
-
Display attributes: Like the Attributes list, you can control the list of attributes to be displayed in the attributes list of an element. By default, four Display attributes 鈥 audience, platform, product, and props have been configured to be shown in an element鈥檚 attribute list. You can also add a display attribute using the Add icon on the top. You can also delete any of the display attributes using the Delete icon.
The attributes defined for an element are displayed in the Layout and the Outline view.
-
Translation: This tab contains the options to create language groups, propagate the source labels to the target version, and clean up the translation project.
-
Language Groups: As an administrator, you can create a group of languages and use them as a set to translate the content.
Perform the following steps to create a new language group:- Select Add.
- Enter the language group name. Each language should have a unique name. You can view an error if the name field is empty or if the name isn鈥檛 unique.
- Select the languages from the dropdown. You can select multiple languages.
Type the first few characters of the language, or the language code to filter the desired languages. For example, type 鈥榚n鈥 to filter all the languages that contain 鈥榚n鈥 at the beginning of their name or code.
-
Select the Done icon to add the selected languages to the group. The languages are displayed. When you add three or more languages, the Show more option is displayed. You can select Show more to view all the languages present in the group.
note tip TIP Toggle Show more to Show less and view only a few languages. -
Hover over the languages in a group to edit
-
Save the Settings.
note note NOTE As a user, you can view the language groups configured to your folder profile.
-
Propagate source version labels to the target version: Select this option to pass the label of the source file version to the translated file. By default, this is disabled.
-
Translation project cleanup after completion: Select this option to configure the translation projects to be disabled or deleted automatically after the translation. By default, None is selected, so that the project exists after translation.
You can disable the translation projects if you want to use them later. Deleting a project permanently deletes all files and folders present in the project.
-
-
Metadata: You can control the version metadata of the topic and their values to be displayed in the Version history dialog box. In the metadata path, specify the location of the nodes from which you want to pick the metadata. You can also define a custom name for the metadata as the label. The default properties are Title, Document State, and Tags.
The metadata can be picked from any property under the
/jcr:content
node of the asset, so you can add the path of the property as the Metadata path.An error is displayed if the metadata path is blank. If you leave the label blank, the last element is picked as the label.
Configure the metadata for the Version History dialog box.
You can also define the order in which these metadata tags are displayed. To change the default order of these tags, select the dotted bars to drag and drop the tags at the desired location.
The metadata labels appear in the same sequence in the Version history dialog box of the Editor.
Toolbar
The toolbar appears when you open a topic or map for editing in the Editor. Features available in the toolbar are as follows:
Menu dropdown
The Menu dropdown provides access to the editing actions, Find and replace, Version history, Version label, Merge, Create review task, Track changes, and Tags feature.
The detailed explanation of these features is as follows:
Editing actions
When editing a topic in the Editor, access the various editing actions such as Cut or Ctrl+X , Copy or Ctrl+C , Undo or Ctrl+Z , Redo or Ctrl+Y and Delete present in the Menu dropdown.
Find and replace
The Find and replace feature is available in Author and Source view modes. When enabled, the Find and Replace text bar appears at the bottom of the topic editing area. You can use the shortcut keys CTRL+F to invoke the Find and replace bar.
Using the settings icon (
The search is instantaneous, which means that as you type the search phrase or word in the Find field, the term is immediately searched and selected in the topic. Similarly, for replacing a text in your topic, enter the search term and its replacement in the respective fields and select the Replace or Replace All button.
In the Source view, the Find and replace feature is extremely useful for searching for a specific element or attribute. For example, if you want to replace the value of the @product
attribute, it can be easily done from the Source view. The Author view does not allow you to search on the basis of an attribute or element. However, you must use caution while using the Replace All feature, as it might overwrite the XML code.
Version history
The Version history feature in the Editor allows you to check the available versions of your DITA files, compare them, and revert to any version from the Editor itself. You can compare the content and metadata of the current version (which can also be a working copy) with any previous version of the same file. You can also view the labels and comments for the compared versions.
To access the version history and revert to a specific version of your topic, perform the following steps:
-
Open a topic in the Editor.
-
Select Version history from the Menu dropdown.
The Version History dialog box appears.
Preview the changes in the different versions of a topic.
-
Choose a version of the topic that you want to compare or revert to in the Compare with dropdown list.
note note NOTE If a version has labels applied to it, they are also shown (in brackets) along with the version number. -
Enable the View labels and comments option to view the labels and comments applied to the current and the compared versions.
-
You can also view the following information in the Version history dialog box:
Preview tab: The newly added content is in green font, and the deleted content is in red font.
Metadata tab: The newly added metadata is in green font, and the deleted metadata is in red font.
Compare the metadata of different versions in the Version history.
note note NOTE Your system administrator can change the metadata to be shown from the Metadata tab in the Settings. For details, refer to the More actions section of the Tab bar. You can also view the user and time details of the current and the compared version.
Once you choose a version from the drop-down list, the Revert to selected version option is made available. The preview window displays the differences between the current version and the selected version of the topic.
-
Select Revert to selected version to revert your working copy with the selected version of the topic.
The Revert Version dialog box appears.
-
(Optional) Provide a reason for reverting to an earlier version. You can also create a new version of the currently active working copy of your topic.
-
Select Confirm.
Your working copy of the file is reverted to the selected version. If you choose to create a new version of the currently active working copy, then a new version of the file is also created with all working changes.
When you revert to an earlier version, a visual cue is shown indicating that the version you are currently working on is not the latest version.
Version labels
Labels help you identify the stage in which a particular topic is in the DDLC (Document Development Life Cycle). For example, when you are working on a topic, you could set the label as 鈥淎pproved鈥. Once a topic is published and made available to customers, you can assign 鈥淩eleased鈥 label to that topic.
Experience Manager Guides allows you to specify labels in a free-form text format or use a set of predefined labels. The custom label would allow any author in the system to specify a label as per their choice. This gives flexibility; however, it introduces inconsistent labels in the system. To overcome this issue, administrators can configure a set of predefined labels. For more information about configuring predefined labels, view Configure and customize the XML Web Editor in the Install and configure 51黑料不打烊 Experience Manager Guides as a Cloud Service.
These labels are shown in the form of a drop-down list to authors wherever they need to specify a label. This ensures that only predefined, consistent labels are used in the system.
There are different methods through which you can apply labels to your topics - Version history panel in Assets UI, Baselines UI, and the Editor. The Version Label feature in the Editor gives authors a quick and easy way to assign labels to their topics.
To add labels to your topic from the Editor, perform the following steps:
-
Open a topic in the Editor.
-
Select Version labels from the Menu dropdown.
The Version Label Management dialog box is displayed.
The Version Label Management dialog box is split into two parts 鈥 the left panel has a list of versions available for the topic along with label drop-down list (or a text box to enter a label) and the right panel with a preview of the topic.
-
Select a version on which you want to apply labels.
When you choose a different version of the topic from the version list, then the preview panel displays the changes in-between the current version and the selected version of the topic
note note NOTE If a label is already applied on a version, it is displayed next to the version number in the drop-down list and below the Select Version list. You can remove an existing label by selecting the (x) icon next to the label. -
In case your administrator has defined a list of labels, then you are shown a drop-down list of the labels from where you can choose the labels that you want to apply. You can select multiple labels from the drop-down list.
Else, you are shown a text box, wherein you can enter the labels that you want to add to your topic.
note note NOTE You cannot apply the same label on multiple versions of a topic. If you try to associate an existing label, then you are given an option to remove it from the existing version and apply it on the selected version of the topic. -
Select Add Label.
-
In the Apply Label confirmation message, select the Move label(If used on another version) option to move labels from an existing version to the selected version. If you do not select this option and there are labels that are assigned to a different version of the topic, then they are not moved to the selected topic鈥檚 version. Such labels are ignored in the label application process.
Merge
When you work in a multi-author environment, it becomes difficult to track what changes the other authors have made in a topic or map. The Merge feature gives you more control over not only viewing the changes, but also what changes are retained in the latest version of the document.
-
Merge topic files
To merge changes in a topic, perform the following steps:
-
Open a topic in the Editor.
-
Select Merge.
The Merge dialog appears.
-
(Optional) You can also browse and select a new file from some other location in your repository.
-
Select a version of the file with which you want to compare the current version of the file.
-
From the Options, choose:
-
Track changes from selected version: This option shows all content updates in the form of tracked changes. You can then choose to accept or reject changes in the document one at a time or all in one go.
-
Revert to selected version: This option reverts the current version of the document to the selected version. This option does not give you any control on what content is accepted or rejected.
-
-
Select Done.
-
If you selected the Track changes from selected version option, then all changes from the selected version are shown in the Tracked changes feature of the right panel.
You can choose to accept or reject all comments from the Tracked changes panel or accept or reject individual comment.
-
-
Merge map files
To merge changes in a map file, perform the following steps:
-
Open a map in the Editor.
-
Select Merge.
The Merge dialog box appears.
-
(Optional) You can also browse and select a new file from some other location in your repository.
-
Select a version of the file with which you want to compare the current version of the file.
-
From the Options, choose:
-
Track changes from selected version: This option shows all content updates in the form of track changes. You can then choose to accept or reject changes in the document one at a time or all in one go.
-
Revert to selected version: This option reverts the current version of the document to the selected version. This option does not give you any control on what content is accepted or rejected.
-
-
Select Done.
-
If you selected the Track changes from selected version option, then all changes from the selected version are shown in the Tracked changes panel (on the right).
You can choose to accept or reject all changes from the Tracked Changes panel or accept or reject individual change in the map file.
-
Create review task
You can create a review task of the current topic or map file directly from the Editor. Open the file for which you want to create the review task and select Create review task from the Menu dropdown to initiate the review creation process.
Track changes
You can keep a track of all updates made on a document by enabling the Track changes mode. After enabling the track changes, all insertions and deletions are captured in the document. All deleted content is highlighted using Strikethrough and all insertions are highlighted in green color text. In addition, you also get the change bars at the edge of the topic page. Again, a red bar is shown for deleted content and a green bar is shown for added content. In case there is an addition and deletion on the same line, then both green and red bars are shown.
The following screenshot highlights the deleted and inserted content along with the change bars:
A typical use case for tracking changes in a document can be for doing peer review. You can enable track changes and share your document for review, and the reviewer then makes changes with track changes ON. When you receive the document, you should then have a mechanism to view the suggested updates along with a convenient way to accept or reject changes.
Experience Manager Guides provides the Tracked changes feature that contains information about the updates made in the document. The Tracked changes feature provides information about what updates were made, who made them, and at what time. Using the Tracked changes feature, you can also easily accept or reject the suggested updates in the document.
To access the feature, select the Track changes icon in the right panel.
Selecting a tracked change selects the changed content in the document. You can accept a change by selecting the Accept Change icon or reject it by selecting the Reject Change.
If you want to accept or reject all changes with a single click, select Accept all changes or Reject all changes.
Tags
The Tags feature in the Editor is a toggle button that controls the visibility of DITA elements. When enabled, it displays structural tags within the content, allowing you to view and manage the underlying DITA elements more effectively. When disabled, the editor hides these tags, providing a cleaner and more focused authoring environment.
The following screenshot shows a document with the Tags view enabled:
The following operations can be performed in a document with Tags:
-
Select an element: Select the opening or closing tag of an element to select its content.
-
Expand or collapse tags: Select the + or - sign in a tag to expand or collapse it.
-
Use the context menu: The context menu provides options to cut, copy, or paste the selected element. You can also insert an element before or after the selected element. The other options allow you to Generate ID or open the Properties panel for the selected element.
-
Drag-and-drop elements: Select an element鈥檚 tag and easily drag-and-drop it on your document. If the drop location is a valid location where the element is allowed, the element is placed at the dropped location.
tagsView
property in the ui\_config.json
file. For more details, view the Configure default value for Tags View section in Install and configure 51黑料不打烊 Experience Manager Guides as a Cloud Service.Content insertion options
Element -
Inserts a valid element at the current or next valid location. You can also use the keyboard shortcut Alt+Enter to open the Element dialog box. For example, you are editing a paragraph, then in the Element dialog box, a list of elements appears that can be inserted in the paragraph. Select the element that you want to insert. You can use the keyboard to scroll through the list of elements and press Enter to insert the required element.
You can view two types of valid elements:
-
Valid elements at the current location: The list displays the elements that you can insert at the current cursor location itself.
-
Valid elements outside the current location: The list displays the elements that you can insert after any of the parents for the current element within the element hierarchy.
For example, if you are within the inline <b>
element, you can insert elements like <u>
, <xref>
, <i>
at the current location. In contrast, you can insert elements like <table>
and <topic>
outside the current location.
You can also type a character or string in the search box and search for the elements that begin with it.
Enter 鈥榯鈥 to search for all valid elements that begin with 鈥榯鈥.
If you are working inside a block element like a note
, then use the Insert element icon to insert a new element after the note
element. In the following screenshot a note element has been inserted inside the p (paragraph) element:
If you press Enter in the note element, a new paragraph is created within the note element itself. To insert a new element outside note, select the p element (highlighted in screenshot) in the elements breadcrumb and then select the Element icon or press Alt+Enter to open the Insert element dialog box. Then, select the desired element and press Enter to insert the selected element after the note element.
You can also add an element between two elements when a blinking block cursor appears.
For example, if you are working on a DITA topic, and the block cursor is blinking between the short description and the body, you can add prolog
element and then add copyright, author, and other details.
Another way of entering a new element is by using the context menu. Right-click at any place in your document to invoke the context menu. From this menu choose Insert Element to display the Insert element dialog box and choose the element that you want to insert.
Paragraph -
Insert paragraph element at the current or next valid location.
Bulleted list -
Creates a bulleted list at the current or next valid location. If you are on a bulleted list and select this icon, the item is converted into a normal paragraph.
Numbered list -
Creates a numbered list at the current or next valid location. If you are on a numbered list and select this icon, the item is converted into a normal paragraph.
Table -
Inserts a table at the current or next valid location. Select the Table icon to open the Insert Simple Table dialog box.
<simpletable>
or <tgroup>
depending on the settings configured in the XML Editor Configuration. For more details, view Configure the display of pasted tables.You can specify the number of rows and columns required in the table. If you want to keep the first row as the table header, select the Set first row as header option. To add a title to your table, enter it in the Title field.
Once a table is inserted, you can modify the table using the context menu.
Using the table鈥檚 context menu, you can:
-
Insert cells, rows, or columns
-
Merge cells in right and down directions
-
Split cells horizontally or vertically
-
Delete cells, rows, or columns
-
Generate IDs
You can also define attributes on multiple cells, entire row, or column of a table. For example, to align table cell, drag and select the required cell. In the Content Properties panel (on the right), the property Type changes to entry.
- In the Attributes section, select +Add.
- Select the
@valign
attribute from the Attribute dropdown list. - From the value dropdown list, select the desired text alignment you want to apply on the selected table cells.
- Select Add.
Image -
Inserts an image at the current or next valid location. Select the Image icon to open the Insert Image dialog box and then search and select the image you want to insert.
You can add an image/Figure Title and Alternate Text for the image in the Insert Image dialog box.
![NOTE]
When you insert an image and specify an alternate text for the same, it is added within the
<alt>
element in accordance with the latest DITA standards. The use of the@alt
attribute for alternate text is deprecated, but it remains supported in previous DITA versions.
Using the Select File option, you can search for the required image file by file name. You can also filter the search results by Path (to search in), Collections, File Type, and Tags. Once you have found the required image file, select the file and choose Select to insert the image in your document. You can insert various formats of image files, such as .png
, .svg
, .gif
, .jpg
, .eps
, .ai
, .psd
, and more.
Once you have inserted an image, you can change the height, width, placement, and attributes from the Content properties panel. Select the image file and then make changes in the Content properties panel in the right panel.
The Source field displays the UUID of the inserted image file. You can find the complete path of the inserted image file by hovering the mouse pointer over the Source field. The path is displayed in the tooltip.
You can resize an image by providing either Height or Width value for the image file. The aspect ratio of the image is maintained automatically. If you want, you can also choose not to maintain the aspect ratio of the image file by selecting the lock icon (of Maintain Aspect Ratio) and providing Height and Width values.
You can also specify the Placement setting for the image as Inline or Break. In case you choose to use the Break placement option, you can then choose where to align the image (Left, Center, or Right).
You can also add other properties for an image file by selecting the required properties in the Attributes field.
Context menu for image or media files
You can also perform some common operations for images and media files using the context menu. Right-click at any place on your image to invoke the context menu.
The context menu provides options to cut, copy, or paste the image or media. You can insert an element before or after the selected element. You also have the option to rename or unwrap an element. You can locate the selected image or media in the repository or view the preview of the file in Assets UI.
The other options in the context menu allow you to copy a path, edit an image map, rename element, create a snippet, or generate IDs for the selected element.
Insert/Edit Image Map
Inserts an image map on the selected image. An image with clickable areas that link to topics or web pages is called an image map.
Select an image in the current topic and select the Insert/Edit Image Map icon to open the insert Image Map dialog box.
Choose the preferred shape Rectangle
If areas overlap, you can bring the shape forward or send it backward by clicking on the respective icon in the toolbar. You can also remove an area by selecting it and clicking the Delete icon. Double-clicking on an area opens the Reference dialog wherein you can change the destination link. Once you have marked the required areas on your image, save the changes by selecting Done.
Multimedia
Inserts different types of multimedia files. Select the Multimedia dropdown icon and choose the type of file you want to insert. The supported multimedia formats are:
- Audio File
- Video File
- YouTube
- Vimeo
On selecting the Audio or Video file option, you are shown the repository view to browse and select the desired file. If you choose YouTube or Vimeo, then you get the Insert Multimedia dialog. Paste the link of the video file in the Web Link field and select Insert to add the video at the current or next valid location in your document.
watch?v=
with embed
in the URL. For example, to add a YouTube video link: https://www.youtube.com/**watch?v**=WlIKQOrmZcs
, you need to add it as: https://www.youtube.com/**embed/**WlIKQOrmZcs
. This change ensures that the video gets embedded in the AEM Site and PDF output.You can also add the Audio or Video File from the Insert Multimedia dialog. Select the Audio/Video File option and then, select the browse icon to launch the repository view. Select the audio or video file from the repository and select Select to add the link of the file in the Audio/Video File field. In case you choose a video file, then a preview of the file is also shown in the Preview area. You can play the video file to view its preview.
Cross Reference
Insert references of type 鈥 Content Reference, Content Key Reference, Key Reference, File Reference, Web Link, or Email Link.
Select the Select File icon (for Content Reference and File Reference) or Select Root Map icon (for Content Key Reference and Key Reference) and select the desired file or content to link to.
A link of the selected reference is added in the document. The context menu on the link gives you the options to:
- Insert Element: Shows a list of valid elements that you can insert at the given context.
- Copy UUID: Copies the UUID of the inserted reference.
- Copy Path: Copies the complete path of the inserted reference.
- Generate IDs: Generates unique ID for the inserted reference.
You can also search using the UUID of the file that you want to reference. For Content and Key Reference links, enter the UUID of the file that you want to link to, and the file is automatically searched and displayed in the Preview section. When you specify the UUID of the file, you need not explicitly mention the file extension for .xml files. The .xml extension is auto-appended to the UUID.
If your administrator has enabled the UUIDs option in XMLEditorConfig, then you will view the UUID of the referenced content in the Link property.
Filter Search
You can search for some text in the files present on the selected path of the AEM repository. For example, 鈥榞eneral鈥 is searched in the given below screenshot. You can also narrow down your search using enhanced filters. You can look for all DITA Files like DITA Topics and DITA Maps present on the selected path.
You can search for Non-DITA Files like the Image Files, Multimedia, and documents in the selected path. You can also search for specific values in the attributes of DITA elements. You can also look for files which are checked out by the specified user.
The list of filtered files which contain the searched text is displayed. For example, in the above screenshot the files containing the text 鈥榞eneral鈥 are listed. You can also preview the content of the file.
Reusable Content -
Reuse content that exists within any other document in your project. You can insert content by directly linking to the content in a file or by using a key reference, view Resolve key references. When you select the Reusable content icon, you get the Reuse Content dialog box:
In the Reuse Content dialog box, select the DITA file for file references or the DITA map file that contains the key references. Once selected, the topic or key references are shown in the dialog. You can select the ID/key of the topic that you want to insert and select Done to insert the content within your topic.
For inserting Content Reference, you can also enter the UUID of the file and the reusable content from that file is listed in the Preview section.
Based on the setting for inserting links, you could either view the UUID of the inserted content or the relative path in the Properties panel or the Source code view. The link is always created using the UUID of the referenced content. View Configure UUID-based links in the Install and configure 51黑料不打烊 Experience Manager Guides as a Cloud Service.
You can also embed the referred content within the topic by right-clicking on the referred content and choosing Replace Reference with Content from the context menu.
Symbol -
Inserts special characters in your topic. Select the Symbol icon to open the Insert Special Character dialog box.
In the Insert Special Character dialog box, you can search for a special character using its name. All special characters are stored under various categories. Use the Select Category drop-down list and select a category. The special characters available within the selected category are displayed. You can navigate the list of special character using the arrow keys or select the desired character that you want to insert. The Name and Hex Code of the selected special character are displayed below the list. Select Insert to insert the selected character in your document.
Keyword -
Insert keyword defined in your DITA map. Select the Keyword option to open the Key Reference dialog box.
The keywords are listed in alphabetical order and you can also search keyword(s) by typing a search string in the Search box. The search result will return the keywords containing the string in ID or Value. The keywords defined in your DITA map are listed in this dialog. Choose the keyword that you want to insert and select Insert.
You can also change the attributes of the inserted keyword by right-clicking on the keyword and selecting the Attributes option. The **Attributes for Keyword dialog box open:
You can change the keyword鈥檚 attributes or add a new attribute to the keyword.
Snippets -
Insert a snippet at the current or next valid location. For this feature to work, you must have snippets defined in your system. For more information about adding a snippet, view the Snippet feature description in the Left panel section.
When you select the Snippets option, you are shown the Insert Snippet catalog. The catalog is context-sensitive, which indicates that it will show the snippets only if they are allowed at the current location.
The following example shows two pre-configured snippets - Warning and Error that can be inserted at the current location in the document.
When you choose a snippet from the list, it gets inserted at the current or next valid location in the document. The following screenshot shows the Error snippet inserted in the document:
Citations -
Create Citations and add them to your content. Learn how to add and manage citations in your content.
Query data -
Connect with your data source and use the data to create content. Learn how to use data from your data source.
Version information and Save as new version
The Version information & Save as new version feature combines version tracking and content saving into a single functionality.
-
Version information displays the current version of the topic or map. An asterisk (*) appears next to the version number to indicate unsaved changes.
The version number changes with every new version that is created for the topic or map file. If you are working on a newly created document, the version information is shown as none.
-
Save as new version is a button that saves the changes you have made in your topic and also creates a new version of your topic.
When you choose to save a topic or map using Save as new version, the following dialog box appears:
Enter comments and version labels to identify the changes and select Save to create a new version of your file.
When you choose the Save as new version option, the first version of the topic is created in DAM, which also becomes the currently active version of your topic. Later, if you revert to an older version of the topic, then that becomes your current active version of the topic.
If your administrator has pre-configured version labels, then you will view those labels in a drop-down list. You can choose a label from the list of available labels and save your document.
At the time of saving a topic, you can add a comment specifying the changes that you have made in the topic. This comment is shown in the topic鈥檚 Version History.
If your topic is under review, your reviewers will get a notification saying that a newer version of the topic is available. They can easily access the latest revision of your document and continue reviewing the latest version of your topic.
When you hover your pointer over a topic鈥檚 title, you are shown the file title, file path, and the version number.
Lock/unlock
Locks or unlocks the current file. Locking a file gives you an exclusive write access to the file. This restricts other users from editing the file. Unlock the file if you want others to have editing access. When the file is unlocked, the changes are saved in the current version of the file.
If you are in the Map View and you expand the parent map, you can lock all files in the map with a single click. Simply expand the parent map file and select the parent file, which results in selecting all files within the map. Then you can select Lock
In the Repository panel, the locked files are displayed with a lock icon. When you hover over this lock icon, the Locked by you/username is displayed as a tooltip.
If a file is locked by another user, hovering over the lock icon in the Repository displays the name of the user who locked it. In this case, the file opens in Read-only mode, with Read-only access displayed next to the version information.
As an administrator, you also get access to the Force unlock feature that allows you to unlock the file locked by other users. Use this feature to access the editing rights on a file locked by other users.
Left panel
The left panel gives you quick access to Collections, Repository view, Map view, and more features. You can expand the panel by selecting the Expand icon placed at the bottom-left corner of the interface. Once expanded, use the Collapse icon to collapse the panel. In the expanded view, it displays the names of the icons which appear as tooltips in the collapsed view.
The left panel gives you access to the following features:
Some of the features in the left panel are available under the More section. Select the More icon
An additional option labeled as Workfront is also displayed in the left panel if 51黑料不打烊 Workfront is configured.
For details, view Workfront integration.
The detailed explanation of the left panel features is as follows:
Collections
If you work on a set of files or folders, you can add them to your favorite list to access them quickly. Collections show the list of documents that you have added and other publicly accessible list of documents from the other users.
By default, you can view the files by titles. As you hover over a file, you can view the file title and the file path as a tooltip.
To create a new collection, Select the + icon next to Collections panel to bring up the New collection dialog box:
Enter a title and description for the collection that you want to create. If you select Public, then this favorite is shown to other users as well.
To add a file to collections, use any of the following methods:
-
Navigate to the required file or folder in the Repository view, select the Options icon to open the context menu, and choose Add to > Collections. In the Add to collections dialog box, you can choose to add the file/folder to an existing favorite or create a new one.
-
Right-click on a file鈥檚 tab in the editor to open the context menu. Choose Add to > Collections to add the file to your favorites list.
- To remove an item from the favorites list, select the Options icon next to the item in a Favorites collection and choose Remove from collections.
- To preview the file without opening it, select a file and then select Preview from the Options menu.
Options menu for a collection
You can also perform many actions using the Options menu available for a Collection:
- Rename: Rename the selected collection.
- Delete: Delete the selected collection.
- Refresh: Get a fresh list of files and folders from the Repository.
- View in Assets UI: Show the file or folder contents in the Assets UI.
Repository
When you select the Repository icon, you get a list of files and folders available in DAM. By default, you can view the files by titles. As you hover over a file, you can view the file title and the file name as a tooltip.
75 files are loaded at a time. Each time you select Load more鈥 75 files are loaded, and the button stops being displayed when all the files have been listed. This batch loading is efficient, and you can access the files faster in comparison to loading all the files existing in a folder.
You can easily navigate to the required file within DAM and open it in the Editor. If you have the required access to edit the file, then you can do so.
You can also select and play an audio or video file in the Editor. You can change the volume or
the view of the video. In the shortcut menu you also have the options to download, change playback
speed, or view picture in picture.
Select a map and press Enter or double-click to open it in the Map view. For more details, view the Map view feature description in the Left panel section. Select a topic and press Enter or double-click to open it in the Content editing area. Being able to navigate and open a file directly from the Editor saves time and increases productivity.
Filter Search in Repository
The Editor provides enhanced filters for searching text. You can search and filter for a text in the files present on the selected path of the 51黑料不打烊 Experience Manager repository. It searches in the title, filename, and content in the files.
Apply filters to search for the files containing the text personal spaceship.
Select the Filter Search (
You have the following options to filter the files and to narrow down your search in the 51黑料不打烊 Experience Manager repository:
-
DITA Files: You can look for all DITA Topics and DITA Maps present on the selected path. These are selected by default.
-
Non-DITA Files: You can search for Ditaval Files, Image Files, Multimedia, Documents, and JSON in the selected path.
Use the quick filters to search for DITA and Non-DITA files.
Advanced filtering
Select the Advanced filtering
You can view the following options under the General and Advanced tabs.
General
- Search results with: Search for some text in the files present on the selected path of the 51黑料不打烊 Experience Manager repository. The text is searched in the title, filename, and content in the files.
This is in sync with the search box on the repository window. For example, if you type general purpose
in the search box on the repository panel, it also appears in the Advanced filter dialog box and vice versa.
- Search in: Select the path where you want to search the files present in the 51黑料不打烊 Experience Manager repository.
Advanced
-
DITA Elements: You can also search for specific values in the attributes of the specified DITA elements.
- Select Add element to add the elements, attributes, and values.
- Apply the filters that you have selected.
-
Select Clear all to clear all the applied filters.
-
Select the Close filter
note note NOTE Your system administrator can also configure the text filters and show or hide other filters. For more details, view Configure text filters section in the Install and configure 51黑料不打烊 Experience Manager Guides as a Cloud Service. The list of filtered files that contain the searched text is displayed. For example, the files containing the text personal spaceship
are listed in the previous screenshot. You can select multiple files from the filtered list to drag and drop them into a map opened for editing.
Options menu
In addition to opening files from the left panel, you can also perform many actions using the Options menu available in the Repository view. You will view different options, depending on whether you choose a folder, topic file, or a media file.
Options for a folder
You can perform the following actions using the Options menu available for a folder in the Repository view:
-
New: Create a new DITA topic, DITA map, or a folder.
Steps to create a new topic:
-
Select New > Topic.
-
The New topic dialog box is displayed.
-
In the New topic dialog box, provide the following details:
-
A Title for the topic.
-
(Optional)* The file name for the topic. The file name is auto-suggested based on the topic Title. In case your administrator has enabled automatic file names based on UUID setting, then you will not view the Name field.
-
A template on which the topic will be based. For example, for an out-of-the-box setup, you can choose from the Blank, Concept, DITAVAL, Reference, Task, Topic, Markdown, Glossary, and Troubleshooting templates. If your folder has a Folder Profile configured on it, then you will view only those topic templates that are configured on the Folder profile.
-
Path where you want to save the topic file. By default, the path of currently selected folder in the repository is shown in the Path field.
-
-
Select Create. The topic is created at the specified path. Also, the topic is opened in the Editor for editing.
Steps to create a new DITA map:
-
Select New > DITA map.
-
The New map dialog box is displayed.
-
In the New map dialog box, provide the following details:
- A Title for the map.
- (Optional) The file name for the map. The file name is auto-suggested based on the map title. In case your administrator has enabled automatic file names based on UUID setting, then you will not view the Name field.
- A template on which the map will be based. For example, for an out-of-the-box setup, you can choose from the Bookmap or DITA map templates.
- Path where you want to save the map file. By default, the path of currently selected folder in the repository is shown in the Path field.
-
Select Create. The map is created and added within the folder specified in the Path field. Also, the map is opened in the Map view. You can open the map file in the Map Editor and add topic to it. For more information about adding topics to a map file, view Create a map. Alternatively, select Open in map console to open the map in Map console.
Steps to create a new folder:
-
Select New > Folder.
-
The New folder dialog box is displayed.
-
In the New folder dialog box, provide the following details:
- A Title for the folder, which is auto-converted into the folder name.
- Path where you want to save the folder. By default, the path of currently selected folder in the repository is shown in the Path field.
-
Select Create. The folder is created and added within the folder from where the create folder option was executed.
-
-
Upload Assets: Upload a file from your local system to the selected folder in 51黑料不打烊 Experience Manager repository. You can also drag-and-drop files from your local system onto your current working topic. This is very useful if you want to insert images from your local system into your topic.
You can select a folder where you want to upload the file and a preview of the image is also shown. If you want to rename the file, you can do so in the file name text box. Select Upload to complete the file upload process. If you have dragged and dropped an image file on a topic, then the image file is added in the article, and it is also uploaded.
If your administrator has enabled the UUIDs option in XMLEditorConfig, then you will view the UUID of the uploaded image in the Source property.
-
Find files in folder: Shifts the focus to repository search wherein you can enter the search term. The search is performed under the selected folder in the repository. You can also apply a filter to return DITA Files, Image Files, or both.
You can also search using the UUID of a file. In that case, the search results display the title of the DITA/XML file and in case of the file is an image file, then the UUID of the file is displayed. In the following search example, the UUID of an image file is searched and the search results display the UUID of the original image file and the topic title of the file where that image is referenced.
-
Collapse: Collapse the selected folder in the repository.
note note NOTE Use the > icon next to a folder to expand it. -
Add to collections: Adds the selected folder to favorites. You can choose to add it to an existing or new collection.
-
Refresh: Get a fresh list of files and folders from the repository.
-
View in Assets UI: Show the folder contents in the Assets UI.
Options for a file
Get access to different options in the Options menu depending on whether you select a media file or a DITA file. Some common options available for both media and DITA files are:
- Edit
- Open in FrameMaker
- Duplicate
- Lock/unlock
- Preview
- Move to
- Rename
- Delete
- Generate
- Download as PDF
- Add to
- Copy
- View in Assets UI
- Properties
The various options in the Options menu are explained below:
-
Edit: Open the file for editing. In case of a .ditamap/.bookmap file, it is opened in the Map Editor for editing.
-
Duplicate: Use this option to create a duplicate or a copy of the selected file. You also have the option to rename the duplicate file in the Duplicate Asset prompt. By default, the file is created with a suffix (like filename_1.extension). The title of the file remains same as the source file and the new file begins with version 1.0. All references, tags, and metadata are copied while the baselines are not copied in the duplicate file.
-
Lock: Get a lock on the selected file for editing. If the file is locked, hovering the mouse pointer over the lock icon shows Locked by you if you locked it, or Locked by [username] if another user has locked it.
-
Preview: Get a quick preview of the file (.dita, .xml, audio, video, or image) without opening it. You can resize the preview pane. If the content contains any
<xref>
or<conref>
, you can select it to open it in a new tab. The title of the file appears in the window. If no title is present, then the filename appears. To close the Preview panel, you can either select the close icon or select anywhere outside the pane. -
Rename: Use this option to rename the selected file. Enter the name of the new file in the Rename Asset dialog.
- You can rename a file of any type.
- You can鈥檛 change the extension of a file.
- Two files cannot have the same name. So, you cannot rename a file to a name that already exists. An error is displayed.
-
Move to: Use this option to move the selected file to another folder.
- You can either type the name of the destination folder or choose Select Path to select the destination folder.
- You can move a file of any type to any destination within the Content folder.
- Two files cannot have the same name. So, you cannot move a file to a folder where a file with the same name already exists.
If you try to move a file to a folder where a file with the same name but a different title exists, the Rename and move file dialog is displayed, and you need to rename the file before moving it. The moved file in the destination folder has the new file name.
note note NOTE You can also drag and drop a file to another destination folder. Exclusion scenarios
Experience Manager Guides doesn鈥檛 allow you to rename or move a file in the following scenarios:
-
You cannot move or rename a file if it鈥檚 part of a review or a translation workflow.
-
If any other user locks the file, you cannot rename or move it, you will not view the Rename or Move to option for the file.
note note NOTE If your administrator has given you the permissions on a folder, only then the Rename or Move to options are displayed. accordion Cloud Services Renaming or moving any file does not break any existing references from or to the file, as every file has a unique UUID. -
Delete: Use this option to delete the selected file. A confirmation prompt is displayed before deleting the file.
-
A confirmation prompt is displayed before deleting the file.
-
If the file is not referenced from any other file, it is deleted, and a success message is displayed.
-
If the file is locked, you cannot delete it, and an error message is displayed.
note note NOTE If your administrator has prevented the deletion of locked files, only then the error message is displayed. For more details, view Prevent deletion of checked out files section in the Install and configure 51黑料不打烊 Experience Manager Guides as a Cloud Service. -
If the file is added to a collection, the Force Delete dialog box is displayed, and you can forcefully delete it.
-
If the file is referenced from any other file then Force Delete dialog with the confirmation message is displayed, and you can forcefully delete the file:
note note NOTE If your administrator has given the file delete permission, then Force Delete is enabled. Else, Force Delete is disabled and a message is displayed that you do not have permission to delete referenced files. For more details, view Prevent deletion of referenced files section in the Install and configure 51黑料不打烊 Experience Manager Guides as a Cloud Service. -
If you delete a referenced topic and you have opened the file containing references for edit, it will show the broken link for the referenced file.
note note NOTE You can also delete the selected file similarly using the Delete key of the keyboard. -
-
Copy: You can choose from the following options:
-
Copy UUID: Copy the UUID of the selected file to Clipboard.
-
Copy Path: Copy the complete path of the selected file to Clipboard.
-
-
Add to: You can choose from the following options:
-
Collections: Adds the selected file to Collections. You can choose to add it to an existing or new collection.
-
Reusable content: Adds the selected file to the Reusable content list in the left panel.
-
-
Properties: Use this to open the properties page of the selected file. This properties page can also be accessed from the Assets UI by selecting a file and then selecting Properties icon in the toolbar.
-
Open in map dashboard: In case the selected file is a DITA map, then this option opens the map dashboard.
-
Open in map console: In case the selected file is a DITA map, then this option opens the map console.
-
Edit in Oxygen: Select this option to edit the selected file in the Oxygen connector plugin. The file is opened for editing.
note note NOTE Contact your customer success team to get this feature enabled in the environment. This isn鈥檛 enabled as a part of the out-of-the-box support. For more details, view the Configure the option to edit in Oxygensection in the Installation and Configuration Guide. -
View in Assets UI: Use this to show a preview of a .dita/.xml file in the Assets UI. In case of a .ditamap/.bookmap file, all topic files within the map are shown in a single unified page-by-page view.
-
Download as PDF: Use the option to generate the PDF output and download it.
-
Generate: Use the option to publish a map or topics within a map to a Sites page, Content Fragment, or Experience Fragment.
Map
When you select the Map view icon, the Map view is displayed where a a list of topics within the map file is displayed. If you have not opened any map file, then the Map view appears blank. Double-clicking on any map file opens the map file in this view. You can double-click on any file within the map to open it in the Editor.
By default, you can view the files by titles. As you hover over a file, you can view the file title and the file path as a tooltip.
When you open a map in the map view, the title of the current map is displayed in the center of the Tab bar. If the title is too long, then an ellipsis is displayed and you can also hover over the title to view the full title in the tool tip.
When you define key attributes for the topic or map references, you can view the title, the corresponding icon, and the key in the left panel. The key is displayed as keys=<key-name>
.