Please enable JavaScript to view this site.

 

Navigation: Appendices > Typography > XML Identifiers

Internal Data Structures XML Identifiers

Scroll Prev Up Next More

The XML identifiers for various internal data structures, used in script line properties, are:

 

TAboveBelowHorizonRec, TAboveBelowTextOptions, TBoxStyle, TBoxTextAttr, TCmyk, TColorAttr, TCombinedFrameShadeRec, TCombinedFrameShadeType, TComboTextFrameRec, TComboTextShadeRec, TConditionBoolType, TCountryIdList, TDateConditionsRec, TDefaultLineEndingOptionsRec, TDropsCaps, TFirstBaselineAttr, TFirstHours, TFlowOfDates, TFontAttr, TFrameAttr, TGenTokens, TGenTokensOptions, TGridLock, THardDatesList, THolidaysDisplayOptions, THolidaysOverrideOptions, TKeepLinesTogether, TLanguageIdList, TLineEndingOptionsRec, TLineEndingRec, TLunarDaysOptionsRec, TMacroBlobItem, TMacroResultingActions, TmcDayHeader, TmcFontSettings, TmcMoonPhases, TmcOneLineTabsOptions, TmcOptions, TmcOutsideDays, TmcTextStyle, TMinicalAlternateFontOptions, TMinicalCurrentDayOptions, TMinicalCurrentMonthOptions, TMinicalCurrentWeekOptions, TMinicalFiveWeeksOptions, TXtagText, TMinicalHolidaysOptions, TMinicalHorizontalRec, TMinicalMoonPhasesOptions, TMinicalOutsideDaysOptions, TMinicalParagraphStyleRec, TMinicalWeekdaysOptions, TMinicalWeekNumbersOptions, TMonthHeaders, TMonthHeadersOptions, TMonthlyOutsideDaysOptions, TMonthlyOutsideDaysVisibilityFormatting, TMoonCalcOptions, TMoonEighthPhasesRec, TMoonOptionsStruct, TMoonQuarterPhasesRec, TMoonSourceIDs, TMultiHolidaysOptions, TMuslimDataSet, TMuslimPrayersCalcOptions, TMuslimTimesDataRec, TOneLineMinicalendarOptions, TOverrideLineEndingText, TParagraphAttributesRec, TParagraphFormatsRec, TParagraphRuleAboveBelowRec, TParagraphTabulationsRec, TPhysicalPagesRule, TPhysicalPagesRules, TPhysicalSectionsBlobItem, TPictureboxAttr, TPlanetsOptionsRec, TRepeatDatesList, TRuleAboveBelow, TRuleStyle, TSaintsOptionsRec, TSaintsSets, TSeasonsDisplayRec, TSeasonsSymbolsAndNames, TShowAboveBelowWhen, TSloganRuleRec, TSloganRulesInfo, TStartOfWeekOptions, TSummerTimeOptionsRec, TSunCalcOptions, TSunSourceIDs, TTabsBoxOptions, TTabsMonthOptions, TTemplateColors, TTextColumnsAttr, TTextFrameRec, TTextInsetsAttr, TTextShadeRec, TTextStrokeRec, TTextVertAlignAttr, TTimesDisplayRec, TXtagsFormats, TXtagsParagraphFormatting, TXtagsRule, TXtagsTabs, xBoxActions, xTextActions, xTextActionsAttributes, TZodiacDisplayRec, TZodiacSymbolsAndNames

 

They are covered in detail, below.

 

TAboveBelowHorizonRec

 

This data structure contains the settings used to display some text, instead of times, on dates when the Sun or the Moon or one of the planets is above or below the horizon all day, in response to the tokens [sab] (for the Sun), [mab] (for the Moon) and [plXab] (for the planets).

 

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).

TAboveBelowTextOptions

 

This data structure is part of the TAboveBelowHorizonRec data structure, and specifies the text and font to use to display, instead of times, on dates when the Sun or the Moon or one of the planets is above or below the horizon all day, in response to the tokens [sab] (for the Sun), [mab] (for the Moon) and [plXab] (for the planets).

TBleedOptions

 

This data structure specifies if the image placed in a picturebox should bleed off the page or not.

 

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.

