comet.constants ******************************************************************************* .. py:module:: comet.constants The constants module contains convenience constants for making scripts more readable. Callers can use the constant names instead of their represented values and check return values against them. .. _constants: Constants =============================================================================== .. _constants.HostEnvironments: Host environments ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: kHostInDesign .. autodata:: kHostInDesignServer .. autodata:: kHostCometPDF .. autodata:: kHostIllustrator .. pprint:: constants.kHosts .. _constants.Designate: Designate ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: kDesignateUndef .. autodata:: kDesignateCursor .. autodata:: kDesignateSelected .. autodata:: kDesignateDocument .. autodata:: kDesignateVisibleLayers .. autodata:: kDesignateActiveLayer .. pprint:: constants.kDesignate .. _constants.Contexts: Contexts ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: kContextUnknown .. autodata:: kContextPlaceHolderLoad .. autodata:: kContextPlaceHolderSync .. autodata:: kContextPlaceHolderStore .. autodata:: kContextPlaceHolderBuild .. autodata:: kContextPlaceHolderBuildPost .. autodata:: kContextPlaceHolderPrefix .. autodata:: kContextPlaceHolderPostfix .. autodata:: kContextPanelAction .. autodata:: kContextLayoutRule .. autodata:: kContextLayoutRuleCondition .. autodata:: kContextLayoutRuleDynamicList .. autodata:: kContextProductBuildPre .. autodata:: kContextBuildSupport .. autodata:: kContextFuncVarDynamicDef .. autodata:: kContextFuncVarAvailValues .. autodata:: kContextBatch .. autodata:: kContextDoubleClickProductPool .. autodata:: kContextDoubleClickPublications .. autodata:: kContextDoubleClickPreviews .. autodata:: kContextExtendScript .. autodata:: kContextAllowLogin .. autodata:: kContextAfterLogin .. autodata:: kContextXMLScript .. autodata:: kContextCometTestPreScript .. autodata:: kContextCometTestScript .. autodata:: kContextCometTestPostScript .. autodata:: kContextPlaceHolderStringCompare .. autodata:: kContextDocWatch .. autodata:: kContextURLLinkDestFolder .. autodata:: kContextURLLinkHeaderData .. autodata:: kContextURLDropActionID .. autodata:: kContextURLDrop .. autodata:: kContextAlternativeTemplate .. autodata:: kContextTableModuleInsertRow .. autodata:: kContextTableModuleOmitRow .. autodata:: kContextTableModuleInsertColumn .. autodata:: kContextTableModuleOmitColumn .. autodata:: kContextTableModuleLayoutRule .. autodata:: kContextTableModuleCellID .. autodata:: kContextPublicationCheckout .. autodata:: kContextPublicationAfterSave .. autodata:: kContextPublicationBeforeClose .. autodata:: kContextPublicationStatus .. autodata:: kContextPublicationCheckin .. autodata:: kContextPublicationAfterClose .. autodata:: kContextPublicationRevert .. autodata:: kContextPublicationAfterCheckout .. autodata:: kContextNoteParastyle .. autodata:: kContextNoteTargetLayer .. autodata:: kContextPODSpecialCases .. autodata:: kContextProductPoolEntries .. autodata:: kContextProductPoolSFDefaultValue .. autodata:: kContextToDoListCustomTask .. autodata:: kContextPreviewsEntries .. autodata:: kContextPreviewsLink .. autodata:: kContextPageTemplateAfterApply .. autodata:: kContextServerInterface .. autodata:: kContextStampAction .. autodata:: kContextExcelQueryFunction .. pprint:: constants.kContexts .. _constants.actionTypes: Action types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: kActionTypeLoad .. autodata:: kActionTypeStore .. autodata:: kActionTypeSync .. autodata:: kActionTypeBuild .. pprint:: constants.kActionTypes .. _constants.Indices: Indices ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: kStart .. autodata:: kEnd .. autodata:: kTotalEnd .. pprint:: constants.kIndices .. _constants.Sides: Sides ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: kSideLeft .. autodata:: kSideTop .. autodata:: kSideRight .. autodata:: kSideBottom .. autodata:: kSideAll .. pprint:: constants.kSides .. _constants.refPoints: Reference Points ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: kRefPointTopLeft .. autodata:: kRefPointTopCenter .. autodata:: kRefPointTopRight .. autodata:: kRefPointLeftCenter .. autodata:: kRefPointCenter .. autodata:: kRefPointRightCenter .. autodata:: kRefPointBottomLeft .. autodata:: kRefPointBottomCenter .. autodata:: kRefPointBottomRight .. pprint:: constants.kReferencePoints .. _constants.ImagePlacement: Image placement ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: kPlaceTopLeft .. autodata:: kPlaceTopCenter .. autodata:: kPlaceTopRight .. autodata:: kPlaceMiddleLeft .. autodata:: kPlaceCentered .. autodata:: kPlaceMiddleRight .. autodata:: kPlaceBottomLeft .. autodata:: kPlaceBottomCenter .. autodata:: kPlaceBottomRight .. autodata:: kPlaceLikeExisting .. autodata:: kPlaceWithFittingOptions .. autodata:: kPlaceRemoveIfNoExist .. _constants.TextFormats: Text formats ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Format specifications with the identifier *Plus* in the name additionally replace all automatic page numbers, paragraph names and footnote markers by their current values. .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: kExportPlain .. autodata:: kExportTagged .. autodata:: kExportTT .. autodata:: kExportW2 .. autodata:: kExportUnitext .. autodata:: kExportXUnitext .. autodata:: kExportPlainWithTables .. autodata:: kExportUnitextWithTables .. autodata:: kExportXUnitextWithTables .. autodata:: kExportPlainNoTypografics .. autodata:: kExportPlainWithTablesNoTypografics .. autodata:: kExportHTML .. autodata:: kExportHTMLWithTables .. autodata:: kExportRTF .. autodata:: kExportXMLUnitext .. autodata:: kExportXMLUnitextWithTables .. autodata:: kExportHTMLWithStyles .. autodata:: kExportW2Raw .. autodata:: kExportPlusPlain .. autodata:: kExportPlusUnitext .. autodata:: kExportPlusXUnitext .. autodata:: kExportPlusXMLUnitext .. autodata:: kExportPlusPlainNoTypografics .. autodata:: kExportPlusHTML .. autodata:: kExportW2ML .. autodata:: kExportHTMLWithStylesAndCSS .. pprint:: constants.kTextFormats .. _constants.PageItemTypes: Pageitem types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: kPageItemTypeUnknown .. autodata:: kPageItemTypeText .. autodata:: kPageItemTypeGraphic .. autodata:: kPageItemTypeGroup .. autodata:: kPageItemTypeLegacyText .. autodata:: kPageItemTypeGraph .. autodata:: kPageItemTypeGuide .. autodata:: kPageItemTypeQRCode .. autodata:: kPageItemTypeTextOnPath .. pprint:: constants.kPageItemTypes .. _constants.ListTypes: List types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: kListTypeNone .. autodata:: kListTypeBullet .. autodata:: kListTypeNumbered .. pprint:: constants.kListTypes .. _constants.BasicTypes: Basic types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: kInt .. autodata:: kFloat .. autodata:: kString .. pprint:: constants.kBasicTypes .. _constants.LayoutRuleSituations: Layout rule situations ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: kLayoutRuleSituationCreate .. autodata:: kLayoutRuleSituationLoad .. autodata:: kLayoutRuleSituationReorganize .. autodata:: kLayoutRuleSituationGeometryChange .. autodata:: kLayoutRuleSituationBuild .. autodata:: kLayoutRuleSituationAll .. pprint:: constants.kLayoutRuleSituations .. _constants.StyleTypes: Style types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: kStyleTypeObject .. autodata:: kStyleTypeTable .. autodata:: kStyleTypeCell .. autodata:: kStyleTypeParagraph .. autodata:: kStyleTypeCharacter .. pprint:: constants.kStyleTypes .. _constants.PageTypes: Page types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: kPageTypeUnknown .. autodata:: kPageTypeLeft .. autodata:: kPageTypeUnisex .. autodata:: kPageTypeRight .. pprint:: constants.kPageTypes .. _constants.PanelIDs: Panel IDs ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: kPanelUndef .. autodata:: kPanelProducts .. autodata:: kPanelPreviews .. autodata:: kPanelPageitems .. autodata:: kPanelPublications .. autodata:: kPanelToDoList .. autodata:: kPanelPlaceholder .. autodata:: kPanelPlaceholderValues .. autodata:: kPanelPageitemsBehavior .. autodata:: kPanelCometAdmin .. autodata:: kPanelLayoutRules .. autodata:: kPanelFrameTags .. autodata:: kPanelAreaBuild .. autodata:: kPanelPriintAdjust .. autodata:: kPanelPriintAdjustList .. autodata:: kPanelPlaceholderValuesInfo .. autodata:: kPanelFrontRow .. autodata:: kPanelNotes .. autodata:: kPanelPreviewDetails .. autodata:: kPanelProductsOfDocument .. autodata:: kPanelPublicationInfo .. autodata:: kPanelSettings .. autodata:: kPanelCometTests .. autodata:: kPanelURLLink .. autodata:: kPanelDocumentAttributes .. autodata:: kPanelTables .. autodata:: kPanelTableStyles .. autodata:: kPanelCellStyles .. autodata:: kPanelBatch .. pprint:: constants.kPanelIDs .. _constants.SyncStates: Sync states ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kSyncStateUndefined .. autodata:: kSyncStateOverridden .. autodata:: kSyncStateLoadError .. autodata:: kSyncStateNoMarker .. autodata:: kSyncStateNotFound .. autodata:: kSyncStateChanged .. autodata:: kSyncStateRemoved .. autodata:: kSyncStateOk .. autodata:: kSyncStateNotUnique .. pprint:: constants.kSyncStates .. _constants.BuildSituations: Build situations ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kSituationCheckSizeBefore .. autodata:: kSituationCheckSizeAfter .. autodata:: kSituationBeforeCreateContinue .. autodata:: kSituationAfterCreateContinue .. autodata:: kSituationProductPlaced .. autodata:: kSituationUnsolvableOversets .. autodata:: kSituationAfterBuild .. autodata:: kSituationProductFinished .. pprint:: constants.kBuildSituations .. _constants.LinkTypes: Link types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kLinkTypeText .. autodata:: kLinkTypeFrame .. pprint:: constants.kLinkTypes .. _constants.PlaceHolderSlots: Placeholder slots ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Placeholder slots are used in conjunction with :py:func:`.placeholder.getTagValue` and :py:func:`.placeholder.setTagValue` .. table:: :class: comet alternating-rows +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Identifier (str) | Type | Notes | +========================================================+=============================+======================================================================================================================================================================================+ | Placeholder, Platzhalter | int | The associated placeholder definition should exist and be of the correct type. | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ID | | Object-ID, comprised of three numbers and a string. | +--------------------------------------------------------+ + + | ID2 | | | +--------------------------------------------------------+ + + | ID3 | | | +--------------------------------------------------------+-----------------------------+ + | STRINGID | str | | +--------------------------------------------------------+ + + | STRINGID1 | | | +--------------------------------------------------------+ + + | STRINGID2 | | | +--------------------------------------------------------+ + + | STRINGID3 | | | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Class | int | Class ID of the object, which can be linked with this placeholder. | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Select | int | IDs of the actions which can be executed from the placeholders. | +--------------------------------------------------------+ + + | Sync | | | +--------------------------------------------------------+ + + | Update | | | +--------------------------------------------------------+ + + | Lov | | | +--------------------------------------------------------+ + + | ObjectNameID | | | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | RelatedTo | | Type of the placeholder | | | | | | | | | **1** : text | | | | | **2** : textframe | | | | | **3** : imageframe | | | | | **4** : xmlelement | | | | | **5** : Document action | | | | | **6** : multiframe (Repeated Element) | | | | | **7** : multitext (Repeated Text) | | | | | **8** : Serial letter placeholder (Plugin Serial letter) | | | | | **-2000** : Excel-supported table (Pluginin XCell) | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Color | | ID of a color. The color is used to present the placeholder in the placeholder panel and in the document. | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | SyncStateInvisible | | Can the placeholder display a status (see get_sync) or not? | | | | | | | | | **0** : Do not show | | | | | **1** : Status can be shown | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | LoadConstraint | | Unused | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Format | | For repeating elements the ID of the action is specified here which is to be executed if the elements are to be set up | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Group | | Group ID of a placeholder frame. The group ID is allocated for Document build, so that frames are located on the same grid locations even though these are not grouped in InDesign®. | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | str | For Excel-supported tables contains the path of the associated Excel table. Relative paths are determined depending on the document. | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Table | | :priint-important:`Check sum, do NOT change!` | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Created | | Date information in the format YYYYMMDDHHMMSS | +--------------------------------------------------------+ + | | Modified | | | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Grid | int | Specification of the document build. The value of these fields can be set in the plugin Build rules. | +--------------------------------------------------------+ + + | GridElement | | You can use Pre- and PostRule to create new pages : | +--------------------------------------------------------+ + + | PreRule | | | **-1** : New page | +--------------------------------------------------------+ + | **-2** : New left page + | PostRule | | | **-3** : New right page | +--------------------------------------------------------+-----------------------------+ + | PreRuleParams | str | | +--------------------------------------------------------+ + + | PostRuleParams | | | +--------------------------------------------------------+ + + | AdParams | | | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Infos1 | | Additional information to the placeholder. The specifications are limited to 4000 characters. If the specification is longer than 4000 characters, the empty string is used. | +--------------------------------------------------------+ + + | Infos1 | | | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | SequenceNr | int | | Sequence in which the frames of a template are loaded during insertion. If no sequence number is specified (0), the frames are loaded in a default order. | | | | | The specification only has a meaning when inserting templates that consist of several frames. The same sequence is applied after insertion (PostScript).. | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | PostScript | | | After inserting the frame using a template, a post-processing procedure can be executed. | | | | | The ID specifies the number of the action to be executed. The actions frame postscripts must have the ClassID 16. | | | | | If a template consists of several frames, the sequence of execution can be specified via SequenceNr. | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ShowPostScript | | Should the sequence number and postscript ID be shown in the document? The display only occurs if placeholders are also displayed. | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | TextflowType | | How to use the frame in case of a text flow? | | | | | | | | | **0** : Insert text content | | | | | **1** : Insert as inline | | | | | **2** : Do not insert | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | TextflowOnly | | If the frame is part of a template, this value controls how to deal with the frame in normal (drag'n drop, build products, ...) template inserts. | | | | | | | | | **0** : Take this frame to the document | | | | | **1** : Do not insert this frame into the document unless a text flow build is running. | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | TextflowUsage | | Internal, :priint-important:`do not change!` | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | AdaptSequ | | Internal, :priint-important:`do not change!` | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | AdaptGroup | str | Internal, :priint-important:`do not change!` | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | PageitemID | int | ID of the template which built this frame. | | | | | | | | Template ID vs. product template ID | | | | Imagine a product is built with template 100 and gets frames 1, 2, 3. frame 2 creates two more frames (4 and 5) with document::place_items and template 300. | | | | | | | | Until v3.2.3 the frames have the following PageitemID : | | | | | | | | - Frame 1 : 100 | | | | - frame 2 : 100 | | | | - frame 3 : 100 | | | | - Frame 4 : **300** | | | | - Frame 5 : **300** | | | | | | | | If the document is now reorganized, it can no longer be clearly determined with which template the product was built and the reorganization | | | | may now use template 300 for the product instead of the desired template 100. | | | | From v3.3 PageitemID therefore contains the unique product template ID for all frames of the product, in this case 100 : | | | | | | | | - Frame 1 : 100 | | | | - Frame 2 : 100 | | | | - Frame 3 : 100 | | | | - Frame 4 : **100** | | | | - Frame 5 : **100** | | | | | | | | With the value *PageitemDirectID* you can get the ID of the template with which a frame was inserted. | | | | | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | OrgPageitemID | | A product is to be built with a certain template. This template has a TemplateID script and instead of the passed template another template is used. | | | | In OrgPageitemID the original templateID is still retained. | | | | | | | | | e.g. | | | | | Product with template 100 | | | | | TemplateID script of template 100 calculates as ID 110 | | | | | :priint-important:`OrgPageitemID` = 100 | | | | | :priint-important:`Pageitem` = 110 | | | | | :priint-important:`PageitemDirectID` = 110 | | | | | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | SmartInfo | str | | Information about the template behavior. The string is structured as described in the following table. You can change the content of the SmartInfo. | | | | | However, make sure that the string remains syntactically correct according to the following table. The individual fields are separated by spaces. | | | | | **Incorrect entries can lead to errors in the program and document!** | | | | | :priint-important:`The string can be supplemented by Werk II with further data. Do not add your own data here! You can store your own data in the fields Infos1 and Infos2.` | | | | | See :py:meth:`.CFrame.getSmartItemData` and :py:meth:`.CFrame.setSmartItemData` for more information.` | | | | | | | | +----------------------+-----------------------------------------------------------------+ | | | | | Type | Description | | | | | +======================+=================================================================+ | | | | | str | Frame label, :priint-important:`one character only` | | | | | +----------------------+-----------------------------------------------------------------+ | | | | | int [0-23] | Color-ID | | | | | +----------------------+-----------------------------------------------------------------+ | | | | | int [0-6] | Page type of the frame | | | | | | | | | | | | | | - **0** : undefined | | | | | | | - **1** : left | | | | | | | - **2** : right | | | | | | | - **3** : continuation left | | | | | | | - **4** : continuation right | | | | | | | - **5** : spread | | | | | | | - **6** : continuation spread | | | | | | | | | | | | +----------------------+-----------------------------------------------------------------+ | | | | | int [0-3] | Continuation type | | | | | | | | | | | | | | - **0** : normal | | | | | | | - **1** : continue frame (triangle) | | | | | | | - **2** : repetition (unused) | | | | | | | - **3** : continue frame with fixed height (empty triangle) | | | | | | | | | | | | +----------------------+-----------------------------------------------------------------+ | | | | | str | Internal ID. :priint-important:`Do not change!` | | | | | +----------------------+-----------------------------------------------------------------+ | | | | | int | Flags (bit field) | | | | | | | | | | | | | | - **0x00000001** : Load frame place holders | | | | | | | - **0x00000002** : Load text place holders | | | | | +----------------------+-----------------------------------------------------------------+ | | | | | int [0-3] | Area type | | | | | | | | | | | | | | - **0** : Bounding Box | | | | | | | - **1** : Path (Star) | | | | | | | - **2** : Path with holes (empty star) | | | | | | | - **3** : ignore (Minus) | | | | | | | | | | | | +----------------------+-----------------------------------------------------------------+ | | | | | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ObjectNameID | int | ID of the action with which the object name can be calculated | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | BuiltByID | | ID of product which built this frame | +--------------------------------------------------------+ + + | BuiltByID2 | | | +--------------------------------------------------------+ + + | BuiltByID3 | | | +--------------------------------------------------------+-----------------------------+ + | BuiltByStringID | str | | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | BuildRemains | int | Number of elements that could not be inserted because the repeating frame is full | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Chapter | | **[unused]** Chapter id | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ChapterRule | | **[unused]** 0 : new left page, 1 : new page, 2 : new right page | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | HeightFromTemplate | str | Original height from the template. | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | OriginBBox | | Original bbox of frame from the template. Blank delimited string of four floats. | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Prefix | | Text to insert into the document before/behind the placeholder, if the placeholder is not empty | +--------------------------------------------------------+ + + | Postfix | | | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | PrefixIfEmpty | | Text to insert into the document before/behind the placeholder, if the placeholder is empty | +--------------------------------------------------------+ + + | PostfixIfEmpty | | | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Continue | int | Unique id of the continuing template the frame belongs to. | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | PageBreakID | | New chapter-ID. This ID is shown in left top corner of the Comet groups and is used for page breaks in document reorganizings. | | | | All products with the same (or an empty) chapter ID are containing to the same chapter. Every change of the chapter ID forces a page break. | | | | Page template and page type are read from *PageBreakTemplateID** and *PageBreakType*. | | | | Set the chapter ID in **all frames of a Comet group**. By default we use page UIDs as to be chapter IDs, but you may use any unique number here. | | | | Good candidates may be the Comet group ID or the UID of a frame of the list. | | | | | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | PageBreakTemplateID | | Page template applied to the new page. You may use same page template as in the previous chapter. | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | PageBreakType | | - **0** : new left page | | | | - **1** : new page | | | | - **2** : new right page | | | | | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | PageBreakLayers | str | Layout layers for the chapter. Include all layers into double quotas and use single blanks as delimiters. | | | | The given layers must not exist in the document. Use the following definitions for variable layers | | | | | | | | - *"ab++#--background"* : All layers behind the current | | | | - *"ab++#--except layerName"* : All layers except layerName | | | | - *"ab++#--behind layerName"* : All layers behind layerName | | | | | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | RepetitionParent | int | UID of repetition parent. If the frame was not created as a repetition child, the value is 0. | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | LayoutRules | str | String for defining the layout rules. | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | StaticLink | int | Static product link property of place holder | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | BuildUsage | | How should the frame be used in text flow builds? | | | | | | | | - **0** : Insert content | | | | - **1** : Insert frame as inline | | | | - **2** : Do not use | | | | | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | FunctionVariables | str | Function Variables | +--------------------------------------------------------+ +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | HashValues | | Fixed contents of the placeholder | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _constants.PublicationSelectors: Publication selectors ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Publication selectors are used in conjunction with the publication classes like :py:class:`.CPublication` and their functions like :py:meth:`.CPublication.getValue`. The following table indicates which selector can be used with the **getValue** function of each publication class. .. list-table:: :header-rows: 1 :class: comet alternating-rows :widths: 40 10 10 10 10 10 10 * - Selector - Data type - :py:class:`CPublication` - :py:class:`CPublicationType` - :py:class:`CParameter` - :py:class:`CPlanning` - :py:class:`CWorkflowStatus` * - .. autodata:: kPublicationID - :py:class:`int` - |check| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationID2 - :py:class:`int` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: kPublicationID3 - :py:class:`int` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: kPublicationStringID - :py:class:`str` - |check| - |check| - |check| - |x| - |check| * - .. autodata:: kPublicationInfo - :py:class:`str` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: kPublicationName - :py:class:`str` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: kPublicationLabel - :py:class:`str` - |check| - |check| - |check| - |check| - |check| * - .. autodata:: kPublicationType - :py:class:`.CParameter`: :py:class:`int` |br| else: :py:class:`str` - |check| - |x| - |check| - |x| - |check| * - .. autodata:: kPublicationStatus - :py:class:`str` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: kPublicationInfo1 - :py:class:`str` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: kPublicationInfo2 - :py:class:`str` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: kPublicationDomain - :py:class:`str` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: kPublicationPath - :py:class:`str` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: kPublicationURL - :py:class:`str` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: kPublicationCanOverrideURL - :py:class:`bool` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: kPublicationCanOverrideLocal - :py:class:`bool` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: kPublicationHasChildren - :py:class:`bool` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: kPublicationStatementID - :py:class:`int` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: kPublicationIconID - :py:class:`int` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: kPublicationValue1 - :py:class:`str` - |x| - |x| - |check| - |x| - |x| * - .. autodata:: kPublicationValue2 - :py:class:`str` - |x| - |x| - |check| - |x| - |x| * - .. autodata:: kPublicationValue3 - :py:class:`str` - |x| - |x| - |check| - |x| - |x| * - .. autodata:: kPublicationIdentifier - :py:class:`str` - |x| - |x| - |check| - |x| - |check| * - .. autodata:: kPublicationActionID - :py:class:`str` - |x| - |x| - |x| - |x| - |check| * - .. autodata:: kPublicationDocumentID - :py:class:`str` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: kPublicationFieldCount - :py:class:`int` - |x| - |x| - |check| - |x| - |x| * - .. autodata:: kPublicationBucketID - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationBucketRefs - :py:class:`list` [:py:class:`str`] - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationContextAssortment - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationContextCountry - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationContextLanguage - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationContextWell - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationContextMarket - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationContextTargetGroup - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationContextPublication - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationContextDocumentID - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationCordRefs - :py:class:`list` [:py:class:`str`] - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationCreatedBy - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationCreatedOn - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationDeleted - :py:class:`bool` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationDpTemplateID - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationEntityBucketID - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationEntityModelID - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationEntityPlanningID - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationImportID - :py:class:`int` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationKeyValueRefs - :py:class:`list` [:py:class:`str`] - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationChildren - :py:class:`list` [:py:class:`str`] - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationMediaAssetRefs - :py:class:`list` [:py:class:`str`] - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationMetaData - :py:class:`list` [:py:class:`str`] - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationOrigin - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationPageID - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationPageTemplateElementID - :py:class:`int` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationPageTemplateID - :py:class:`int` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationParentPlanningID - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationPriceRefs - :py:class:`list` [:py:class:`str`] - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationPrintTemplateID - :py:class:`int` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationSequence - :py:class:`int` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationTableDataRefs - :py:class:`list` [:py:class:`str`] - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationTextRefs - :py:class:`list` [:py:class:`str`] - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationTimestamp - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationUpdatedBy - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationUpdatedOn - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationUsePrintPageTemplate - :py:class:`bool` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationVersion - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationXPosBottomRight - :py:class:`float` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationXPosTopLeft - :py:class:`float` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationYPosBottomRight - :py:class:`float` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: kPublicationYPosTopLeft - :py:class:`float` - |x| - |x| - |x| - |check| - |x| .. _constants.DocCloseModes: Document close modes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Used with :py:meth:`.CDocument.close` .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kDocCloseProcess .. autodata:: kDocCloseSchedule .. autodata:: kDocCloseImmediate .. pprint:: constants.kDocCloseModes .. _constants.ColorModels: Color models ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kColorModelUnknown .. autodata:: kColorModelGray .. autodata:: kColorModelRGB .. autodata:: kColorModelCMYK .. autodata:: kColorModelLAB .. pprint:: constants.kColorModels .. _constants.LinkFirstSelectors: Link first selectors ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kLinkFirstLeftTop .. autodata:: kLinkFirstRightTop .. autodata:: kLinkFirstOuterTop .. autodata:: kLinkFirstInnerTop .. autodata:: kLinkFirstLeftBottom .. autodata:: kLinkFirstRightBottom .. autodata:: kLinkFirstOuterBottom .. autodata:: kLinkFirstInnerBottom .. pprint:: constants.kLinkFirstSelectors .. _constants.LinkSorting: Link sorting ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kLinkSortNo .. autodata:: kLinkSortColwise .. autodata:: kLinkSortRowwise .. autodata:: kLinkSortByZOrder .. pprint:: constants.kLinkSorting .. _constants.LineTypes: Line types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kLineTypeRow .. autodata:: kLineTypeColumn .. pprint:: constants.kLineTypes .. _constants.RowTypes: Row types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kRowTypeAll .. autodata:: kRowTypeHeader .. autodata:: kRowTypeBody .. autodata:: kRowTypeFooter .. pprint:: constants.kRowTypes .. _constants.StrokeSelectors: Stroke selectors ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: constants.kStrokeSideNone .. autodata:: constants.kStrokeSideLeft .. autodata:: constants.kStrokeSideTop .. autodata:: constants.kStrokeSideRight .. autodata:: constants.kStrokeSideBottom .. autodata:: constants.kStrokeSideInteriorRows .. autodata:: constants.kStrokeSideInteriorColumns .. autodata:: constants.kStrokeSideAll .. pprint:: constants.kStrokeSelectors .. _constants.StrokeAttributes: Stroke attributes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: constants.kStrokeAttrNone .. autodata:: constants.kStrokeAttrWeight .. autodata:: constants.kStrokeAttrColor .. autodata:: constants.kStrokeAttrStrokeType .. autodata:: constants.kStrokeAttrTint .. autodata:: constants.kStrokeAttrOverprint .. autodata:: constants.kStrokeAttrGapColor .. autodata:: constants.kStrokeAttrGapTint .. autodata:: constants.kStrokeAttrGapOverprint .. autodata:: constants.kStrokeAttrAll .. autodata:: constants.kStrokeAttrRGBColor .. autodata:: constants.kStrokeAttrGapRGBColor .. pprint:: constants.kStrokeAttributes .. _constants.StrokeTypes: Stroke types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: constants.kStrokeTypeNone .. autodata:: constants.kStrokeTypeSolid .. autodata:: constants.kStrokeTypeDashed .. autodata:: constants.kStrokeTypeDash4X4 .. autodata:: constants.kStrokeTypeDash3X2 .. autodata:: constants.kStrokeTypeDots .. autodata:: constants.kStrokeTypeWavy .. autodata:: constants.kStrokeTypeStraightHash .. autodata:: constants.kStrokeTypeRightSlant .. autodata:: constants.kStrokeTypeLeftSlant .. autodata:: constants.kStrokeTypeDiamond .. autodata:: constants.kStrokeTypeJapaneseDots .. autodata:: constants.kStrokeTypeThinThin .. autodata:: constants.kStrokeTypeThinThick .. autodata:: constants.kStrokeTypeThickThin .. autodata:: constants.kStrokeTypeThickThick .. autodata:: constants.kStrokeTypeThinThickThin .. autodata:: constants.kStrokeTypeThickThinThick .. autodata:: constants.kStrokeTypeTriple .. autodata:: constants.kStrokeTypeTableStrip .. pprint:: constants.kStrokeTypes .. _constants.ProductSelectors: Product selectors ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kProductID .. autodata:: kProductID2 .. autodata:: kProductID3 .. autodata:: kProductPageitemID .. autodata:: kProductDocID .. autodata:: kProductMasterpage .. autodata:: kProductGrid .. autodata:: kProductGridID .. autodata:: kProductElement .. autodata:: kProductElementID .. autodata:: kProductNeedsrequest .. autodata:: kProductDefined .. autodata:: kProductLevel .. autodata:: kProductSubstatement .. autodata:: kProductClassID .. autodata:: kProductRow1 .. autodata:: kProductRow2 .. autodata:: kProductPreRuleID .. autodata:: kProductPreRuleparams .. autodata:: kProductPostRuleID .. autodata:: kProductPostRuleparams .. autodata:: kProductAdparams .. autodata:: kProductStringID .. autodata:: kProductSnippetAttr .. autodata:: kProductProductTextmodel .. autodata:: kProductProductStart .. autodata:: kProductProductEnd .. autodata:: kProductProductType .. autodata:: kProductProductLayer .. autodata:: kProductProductTagID1 .. autodata:: kProductProductTagID2 .. autodata:: kProductProductPageType .. autodata:: kProductProductOriginals .. autodata:: kProductProductUsedPageitem .. autodata:: kProductProductDocPosition .. autodata:: kProductProductToDelete .. pprint:: constants.kProductSelectors .. _constants.ProductBuildFlags: Product build flags ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kUseDefaultGrid .. autodata:: kIgnoreIncompletePlacements .. autodata:: kAllowIncompletePlacements .. autodata:: kCheckIfNotExists .. autodata:: kShowErrors .. autodata:: kIntersectionsAllowed .. autodata:: kCheckGridElementSize .. autodata:: kUseFullPage .. autodata:: kDisableOptimizing .. autodata:: kPreferDefaultPageItem .. autodata:: kSuppressAutoExtent .. autodata:: kUseBleed .. autodata:: kExpandGroups .. autodata:: kAutoDetectType .. autodata:: kInsertTextBeforeExceptFirst .. autodata:: kInsertTextAfterExceptLast .. autodata:: kShowProgress .. autodata:: kSuppressShowErrors .. autodata:: kAllowDoublers .. autodata:: kReloadAll .. autodata:: kSkipEmptyTemplates .. autodata:: kSuppressAlerts .. autodata:: kIgnoreErrors .. autodata:: kPreferExistingPages .. autodata:: kPreferProductPT .. autodata:: kLoadMasterItems .. autodata:: kFillPage .. autodata:: kCropPage .. pprint:: constants.kBuildFlags .. _constants.ExcelCellTypes: Excel cell types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kExcelCellTypeError .. autodata:: kExcelCellTypeNumber .. autodata:: kExcelCellTypeText .. autodata:: kExcelCellTypeBoolean .. autodata:: kExcelCellTypeDateTime .. autodata:: kExcelCellTypeBlank .. autodata:: kExcelCellTypeEmpty .. pprint:: constants.kExcelCellTypes .. _constants.ExcelSelectors: Excel selectors ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kExcelBorderLeft .. autodata:: kExcelBorderTop .. autodata:: kExcelBorderRight .. autodata:: kExcelBorderBottom .. autodata:: kExcelBorderDiagonal .. autodata:: kExcelPatternForeground .. autodata:: kExcelPatternBackground .. pprint:: constants.kExcelSelectors .. _constants.ExcelBorderStyles: Excel border styles ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kExcelBorderStyleError .. autodata:: kExcelBorderStyleNone .. autodata:: kExcelBorderStyleThin .. autodata:: kExcelBorderStyleMedium .. autodata:: kExcelBorderStyleDashed .. autodata:: kExcelBorderStyleDotted .. autodata:: kExcelBorderStyleThick .. autodata:: kExcelBorderStyleDouble .. autodata:: kExcelBorderStyleHair .. autodata:: kExcelBorderStyleMediumDashed .. autodata:: kExcelBorderStyleDashdot .. autodata:: kExcelBorderStyleMediumDashdot .. autodata:: kExcelBorderStyleDashDotDot .. autodata:: kExcelBorderStyleMediumDashDotDot .. autodata:: kExcelBorderStyleSlantDashDot .. pprint:: constants.kExcelBorderStyles .. _constants.ExcelUnderlineStyles: Excel underline styles ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kExcelUnderlineNone .. autodata:: kExcelUnderlineSingleAbove .. autodata:: kExcelUnderlineDoubleAbove .. autodata:: kExcelUnderlineSingleBelow .. autodata:: kExcelUnderlineDoubleBelow .. pprint:: constants.kExcelUnderlineStyles .. _constants.ExcelFontPosition: Excel font positions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kExcelPositionNormal .. autodata:: kExcelPositionSuper .. autodata:: kExcelPositionSub .. pprint:: constants.kExcelPositions .. _constants.MagnetSituations: Magnet situations ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kMagnetsNone .. autodata:: kMagnetsPlaceholder .. autodata:: kMagnetsScript .. autodata:: kMagnetsBuildProducts .. autodata:: kMagnetsToDoList .. autodata:: kMagnetsChangeTemplate .. autodata:: kMagnetsLayoutRule .. autodata:: kMagnetsAll .. pprint:: constants.kMagnetSituations .. _constants.MagnetStates: Magnet states ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kMagnetsEnable .. autodata:: kMagnetsDisable .. autodata:: kMagnetsToggle .. pprint:: constants.kMagnetStates .. _constants.SwatchTypes: Swatch types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kSwatchTypeNone .. autodata:: kSwatchTypeBaseColor .. autodata:: kSwatchTypeTintColor .. autodata:: kSwatchTypeMixedInkColor .. autodata:: kSwatchTypeLinkedMixedInkColor .. autodata:: kSwatchTypeMixedInkParent .. autodata:: kSwatchTypeGradient .. autodata:: kSwatchTypeBlackBoxPaint .. autodata:: kSwatchTypeOther .. pprint:: constants.kSwatchTypes .. _constants.SwatchSpaces: Swatch spaces ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kSwatchSpaceInvalid .. autodata:: kSwatchSpaceFromDisk .. autodata:: kSwatchSpaceEmbeddedInImage .. autodata:: kSwatchSpaceEmbeddedInDocument .. autodata:: kSwatchSpaceGray .. autodata:: kSwatchSpaceRGB .. autodata:: kSwatchSpaceCMYK .. autodata:: kSwatchSpaceLAB .. autodata:: kSwatchSpaceVirtual .. pprint:: constants.kSwatchSpaces .. _constants.CellTypes: Cell types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kCellTypeText .. autodata:: kCellTypeGraphic .. pprint:: constants.kCellTypes .. _constants.OverprintSettings: Overprint settings ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kOverprintBasic .. autodata:: kOverprintStroke .. autodata:: kOverprintFill .. autodata:: kOverprintGap .. pprint:: constants.kOverprintSettings .. _constants.SnippetMatchSettings: Snippet match settings ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kSnippetsNever .. autodata:: kSnippetMatchesProduct .. autodata:: kSnippetMatchesTemplate .. autodata:: kSnippetMatchesDocument .. autodata:: kSnippetMatchesStrict .. autodata:: kSnippetMatchesTolerant .. autodata:: kSnippetFallbackToTemplate .. autodata:: kSnippetMatchesLayer .. autodata:: kSnippetMatchesContext .. autodata:: kSnippetMatchesExactly .. autodata:: kSnippetAcceptAnyMatch .. autodata:: kSnippetCreate .. pprint:: constants.kSnippetMatching .. _constants.PageInfo: Page info ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kPageInfoActivated .. autodata:: kPageInfoID .. autodata:: kPageInfoIDs .. autodata:: kPageInfoName .. autodata:: kPageInfoPageType .. autodata:: kPageInfoBarrierType .. autodata:: kPageInfoSuccessorID .. autodata:: kPageInfoMasterpages .. autodata:: kPageInfoAutoOpposite .. autodata:: kPageInfoAutoSuccessor .. autodata:: kPageInfoOppositeID .. autodata:: kPageInfoDocu .. autodata:: kPageInfoDirection .. autodata:: kPageInfoOrigin .. autodata:: kPageInfoBkLayers .. pprint:: constants.kPageInfo .. _constants.HorizontalJustification: Horizontal Justification ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kJustifyLeft .. autodata:: kJustifyRight .. autodata:: kJustifyCenter .. autodata:: kJustifyFullLastLineLeft .. autodata:: kJustifyFullLastLineRight .. autodata:: kJustifyFullLastLineCenter .. autodata:: kJustifyFullLastLineFull .. pprint:: constants.kHorizontalJustification .. _constants.TableColumnCompression: Table column compression ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kBroadenFirstLast .. autodata:: kBroadenFirst .. autodata:: kBroadenLast .. autodata:: kBroadenNever .. pprint:: constants.kTableColumnCompression .. _constants.WrapTypes: Wrap types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kWrapUndef .. autodata:: kWrapNone .. autodata:: kWrapBand .. autodata:: kWrapNextFrame .. autodata:: kWrapBothSides .. autodata:: kWrapWithinHoles .. autodata:: kWrapAutoContour .. autodata:: kWrapManualContour .. autodata:: kWrapLeftContour .. autodata:: kWrapRightContour .. pprint:: constants.kWrapTypes .. _constants.PageTemplateAttributes: Page template attributes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kPageTemplateActive .. autodata:: kPageTemplateID .. autodata:: kPageTemplateIDs .. autodata:: kPageTemplateName .. autodata:: kPageTemplatePageType .. autodata:: kPageTemplateBarrier .. autodata:: kPageTemplateSuccessor .. autodata:: kPageTemplateMasterPages .. autodata:: kPageTemplateAutoOpposite .. autodata:: kPageTemplateAutoSuccessor .. autodata:: kPageTemplateOpposite .. autodata:: kPageTemplateOrigin .. autodata:: kPageTemplateLabel .. autodata:: kPageTemplateDocName .. autodata:: kPageTemplateOwner .. pprint:: constants.kPageTemplateAttributes .. _constants.PageElementAttributes: Page element attributes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kPageElementName .. autodata:: kPageElementUID .. autodata:: kPageElementActive .. autodata:: kPageElementSequ .. autodata:: kPageElementType .. autodata:: kPageElementAutoLink .. autodata:: kPageElementVerticalJust .. autodata:: kPageElementMinimumVJ .. autodata:: kPageElementStylesVJ .. autodata:: kPageElementMinimumVJEnabled .. autodata:: kPageElementStylesVJEnabled .. autodata:: kPageElementHasMoreObjects .. autodata:: kPageElementBuildDirection .. autodata:: kPageElementMinDistX .. autodata:: kPageElementMinDistY .. autodata:: kPageElementJustificationEnabled .. autodata:: kPageElementJustification .. autodata:: kPageElementJustificationScript .. autodata:: kPageElementBBoxLeft .. autodata:: kPageElementBBoxTop .. autodata:: kPageElementBBoxRight .. autodata:: kPageElementBBoxBottom .. pprint:: constants.kPageElementAttributes .. _constants.DelimiterTypes: Placeholder delimiter types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kDelimiterPrefix .. autodata:: kDelimiterPrefixIfEmpty .. autodata:: kDelimiterPostFix .. autodata:: kDelimiterPostFixIfEmpty .. pprint:: constants.kDelimiterTypes