ĆŪ¶¹ŹÓʵ

Keys in map view {width="300"}

If you have editing rights on the map files, you will be able to edit the files as well. For more information about opening and editing a topic through DITA map, view Edit topics through DITA map.

The following options are available for a map file in the Map view:

  • Open in map console: Opens the map file in the Map console.
  • Edit: Opens the map file for editing.
  • Options: Opens the context menu for the selected map file.

You can perform the following actions using the Options menu of the map file:

Options menu in Map view

  • Edit: Open the map file for editing in the Map Editor.

  • Select all: Select all files in the map.

  • Clear selection: Deselect the selected files in the map.

  • Lock: Get a lock on the selected files in the map.

  • Unlock: Unlocks the map file and makes it available for editing. It does not revert the changes to earlier version.

  • Save as new version and unlock: Create a newer version and release the lock on the selected files in the map.

  • Preview: Open a preview of the map file. In this view, all topic files within the map are shown in a single unified page-by-page view.

  • Copy: You can choose from the following options:

    • Copy UUID: Copy the UUID of the map file to Clipboard.
    • Copy Path: Copy complete path of the map file to Clipboard.

  • Locate in repository: Shows the location of the map file in the repository (or DAM).

  • Add to: You can choose from the following options:

    • Collections: Adds the map file to collections. You can choose to add it to an existing or new collection.

    • Reusable content: Adds the map file to the Reusable content list in the left panel.

  • Properties: Use this to open the properties page of the map file. This properties page can also be accessed from the Assets UI by selecting a file and selecting the Properties icon in the toolbar.

  • Open map dashboard: Opens the map dashboard.

  • View in Assets UI: Use this to show a preview of the map file in the Assets UI. In this view, all topic files within the map are shown in a single unified page-by-page view.

  • Download map: Select this option to open the Download map dialog box.

    In the Download Map dialog box, you can choose the following options:

    Use Baseline: Select this option to get a list of Baselines created for the DITA map. If you want to download the map file and its contents based on a specific Baseline, select the Baseline from the drop-down list. For more details about working with Baselines, view Work with Baseline.

    Flatten File Hierarchy: Select this option to save all referenced topics and media files in a single folder.

    You can also download the map file without selecting any option. In that case, the last persisted versions of the referenced topics and media files are downloaded.

    After you select the Download button, the map export package request is queued. The Success dialog box is displayed if the package is created successfully. You can select the Download button from the Success dialog box.

    You receive the map download-ready notification if the map is ready to download. In case the download fails, you receive the notification that the map download failed.

    You can access the download link from the ĆŪ¶¹ŹÓʵ Experience Manager notification Inbox. Select the generated map notification in the Inbox to download the map in .zip format.

    note note
    NOTE
    By default, the downloaded maps remain for five days in the ĆŪ¶¹ŹÓʵ Experience Manager notification Inbox.

  • Close map context: Closes the map file.

The following screenshot shows the Options menu for a file in the map view:

You can perform the following actions using the Options menu:

  • Edit: Open the file for editing. In case of a .ditamap/.bookmap file, it is opened in the Map Editor for editing.

  • Lock: Locks the selected file. For a locked file, this option changes to Unlock.

    note note
    NOTE
    • If a file is locked by a user, hovering the mouse pointer over the lock icon shows the user (name) who has locked the file.
    • When you check in a file, it prompts you to save the changes. If you donā€™t save your changes, then it only checks in the file.

  • 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 pane, you can either select the close icon or select anywhere outside the pane.

  • Copy: You can choose from the following options:

    • Copy UUID: Copy the UUID of the selected file to Clipboard.
    • Copy Path: Copy complete path of the selected file to Clipboard.

  • Locate in repository: Shows the location of the selected file in the repository (or DAM).

  • Expand all: Expand all topics in the map files.

  • Collapse all: Collapse all topics that are a part of the current map file.

  • 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 selecting the Properties icon in the toolbar.

  • 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.

  • Generate: Generate the output for the selected file at Sites page, Content fragment, or Experience Fragment.

NOTE
You can also open and edit the properties of selected topics in a DITA map from the More Options menu under References.

Reusable content

One of the main features of DITA is the ability to reuse content. The Reusable content panel can store your DITA files from where you generally insert reusable content. Once added, the DITA files remain in the Reusable content panel across sessions. This means that you donā€™t have to add your DITA files again to access them later.

