DITA map report from the Web Editor id231HF0Z0NXA

In the Repository panel, open the DITA map file in Map View.

Click the Manage tab.

Double-click Topic List on the left. The list of topics present in the DITA map is displayed.

{width="800"}

From the Filters Panel you can filter your topics based on the Reference type (direct or indirect), Document State (the current state of your topics. For example if your topics are in Edit, In-Review, or Reviewed state, these are listed) or the Author of the topic.

You can also use the following topic filtering options to choose to display the following columns in the list:

• Topic The title of the topic is specified in the DITA map. You can click the topic to edit it.
• File Name Name of the file.
• UUID The universally unique identifier (UUID) of the file.
• File Location The complete path of the topic.
• Reference Type The type of reference – direct or indirect.
• Document State The current state of the topic.
• Author The user who worked last on the topic.
• Parent Map The list of all maps where the topic is directly referenced.

Click Download CSV to download the current snapshot of the topics in the DITA map. The CSV contains the selected columns and the topics filtered in the Topic List view. You can then open this topic list CSV file in any CSV editor.

In the Repository panel, open the DITA map file in Map View.

Click the Manage tab.

Double-click Metadata on the left. The metadata list of all the references in the DITA map is displayed. This includes the media references also.

{width="800"}

From the Filters panel you can filter your topics based on the Document State (the current state of your topics. For example if your topics are in Edit, In-Review, or Reviewed state, these are listed), References (direct or indirect), File Type (Map, Topic, and Image) of the reference.

You can also choose to view only the Files with no tags or also choose specific tags from the Tags filter to view the files associated with them.

1. You can also use the following topic filtering options to choose to display the following columns in the metadata list:

   • Title (selected by default) The title of the referenced file is specified in the DITA map. You can click the file to edit it.You can also click and play an audio or video file in the Web 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.

     note note
     NOTE
     A checked-out icon also appears near the title of a checked-out file. You can hover over the icon to view the name of the user.

   • File Name The name of the file.

   • File Location The complete path of the file.

   • Tags (selected by default) Tags applied on the file.

     note note
     NOTE
     By default, you can view two tags for a file. To view more tags, click Show More. Click Show Less to contract the list again.

   • Reference Type The type of reference – direct or indirect

   • Document State (selected by default) The current state of the reference file.

   • File Type (selected by default) Type of the source file. The available options are Map, Topic, and Image.

   • Checked Out by The user who has checked out the file.

Click Download CSV to download the current snapshot of the references in the DITA map. The CSV contains the selected columns and the references filtered in the Topic List view. You can then open this metadata CSV file in any CSV editor.

To update metadata, select the files for which you want to update.

Select Manage from the top.

{width="350"}

If you want to add any new tags, select new tags from the dropdown list to apply them to all selected topics. You can also delete any tag by clicking the cross icon near the tag.

Select a new document state if you want to change the document state of all the selected references. The dopdown displays the common possible state for all selected topics. For example, if the current state of your topics is In-Review, then you can view Draft, Approved, or Reviewed state.

Click Update to update the metadata. A confirmation message is displayed for the metadata whether it is updated successfully or has any failed updates. You also click Download Report to download the metadata CSV from the confirmation dialog. This CSV contains the details of the update status for the selected references.

In the Repository panel, open the DITA map file in Map View.

Click the Manage tab.

Double-click Multimedia on the left. The list of multimedia present in the DITA map is displayed.

From the Filters panel you can order the list by multimedia or by the names of used in references.

• When you order by Multimedia, the****name of the multimedia is displayed in the first column and then the names of all references in which they have been used, are displayed in another column on the same row. For example, the following screenshot shows the multimedia WarmCoolForC.gif in the first column and three references in which it is used, are displayed in the third column on the same row.

  {width="650"}

• If you order by Used In column, you will view the transposed view wherein the names of the references in which multimedia have been used are listed in the first column while the multimedia names are listed in another column on separate rows. For example, the following screenshot shows the names of three references (Adjust the seat temperature, Change the seat temperature display, and Crew area) in the first column and the multimedia WarmCoolForC.gif is displayed in the third column on three separate rows.

  {width="650"}

You can filter your multimedia based on the Multimedia Type, and Reference Type. The list of multimedia files is displayed based on your selection in the drop-down. For example, you can choose to display only the audio references in your DITA map, and a file shows only the audio references used in it.

You can also use the following filtering options to choose to display the following columns in the list:

• Multimedia (selected by default) The title of the multimedia is specified in the DITA map. You can click the multimedia to edit it.
• Multimedia Location The complete path of the multimedia.
• Multimedia UUID The universally unique identifier (UUID) of the file.
• Multimedia Type (selected by default) Type of the multimedia. The available options are Audio, Video, or Image.
• Used In (selected by default) The references in which the multimedia has been used. You can click the reference to edit it.
• Reference Type (selected by default) The type of reference - direct or indirect.

You can also click and play an audio or video file in the Web 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.

{width="800"}

Click Download CSV to download the current snapshot of the multimedia in the DITA map. The CSV contains the selected columns and the multimedia filtered in the Multimedia view. You can then open this multimedia CSV file in any CSV editor.

In the Repository panel, open the DITA map file in Map View.

Click the Manage tab.

Double-click Broken Links on the left. The list of broken links or references present in the DITA map is displayed.

From the Filters panel you can order the list by links or by the names of used in references.

– When you order by Broken Link, the paths of the broken links are displayed in the first column and then the names of all references in which they have been used, are displayed in another column on separate rows. If the same broken link is used in multiple files, then they are displayed on one row and are shown as grouped or sub-rows. For example, the following screenshot shows three broken links in the first column and the reference in which they are used, TestMap.ditamap is displayed in the third column on three separate rows.
{width="800"}

– If you order by Used In column, you will view the transposed view wherein the names of the references in which the broken links have been used are listed in the first column while the broken links are listed in another column on the same row. For example, the following screenshot shows the reference (in which the broken link is used) TestMap.ditamap in the first column and the broken links are displayed in the third column on the same row.
{width="800"}

You can filter your broken links based on the File Type and Link Type. The list of broken links is displayed based on your selection in the drop-down. For example, you can choose to display only the content references in your DITA map, and a file shows only the content references used in it.

Depending on the type of references used in your map, File reference, Key reference, Content Reference, Content Key Reference, Image Reference, and Multimedia File Reference are listed in the Link Type drop-down, and DITA Topic or DITA Map are listed in the File Type dropdown.

You can also use the following filtering options to choose to display the following columns in the list:

– Broken Link (selected by default) The path of the broken link is specified in the DITA map.

– Link Type (selected by default) The type of the links. The available options are Content Key Reference, Content Reference, DITA Topic, File Reference, Image Reference, Key reference, and Multimedia File Reference.

– Used In (selected by default) The references in which the broken link has been used. You can click the reference to view it in author mode.

– File Type (selected by default) The type of reference – DITA Map or DITA Topic.
Click Refresh to get a fresh list of broken links and view any change in your map file or if any broken link within your DITA map is updated.

You can click on the Fix link icon ( ) to fix the broken link.

note note
NOTE
Hover over the broken link path under the Broken Link column to view the Fix link ( ) icon.

You can fix a link in both views- when you have ordered by Broken Links or by Used In.

You need to update the required reference details in the Update Link dialog. The details required in Update Link dialog would depend on the type of reference.
Once you fix a link, it is not displayed under the list of broken links. Instead, you can view it under the Topic List or Metadata.

Click Download CSV to download the current snapshot of the broken links in the DITA map. The CSV contains the selected columns and the broken links filtered in the Broken Links view. You can then open and view this CSV file in any CSV editor.