Customize global variables for your publications

Build 1501 on 14/Nov/2017  This topic last edited on: 9/Nov/2017, at 16:17

There's a number of global variables you may want to customize before using the GN4 system.

All variables listed below are defined in add-ins scripting with their default values (EdConfig class in Ted.vb). If a variable does not appear in the EditorialConfig, a default value is used.

If you need values to be different than the default values, for each such value add a line to the <Dict>  node in the EditorialConfig.

Click to toggle expandChange the variable value

Run EdAdmin4, click Client applications under Application Configuration, locate EditorialConfig and double-click it.

Look under the <Dict> node if there's already a line with the variable you want to change.

A line format is:

<Item Name="variable_name" Value="your_value" />

Change the your_value to what is suitable for you.

For Boolean variables, use "0" for false, and "-1" for True.

Notes

•If changing bulletsMenuChars, have in mind that you need to adjust also bulletsMenuLabels, and perhaps also globBullFnt and globBullInd.

•If changing names of article elements (bodyname, headname, etc), have in mind that the values must correspond to the names in the GN4.XSD schema.

Add a new line on the end of the list in the <Dict> node, but above the </Dict> statement.

A line format is:

<Item Name="variable_name" Value="your_value" />

Enter the variable name as specified in the Reference. Set your_value to what is suitable for you.

For Boolean variables, use "0" for false, and "-1" for True.

Notes

•If adding line for bulletsMenuChars, have in mind that you need to adjust also bulletsMenuLabels, and perhaps also globBullFnt and globBullInd.

•If adding lines for names of article elements (bodyname, headname, etc), have in mind that the values must correspond to the names in the GN4.XSD schema.
Click to toggle expandReference of existing variables

VARIABLE

TYPE

DESCRIPTION

DEFAULT VALUE

audioname

String

Name of the article audio element as in schema

"audioCaption"

blogpostname

String

Name of the blog post element as in schema

"blogPost"

bodyname

String

Name of the body element as in schema

"body"

BoxPreset00..15

String

Box preset string

See Ted.vb

bulletsMenuChars

String

Bullet characters string. Bullet characters appear as normal font, but indeed are referred to the font, specific in the style pointed by sBulletString1 global variable.

Must have the same number of members as bulletMenuLabels and correspond to the meaning of labels.

"l,n,m,o,3,4,F,G,H,I,J,p,q,r,u,v,â,ã,ä"

bulletsMenuLabels

String

Bullet menu entries.

Must correspond to the bulletsMenuChars, ie. to have the same number of members and that the meaning of labels corresponds to the characters specified in bulletsMenuChars.

 

See also globBullFnt and globBullInd.

"Black round,Black square,White round,White square,Tick,Tick bold,Diamond filled,Diamond hollow,Star filled,Star hollow,Star circle,White square shadow up,White square shadow down,White square shadow up light,Romb,Four rombs,Arrow 1,Arrow 2,Arrow filled"

bylinesstyles

String