You can simply drag-and-drop reusable content from the panel onto your current topic and it gets inserted easily and quickly. You can also get a preview of the content before inserting it in your document.

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.

NOTE
As an administrator, you can also choose to view the list of files by filenames in the Editor. Select the File name option of the Editor files display configuration section in User preferences.

To add a DITA file to your Reusable content panel, use any of the following methods:

  • Select the + icon next to Reusable content to open the browse file dialog box. Select the file that you want to add and then select Add to complete the process.

  • In the Repository view, select the Options icon of the desired file and choose Add to > Reusable content from the context menu.

  • Right-click on a fileā€™s tab in the editor to open the context menu and choose Add to > Reusable content.

Once the file is added, you can view all reusable content elements from the file in the Reusable content panel. Reusable content is shown with their IDs and element names.

When you add a file to the Reusable content list, the fileā€™s title is shown instead of the UUID of the file. To check the UUID of the file, mouse hover over the fileā€™s title and the UUID of the file is displayed in the tooltip.

{width="400"}

NOTE
You can add multiple files to the reusable content list. Then you can insert the desired content from the Reusable content panel into your document.

Refresh: Rechecks for all reusable content and displays a fresh list of reusable content.

To insert content from the Reusable content panel, use any of the following methods:

  • Hover the mouse pointer over an element that you want to insert, select the Options icon, and choose Insert reusable content from the dropdown.

    {width="400"}

    note note
    NOTE
    Select a file and then select Preview from the Options menu to preview the file without opening it. You can also preview the references present in a topic. The reference ID appears in the window.
    The Preview option is also available in the Options menu of an element, which gives you a quick preview of the element before inserting it.

  • Drag-and-drop the reusable content item from the panel at the desired location in your document.

Outline

When you select the Outline icon, you get the hierarchical view of the elements used in the document.

{width="300"}

The Outline view offers the following features:

  • A tree view of all elements used in the document.

  • If an element has an ID, attribute, and text you can view them along with the element.

  • Access Outline view in both Author and Source views.

  • Use the filter drop-down list to show all elements or only the broken references:

  • Choosing an element in the Outline view selects the elementā€™s content in the Author or Source view. The Outline view remains in sync with the Author and Source view. If you make any changes in any view, you can view them in the Outline view. For example, if you add a paragraph or update an element in the Author view, it is shown in the Outline view.

    {width="650"}

  • Drag and drop elements. You can easily replace an element by dropping another element on it. If you drag and drop an element over another element and you view a dashed rectangle box around the element, it indicates that the element will get replaced. It replaces the element on which the element is dropped.

    If you drag and drop an element, a dashed rectangle indicates that the element can be placed at the current location. If the drag and drop is invalid, then an error message is shown to indicate that the operation is not allowed.

  • The Options menu in the Outline view allows you to perform generic operations such as Cut, Copy, Delete, Generate ID, Insert element before or after the current element, Rename or replace an element, Wrap an element, Unwrap an element, and create a snippet out of the selected element.

NOTE
For more details on Generate ID, Insert element before or after the current element, and Unwrap an element, view Other features in the Editor.

View Configure

Using the View Configure option, you can choose to view the following:

  • Show ID: Shows the id of the element.
  • Show Attribute: Shows the attribute along with its value.
  • Show Text: Shows the text. If the text is longer than 20 characters, then an ellipsis is displayed.

If a block element has its own text, it is displayed along with that block element. If it does not have itā€™s own text, the text of the first child element is displayed along with that block element.

{width="550"}

If your administrator has created a profile for attributes, then youā€™ll get those attributes along with their configured values. You can also assign display attributes configured by your administrator under the Display attributes tab in the Settings. The attributes defined for an element are displayed in the Layout and the Outline view.

For more details, view the Display attributes within the Settings feature description in the Left panel section.

Search feature

Using the search feature, you can search for an element by its name, id, text or attribute value.

The search is case-insensitive and exactly matches the string. The search results are sorted on the basis of the elementā€™s position in the document.