TBoxStyle

 

This data structure describes the frame and background attributes of a textbox or picturebox.

 

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.

TBoxTextAttr

 

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.

TCmyk

 

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.

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.

TCombinedFrameShadeRec

 

This data structure describes the way in which a TComboTextFrameRec and a TComboTextShadeRec data structure are combined into minicalendar dates framing and shading. In turn, it contains a TCombinedFrameShadeType field as well as Layer number and DeleteOtherLayers fields.

TCombinedFrameShadeType

 

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.

TComboTextFrameRec

 

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.

TComboTextShadeRec

 

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.

TConditionBoolType

 

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.

TCountryIdList

 

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.

TDateConditionsRec

 

This data structure contains a TConditionBoolType data type and 5 strings . These 5 strings (Weekdays, Holidays, DaysOfMonth, Miscellaneous, MoonPhases) represent which of the corresponding items are selected for the current condition in the GenTokens special cases dialog.

 

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.

TDefaultLineEndingOptionsRec

 

This data structure is the same as the TLineEndingOptionsRec data structure, but it is used for the first, default, TLineEndingOptionsRec data structure of GenTokens Options, the one with no conditions (that is to say with the internal TDateConditionsRec data structure remaining unused), contained in the larger TGenTokensOptions data structure.

TDropsCaps

 

This data structure is part of the TParagraphAttributesRec data structure that implements the fuller paragraph attributes used in macros paragraph results and SARAs paragraph changes.

 

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-2024, and therefore contains additional features that were not present in QuarkXPress 3.32.

TFirstBaselineAttr

 

This data structure is part of the TBoxTextAttr data structure that implements the text in box attributes used in macros text in box results and SARAs text in box changes.

TFirstHours

 

This data structure is part of the TMiscGridOptions data structure which implements the Grid Options script line property. It is used to specify the first hour of the day to use for the schedule hour tokens of the form [h1]..[h24].

TFlowOfDates

 

This data structure implements the flow of dates settings of the minicalendars script line property, as shown in the image on the right, and as implemented by the TCurrentMiniCalOptions data structure.

TFontAttr

 

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.

TFrameAttr

 

This data structure describes the settings to be applied to the current textbox frame, as found in the current month minicalendar options, and in macros modify box results and SARAs modify box changes.

 

The TFrameAttr data structure can be found in the larger TMacroResultingActions data structure.

TGenTokens

 

This data structure is part of the TMiscGridOptions data structure which implements the Grid Options script line property, and contains 18 TGenTokensOptions elements, each implementing the response to any one of the 18 possible GenTokens tokens.

TGenTokensOptions

 

This data structure contains all the GenTokens settings implementing the response to any one of the 18 possible GenTokens tokens.

 

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.

TGridLock

 

This data structure is part of the TParagraphAttributesRec data structure that implements the fuller paragraph attributes used in macros paragraph results and SARAs paragraph changes.

 

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-2024, and therefore contains additional features that were not present in QuarkXPress 3.32.

THardDatesList

 

This data structure contains up to 127 hard-coded dates, running from 1 to 127.

 

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.

THolidaysDisplayOptions

 

This data structure implements the holidays (display) script line property settings for one of the 5 aeiou-Holidays lists.

 

The holidays (display) script line property is part of the Diary Grids script line implemented by the TMultiHolidays script line property.

THolidaysOverrideOptions

 

This data structure implements the Holidays (override) script line property settings for one of the 5 aeiou-Holidays lists.

 

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.

TKeepLinesTogether

 

This data structure is part of the TParagraphAttributesRec data structure that implements the fuller paragraph attributes used in macros paragraph results and SARAs paragraph changes.

 

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-2024, and therefore contains additional features that were not present in QuarkXPress 3.32.

TLanguageIdList

 

This data structure contains up to 127 language IDs, running from 1 to 127, as part of the Languages script line property of the International script line.

TLineEndingOptionsRec

 

This data structure represents the combined elements that make-up an individual GenTokens Options Special Case, both the conditions and the line ending of that Special Case.

 

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.

TLineEndingRec

 

This data structure is the line ending part of the TLineEndingOptionsRec data structure which implements the special cases of the GenTokens Options.

 

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.

