You are here: Glossary
Close
Doc-O-Matic 10
Glossary
The code that identifies preformatted text in HTML. Text enclosed in <pre> tags is usually rendered without removing white spaces, with a fixed-pitch font, without automatic word wrap.
Doc-O-Matic features that automatically generate content for documentation and automate documentation tasks.
A Doc-O-Matic feature that automatically creates folder topics for symbol types. Folder topics are symbol topics.
A file that Doc-O-Matic uses to store comments and topic text. DTX files are also called Topic Files.
The code that identifies headings in HTML. For example, <h1>This is a heading on the first level</h1>.
A comment style that is processed by the Java compiler.
The writer of a PDF document who's name appears in the PDF summary (a document property of a PDF document).
In Doc-O-Matic a view that presents option pages in a hierarchical tree.
Doc-O-Matic feature that automates the process of creating and saving new topics.
A comment style that is processed by the C# and VB.NET compiler in the .NET framework.
In Doc-O-Matic section that can be used more than once in each topic and named individually.
In Doc-O-Matic topics that are shown for another topic in the output.
A Doc-O-Matic feature that automatically creates links from words or symbol names to topics the topic IDs of which are the same as the words or symbol names or can be associated with them.
A Doc-O-Matic feature that automatically creates Summary sections from the first sentence of a topic.
A Doc-O-Matic feature that inserts automatically created text for undocumented symbols and all topics.
In Doc-O-Matic sections that Doc-O-Matic includes in the output to present automatically generated content such as class hierarchies, declaration syntax and navigation overviews
In Doc-O-Matic automatically created sections that show the implementation source of files and functions.
A Doc-O-Matic feature that ignores marked parts in the source code.
A selective compilation based on whether some condition is true or false.
In Doc-O-Matic specifications for the output of a documentation project.
An automatically created sections that shows a link to the file, the namespace and the modul a class is contained in. Optionally this section can be added to member topics.
Grouping level for topics.
In Doc-O-Matic automatically generated link that the user can use to copy the source code to the clipboard.
A section that is used in Doc-O-Matic for text at the beginning of a topic that does not start with section starters.
A file that contains all section names of your project and all words that Doc-O-Matic automatically inserts in the generated output.
Topics that do not contain text that is exported to the output.
In Doc-O-Matic sections that can be shown or hidden by clicking + next to the section heading.
In Doc-O-Matic the export state determines whether or not a topic appears in the created Help. The export state of topics can be set on a per topic basis or a type basis.
A Doc-O-Matic feature that ensures that only topics with a matching version number are exported.
A Doc-O-Matic feature that sets the default visibility of members to published if they are derived from certain base classes.
The settings that are used when the user does not specify an alternative.
A set of characters added to a filename that serves to extend or clarify its meaning or to identify a file as a member of a category.
In Doc-O-Matic short pieces of information attached to a topic.
A Doc-O-Matic feature that ensures that documents using non-standard PDF fonts can be viewed on all machines.
In Doc-O-Matic a way of presenting values and their description one beneath the other.
In Doc-O-Matic a set of design elements that provide a look for your documentation.
A file of a programming language that Doc-O-Matic does not understand natively and interprets as DTX file. Comment styles must be specified and topic identifiers must be inserted manually for each symbol. For example, VB6, Ada and SQL files are generic source files.
A topic that is not associated with a source code symbol.
Folders for global symbols in source files.
In Doc-O-Matic lines in source comments that are removed from the topic text.
In Doc-O-Matic folders in which images have to be stored so that they can be included in the output.
Doc-O-Matic considers a symbol an "implementation detail" if either of the following is true:
A statement within a source-code file that causes another source-code file to be read in at that spot.
Images that display information about symbol attributes or symbol types in symbol overviews.
A Doc-O-Matic feature that automatically copies descriptions from inherited symbols.
The combining of an Help system with the Help system of an IDE.
A file that Doc-O-Matic interprets as DTX file when you add the file to your project. For example, generic source files are interpreted files. Plain text and .html files are interpreted files if you do not convert them into .dtx files.
In Doc-O-Matic automatically created subsections of navigation sections that show legend icons and their description.
In Doc-O-Matic automatically created tables that shows legend icons and their description in the Legend sub sections of navigation sections.
An automatically generated section that shows links to subpages for Topic Navigation and Additional Information, Body Source Code and See Also Lists type sections.
Folders for parts of classes such as methods, data members and enumerations.
In Doc-O-Matic the listing of members of structs, records, units and enums in the Members section.
Automatically created page that lists all members in a class.
A Doc-O-Matic feature to divide large projects into smaller parts.
A context for identifiers. C++, Java, C#, VB.NET and in Delphi 8 and later provide support for namespaces.
A file of a programming language that Doc-O-Matic parses and understands natively. Doc-O-Matic detects and sorts symbols in these files. For example Delphi, C, C++, C#, VB.NET, Java and ASPX files are native language source files.
In Doc-O-Matic automatically created overviews that show symbols and short descriptions in the Navigation section.
In Doc-O-Matic automatically added sections that include overviews of symbols and topics and links such as links to the parent topic.
Folders for overloaded functions. The overloaded functions appear in a table in the Overloaded List section.
Functions with the same name. The functions are distinguished by their parameter types, return value types or both.
A character that separates a parameter name or a return value and its description.
To break source code into smaller chunks so that source code symbols can be sorted and comments extracted.
A text file.
In Doc-O-Matic sections that are available in the Doc-O-Matic installation.
A file containing all topic IDs of a Doc-O-Matic project as link targets for HTML Help systems and PDF.
A name for your Doc-O-Matic project.
In Doc-O-Matic tags that are used to change the appearance of topics such as the title tag.
Characters that separate section text from section starters.
Characters that indicate that a new section starts in Doc-O-Matic
Topics that have a special meaning to Doc-O-Matic. Their topic ID starts with !!.
In Doc-O-Matic the root topic for all symbols in the symbol hierarchy.
The comment for a symbol in Doc-O-Matic.
In Doc-O-Matic sections that are displayed in a tab set, each section on one tab.
Characters that indicate the end of a comment block or a section. Doc-O-Matic automatically removes these characters in the output.
A Doc-O-Matic feature that allows you to apply character formatting, add images, add prefixes and exclude parts of topic text in each configuration separately by labeling parts of topic text.
In Doc-O-Matic links that appear below the topic title on topic pages and on other pages.
Any nonreducible textual element in data that is being parsed.
A unique string of characters that identifies a topic in Doc-O-Matic. For symbol topics the fully qualified symbol name is used as topic ID.
A character used in Doc-O-Matic to identify a topic and to assign a topic to a specific symbol.
In Doc-O-Matic lines that are used to enhance the legibility of source comments.
Comment characters used in .NET programming languages that start with three slashes "///".
In Doc-O-Matic topics that the user marks as unfinished. Unfinished topics can be excluded from the output.
In Doc-O-Matic sections that the user defines in his project.
The version identifier of your documentation. The version check feature uses the version number to prevent the export of outdated topics in your documentation.
Folders for parts of classes sorted according to keywords such as public, protected and private.
Keywords such as public, protected and private.
The page that appears when the HTML Help system is opened.
Copyright © 2000-2019 toolsfactory software inc. All rights reserved.