You can search for a string in the element if it is shown in the Outline view. For example, if the string ā€œĆŪ¶¹ŹÓʵā€ is present in the text of the element and is shown in the Outline View panel (as you have selected Show Text from the View Options dropdown), then the containing element is filtered. But if the text is not shown in the Outline View panel (as you have not selected Show Text from the View Options dropdown), then the containing element is not filtered. Similarly, you will find the string in the ID or attributes if you have selected them.

Glossary

Experience Manager Guides allows you to easily create and use the glossary type documents. You can create glossary topic files and then include them in a common glossary map. Once this map is added as your root map, the glossary entries are then shown in the Glossary panel.

{width="650"}

To insert a term from the glossary, simply drag-and-drop the entry from the panel to the desired location in your topic. The Options menu of a glossary term allows you to get a quick Preview of the entry term, Copy path of the entry term file, or locate the entry term file in the repository.

Perform the following steps to search text terms and replace them with glossary abbreviations:

  1. Open the DITA topic or map in which you wish to search and convert the text or terms.
  2. Select the glossary panel to view the glossary terms present in the root map. You can drag-and-drop these terms to add them to the open topic.
  3. Select the Hotspot tool ( ) in the Glossary panel to search and convert specific text terms to linked glossary abbreviations. Also, vice versa you can use it to search glossary abbreviations and convert them to text terms.

You can configure the following settings of the Hotspot tool:

{width="300"}

  • Glossary keys: Select the glossary keys from the DITA map you want to use for the search in the selected topic. The selected keys will be displayed below. You can remove a selected key by selecting the Remove icon.

  • Topics: Choose either the Current topic opened in the Editor, all Opened topics in the current map, or the Current map being edited in the Map Editor to search the terms.

  • Filter Topics by Status: You can choose to limit the search to topics that have the selected document status. The topics can be in Draft, Edit, In-Review, Approved, Reviewed, Done status, or in any one of the state as configured by the organization.

  • Action: You can choose to either search the glossary keys Manually for each topic or Automatically for all topics. If you choose Manually for each topic, it prompts you to confirm before converting each term in every topic. If you choose Automatically for all topics, it converts all terms in all the topics automatically.

  • Convert: You can either convert a searched Text to glossary term or Glossary term to text.

  • Options: You can select from the following options:

    • Case-sensitive match: Searches for a term to find the match which has the same casing. For example, ā€˜USBā€™ will not match with ā€˜usbā€™.
    • Convert only the first instance: If multiple instances of the searched term are present in a topic, only the first instance is converted.
    • Lock file before conversion: The searched file is locked before the terms are converted.
    • Create a new version after conversion: A new version of the topic is created after the conversion of terms has been completed.

  • Next button appears if you select Manually for each topic option. Select Next to convert the terms for each topic on the basis of the selected settings. It prompts for conversion of terms in each topic and moves to the next file. You can choose to convert a term or skip it and move to the next term.

    {width="300"}

  • Convert button appears if you select Automatically for all topics option. Select Convert to convert all the terms found in the document to linked glossary abbreviations.

A list of the Topics Updated with the converted terms and Topics with Error is displayed. Hover over the info icon near Topics with Error to view the details of the error.

NOTE
Refresh the topic to view the converted terms.

Conditions

The Conditions panel displays the conditional attributes defined by your administrator in the global or folder-level profile. You can add conditions to your content by simply dragging and dropping the desired condition onto your content. The conditional content is highlighted using the color defined for the condition for easy identification.

You can also apply multiple conditions on an element by dragging-and-dropping multiple conditions on an element. When you apply multiple conditions on an element, the Properties panel displays the applied conditions separated with a comma.

However, in the Code view the conditions are separated using a space delimiter. When you add or edit a condition in Code view, ensure that multiple conditions are separated using a space.

IMPORTANT
The following screenshot is of a user with administrative privileges. As a user with administrative privileges, you can add, edit, and delete conditions. Else, as a normal author, you will only get the option to apply conditions.

To add or define a condition, select the + icon next to Conditions panel to bring up the Define Condition dialog box:

{width="400"}

From the Attribute list, select the conditional attribute that you want to define, enter a value for the condition, then specify the label that is displayed in the Conditions panel. Define a group for the condition. You can add multiple conditions to a group. You can also define a color for the condition. This color is set as the background color of the content on which the condition is applied.

You can group the conditions and structure them in nested folders. Groups help you create conditions at multiple levels and organize them better for use in the content.