TLunarDaysOptionsRec

 

This data structure implements the settings contained in the Lunar Days (Tithis) section of the Moon Phases tab of the Moon and Sun Options script line property editor, and control the display and appearance of the result of Moon/Lunar Day tokens.

TMacroBlobItem

 

This data structure contains all the elements of the response to macro tokens of one specific index (such as all tokens of the same index *1, for example).

 

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).

TMacroResultingActions

 

This data structure describes all the settings found in macros resulting actions, including the following data structures: xTextActions, TBoxTextAttr, and TPictureboxAttr.

 

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.

TmcDayHeader

 

This data structure contains the settings used by the minicalendar weekday headers options of the minicalendar options of DiaryGrid script lines.

 

The TmcDayHeader data structure is contained in the TmcOptions data structure.

TmcFontSettings

 

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.

TmcMoonPhases

 

This data structure contains the visibility settings used by the minicalendar Moon phases options of the minicalendar options of DiaryGrid script lines, as highlighted in the image on the right.

 

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.

TmcOneLineTabsOptions

 

This data structure implements the one line minicalendars special tabulations settings found in the one line minicalendars options of the minicalendars script line property, as shown in the image on the right, and as implemented by the TCurrentMiniCalOptions data structure.

TmcOptions

 

This data structure contains most of the settings of the Minicalendars script line property, as implemented by the TCurrentMiniCalOptions data structure. The principal data structures of the the Minicalendars script line property, not implemented by the present data structures, are the TmcOneLineTabsOptions and the TMinicalParagraphStyleRec data structures.

TmcOutsideDays

 

This data structure contains only the visibility setting (Show) used by the minicalendar outside days options of the minicalendar options of DiaryGrid script lines, as highlighted in the image on the right.

 

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.

TmcTextStyle

 

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).

TMinicalAlternateFontOptions

 

This data structure exists as Alternate1 and Alternate2 in the alternate font minicalendar font formats of the minicalendar options of DiaryGrid script lines, as shown in the image on the right.

 

Each of these 2 instances of the TMinicalAlternateFontOptions data structure contains an AltFontSettings of the TmcFontSettings data structure type.

TMinicalCurrentDayOptions

 

This data structure implements the current day options of the minicalendars script line property, as shown in the image on the right, and as implemented by the TCurrentMiniCalOptions data structure.

 

Besides the CurDay_AllSpread and the CurDay_EvenOutsideDays data fields, it also contains a field CurDaysFontSettings of the type TmcFontSettings.

TMinicalCurrentMonthOptions

 

This data structure implements the current month options of the minicalendars script line property, as shown in the image on the right, and as implemented by the TCurrentMiniCalOptions data structure

 

Besides the ApplyCurMonthToWholeBox data field, it also contains a field CurMonthFontSettings of the type TmcFontSettings, and a field BoxStyle of the type TBoxStyle.

TMinicalCurrentWeekOptions

 

This data structure implements the current week options of the minicalendars script line property, as shown in the image on the right, and as implemented by the TCurrentMiniCalOptions data structure.

 

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.

TMinicalFiveWeeksOptions

 

This data structure implements the five-week options of the minicalendars script line property, as shown in the image on the right, and as implemented by the TCurrentMiniCalOptions data structure.

 

TXtagText

 

This data structure contains the Xtags values of the 23/30 and 24/31 representations of 5-week minicalendars.

 

TMinicalHolidaysOptions

 

This data structure implements the holidays and holidays 2 options of the minicalendars script line property, as shown in the image on the right, and as implemented by the TCurrentMiniCalOptions data structure.

 

There are two TMinicalHolidaysOptions data structures; Holidays1 and Holidays2.

TMinicalHorizontalRec

 

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.

TMinicalMoonPhasesOptions

 

This data structure contains all the settings used by the minicalendar Moon phases options of the minicalendar options of DiaryGrid script lines.

 

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).

TMinicalOutsideDaysOptions

 

This data structure fully implements the outside days options of the minicalendars script line property, as shown in the image on the right, and as implemented by the TCurrentMiniCalOptions data structure.

 

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.

TMinicalParagraphStyleRec

 