A string that describes the byline styles: name, first line style, second line style (for bylines in two lines), three-letter code (F for user’s fullname - for first style, M=mail, D=description [for second line]; use # as a placeholder, e.g. FM#), byline prefix or # if no prefix.

"Simple,by01a,#,F##,#,Two-lines,by01,by02,FM#,#"

cPt

String

Default point. Change it to dd for some European installations.

"pt"

F_JumpBotC

String

name of the jump head element as in schema

empty string

F_JumpBotH

String

height of the bottom jumpline

"20pt"

F_JumpBotM

String

margin of the bottom jumpline

"0pt"

F_JumpBotT

String

tags of the bottom jumpline

empty string

F_JumpTopC

String

name of the main headline element as in schema

empty string

F_JumpTopH

String

height of the top jumpline

"20pt"

F_JumpTopM

String

margin of the top jumpline

"0pt"

F_JumpTopT

String

tags of the top jumpline

empty string

glbAppLocalTextProcessing

Integer

0-prompt, 1-clear, 2-jumpline, 3-insert on top, 4-insert on bottom

"-1"

glbArchivedWorkstateId

Integer

id of the workstate named Archived

"-1"

glbArchivePrintConfig

String

name of print config for archiving

"PDFVariantArchive"

glbArtMergeDefAction

Integer

the menu command for the article merge

"-1"

glbBDefCopyFolder

String

default copy folder when copying from book

empty string

glbBIfContains

String

ARTICLE COPY DIALOG FOR PAGECOPY: if name "contains" string

empty string

glbBIfEndsWith

String

ARTICLE COPY DIALOG FOR PAGECOPY: if name "ends" with string

empty string

glbBIfStartsWith

String

ARTICLE COPY DIALOG FOR PAGECOPY: if name "starts" with string

empty string

glbBNameDelimiter

String

default name delimiter

"_" underscore character

glbBodyMinH

Integer

Miminum allowed height of body frame when adding objects through AddObjectAuto script

"100000" (mpt)

glbBodyMinM

Integer

The multiplier for min height of the body element (GetVG * glbBodyminM, if glbDefaultsHavePriority is false, default is 10

"10"

glbBPrefix

String

ARTICLE COPY DIALOG FOR PAGECOPY: article name prefix string

empty string

glbBReplaceContains

String

ARTICLE COPY DIALOG FOR PAGECOPY: replace "contains" string

empty string

glbBReplaceEndsWith

String

ARTICLE COPY DIALOG FOR PAGECOPY: replace "ends" string

empty string

glbBReplaceStartsWith

String

ARTICLE COPY DIALOG FOR PAGECOPY: replace "starts" string

empty string

glbBSuffix

String

ARTICLE COPY DIALOG FOR PAGECOPY: article name suffix string

empty string

glbDefaultsHavePriority

Boolean

Defines if glbKickerH and other similar values have priority over multipliers of VG, when adding frames for article elements on page through AddObjectAuto, default is 0, means "won't be used"

"0"

glbDescStyle

String

obsolete

"by01"

glbEDefCopyFolder

String

default copy folder when copying from book - apparently not used!

empty string

glbEIfContains

String

ARTICLE COPY DIALOG FOR PAGECOPY: if name "contains" string

empty string

glbEIfEndsWith

String

ARTICLE COPY DIALOG FOR PAGECOPY: if name "ends" with string

empty string

glbEIfStartsWith

String

ARTICLE COPY DIALOG FOR PAGECOPY: if name "starts" with string

empty string

glbEPrefix

String

ARTICLE COPY DIALOG FOR PAGECOPY: article name prefix string

empty string

glbEReplaceContains

String

ARTICLE COPY DIALOG FOR PAGECOPY: replace "contains" string

empty string

glbEReplaceEndsWith

String

ARTICLE COPY DIALOG FOR PAGECOPY: replace "ends" string

empty string

glbEReplaceStartsWith

String

ARTICLE COPY DIALOG FOR PAGECOPY: replace "starts" string

empty string

glbESuffix

String

ARTICLE COPY DIALOG FOR PAGECOPY: article name suffix string

empty string

glbHeadH

Integer

AddObjectAuto: default headline height

"60000" (mpt)

glbHeadM

Integer

AddObjectAuto: the multiplier for height of the head element (GetVG * glbHeadM, if glbDefaultsHavePriority is false, default is 6

"6"

glbIntroH

Integer

AddObjectAuto: default intro height

"30000" (mpt)

glbIntroM

Integer

he multiplier for height of the intro element (GetVG * glbIntroM, if glbDefaultsHavePriority is false, default is 3

"3"

glbKickerH

Integer

AddObjectAuto: default kicker height

"30000" (mpt)

glbKickerM

Integer

the multiplier for height of the kicker element (GetVG * glbKickerM, if glbDefaultsHavePriority is false, default is 3

"3"

glblinkwithoutcrop

Boolean

If "-1", in OnDrop function of Page.vb causes AddImageToArticleNoCrop to be called by default when dragging.

"0"

glbMinVertGrid

Integer

A threshold to consider the VG to be 0 - if less of this value, it is considered as "not set".

"5000" (mpt)

glbNameStyle

String

obsolete

glbPhotoH

Integer

height of the photo element

"60000" (mpt)

glbPhotoM

Integer

the multiplier for height of the photo element (GetVG * glbPhotoM, if glbDefaultsHavePriority is false, default is 6

"6"

glbpncode

Integer

PERSONAL INLINE NOTES: in J library must exist a character style whose tag name is defined in glbpntag variable, e.g glbpntag = "pn", that character style must use the remcode, whose number is defined in glbpncode, e.g. glbpncode = 2

"2"

glbpntag

String

see above

"pn"

glbPullQuoteH

Integer

height of the pull quote element

"40000" (mpt)

glbPullQuoteLRM

String

left/right margin of auto-inserted pull quote. If auto, then LRM = CInt(Page.GetInterCol / 2)

"auto"

glbPullQuoteM

Integer

the multiplier for height of the pullquote element (GetVG * glbpullquoteM, if glbDefaultsHavePriority is false, default is 4

"4"

glbPullQuoteTBM

String

top/bottom margin of auto-inserted pull quote. If auto, then TBM = GetVG()

"auto"

glbReplaceNonDummyImg

Boolean

replace non dummy images

"0"

glbReverseFormatSuffix

String

white-on-black (reverse) format suffix. If you want to switch quickly between black on white and white on black text, duplicate a format and add the suffix to its name. Set the default text color as white.

"-W"

glbStoryEndBegCurPosition

Integer

displays the menu command for the article merge if -1, otherwise uses the value specified as the menu command: "0" = end of text, "1" = beginning of text, "2" = cursor position.

"-1"

glbsubHeadH

Integer

height of the subhead element

"30000" (mpt)

glbsubHeadM

Integer

the multiplier for height of the subhead element (GetVG * glbsubHeadM, if glbDefaultsHavePriority is false, default is 3

"3"

glbToArchiveWorkstateId

Integer

id of the workstate named ToArchive

glburltag

String

Used by sysUrlLink to insert a clickable Web link in text (effective on Web)

"link"

glbUseRunaroundWhenAddingCaption

Boolean

Used in AddCaptionToImage to apply runaround when creating captions

"-1"

glbuseSectionFolder

Boolean

Used in OnToolCreateNewArticle to use section folder (from defaultFolderRef) for the new articles.

"0"

glbVertGrid

Integer

Used in GetVG to return non-zero value if all other computes to 0.

"10000" (mpt)

glbWarnOnVGrid0

Boolean

Used in OnPageOpen to warn if the page has VG=0

"0"

globalSpikeDelElt

Integer

Controls if the removed article element must be automatically deleted.

"1"

globalUseModulesAsVg

Boolean

If "-1" then modules are used as VG instead of page.getvertgrid.

"0"

globBullFnt

Integer

bullet font number

"201" in 1.4 and earlier, "0" in 1.4.1510 and newer

globBullInd

Integer

default indent for hanging bullets

"8535"

headname

String

article element name as in schema

"head"

introname

String

article element name as in schema

"intro"

kickername

String

article element name as in schema

"kicker"

photoname

String

article element name as in schema

"photoCaption"

previewmode

String

parameter for Page.pagepreview.

"s400"

previewmodedummy

String

parameter for Page.pagepreview.

"s800d"

PrintRegion

 

(since 1.4.1509)

String

Used in EditFontStylePrintOnly to set print text only, typography-sensitive.

For usage and customizing, see Routing parts of text only to print edition

 

","

PrintRegionId

Integer

"1899" in 1.4 and earlier, "0" in 1.4.1510 and newer-

pullquotename

String

article element name as in schema

"pullQuote"

sBulletString1

String

bullet tag name

">pbullet<"

smsbodyname

String

article element name as in schema

"smsBody"

sNumberString1

String

numbering style tag name

">pnumber<"

subheadname

String

article element name as in schema

"subHead"

titleCaseStopWords

String

Used in EditTitleCaseToggle

"a,and,at,be,but,in,it,not,of,on,or,the,to,with"

urlname

String

article element name as in schema

"urlCaption"

videoname

String

article element name as in schema

"videoCaption"

webbodyname

String

article element name as in schema

"webBody"

webheadname

String

article element name as in schema

"webHead"

WebRegion

 

(since 1.4.1509)

String

Used in EditFontStyleWebOnly to set print text only, typography-sensitive.

For usage and customizing, see Routing parts of text only to Web channel.

","

WebRegionId

Integer

"9419" in 1.4 and earlier, "0" in 1.4.1510 and newer-

See also

About global overridable variables

Edit EditorialConfig