For example, you can create condition groups of products like Acrobat and AEM Guides. You can select the conditional attributes for both groups. Under each group, you can have specific values like User, Admin, Reviewer, and Author.

NOTE
Either type in to create a new group or select an existing group for a particular attribute.

You can use / and define sub-groups like AEM Guides/Cloud Service.

condtions organised in a nested hierarchy {width="300"}

To edit a condition, choose Edit from the Options menu. The Edit Condition dialog box is displayed:

{width="400"}

Specify the details in the same way as configured while defining a new condition.

Subject scheme

Subject scheme maps are a specialized form of DITA maps that are used to define taxonomic subjects and controlled values. Depending upon your requirements, you can create a subject scheme map and reference it within your root map file. Experience Manager Guides allows you to define the nested-level hierarchy of the subject definitions in your subject scheme.

You can easily create and then use the subject scheme in a subject scheme map. Once this map is added as your root map, the subject scheme is then shown in the Subject Scheme panel. The Subject scheme panel displays the available subject scheme in a nested or hierarchical manner.

Experience Manager Guides also supports nested level subject scheme maps, and you can have multiple subject schemes defined under the root subject scheme map.

The following example shows how to use subject scheme in Experience Manager Guides.

  1. Create a subject scheme file in a tool of your choice. The following XML code creates subject scheme that binds values for the platform attribute.
<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE subjectScheme PUBLIC "-//OASIS//DTD DITA Subject Scheme Map//EN" "subjectScheme.dtd">
    <subjectScheme id="GUID-4f942f63-9a20-4355-999f-eab7c6273270">
        <title>rw</title>
        <!-- Define new OS values that are merged with those in the unixOS scheme -->
        <subjectdef keys="os">
            <subjectdef keys="linux">    </subjectdef>
            <subjectdef keys="mswin">    </subjectdef>
            <subjectdef keys="zos">    </subjectdef>
        </subjectdef>
        <!-- Define application values -->
        <subjectdef keys="app" navtitle="Applications">
            <subjectdef keys="apacheserv">    </subjectdef>
            <subjectdef keys="mysql">    </subjectdef>
        </subjectdef>
        <!-- Define an enumeration of the platform attribute, equal to       each value in the OS subject. This makes the following values       valid for the platform attribute: linux, mswin, zos -->
        <enumerationdef>
            <attributedef name="platform">    </attributedef>
            <subjectdef keyref="os">    </subjectdef>
        </enumerationdef>
        <!-- Define an enumeration of the otherprops attribute, equal to       each value in the application subjects.       This makes the following values valid for the otherprops attribute:       apacheserv, mysql -->
        <enumerationdef>
            <attributedef name="otherprops">    </attributedef>
            <subjectdef keyref="app">    </subjectdef>
        </enumerationdef>
    </subjectScheme>

{width="300"}

  1. Save the file with a.ditamap extension and upload it to any folder in DAM.

    note note
    NOTE
    You can add a reference to the subject scheme file in the parent DITA map.

    {width="550"}

  2. Set the parent map as the root map in the User preferences. Once this map is added as your root map, the subject scheme is then shown in the Subject scheme panel.

    {width="650"}

  3. In the Editor, open the file where you want to use the subject scheme definitions.

  4. Apply the subject scheme to your content by simply dragging and dropping the desired subject scheme onto your content. The content is then highlighted in the defined color.

Handling hierarchical definitions of subject definitions and enumerations

Besides handling the enumerations and the subject definitions present in the same map, Experience Manager Guides also provides the feature to define enumerations and subject definitions in two separate maps. You can define one or more subject definitions in a map and the enumeration definitions in another map and then add the map reference. For example, the following XML code creates subject definitions and enumeration definitions in two separate maps.