This data structure implements the full paragraph formatting settings of the minicalendars script line property, as shown in the image on the right, and as implemented by the TCurrentMiniCalOptions data structure.

 

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.

TMinicalWeekdaysOptions

 

This data structure implements the $$ headers and @ dates formatting settings of the minicalendars script line property, as shown in the highlighted part of the image on the right, and as implemented by the TCurrentMiniCalOptions data structure.

TMinicalWeekNumbersOptions

 

This data structure implements the week numbers formatting settings of the minicalendars script line property, as shown in the image on the right, and as implemented by the TCurrentMiniCalOptions data structure.

 

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.

TMonthHeaders

 

This data structure is an array of 12 TMonthHeadersOptions data structures, collectively specifying the response to the 12 possible individual TMonthHeadersOptions data structures to MonthHeader tokens as specified in the GridOptions script line property editor.

TMonthHeadersOptions

 

This data structure implements the elements of the response to one of the 12 individual MonthHeader tokens, collectively contained in the TMonthHeaders data structure in the GridOptions script line property editor, as shown in the image on the right.

TMonthlyOutsideDaysOptions

 

This data structure implements the monthly outside days settings of the GridOptions script line property editor, as shown in the image on the right.

 

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

 

This data structure specifies the text formatting to apply to the result of normal tokens on days which do not belong to the current month, as part of the monthly outside days formatting settings of the GridOptions script line property editor, as implemented by the TMonthlyOutsideDaysOptions data structure, as shown in the image on the right.

TMoonCalcOptions

 

This data structure implements the calculation options part of the moon data source script line property, as shown in the screenshot of the corresponding property editor, on the right, and implemented by the TMoonDataSource data structure.

 

It only contains the simple data fields IgnoreSummerTimeRegardless, IgnoreRefraction, RiseSetPosition (with values 0=rspdTop, 1=rspdCenter, and 2=rspdBottom) and UseFixedDiskSize.

TMoonEighthPhasesRec

 

This data structure contains the list of the 4 characters to use for all the 1/8 Moon phases, namely all the waxing and waning phases.

 

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.

TMoonOptionsStruct

 

This data structure contains most of the Moon phases options settings of the Moon and Sun Options script line property, used to process Moon tokens.

 

The image on the right shows the position of the presents data structure's settings in the Moon and Sun Options property editor dialog.

TMoonQuarterPhasesRec

 

This data structure contains the list of the 4 characters to use for the standard quarter Moon phases (new, first quarter, full, last quarter), as shown in the image on the right.

 

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.

TMoonSourceIDs

 

This data structure holds the list of Moon set IDs used in the moon data source script line property, as shown in the screenshot of the corresponding property editor, on the right, and implemented by the TMoonDataSource data structure.

TMultiHolidaysOptions

 

This data structure implements the holidays (multiple) script line property settings for one of the 5 aeiou-Holidays lists.

 

The holidays (display) script line property is part of the Diary Grids script line implemented by the TMultiHolidays script line property.

TMuslimDataSet

 

This data structure contains the muslim calendar to use for the muslim dates tokens of the current script, as part of the muslim data script line property, as shown in the image on the right.

TMuslimPrayersCalcOptions

 

This data structure contains the implementation of a single muslim prayer times source to use for the muslim prayer times tokens of the current script, as part of the muslim data script line property, as shown in the image on the right.

 

One or more TMuslimPrayersCalcOptions data structures are, in turn, included in the TMuslimTimesDataRec data structure.

TMuslimTimesDataRec

 

This data structure contains the muslim times options to use for the muslim prayer times tokens of the current script, consisting of one or more TMuslimPrayersCalcOptions data structures, as part of the muslim data script line property, shown in the image on the right.

TOneLineMinicalendarOptions

 

This data structure implements the one line minicalendars options of the minicalendars script line property, as shown in the image on the right, and as implemented by the TCurrentMiniCalOptions 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.

TOverrideLineEndingText

 

This data structure contains the elements that specify if the Text and Tokens to display on each generated line specific Special Case of a specific GenTokens options set, should be overridden and, if so, what text and tokens to use.

 

The TOverrideLineEndingText data structure is, in turn, part of the TLineEndingRec data structure which specifies the Line Endings of a specific GenTokens options set.

