You are here: Interface Components > View Tab
Other Interface Components
Doc-O-Matic Tools
Messages
> Content Manager
Close
Doc-O-Matic 10
Content Manager

In the Content Manager all topics and symbols in a Doc-O-Matic project appear in a hierarchy. In this view you can create new documentation for symbols, for symbol folders and new topics. You can structure your hierarchies by creating folders and by sorting and moving topics. In addition, you can determine which topics are exported to which configuration and appear in the table of contents

The command list shows how you can change your documentation in the Content Manager

The Content Manager consist of the following major parts:

  • The topic hierarchy that displays all symbols, topics, special topics, templates and snippets. Next to symbol and topic names the following icons and check boxes are displayed:
    • Symbol and topic type icons.
    • Documentation status icons. All documentation states are listed in the Export and Documentation State Overview.
    • Export state check box. All export states are listed in the Export and Documentation State Overview.
  • Columns, that display certain properties of each topic. All columns are listed in the Columns Overview.
  • Manage tab. All buttons and commands are listed in the Command Overview.
  • Shortcut menu
  • Source code view displaying the source file of symbols and topics.
  • Filter
  1. In the hierarchy select the symbol or topic that you do not want to export.
  2. Click the Export state check box next to the symbol or topic.
  • On the shortcut menu point to Columns.
  • Select or deselect the column that you want to display or hide.

The following table describes ribbon button, commands on the right-click menu, and shortcuts:

Group
Icon
Command
Shortcut
Description
Navigate
Back
Helps you navigating through your documentation. Selects the topic that was previously selected.
Navigate
Forward
After using the back button, clicking the forward button, selects the next topic in the history
Navigate
Find Topic
Finds topics in the hierarchy.
Navigate
Filter
Shows or hides the Filter.
Navigate
>
Open > Open Source
ENTER
Opens the source of the selected symbol using the registered application or the application set in the Application Options.
Navigate
Open Implementation
CTRL+ENTER
Opens the implementation source of the selected symbol using the registered application or the application set in the Application Options.
Show Source File in Windows Explorer
Show the file, that contains the selected symbol, in the Windows Explorer.
Navigate
Open External Topic > HTML File
Opens the HTML source file for the external topic in your source editor.
Navigate
Open External Topic > PDF File
Opens the PDF source file for the external topic in your source editor.
Navigate
Display > Don't Show Source
Hides the source code view.
Navigate
Display > Show Declaration Source
The source code view shows the declaration source of the symbol (regenerated by Doc-O-Matic).
Navigate
Display > Show Body Source
The source code view shows the implementation code of functions extracted from your sources
Navigate
Display > Show Both
The source code view shows the implementation code and the declaration code.
Navigate
Display > Show Source File
The source code view shows the whole source file.
Display > Option
Opens the Content Manager Options Application Options page.
Copy Topic ID to Clipboard
Copies the topic ID of the current topic to the clipboard. All topic IDs of the project are listed in the Topic Picker of the Topic Editor.
Create Content
F4
Creates a new topic for the current symbol or topic according to the QuickDoc settings for the topic type.
Create Content
>
QuickDoc Settings
Lets you change QuickDoc Settings.
Create Content
Document
CTRL+F4
Creates a new topic for the current symbol if it has no documentation.
Create Content
New Topic
Creates a new topic.
Create Content
New Snippet
Creates a new snippet.
Design
Contents Design > Design
Turns on the Contents Design mode.
Design
>
Contents Design > TOC Lock
Locks hierarchy information.
Design
>
Contents Design > Full Lock
Locks hierarchy information and state check boxes.
Design
>
Contents Design >Apply Status Globally
Applies status changes such as export states, TOC appearance and joined subtopics to all configurations.
Get TOC from Topic
Extracts TOC information formatted as lists from the selected topic.
Design
Contents Design > Move Left
SHIFT+CTRL+LEFT ARROW
Moves the selected topics one level up in the hierarchy.
Design
Contents Design > Move Right
SHIFT+CTRL+RIGHT ARROW
Moves the selected topics one level down in the hierarchy.
Design
Contents Design > Move Up
SHIFT+CTRL+UP ARROW
Moves the selected topics one place up in the topic order.
Design
Contents Design > Move Down
SHIFT+CTRL+DOWN ARROW
Moves the selected topics one place down in the topic order.
Design
>
Contents Design > Sort by Title Ascending
Sorts the subtopics of the selected topic by topic titles in ascending order.
Design
>
Contents Design > Sort by Title Descending
Sorts the subtopics of the selected topic by topic titles in descending order.
Design
Contents Design > Custom Sort
Lets you sort topics.
Export
Modify > Select Next Export State
CTRL+E
Cycles the export state to the next value. The change is indicated by a different appearance of the check box in front of the topic.
Export
Modify > Set Export State to Predefined
Sets export state of all selected topics to the value set in the Settings.
Export
Modify > Set Export State to Exported
Sets export states of all selected topics to Exported.
Export
Modify > Set Export State to Not Exported
Sets export states of all selected topics to Not Exported.
Table of Contents
Modify > Show in Table of Contents
CTRL+T
Cycles the appearance in the table of contents to the next value. The change is indicated by a mark in the check box In TOC.
Table of Contents
Modify > Folder Only
Cycles the property In TOC Only to the next value. If a topic is a only a Folder it only appears in the TOC in the Help systems and as heading in PDF and RTF.
Table of Contents
Join Sub-Topics
Indicates that the subtopics are joined on the page of the current topic. This feature applies only for HTML Help systems. Select the Join Sub-Topics check box, to show all subtopics of the topic on the page of this topic.
Folders
Folders > Folders in Modules
Groups symbols in modules in folders.
Folders
Folders > Folders in Namespaces
Groups symbols in namespaces in folders.
Folders
>
Folders > No Member Folders
Groups members of classes as subtopics of the class.
Folders
>
Folders > Member Type Folders
Groups members of classes in folders such as methods and properties.
Folders
>
Folders > Extended Member Type Folders
Groups methods in subfolder such as constructors and destructors.
Folders
>
Folders > Member Visibility Folders
Groups members of classes according to their visibility such as private and public.
Folders
>
Folders > Overloaded Function Folders
Adds folders for overloaded functions.
Folders
>
Folders > Member Overview Topics
Adds member overview topics following the class topic.
Folders
Folders > More Options
Opens the Advanced Symbol Hierarchy Options dialog box. In this dialog you can sort symbols and move the constructors and destructors to the top level of the class.
Columns > In TOC
Indicates that the topic appears in the table of contents. Select the In TOC check box to show the topic in the table of contents.
Columns > Folder
Indicates that the topic appears as Folder or as topic. Select the Folder check box to show the topic only as entry in the TOC.
Columns > Topic ID
Shows the topic ID of a topic.
Columns > Filename
Shows the name of the file in which the topic is stored.
Columns > Path
Shows the path to the file where the topic is stored.
Columns > Alias, Combine, Copy
Indicates that the topic uses the topic text of another topic (only if you use the Combine and Alias property or combine and alias tag not if you use the Combine With or Alias of property or combinewith and aliasof tag).
Columns > Join Sub-Topics
Indicates that the subtopics are joined on the page of the current topic. This feature applies only for HTML Help systems. Select the Join Sub-Topics check box, to show all subtopics of the topic on the page of this topic.
Columns > Show All
Shows all columns in the Content Manager.
Columns > Hide All
Hides all columns in the Content Manager.
Columns > Reset
Resets the columns to the factory default.

Each topic can have one of the following export states:

Icon
Meaning
Exported
Not exported
Exported due to default setting
Not exported due to default setting
Not exported due to restricted export of group topics

Each symbol can have one of the following documentation states.

Icon
Meaning
Symbol or topic is documented.
Symbol uses documentation of a member in an ancestor class.
Symbol is undocumented.
Symbol uses the documentation of another topic via alias, combine or copy.
Symbol or topic is unfinished.

Namespace Handling

Copyright © 2000-2020 toolsfactory software inc. All rights reserved.