The subject definitions are defined in subject_scheme_map_1.ditamap

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE subjectScheme PUBLIC "-//OASIS//DTD DITA Subject Scheme Map//EN" "../dtd/libs/fmdita/dita_resources/DITA-1.3/dtd/subjectScheme/dtd/subjectScheme.dtd">
    <subjectScheme id="subject-scheme.ditamap_f0bfda58-377b-446f-bf49-e31bc87792b3">

    <title>subject_scheme_map_1</title>

    <subjectdef keys="os" navtitle="Operating system">
        <subjectdef keys="linux" navtitle="Linux">
        <subjectdef keys="redhat" navtitle="RedHat Linux">
        </subjectdef>
        <subjectdef keys="suse" navtitle="SuSE Linux">
        </subjectdef>
        </subjectdef>
        <subjectdef keys="windows" navtitle="Windows">
        </subjectdef>
        <subjectdef keys="zos" navtitle="z/OS">
        </subjectdef>
        </subjectdef>
        <subjectdef keys="deliveryTargetValues">
        <subjectdef keys="print">
        </subjectdef>
        <subjectdef keys="online">
        </subjectdef>
    </subjectdef>
    <subjectdef keys="mobile" navtitle="Mobile">
        <subjectdef keys="android" navtitle="Android">
        </subjectdef>
        <subjectdef keys="ios" navtitle="iOS">
    </subjectdef>
    </subjectdef>
    <subjectdef keys="cloud" navtitle="Cloud">
        <subjectdef keys="aws" navtitle="Amazon Web Services">
        </subjectdef>
        <subjectdef keys="azure" navtitle="Microsoft Azure">
        </subjectdef>
        <subjectdef keys="gcp" navtitle="Google Cloud Platform">
        </subjectdef>
    </subjectdef>
    </subjectScheme>

The enumeration definition is present in subject_scheme_map_2.ditamap.

<?xml version="1.0" encoding="UTF-8"?>
        <!DOCTYPE subjectScheme PUBLIC "-//OASIS//DTD DITA Subject Scheme Map//EN" "../dtd/libs/fmdita/dita_resources/DITA-1.3/dtd/subjectScheme/dtd/subjectScheme.dtd">
        <subjectScheme id="subject-scheme.ditamap_17c433d9-0558-44d4-826e-3a3373a4c5ae">
        <title>subject_scheme_map_2</title>
        <mapref format="ditamap" href="subject_scheme_map_1.ditamap" type="subjectScheme">
        </mapref>
        <enumerationdef>
        <attributedef name="platform">
        </attributedef>
        <subjectdef keyref="mobile">
        </subjectdef>
        <subjectdef keyref="cloud">
        </subjectdef>
        </enumerationdef>
        </subjectScheme>

Here subject definitions are defined in subject_scheme_map_1.ditamap while the enumeration def is present in subject_scheme_map_2.ditamap. The reference to subject_scheme_map_1.ditamap is also added in subject_scheme_map_2.ditamap.

NOTE
As the subject_scheme_map_1.ditamap and subject_scheme_map_2.ditamap are referenced with each other hence the subject schemes are getting resolved.

The subject-enumeration references are resolved in the following order of priority:

  1. Same map
  2. Referenced map

The references are not resolved if the enumeration is not found in the same map and the referenced map.

Restrict the values to a specific element

You can also restrict the conditions to some elements within a topic. Use the <elementdef> tag to define the element and the <attributedef> tag to define the condition that can be applied to the element. If you donā€™t add the <elementdef> tag, you can apply the conditions to all elements.
For example, use the following enumeration to restrict the @platform attribute to the <shortdesc> element. The other conditions are visible for all elements.

<enumerationdef>
    <elementdef name="shortdesc">
    </elementdef>
    <attributedef name="platform">
    </attributedef>
    <subjectdef keyref="deliveryTargetValues">
    </subjectdef>
    <subjectdef keyref="os">
    </subjectdef>
  </enumerationdef>

Attributes drop-down

You can also change the value of the subject scheme using the Attributes dropdown from the Content properties panel in the Author view.

Perform the following steps to change the value:

  1. Select an attribute from the Attribute dropdown.
  2. Select Edit.
  3. Select the required value from the Value dropdown.
  4. Select Update.

You can also apply values for an attribute by selecting multiple values from the dropdown.

Source view

You can also change the values from the attributeā€™s drop-down in the Source view. The Source view also prevents you from adding any incorrect value.

{width="550"}

View and apply the subject scheme from the Conditions panel

You can also view and apply the subject scheme from the Conditions panel.

To view the subject scheme from the Conditions panel, your system administrator must select the Show subject scheme in the Conditions panel option under the General tab in Settings. For more details, view the Settings section in the Tab bar.

The Conditions panel displays the flat vertical structure of the subject definitions within the subject scheme.

