comet ******************************************************************************* .. py:module:: comet The comet module is the primary service provider for comet related functionality Methods =============================================================================== .. autofunction:: comet.getContext .. autofunction:: comet.getVersion .. autofunction:: comet.getRevision .. autofunction:: comet.setOutput .. autofunction:: comet.getKeyValue .. autofunction:: comet.wlog .. autofunction:: comet.wtlog .. autofunction:: comet.showMessage .. autofunction:: comet.showError .. autofunction:: comet.uncurtain .. autofunction:: comet.pyImport .. autofunction:: comet.mm2pt .. autofunction:: comet.pt2mm .. autofunction:: comet.inch2pt .. autofunction:: comet.pt2inch .. autofunction:: comet.translate .. autofunction:: comet.beep .. autofunction:: comet.isShiftKeyPressed .. autofunction:: comet.isAltKeyPressed .. autofunction:: comet.isCtrlKeyPressed .. autofunction:: comet.runJavaScript .. autofunction:: comet.runCScript .. autofunction:: comet.getScriptClipboard .. autofunction:: comet.setScriptClipboard .. autofunction:: comet.clearScriptClipboard .. _comet.constants: Constants =============================================================================== The :py:mod:`comet` module has a number of constant members which are either used as convenience values for function parameter calls, or as returned values. .. _comet.HostEnvironments: Host environments ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: comet::kHostInDesign .. autodata:: comet::kHostInDesignServer .. autodata:: comet::kHostCometPDF .. autodata:: comet::kHostIllustrator .. pprint:: comet.kHosts .. _comet.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:: comet.kDesignate .. _comet.Contexts: Contexts ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: comet::kContextUnknown .. autodata:: comet::kContextPlaceHolderLoad .. autodata:: comet::kContextPlaceHolderSync .. autodata:: comet::kContextPlaceHolderStore .. autodata:: comet::kContextPlaceHolderBuild .. autodata:: comet::kContextPlaceHolderBuildPost .. autodata:: comet::kContextPlaceHolderPrefix .. autodata:: comet::kContextPlaceHolderPostfix .. autodata:: comet::kContextPanelAction .. autodata:: comet::kContextLayoutRule .. autodata:: comet::kContextLayoutRuleCondition .. autodata:: comet::kContextLayoutRuleDynamicList .. autodata:: comet::kContextProductBuildPre .. autodata:: comet::kContextBuildSupport .. autodata:: comet::kContextFuncVarDynamicDef .. autodata:: comet::kContextFuncVarAvailValues .. autodata:: comet::kContextBatch .. autodata:: comet::kContextDoubleClickProductPool .. autodata:: comet::kContextDoubleClickPublications .. autodata:: comet::kContextDoubleClickPreviews .. autodata:: comet::kContextExtendScript .. autodata:: comet::kContextAllowLogin .. autodata:: comet::kContextAfterLogin .. autodata:: comet::kContextXMLScript .. autodata:: comet::kContextCometTestPreScript .. autodata:: comet::kContextCometTestScript .. autodata:: comet::kContextCometTestPostScript .. autodata:: comet::kContextPlaceHolderStringCompare .. autodata:: comet::kContextDocWatch .. autodata:: comet::kContextURLLinkDestFolder .. autodata:: comet::kContextURLLinkHeaderData .. autodata:: comet::kContextURLDropActionID .. autodata:: comet::kContextURLDrop .. autodata:: comet::kContextAlternativeTemplate .. autodata:: comet::kContextTableModuleInsertRow .. autodata:: comet::kContextTableModuleOmitRow .. autodata:: comet::kContextTableModuleInsertColumn .. autodata:: comet::kContextTableModuleOmitColumn .. autodata:: comet::kContextTableModuleLayoutRule .. autodata:: comet::kContextTableModuleCellID .. autodata:: comet::kContextPublicationCheckout .. autodata:: comet::kContextPublicationAfterSave .. autodata:: comet::kContextPublicationBeforeClose .. autodata:: comet::kContextPublicationStatus .. autodata:: comet::kContextPublicationCheckin .. autodata:: comet::kContextPublicationAfterClose .. autodata:: comet::kContextPublicationRevert .. autodata:: comet::kContextPublicationAfterCheckout .. autodata:: comet::kContextNoteParastyle .. autodata:: comet::kContextNoteTargetLayer .. autodata:: comet::kContextPODSpecialCases .. autodata:: comet::kContextProductPoolEntries .. autodata:: comet::kContextProductPoolSFDefaultValue .. autodata:: comet::kContextToDoListCustomTask .. autodata:: comet::kContextPreviewsEntries .. autodata:: comet::kContextPreviewsLink .. autodata:: comet::kContextPageTemplateAfterApply .. autodata:: comet::kContextServerInterface .. autodata:: comet::kContextStampAction .. autodata:: comet::kContextExcelQueryFunction .. pprint:: comet.kContexts .. _comet.actionTypes: Action types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: comet::kActionTypeLoad .. autodata:: comet::kActionTypeStore .. autodata:: comet::kActionTypeSync .. autodata:: comet::kActionTypeBuild .. pprint:: comet.kActionTypes .. _comet.Indices: Indices ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: comet::kStart .. autodata:: comet::kEnd .. autodata:: comet::kTotalEnd .. pprint:: comet.kIndices .. _comet.Sides: Sides ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: comet::kSideLeft .. autodata:: comet::kSideRight .. autodata:: comet::kSideTop .. autodata:: comet::kSideBottom .. autodata:: comet::kSideAll .. pprint:: comet.kSides .. _comet.refPoints: Reference Points ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: comet::kRefPointTopLeft .. autodata:: comet::kRefPointTopCenter .. autodata:: comet::kRefPointTopRight .. autodata:: comet::kRefPointLeftCenter .. autodata:: comet::kRefPointCenter .. autodata:: comet::kRefPointRightCenter .. autodata:: comet::kRefPointBottomLeft .. autodata:: comet::kRefPointBottomCenter .. autodata:: comet::kRefPointBottomRight .. pprint:: comet.kReferencePoints .. _comet.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:: comet::kExportPlain .. autodata:: comet::kExportTagged .. autodata:: comet::kExportTT .. autodata:: comet::kExportW2 .. autodata:: comet::kExportUnitext .. autodata:: comet::kExportXUnitext .. autodata:: comet::kExportPlainWithTables .. autodata:: comet::kExportUnitextWithTables .. autodata:: comet::kExportXUnitextWithTables .. autodata:: comet::kExportPlainNoTypografics .. autodata:: comet::kExportPlainWithTablesNoTypografics .. autodata:: comet::kExportHTML .. autodata:: comet::kExportHTMLWithTables .. autodata:: comet::kExportRTF .. autodata:: comet::kExportXMLUnitext .. autodata:: comet::kExportXMLUnitextWithTables .. autodata:: comet::kExportHTMLWithStyles .. autodata:: comet::kExportW2Raw .. autodata:: comet::kExportPlusPlain .. autodata:: comet::kExportPlusUnitext .. autodata:: comet::kExportPlusXUnitext .. autodata:: comet::kExportPlusXMLUnitext .. autodata:: comet::kExportPlusPlainNoTypografics .. autodata:: comet::kExportPlusHTML .. autodata:: comet::kExportW2ML .. autodata:: comet::kExportHTMLWithStylesAndCSS .. pprint:: comet.kTextFormats .. _comet.PageItemTypes: Pageitem types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: comet::kPageItemTypeUnknown .. autodata:: comet::kPageItemTypeText .. autodata:: comet::kPageItemTypeGraphic .. autodata:: comet::kPageItemTypeGroup .. autodata:: comet::kPageItemTypeLegacyText .. autodata:: comet::kPageItemTypeGraph .. autodata:: comet::kPageItemTypeGuide .. autodata:: comet::kPageItemTypeQRCode .. pprint:: comet.kPageItemTypes .. _comet.ListTypes: List types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: comet::kListTypeNone .. autodata:: comet::kListTypeBullet .. autodata:: comet::kListTypeNumbered .. pprint:: comet.kListTypes .. _comet.BasicTypes: Basic types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: comet::kInt .. autodata:: comet::kFloat .. autodata:: comet::kString .. pprint:: comet.kBasicTypes .. _comet.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:: comet.kLayoutRuleSituations .. _comet.StyleTypes: Style types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: comet::kStyleTypeObject .. autodata:: comet::kStyleTypeTable .. autodata:: comet::kStyleTypeCell .. autodata:: comet::kStyleTypeParagraph .. autodata:: comet::kStyleTypeCharacter .. pprint:: comet.kStyleTypes .. _comet.PageTypes: Page types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: comet::kPageTypeUnknown .. autodata:: comet::kPageTypeLeft .. autodata:: comet::kPageTypeUnisex .. autodata:: comet::kPageTypeRight .. pprint:: comet.kPageTypes .. _comet.PanelIDs: Panel IDs ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% :align: left .. autodata:: comet::kPanelUndef .. autodata:: comet::kPanelProducts .. autodata:: comet::kPanelPreviews .. autodata:: comet::kPanelPageitems .. autodata:: comet::kPanelPublications .. autodata:: comet::kPanelToDoList .. autodata:: comet::kPanelPlaceholder .. autodata:: comet::kPanelPlaceholderValues .. autodata:: comet::kPanelPageitemsBehavior .. autodata:: comet::kPanelCometAdmin .. autodata:: comet::kPanelLayoutRules .. autodata:: comet::kPanelFrameTags .. autodata:: comet::kPanelAreaBuild .. autodata:: comet::kPanelPriintAdjust .. autodata:: comet::kPanelPriintAdjustList .. autodata:: comet::kPanelPlaceholderValuesInfo .. autodata:: comet::kPanelFrontRow .. autodata:: comet::kPanelNotes .. autodata:: comet::kPanelPreviewDetails .. autodata:: comet::kPanelProductsOfDocument .. autodata:: comet::kPanelPublicationInfo .. autodata:: comet::kPanelSettings .. autodata:: comet::kPanelCometTests .. autodata:: comet::kPanelURLLink .. autodata:: comet::kPanelDocumentAttributes .. pprint:: comet.kPanelIDs .. _comet.SyncStates: Sync states ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: comet::kSyncStateUndefined .. autodata:: comet::kSyncStateOverridden .. autodata:: comet::kSyncStateLoadError .. autodata:: comet::kSyncStateNoMarker .. autodata:: comet::kSyncStateNotFound .. autodata:: comet::kSyncStateChanged .. autodata:: comet::kSyncStateRemoved .. autodata:: comet::kSyncStateOk .. autodata:: comet::kSyncStateNotUnique .. pprint:: comet.kSyncStates .. _comet.BuildSituations: Build situations ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: comet::kSituationCheckSizeBefore .. autodata:: comet::kSituationCheckSizeAfter .. autodata:: comet::kSituationBeforeCreateContinue .. autodata:: comet::kSituationAfterCreateContinue .. autodata:: comet::kSituationProductPlaced .. autodata:: comet::kSituationUnsolvableOversets .. autodata:: comet::kSituationAfterBuild .. autodata:: comet::kSituationProductFinished .. pprint:: comet.kBuildSituations .. _comet.LinkTypes: Link types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: comet::kLinkTypeText .. autodata:: comet::kLinkTypeFrame .. pprint:: comet.kLinkTypes .. _comet.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 | +--------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _comet.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:: comet::kPublicationID - :py:class:`int` - |check| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationID2 - :py:class:`int` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: comet::kPublicationID3 - :py:class:`int` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: comet::kPublicationStringID - :py:class:`str` - |check| - |check| - |check| - |x| - |check| * - .. autodata:: comet::kPublicationInfo - :py:class:`str` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: comet::kPublicationName - :py:class:`str` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: comet::kPublicationLabel - :py:class:`str` - |check| - |check| - |check| - |check| - |check| * - .. autodata:: comet::kPublicationType - :py:class:`.CParameter`: :py:class:`int` |br| else: :py:class:`str` - |check| - |x| - |check| - |x| - |check| * - .. autodata:: comet::kPublicationStatus - :py:class:`str` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: comet::kPublicationInfo1 - :py:class:`str` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: comet::kPublicationInfo2 - :py:class:`str` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: comet::kPublicationDomain - :py:class:`str` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: comet::kPublicationPath - :py:class:`str` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: comet::kPublicationURL - :py:class:`str` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: comet::kPublicationCanOverrideURL - :py:class:`bool` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: comet::kPublicationCanOverrideLocal - :py:class:`bool` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: comet::kPublicationHasChildren - :py:class:`bool` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: comet::kPublicationStatementID - :py:class:`int` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: comet::kPublicationIconID - :py:class:`int` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: comet::kPublicationValue1 - :py:class:`str` - |x| - |x| - |check| - |x| - |x| * - .. autodata:: comet::kPublicationValue2 - :py:class:`str` - |x| - |x| - |check| - |x| - |x| * - .. autodata:: comet::kPublicationValue3 - :py:class:`str` - |x| - |x| - |check| - |x| - |x| * - .. autodata:: comet::kPublicationIdentifier - :py:class:`str` - |x| - |x| - |check| - |x| - |check| * - .. autodata:: comet::kPublicationActionID - :py:class:`str` - |x| - |x| - |x| - |x| - |check| * - .. autodata:: comet::kPublicationDocumentID - :py:class:`str` - |check| - |x| - |x| - |x| - |x| * - .. autodata:: comet::kPublicationFieldCount - :py:class:`int` - |x| - |x| - |check| - |x| - |x| * - .. autodata:: comet::kPublicationBucketID - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationBucketRefs - :py:class:`list` [:py:class:`str`] - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationContextAssortment - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationContextCountry - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationContextLanguage - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationContextWell - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationContextMarket - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationContextTargetGroup - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationContextPublication - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationContextDocumentID - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationCordRefs - :py:class:`list` [:py:class:`str`] - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationCreatedBy - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationCreatedOn - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationDeleted - :py:class:`bool` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationDpTemplateID - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationEntityBucketID - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationEntityModelID - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationEntityPlanningID - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationImportID - :py:class:`int` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationKeyValueRefs - :py:class:`list` [:py:class:`str`] - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationChildren - :py:class:`list` [:py:class:`str`] - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationMediaAssetRefs - :py:class:`list` [:py:class:`str`] - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationMetaData - :py:class:`list` [:py:class:`str`] - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationOrigin - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationPageID - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationPageTemplateElementID - :py:class:`int` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationPageTemplateID - :py:class:`int` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationParentPlanningID - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationPriceRefs - :py:class:`list` [:py:class:`str`] - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationPrintTemplateID - :py:class:`int` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationSequence - :py:class:`int` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationTableDataRefs - :py:class:`list` [:py:class:`str`] - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationTextRefs - :py:class:`list` [:py:class:`str`] - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationTimestamp - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationUpdatedBy - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationUpdatedOn - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationUsePrintPageTemplate - :py:class:`bool` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationVersion - :py:class:`str` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationXPosBottomRight - :py:class:`float` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationXPosTopLeft - :py:class:`float` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationYPosBottomRight - :py:class:`float` - |x| - |x| - |x| - |check| - |x| * - .. autodata:: comet::kPublicationYPosTopLeft - :py:class:`float` - |x| - |x| - |x| - |check| - |x| .. _comet.DocCloseModes: Document close modes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Used with :py:meth:`.CDocument.close` .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: comet::kDocCloseProcess .. autodata:: comet::kDocCloseSchedule .. autodata:: comet::kDocCloseImmediate .. pprint:: comet.kDocCloseModes .. _comet.ColorModels: Color models ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: comet::kColorModelUnknown .. autodata:: comet::kColorModelGray .. autodata:: comet::kColorModelRGB .. autodata:: comet::kColorModelCMYK .. autodata:: comet::kColorModelLAB .. pprint:: comet.kColorModels .. _comet.LinkFirstSelectors: Link first selectors ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: comet::kLinkFirstIgnore .. autodata:: comet::kLinkFirstLeftTop .. autodata:: comet::kLinkFirstRightTop .. autodata:: comet::kLinkFirstOuterTop .. autodata:: comet::kLinkFirstInnerTop .. autodata:: comet::kLinkFirstLeftBottom .. autodata:: comet::kLinkFirstRightBottom .. autodata:: comet::kLinkFirstOuterBottom .. autodata:: comet::kLinkFirstInnerBottom .. pprint:: comet.kLinkFirstSelectors .. _comet.LinkSorting: Link sorting ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: comet::kLinkSortNo .. autodata:: comet::kLinkSortColwise .. autodata:: comet::kLinkSortRowwise .. autodata:: comet::kLinkSortByZOrder .. pprint:: comet.kLinkSorting .. _comet.LineTypes: Line types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: comet::kLineTypeRow .. autodata:: comet::kLineTypeColumn .. pprint:: comet.kLineTypes .. _comet.RowTypes: Row types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: comet::kRowTypeAll .. autodata:: comet::kRowTypeHeader .. autodata:: comet::kRowTypeBody .. autodata:: comet::kRowTypeFooter .. pprint:: comet.kRowTypes .. _comet.StrokeSelectors: Stroke selectors ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: comet.kStrokeSideNone .. autodata:: comet.kStrokeSideLeft .. autodata:: comet.kStrokeSideTop .. autodata:: comet.kStrokeSideRight .. autodata:: comet.kStrokeSideBottom .. autodata:: comet.kStrokeSideInteriorRows .. autodata:: comet.kStrokeSideInteriorColumns .. autodata:: comet.kStrokeSideAll .. pprint:: comet.kStrokeSelectors .. _comet.StrokeAttributes: Stroke attributes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: comet.kStrokeAttrNone .. autodata:: comet.kStrokeAttrWeight .. autodata:: comet.kStrokeAttrColor .. autodata:: comet.kStrokeAttrStrokeType .. autodata:: comet.kStrokeAttrTint .. autodata:: comet.kStrokeAttrOverprint .. autodata:: comet.kStrokeAttrGapColor .. autodata:: comet.kStrokeAttrGapTint .. autodata:: comet.kStrokeAttrGapOverprint .. autodata:: comet.kStrokeAttrAll .. autodata:: comet.kStrokeAttrRGBColor .. autodata:: comet.kStrokeAttrGapRGBColor .. pprint:: comet.kStrokeAttributes .. _comet.StrokeTypes: Stroke types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: comet.kStrokeTypeNone .. autodata:: comet.kStrokeTypeSolid .. autodata:: comet.kStrokeTypeDashed .. autodata:: comet.kStrokeTypeDash4X4 .. autodata:: comet.kStrokeTypeDash3X2 .. autodata:: comet.kStrokeTypeDots .. autodata:: comet.kStrokeTypeWavy .. autodata:: comet.kStrokeTypeStraightHash .. autodata:: comet.kStrokeTypeRightSlant .. autodata:: comet.kStrokeTypeLeftSlant .. autodata:: comet.kStrokeTypeDiamond .. autodata:: comet.kStrokeTypeJapaneseDots .. autodata:: comet.kStrokeTypeThinThin .. autodata:: comet.kStrokeTypeThinThick .. autodata:: comet.kStrokeTypeThickThin .. autodata:: comet.kStrokeTypeThickThick .. autodata:: comet.kStrokeTypeThinThickThin .. autodata:: comet.kStrokeTypeThickThinThick .. autodata:: comet.kStrokeTypeTriple .. autodata:: comet.kStrokeTypeTableStrip .. pprint:: comet.kStrokeTypes .. _comet.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:: comet.kProductSelectors .. _comet.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 .. pprint:: comet.kBuildFlags .. _comet.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:: comet.kExcelCellTypes .. _comet.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:: comet.kExcelSelectors .. _comet.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:: comet.kExcelBorderStyles .. _comet.ExcelUnderlineStyles: Excel underline styles ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kExcelUnderlineNone .. autodata:: kExcelUnderlineSingleAbove .. autodata:: kExcelUnderlineDoubleAbove .. autodata:: kExcelUnderlineSingleBelow .. autodata:: kExcelUnderlineDoubleBelow .. pprint:: comet.kExcelUnderlineStyles .. _comet.ExcelFontPosition: Excel font positions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kExcelPositionNormal .. autodata:: kExcelPositionSuper .. autodata:: kExcelPositionSub .. pprint:: comet.kExcelPositions .. _comet.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:: comet.kMagnetSituations .. _comet.MagnetStates: Magnet states ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kMagnetsEnable .. autodata:: kMagnetsDisable .. autodata:: kMagnetsToggle .. pprint:: comet.kMagnetStates .. _comet.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:: comet.kSwatchTypes .. _comet.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:: comet.kSwatchSpaces .. _comet.CellTypes: Cell types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kCellTypeText .. autodata:: kCellTypeGraphic .. pprint:: comet.kCellTypes .. _comet.OverprintSettings: Overprint settings ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kOverprintBasic .. autodata:: kOverprintStroke .. autodata:: kOverprintFill .. autodata:: kOverprintGap .. pprint:: comet.kOverprintSettings .. _comet.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:: comet.kSnippetMatching .. _comet.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:: comet.kPageInfo .. _comet.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:: comet.kHorizontalJustification .. _comet.TableColumnCompression: Table column compression ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :class: alternating-rows comet :width: 100% .. autodata:: kBroadenFirstLast .. autodata:: kBroadenFirst .. autodata:: kBroadenLast .. autodata:: kBroadenNever .. pprint:: comet.kTableColumnCompression