TParagraphAttributesRec

 

This data structure implements the paragraph attributes settings of the results of macros and SARAs.

 

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-2024 or InDesign, and therefore contains additional features that were not present in QuarkXPress 3.32.

TParagraphFormatsRec

 

This data structure contains the Formats part of the TParagraphAttributesRec data structure, as shown in the image on the right, and which implements the paragraph attributes settings of the results of macros and SARAs.

 

The other 2 data structures contained in the TParagraphAttributesRec data structure, are the TParagraphTabulationsRec and the TParagraphRuleAboveBelowRec data structures.

TParagraphRuleAboveBelowRec

 

This data structure contains the Rules part of the TParagraphAttributesRec data structure, as shown in the image on the right, and which implements the paragraph attributes settings of the results of macros and SARAs.

 

The other 2 data structures contained in the TParagraphAttributesRec data structure, are the TParagraphFormatsRec and the TParagraphTabulationsRec data structures.

TParagraphTabulationsRec

 

This data structure contains the Tabs part of the TParagraphAttributesRec data structure, as shown in the image on the right, and which implements the paragraph attributes settings of the results of macros and SARAs.

 

The other 2 data structures contained in the TParagraphAttributesRec data structure, are the TParagraphFormatsRec and the TParagraphRuleAboveBelowRec data structures.

TPhysicalPagesRule

 

This data structure represents one of the physical sections rules of the TPhysicalPagesRules data structure contained in the Physical Sections script line property of the BookFormat script line.

 

The various ways in which these rules can be defined are shown in the screenshot on the right.

TPhysicalPagesRules

 

This data structure represents the set of 1 to 15 TPhysicalPagesRule that are part of the definition of a physical section contained in the Physical Sections script line property of the BookFormat script line.

TPhysicalSectionsBlobItem

 

This data structure represents the entirety of the definition of a physical section contained in the Physical Sections script line property of the BookFormat script line.

 

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.

TPictureboxAttr

 

This data structure describes the settings that can be applied to an image being inserted in the place of a text box, due to an image token, a slogan token, a holiday token, macros resulting actions, saras resulting actions, as well as for the picturebox options of pdf pages script lines.

 

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.

TPlanetsOptionsRec

 

This data structure contains all the settings and options of the Planets page of the Moon and Sun Options script line property dialog, as shown on the right.

 

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.

TRepeatDatesList

 

This data structure contains all the settings and options of the dates (repeating) script line property dialog, as shown on the right.

 

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.

TRuleAboveBelow

 

This data structure, as shown on the right, contains all the values and settings of either a rule above or a rule below structure of a TParagraphAttributesRec data structure as used in the paragraph attributes settings of the results of macros and SARAs.

 

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.

TRuleStyle

 

This data structure, as shown in the image on the right, contains the name and internal QuarkXPress or InDesign ID for the rule style being used in the current containing TRuleAboveBelow data structure.

TSaintsOptionsRec

 

This data structure contains the options and settings of one of the 5 tabs of the saints/namedays options script line property dialog, as shown on the right.

 

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.

TSaintsSets

 

This data structure contains the holidays set IDs of all 5 of the aeiou-holidays available saints tokens, as selected in the saints/namedays script line property dialog shown on the right.

TSeasonsDisplayRec

 

This data structure contains all the settings of either the Season or the Solstices group of options of the seasons tab of the Moon and Sun Options script line property dialog, as shown on the right.

 

The structure of these 2 sets of options is the same, thus the use of the same data structure.

TSeasonsSymbolsAndNames

 

This data structure contains the list of names and symbols to use to display either the seasons tokens or Solstice and Equinoxes tokens, using the options of the seasons tab of the Moon and Sun Options script line property dialog, as shown on the right.

 

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.

TShowAboveBelowWhen

 

This data type is part of the TAboveBelowHorizonRec data structure, and it specifies when the tokens [sab], [mab] and [plXab], should display some text, instead of times, on dates when the Sun or the Moon or one of the planets is above or below the horizon all day.

 

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).

TSloganRuleRec

 

This data structure, corresponds to the right-side of the slogan rules script line property editor, as shown on the right, and contains the list of all the options and settings that control the behavior of one of  the slogan tokens of the current diary grids script line.

 