You can add conditions to your content by dragging and dropping the desired condition onto your content. The conditional content is highlighted using the color defined for the condition.

Snippets

Snippets are small content fragments that can be reused across various topics in your documentation project. The Snippets panel shows a collection of content snippets that you have created. To insert a snippet, drag-and-drop the snippet from the panel to the desired location in your topic. The Snippets panel allows you to add, edit, delete, preview, and insert a snippet.

IMPORTANT
The following screenshot is of a user with administrative privileges. As a user with administrative privileges, you can add, edit, and delete snippets. Else, as a normal author, you will only get the options to preview and insert a snippet.

To add a snippet, use any of the following methods:

  • Select the + icon next to Snippets to open the New Snippet dialog box.

    {width="300"}

    In the New Snippet dialog box, provide a title which appears in the Snippets panel, a description, and XML code of the snippet content that you want to create. Select Create to save and create the snippet.

  • In the content editing area, right-click on the elementā€™s breadcrumb that you want to use as a snippet and choose Create Snippet from the context menu. The New Snippet dialog appears with the XML code of the selected element populated in the Content field. Enter the Title and Description for the snippet and select Create to save the snippet.

  • In the content editing area, right-click anywhere on the content that you want to use as a snippet and choose Create Snippet from the context menu. The New Snippet dialog box appears with the XML code of the selected element populated in the Content field. Enter the Title and Description for the snippet and select Create to save the snippet.

    The following screenshot highlights the breadcrumb and the content area from where you can invoke the context menu.

    {width="350"}

To insert a snippet, use any of the following methods:

  • Select a snippet from the Snippets panel and drag-and-drop it at the desired location in your topic.

  • Place the insertion point where you want to insert the snippet, from the Options menu of the required snippet, choose Insert Snippet.

NOTE
From the context menu of a snippet entry, you can also choose to Edit, Delete, get a Preview, or Insert a Snippet.

Templates

The Templates panel is available to only administrators. Using this panel, administrator can easily create and manage templates that can then be used by the authors. By default, the templates are categorized under map and topic type templates.

{width="300"}

By default, you can view the files by titles. As you hover over a template, you can view the file title and the file name as a tooltip.

NOTE
As an administrator, you can also choose to view the list of files in the Editor. Select the File name option of the Editor files display configuration section in User preferences.

To learn how to create custom templates, view Create maps based on customized templates.

Citations

In Experience Manager Guides, you can add and import citations and apply them to your content. You can add these citations from any source of books, websites, and journals.

For details, view Add and manage citations in your content.

Language variables

Experience Manager Guides provides the feature to use language variables in the Native PDF output. You can use language variables to define localized strings in the PDF output or to localize any static text in the output templates. You can use CSS styles to localize the strings coming from a CSS.

For details, view Support for language variables.

Variables

Experience Manager Guides allows you to create and manage variables for Native PDF publishing. For details, view Variables in the PDF output.

Find and replace

The Find and replace icon is located at the bottom of the left panel. The Find and replace panel allows you to search for and replace text across files in a map or a folder within your repository. You can find and replace in all topics of a map as well as topics present in the sub-maps within the map.

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.

NOTE
As an administrator, you can also choose to view the list of filenames in the Editor. Select the File name option of the Editor files display configuration section in User preferences.

To perform the global search and replace, perform the following steps:

  1. Open the global Find and replace panel.

  2. Select the Look into dropdown and select one of the following options to perform the search.

    • Current Map: To search in the currently opened map

      note note
      NOTE
      This option appears if you have already opened a map for editing.

    • Path: To search on the selected path

    • Select Map: To search in the selected map

  3. You can use the Options dropdown and choose from the following options:

    • Lock file before replace: Select this option if you want to lock a file automatically before replacing the search term. This setting is more relevant in case your administrator has enabled the configuration to lock a file before editing. With the backend setting enabled, you should select this option. It will prevent the file lock dialog from prompting you to lock every file before making any change. If you do not select this option, then a prompt will appear before a file is opened for editing.

    • Whole words only: Select this option if you want to search for the whole search string. For example, if you enter over in the search string, then the search result will return all files containing words like over and overview. If you want to restrict your search to return the exact term that is entered, then select this option.

    • Create new version after replace: Select this option if you want to create a new version of the topic in which you choose to replace the text. You can also provide version comments which will be added with each updated file.

      If you donā€™t select this option, then the changes are saved in the current version of the topic and no new version is created.

    • Include indirect references: Select this option if you want to search the string in the indirect references also within the DITA map. By default, this is disabled so the search is performed only on the direct references.

  4. Enter the search term or text that you want to find.

  5. Enter the text with which you want to replace the search term.

  6. Press Enter or select Search icon ( ) to perform the search.

  7. Select a file from the search result list. The file is opened in the content editing area with the searched term highlighted in the content.

  8. Select Replace single occurrence ( ) to replace the currently highlighted search term in the topic or select Next match or Previous match to move to the next or previous occurrence of the text.

  9. Select Replace all ( )to replace all occurrences of the searched term in a single file with the replace term in a single click. You will be shown a notification after replacing all the occurrences in the selected file.

