Calyx RIM Administration

TocType

Class Name:
com::liquent::insight::manager::publisher::data::specialsheets::TocType
Field Name Field Type Matching UI Field Req (Y/N) Description Acceptable Values Default Value
bookmark long Bookmark Handling N Indicates whether or not the entries from this TOC will be used to create the bookmarks in the Leaf, Volume, or SingleFile output file containing this TOC:
  • File Bookmarks Only - Do not use the entries from this TOC to create output file bookmarks.
  • All TOC Bookmarks - Use all of the entries from this TOC to create output file bookmarks.
  • FILE
  • ALL
ALL
changeReasonComment string N This field is not used for import.
changeReasonTypeId long N This field is not used for import.
definitionFileReferenceName string TOC Definition File Y A link to the document to use to define the Table of Contents. Example:

//root/folder/file

destinationEntryText string Right Column Entry Text Y Defines the text to appear on the right side of the output TOC, typically a variable.
destinationHyperlinkStyle string N This field is not used for import.
elementType long N This field is not used for import.
extractionExcludeText string Exclude All Bookmarks with the Text N Defines the bookmarks to exclude based on name, and allows for tables and figures to be excluded. Words separated by ; are treated as separate entries.
extractionIncludeText string Include Only Bookmarks with the Text N Defines the bookmarks to include based on name, and allows tables and figures to be included. Words separated by ; are treated as separate entries.
extractLevels long Including Bookmarks up to Level N Defines how many levels of Bookmarks from the starting point of the TOC to include in the output TOC. Must be within the Build TOCs to level range. Number from 1 to 20. 1
id long Y The unique TocType ID represented by a numerical value. This field is used to link classes within Assembly XML. This value will be used to populate corresponding fields in child classes. This ID will be replaced by the database ID in the imported assembly.
includeInPageCountFlag string Include in Page Numbering Y Defines if the TOC pages should be included in the overall page count.
  • Y
  • N
leaderText string Leader Y Defines the leader to use between the text and the right column entry text.
  • USETEMPLATE - Use Template;
  • SPACE - Space " ";
  • DASH - Dash "---";
  • DOT - Dot "...";
  • UNDERLINE - Underline "___".
name string Name Y A unique name for the Table of Contents. Must be unique within Assembly XML.
publishingSettingsLibraryId long Y The value of the ID field of the PublishingSettingsLibrary class. Example:

370515

sourceEntryText string Left Column Entry Text** N Defines the text to appear on the left side of the output TOC, typically either blank or a variable.
tocLevels long Build TOCs to Level N Defines how many levels from the starting point of the TOC to include in the output TOC. Number from 1 to 20. 3
typeCaption string Header N The header that will replace the word header within the TOC Definition File.