Each of the 15 possible TSloganRuleRec data structure is in turn contained in the TSloganRulesInfo data structure.

TSloganRulesInfo

 

This data structure, corresponds to the left-side of the slogan rules script line property editor, as shown on the right, and contains the list of all of  the options and settings that control the behavior of all the slogan tokens of the current diary grids script line.

 

The TSloganRulesInfo data structure contains up to 15 different TSloganRuleRec data structures.

TStartOfWeekOptions

 

This data structure corresponds to the [sw] token set of options, located at the top left of the grid options script line property dialog, as shown on the right.

 

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.

TSummerTimeOptionsRec

 

This data structure contains all the settings of Summer Time group of options of the daylight tab of the Moon and Sun Options script line property dialog, as shown on the right.

TSunCalcOptions

 

This data structure implements the calculation options part of the Sun data source script line property, as shown in the screenshot of the corresponding property editor, on the right, and implemented by the TSunDataSource data structure.

 

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.

TSunSourceIDs

 

This data structure holds the list of Sun set IDs used in the Sun data source script line property, as shown in the screenshot of the corresponding property editor, on the right, and implemented by the TSunDataSource data structure.

TTabsBoxOptions

 

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.

TTabsMonthOptions

 

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.

TTemplateColors

 

This data structure corresponds to the templates color set of options, located in the grid options script line property dialog, as shown on the right.

 

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.

TTextColumnsAttr

 

This data structure is part of the TBoxTextAttr data structure that implements the text in box attributes used in macros text in box results and SARAs text in box changes.

TTextFrameRec

 

This data structure contains all the settings and options of the text framing type of advanced text formatting, as found in the textual part of the resulting actions of macros and saras.

 

This data structure also exists as TComboTextFrameRec, when it is combined with a TComboTextShadeRec and a TCombinedFrameShadeRec for minicalendar dates framing and shading.

TTextInsetsAttr

 

This data structure is part of the TBoxTextAttr data structure that implements the text in box attributes used in macros text in box results and SARAs text in box changes.

TTextShadeRec

 

This data structure contains all the settings and options of the text background shading type of advanced text formatting, as found in the textual part of the resulting actions of macros and saras.

 

This data structure also exists as TCombinedFrameShadeRec, when it is combined with a TComboTextFrameRec and a TCombinedFrameShadeRec for minicalendar dates framing and shading.

TTextStrokeRec

 

This data structure contains all the settings and options of the text stroking type of advanced text formatting, as found in the textual part of the resulting actions of macros and saras.

 

Text stroking is a native way to display 2-color fonts, using normal, monochrome, fonts.

TTextVertAlignAttr

 

This data structure is part of the TBoxTextAttr data structure that implements the text in box attributes used in macros text in box results and SARAs text in box changes.

TTimesDisplayRec

 

This data structure is used throughout the Moon and Sun Options script line property dialog, and is used to specify how to display times obtained from Sun tokens, Moon tokens, zodiac tokens, and planetary tokens.

 

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.

TXtagsFormats

 

This data structure implements the formats paragraph attributes found in GenTokens and Minicalendar Paragraph Formatting and is contained in the TXtagsParagraphFormatting data structure.

TXtagsParagraphFormatting

 

This data structure implements the formats, tabs, and rule above/below, paragraph attributes found in GenTokens and Minicalendar Paragraph Formatting, and is made up of 4 sub-structures: a TXtagsFormats, a TXtagsTabs, and 2 TXtagsRule (one for the rule above and one for the rule below).

TXtagsRule

 

This data structure implements the rule above/below paragraph attributes found in GenTokens and Minicalendar Paragraph Formatting and is contained in the TXtagsParagraphFormatting data structure.

TXtagsTabs

 

This data structure implements the tabs paragraph attributes found in GenTokens and Minicalendar Paragraph Formatting and is contained in the TXtagsParagraphFormatting data structure.

xBoxActions

 

This data structure contains the settings and options of macros resulting box actions.

 

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.

xTextActions

 

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).

 

xTextActionsAttributes

 

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.

TZodiacDisplayRec

 

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.

 

TZodiacSymbolsAndNames

 

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