To enable the Replace all icon, your system administrator must select the option Enable Replace All under the General tab in Settings.

NOTE
Hover over a file from the search result list to view Replace all in File icon on the right of it. You also get the Ignore File icon to remove the file from the search result. The files which you ignore are removed from the list and the searched term is not replaced in them.

Only one replace all operation can be performed at a time in the whole system, and till the time operation is being performed you will view ā€œReplace all in progressā€ status. You can also abort the replace all operation in between or view the log report. If you abort the operation, you will receive a notification about it in your Inbox. You will be shown a success notification after replacing all the occurrences in the selected file.

{width="300"}

You can also use the Find in map option from the Options menu of a map to find and replace text in a map. This option appears for a map opened in the repository panel or in the map view.

{width="550"}

PDF templates

Enables you to work with various PDF templates. For details, view PDF templates.

Review

Experience Manager Guides provides the feature to display all the review tasks in your projects. You can view all the review projects and the active review tasks within the review projects, that youā€™re part of from the Review panel. You can then open the review tasks to view the comments of the various reviewers.

The review panel displays the review tasks. 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.

NOTE
As an administrator, you can also choose to view the list of files by filenames in the Editor. Select the File name option of the Editor files display configuration section in User preferences.

As an author, you can address the comments in a topic using the Editor.

To view the review comments in the active review tasks that are present in your projects, perform the following steps:

  1. Select Review in the left panel. The Review panel opens. All the review projects and the active review tasks within the review projects, that youā€™re part of are displayed.

    {width="300"}

  2. Select a review project and then select a review task from the list to open it.

  3. You can also filter your projects in the following ways:

    • Enter the search term or text you want to find in the title of the project. Then press Enter to perform the search. For example, you can search all projects with the term ā€˜spaceā€™ in the title.

    • Select to open the Filter dialog box. You can select all or only specific projects. The selected projects are listed in the Review panel.

      {width="300"}

      Enable the Tasks initiated by me option to view only the tasks that youā€™ve initiated. The toggle state of this option is maintained even after refreshing the page. Enable the Show only active tasks option to filter the project list to show tasks that are currently active.

  4. By default, in your review project you will view a flat list of topics that have comments associated with them. Apply the required filters from the left rail to filter the topics based on the review comments present in them:

    • View all topics: Lists all topics present in the projects.
    • View topics with comments: List only the topics containing review comments.

  5. You can also enter the search term or text you want to find in the topicā€™s title or file path. The topics which contain the term in the title or the file path are listed.

  6. Double-click any topic to open it in the author view. You can view the comments in the Comments panel.

    note note
    NOTE
    The Review panel and the Comments panel are in sync at all times. In the Comments panel, the comments are loaded based on the review task loaded in the Review panel.
    You can view the closed review tasks in the left rail of Review Panel along with the active review tasks.
    Additionally, for a closed review task you can view the review comments in the Comments panel on the right but the Import Comments and Revert Version buttons are disabled.
    For more information about how to address the comments, view Address review comments.

Content editing area

The content editing area is where the content of your topic or map is displayed. You make all content edits in this area. It gives a WYSIWYG view of the content you are editing.

At the bottom-left of the content editing area, you have the breadcrumb of the element at current cursor location. In the bottom-right corner, the available Editor views are displayed.

To learn more about the Editor views available for a topic file in the content editing area, view Editor views.

NOTE
If you are working on a map file, then different options or views are displayed in the content editing area , including a Layout view for the map file. For more details, view Map editor features.

