The XML identifiers for various internal data structures, used in script line properties, are:
They are covered in detail, below.
![]()
➢These tokens are used, for example, when tabulating sunrise and sunset times for Scandinavian locations above 66 degrees north, where the Sun is always below the horizon (never rises) for part of the winter, and is always above the horizon (never sets) for part of the summer.
The example on the right (taken from the Moon and Sun Options property editor), shows how this data structure is made up of two TAboveBelowTextOptions structures (one for the all day above case and one for the all day below case), and a TShowAboveBelowWhen data type, whose numerical values can be in the range of 0 to 3 (EveryDay, FirstDay, LastDay, FirstAndLastDay, respectively). |
![]() |
TBleedOptions
![]()
If it does, then it also specifies the value in millimeters of the bleed in the 4 directions (left, right, top, bottom). If not, then these values are ignored.
The example on the right is taken from the pdf pages options property editor. |
![]()
As such, as shown in the image on the right, it is made up of two data structures, a TColorAttr for the background attributes, and a TFrameAttr for the frame attributes.
The Font field of this data structure has been replaced, since April 2004, by two TmcTextStyle (one for added styles and one for removed styles) and a TmcFontSettings. |
This data structure describes the text positioning and flow of a textbox as a whole, as used in macros text in box results and SARAs text in box changes, and is made-up of the following structures: TTextInsetsAttr, TTextColumnsAttr, TTextVertAlignAttr and TFirstBaselineAttr. |
This data structure describes a CMYK color in terms of its 4 components (Cyan, Magenta, Yellow, Black), ColorName and an optional 32-bit RGB value. The TCmyk data structure is used in other data structures. See also TColorAttr. |
This data structure is an expanded version of the TCmyk data structure which also includes fields for Shade and Opacity, as well as 3 fields to specify the on/off state of the CMYK, Shade and Opacity fields. |
![]() |
This data type specifies the type of minicalendar dates framing and shading used. Its possible values range from 0 to 5, corresponding to the following settings: cfsNone, cfsText, cfsBoxCreate, cfsBoxKeep, cfsBoxModify, cfsBoxDelete. |
This data structure has the same structure as TTextFrameRec. Its different name comes when it is combined with TComboTextShadeRec as specified by TCombinedFrameShadeRec for minicalendar dates framing and shading. |
This data structure has the same structure as TTextShadeRec. Its different name comes when it is combined with TComboTextFrameRec as specified by TCombinedFrameShadeRec for minicalendar dates framing and shading. |
This data type can have the values 0 or 1 corresponding to cbtAny, cbtAll, respectively, and is part of the definition of the TDateConditionsRec data structure. It is used at the top of the GenTokens special cases dialog, to specify what should happen if only some of the conditions are met. |
This data structure contains up to 127 holidays set IDs, running from 1 to 127. It occurs in aeiou-holidays, dates (variable), holidays (override) and included holidays. |
![]()
The TDateConditionsRec data structure occurs twice in the TLineEndingOptionsRec data structure, once as TrueConditions, and once as FalseConditions. In each case it represents all the true conditions, or all the false conditions, respectively, of the GenTokens special cases dialog. |
![]() |
![]()
This data structure is similar to the formats paragraph attributes found in GenTokens and Minicalendar Paragraph Formatting and which are contained in the TXtagsFormats and the TXtagsParagraphFormatting data structure. The difference is that the TXtagsParagraphFormatting data structure is compatible with all versions of QuarkXPress, beginning with version 3.32, while the TParagraphAttributesRec data structure requires QuarkXPress 2016-2025, and therefore contains additional features that were not present in QuarkXPress 3.32. |
![]() |
![]() |
![]() |
This data structure would only be found in scripts that had not been saved since 2003-2004. It consists of a TColorAttr, which is still being used, and a TFontStyles, offering a simple choice of bold and italics, which has been replaced by the much more versatile TmcFontSettings, used mainly in minicalendar options, but also for the separate formatting of monthly outside days. |
![]()
The TFrameAttr data structure can be found in the larger TMacroResultingActions data structure. |
![]() |
![]()
The TGenTokensOptions data structure contains a few fields, as well as the 15 special cases, each implemented by a TLineEndingOptionsRec.
In turn, the 18 TGenTokensOptions are contained in a TGenTokens data structure. |
![]()
This data structure is similar to the formats paragraph attributes found in GenTokens and Minicalendar Paragraph Formatting and which are contained in the TXtagsFormats and the TXtagsParagraphFormatting data structure. The difference is that the TXtagsParagraphFormatting data structure is compatible with all versions of QuarkXPress, beginning with version 3.32, while the TParagraphAttributesRec data structure requires QuarkXPress 2016-2025, and therefore contains additional features that were not present in QuarkXPress 3.32. |
![]()
➢As is the case in macros, dates are counted from a value of 0 on December 30, 1899, meaning that, for example, January 1, 2020, is date 43831.
This is the main data structure of the THardDates structure that implements the Dates (specific) script line property of the Inserts script line, itself implemented by the TSLX_Insert data structure. |
![]()
The holidays (display) script line property is part of the Diary Grids script line implemented by the TMultiHolidays script line property. |
![]()
➢In contrast to the TCountryIdList data structure, this data structure only contains up to 20 holidays set IDs, running from 1 to 20.
The Holidays (override) script line property is part of the Diary Grids script lines. |
![]()
This data structure is similar to the formats paragraph attributes found in GenTokens and Minicalendar Paragraph Formatting and which are contained in the TXtagsFormats and the TXtagsParagraphFormatting data structure. The difference is that the TXtagsParagraphFormatting data structure is compatible with all versions of QuarkXPress, beginning with version 3.32, while the TParagraphAttributesRec data structure requires QuarkXPress 2016-2025, and therefore contains additional features that were not present in QuarkXPress 3.32. |
![]() |
![]()
The conditions part is implemented by 2 TDateConditionsRec data structures (one holding the conditions that must be true, and the other, the conditions that must be false), while the line ending part is implemented by a single TLineEndingRec data structure.
The data structure TGenTokensOptions, in turn contains 15 special cases, each implemented by a TLineEndingOptionsRec. |
![]()
This data structure contains many sub-structures, only one of which is used at any time, depending on the value of the Line Ending Type field whose values can be letSoft=0, letHard=1, letTab=2, letMacro=3, letFormatting=4, letXtags=5, letNothing=6, letNextBox=7, letNextColumn=8, letSkipLine=9.
When the line Line Ending Type field has the value letFormatting then the Formatting field is implemented by the data structure TXtagsParagraphFormatting which implements the formats, tabs, and rule above/below, paragraph attributes. |
![]() |
![]()
There are up to 30 TMacroBlobItem data structures in the Macros Options script line property.
Apart from the simple data fields holding the database ID of the macro used, and any initial conditions, this data structure contains 2 copies of the TMacroResultingActions data structure (one for the true case, and one for the false case). |
![]()
Two of these TMacroResultingActions data structures (one for the true case, and one for the false case) are in turn contained in the TMacroBlobItem data structure which contains all the elements of the response to macro tokens of one specific index. |
![]()
The TmcDayHeader data structure is contained in the TmcOptions data structure. |
This data structure implements all the settings of the text attributes editor which is used mainly in minicalendar options, but also in grid options and in moon and sun options. |
![]()
➢Note that, since 2003, the TFontAttr part of this structure is no longer used and that the font attributes related to the TmcMoonPhases data structure are contained in a separate field MoonPhasesFontSettings of the type TmcFontSettings.
The TmcMoonPhases data structure and the related MoonPhasesFontSettings field are both contained in the TMinicalMoonPhasesOptions, itself a part of the TmcOptions data structure. |
![]() |
![]() |
![]()
➢Note that, since 2003, the TFontAttr part of this structure is no longer used and that the font attributes related to the TmcOutsideDays data structure are contained in a separate field OutsideDaysFontSettings of the type TmcFontSettings. ➢Additionally, the selection of outside days to show, and whether to show fully-outside weeks, are implemented by the OutsideDaysVisibility and the HideFullyOutsideWeeks fields of the TmcOptions data structure.
The TmcOutsideDays data structure and the related fields, mentioned above, are contained in the TmcOptions data structure. |
This data type is a set of flags, ranging from tsoHide=0 to tsoFontOpacity=25, and representing the activation or not of one of the text attributes implemented in the TmcFontSettings data structure. Note that the TmcFontSettings data structure contains 2 TmcTextStyle set of flags, one for flags that are positive (such as add italics) and one for flags that are negative (such as remove bold). |
![]()
Each of these 2 instances of the TMinicalAlternateFontOptions data structure contains an AltFontSettings of the TmcFontSettings data structure type. |
![]()
Besides the CurDay_AllSpread and the CurDay_EvenOutsideDays data fields, it also contains a field CurDaysFontSettings of the type TmcFontSettings. |
![]()
Besides the ApplyCurMonthToWholeBox data field, it also contains a field CurMonthFontSettings of the type TmcFontSettings, and a field BoxStyle of the type TBoxStyle. |
![]()
This data structure includes the individual dates data structure, made up of the fields CurWeek_AllSpread and CurWeek_EvenOutsideDays and a field CurWeekFontSettings of the type TmcFontSettings.
It also contains a field BoxStyle of the type TBoxStyle which specifies the frame and background settings of weekly bands, as would appear on the second and third tabs of the image on the right. |
![]()
This data structure contains the Xtags values of the 23/30 and 24/31 representations of 5-week minicalendars.
|
![]()
There are two TMinicalHolidaysOptions data structures; Holidays1 and Holidays2. |
This data structure implements the horizontal extent of rules section of the dialog specifying the paragraph formatting settings of the minicalendars script line property, as shown in the highlighted section of the image on the right, and as implemented by the TCurrentMiniCalOptions data structure.
|
![]()
The TMinicalMoonPhasesOptions data structure is made up of a TmcMoonPhases data structure describing its visibility settings, and a TmcFontSettings data structure describing its font attributes (since 2003, the TFontAttr part of the TmcMoonPhases data structure is no longer used). |
![]()
➢Note the the settings of the current data structure only apply to the individual dates that are before or after the month, in minicalendars.
The TMonthlyOutsideDaysOptions data structure is the one that handles normal tokens on days which do not belong to the current month, independently of the present data structure and set of options. |
![]()
In addition to the TApplyMinicalParagraphStylesWhen data field, the present data structure contains a Formatting field of the type TXtagsParagraphFormatting and a Horizontal field of the type TMinicalHorizontalRec. |
![]() |
![]()
In addition to a few simple data fields, as shown on the right, the present data structure contains 3 instances of the TmcFontSettings data structure, namely CurWeekNumFont, OtherWeeksNumFont and FullyOutsideWeeksNumFont. |
![]() |
![]() |
![]()
The monthly outside days settings are only enabled if the current GridTemplate is a monthly, or a weekly grid inside an insert, and are used to specify how to handle normal tokens on days which do not belong to the current month.
➢Note that the present settings only apply to normal tokens, on days which do not belong to the current month (the individual dates that are before or after the month, in minicalendars, are handled according to the independently set TMinicalOutsideDaysOptions data structure).
The TMonthlyOutsideDaysOptions data structure, in turn contains the simple data fields ShowOutsideDays and HideOutsideDaysMethod, as well as 2 data structures of the type TMonthlyOutsideDaysVisibilityFormatting, one for days before the month, and one for days after the month. |
TMonthlyOutsideDaysVisibilityFormatting
![]() |
![]()
It only contains the simple data fields IgnoreSummerTimeRegardless, IgnoreRefraction, RiseSetPosition (with values 0=rspdTop, 1=rspdCenter, and 2=rspdBottom) and UseFixedDiskSize. |
![]()
It also contains the following simple data fields; Display18PhasesTimes, Display18PhasesSingleDays, and Display18PhasesDuration.
These data fields are used to process Moon tokens whenever 1/8 phases of the Moon need to be displayed.
Its instance EighthPhases includes it in the implementation of the TMoonOptionsStruct data structure. |
![]()
The image on the right shows the position of the presents data structure's settings in the Moon and Sun Options property editor dialog. |
![]()
These data fields are used to process Moon tokens whenever phases of the Moon need to be displayed.
The present structure is, in turn, part of the implementation of the larger TMoonOptionsStruct data structure. |
![]() |
![]()
The holidays (display) script line property is part of the Diary Grids script line implemented by the TMultiHolidays script line property. |
![]() |
![]()
One or more TMuslimPrayersCalcOptions data structures are, in turn, included in the TMuslimTimesDataRec data structure. |
![]() |
![]()
In addition to a few simple data fields, as shown on the right, the present data structure contains an instance of the TmcOneLineTabsOptions data structure. |
![]()
The TOverrideLineEndingText data structure is, in turn, part of the TLineEndingRec data structure which specifies the Line Endings of a specific GenTokens options set. |
![]()
Many of the attributes of this data structure are similar to those of the the TXtagsParagraphFormatting data structure.
The difference is that the TXtagsParagraphFormatting data structure is compatible with all versions of QuarkXPress, beginning with version 3.32, while the TParagraphAttributesRec data structure requires QuarkXPress 2016-2025 or InDesign, and therefore contains additional features that were not present in QuarkXPress 3.32. |
![]()
The other 2 data structures contained in the TParagraphAttributesRec data structure, are the TParagraphTabulationsRec and the TParagraphRuleAboveBelowRec data structures. |
![]()
The other 2 data structures contained in the TParagraphAttributesRec data structure, are the TParagraphFormatsRec and the TParagraphTabulationsRec data structures. |
![]()
The other 2 data structures contained in the TParagraphAttributesRec data structure, are the TParagraphFormatsRec and the TParagraphRuleAboveBelowRec data structures. |
![]()
The various ways in which these rules can be defined are shown in the screenshot on the right. |
![]() |
![]()
As shown in the screenshot on the right, it contains a list of overriding name, file name, height and width for the current section, as well as a list of the physical sections rules in the TPhysicalPagesRules data structure at the bottom. |
![]()
The example, of the screenshot on the right, shows all the possible options, although all these options are not applicable in all the cases listed above. |
![]()
This data structure is made up of an Enabled field which determines if the other settings of the data structure are saved with the script or not. These 3 additional data structures are: TPlanetsSymbolsFontRec, TPlanetNamesAndSymbolsRec, and TPlanetsEventsSymbolsRec. As these are used nowhere else in Q++Studio, they are saved as part and parcel of the TPlanetsOptionsRec data structure. |
![]()
This data structure contains a list of up to 127 different month-day pairs, as well as an option field SkipFirstOccurrence and one for SkipLastOccurrence. |
![]()
This data structure is similar to the TXtagsRule paragraph attributes found in GenTokens and Minicalendar Paragraph Formatting, as contained in the TXtagsParagraphFormatting data structure.
The difference is that in the TXtagsRule, all values must be specified, while the TRuleAboveBelow data structure, though all specified, are only used, based on the TParagraphAttributesOption set of flags, running from to paLeftIndent to paEndOfTabulations. |
![]() |
![]()
These 5 data structures, one for each of the aeiou-holidays, are in turn contained in the TSaintsNamedaysOptionsRec data structure (though that data structure is not exposed. |
![]() |
![]()
The structure of these 2 sets of options is the same, thus the use of the same data structure. |
![]()
The structure of these 2 sets of options is the same, thus the use of the same data structure
This data structure is part of the TSeasonsDisplayRec data structure. |
![]()
➢These tokens are used, for example, when tabulating sunrise and sunset times for Scandinavian locations above 66 degrees north, where the Sun is always below the horizon (never rises) for part of the winter, and is always above the horizon (never sets) for part of the summer
The allowed numerical values for this data type are in the range of 0 to 3 (EveryDay, FirstDay, LastDay, FirstAndLastDay, respectively). |
![]()
Each of the 15 possible TSloganRuleRec data structure is in turn contained in the TSloganRulesInfo data structure. |
![]()
The TSloganRulesInfo data structure contains up to 15 different TSloganRuleRec data structures. |
![]()
It is used to specify if the start of week token should be triggered by another weekday than the one specified by the week start setting. |
![]() |
![]()
It only contains the simple data fields IgnoreSummerTimeRegardless, IgnoreRefraction, RiseSetPosition (with values 0=rspdTop, 1=rspdCenter, and 2=rspdBottom), UseFixedDiskSize, DawnAngleDeg, DawnAngleMin, DuskAngleDeg, and DuskAngleMin. |
![]() |
This data structure contains all the settings and options of the special tabulations dialog that modifies single line minicalendars.
It contains a field Enabled which, if true, can then have all dates in the same text box or not (AllMonthsTheSame), as shown on the right. In turn, it contains 5 set of TTabsMonthOptions data structures. |
This data structure contains the settings and options of one of the cases (28, 29, 30, 31 day months) special tabulations dialog that modifies single line minicalendars.
There are 5 of these data structures in the TTabsBoxOptions data structure. |
![]()
➢The names of the template colors of the current script can be read and set within a macro, using the macro functions GetTemplateColorName and SetTemplateColorName.
Each of the 3 templates colors is implemented by a TCmyk data structure. |
![]() |
![]()
This data structure also exists as TComboTextFrameRec, when it is combined with a TComboTextShadeRec and a TCombinedFrameShadeRec for minicalendar dates framing and shading. |
![]() |
![]()
This data structure also exists as TCombinedFrameShadeRec, when it is combined with a TComboTextFrameRec and a TCombinedFrameShadeRec for minicalendar dates framing and shading. |
![]()
Text stroking is a native way to display 2-color fonts, using normal, monochrome, fonts. |
![]() |
![]()
➢The various options and settings, shown on the right, are discussed in the topic on time formatting.
In addition to the simple data fields of this structure, it also contains a MinutesSettings field based on a TmcTextSettings data structure. |
![]() |
![]() |
![]() |
![]() |
![]()
The xBoxActions structure has at least one field, the ActionType field whose possible values are shown on the right. The default is none.
The non-default options are made up of 4 deletion options (delete box, delete group, delete layer, and delete page), modify box (change box frame and background attributes), modify text (change the overall text attribute of the textbox), change to picturebox, and change z-order. |
This data structure contains all the high-level settings and options of the text and text style resulting actions of a macro.
By high-level, we mean the boolean fields that determine if an option is set or not, corresponding to the settings in yellow in the image on the right.
If the replace token with field is set to sResult or text below, then a xTextActionsAttributes data structure is added to the present data structure (if not, then a marker indicates that the data structure uses default settings).
This data structure contains the details of the text and text style resulting actions of a macro.
By details, we mean the fields that supply the information to use, once it is determined that an option is set. This corresponds to the settings in green in the image on the above. |
This data structure represents the Zodiac Symbols Font and the Zodiac Symbols and Names settings of both the Moon and Sun zodiac options script line property dialog, as shown on the right.
These options are used to convert zodiac tokens.
This data structure is part of the TZodiacDisplayRec data structure, as shown in the screenshot on the right. |
See also: Script Line XML identifiers and Script Line Properties XML identifiers.
Topic 183485, last updated on 28-Jul-2022