Right panel

The right panel contains information about the currently selected document.

NOTE
The right panel is resizable. To resize the panel, bring the cursor on the panel boundary, the cursor changes to a double-headed arrow, select and drag to resize the panel width.

The right panel gives you access to the following features:

Content properties

You can access the Content properties feature by selecting the Content properties icon in the right panel. The Content properties panel contains information about the type of currently selected element in the document and its attributes.

Type: You can view and select the tags of the complete hierarchy for the current tag from the dropdown.

Attributes: The Attributes dropdown panel is available in Layout, Author, and Source views. You can easily add, edit, or delete the attributes.

  1. Select Add.

    attrubutes in content properties {width="300"}

  2. In the Attribute dropdown panel, select the attribute from the dropdown list and specify an attributeā€™s value. Then select Add.

    attributes panel with multiple attributes {width="300"}

  3. To edit the attribute, hover over it and select Edit edit-icon .

  4. To delete the attribute, hover over it and select Delete delete-icon .

NOTE
Even if your topic contains referenced content, you can add attributes on it using the properties panel.

If your administrator has created a profile for attributes, then you will get those attributes along with their configured values. Using the content properties panel, you can choose those attributes and assign them to relevant content in your topic. This way you can also create conditional content, which can then be used to create conditional output. For more information about generating output using conditional presets, view Use condition presets.

File properties

View the properties of the selected file by selecting the File properties icon in the right panel. The File properties feature is available in all four modes or views: Layout, Author, Source, and Preview.

The File properties have the following two sections:

General

The General section gives you access to the following features:

file-properties {width="300"}

  • File name: Displays the filename of the selected topic. The filename is hyperlinked to the properties page of the selected file.
  • ID: Displays the ID of the selected topic.
  • Tags: These are the metadata tags of the topic. They are set from the tags field in the properties page. You can type or select them from the dropdown. The tags appear under the dropdown. To delete a tag, select the cross icon next to the tag.
  • Edit more properties: You can edit more properties from the file properties page.
  • Language: Shows the language of the topic. It is set from the language field in the properties page.
  • Created on: Displays date and time on which the topic was created.
  • Modified on: Displays the date and time on which the topic was modified.
  • Locked by: Shows the user who locked the topic.
  • Document state: You can select and update the document state of the currently opened topic. For more details, view Document State.
NOTE
You can copy the attribute values of the various fields in the File properties to the clipboard.

References

The References section gives you access to the following features:

{width="300"}

  • Used in: The Used in references list the documents where the current file is being referred or used.
  • Outgoing links: The Outgoing links list the documents that are referred to in the current document.

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.

NOTE
As an administrator, you can also choose to view the list of files by filenames in the Editor. Select the File name option of the Editor files display configuration section in User preferences.
NOTE
All Used in and Outgoing references are hyperlinked to the documents. You can easily open and edit the linked documents.

In addition to opening files, you can also perform many actions using the Options menu in the References section. Some of the actions that you can perform include Edit, Preview, Copy UUID, Copy Path, Add to collections, Properties.

Review

Selecting the Review icon opens the review panel wherein you can select a review task for the currently opened document and view comments.

{width="300"}

If you have created multiple Review projects, you can select one from the drop-down and access the review comments.

Using the review panel, you can view and post replies to the comments given on the topic. You can accept or reject the comments one by one.

NOTE
The comment box and reply box support multi-line entries and allows users to expand it as needed for providing comprehensive comments as well as detailed reply to the comments. You can use Shift + Enter to go to the next line while writing the comments or replies.

For more information, view Address review comments.

Track changes

Using the Tracked changes feature of the right panel, you can view the information of all updates made in a document. You can also search for any specific updates made to the document.

NOTE
Tracked changes feature shows all updates that have been tracked using the Enable/Disable Track Changes feature of the Tab bar.

Schematron

ā€œSchematronā€ refers to a rule-based validation language used to define tests for an XML file. The Editor supports Schematron files. You can import the Schematron files and also edit them in the Editor. Using a Schematron file you can define certain rules and then validate them for a DITA topic or a map.

Learn how to work with Schematron files in Experience Manager Guides, refer to Support for Schematron files.

Parent topic: Introduction to the Editor

recommendation-more-help