9.4.1 Specifying text properties for flags

To specify the properties of a conditional flag:

[ConditionalFlags]
flagname = property1 property2=value property3 ...

The property and property=value assignments are space delimited.

Properties you can assign to flagname include:

Table 9-1 Text properties for flags

Type of property

Property name

Description

* Not implemented yet

Colors

fgcolor

Foreground color

bgcolor

Background color

chcolor

Change-bar color

Typographics

underline

Normal text underline

doubleline

Double underline

numunderline

Numeric underline

overline

Text overline

strike

Strikethrough

italics

Italic; can be combined with bold

bold

Bold; can be combined with italics

Change bars*

change

Show change bars

chcolor

Change-bar color

chchars

Change-bar character(s); punctuation only

Images*

startflag

Image (or text) at start of flagged element

endflag

Image (or text) at end of flagged element

Colors

For colors, the property name is followed by an equals sign, then by the name of a color, or by the #RRGGBB hex value of the color. Color names you can specify include: 

aqua

gray

navy

silver

black

green

olive

teal

blue

lime

purple

white

fuchsia

maroon

red

yellow

For example:

[ConditionalFlags]
whitefore = fgcolor=white
blueback = bgcolor=blue
greenback = bgcolor=green

A flag may have no more than one foreground color and one background color; if both are assigned, the colors must be different. If the colors are the same, a conflict occurs, and the conflicting properties are replaced by the properties of the conflict flag; see §9.4.3 Highlighting conflicting flag properties.

Typographics

Line properties underline, overline, and strike can be combined for a single flag. However, underline, doubleline and numunderline cannot be combined. Properties bold and italics can be combined for a single flag; they can also be combined with a line property.

For example:

[ConditionalFlags]
deleted = italics strike fgcolor=red

Change bars

(Not implemented yet.)

To show change bars, assign property change to a flag. When you assign change, you can also assign the following properties to the change-bar flag:

Property chcolor may be any of the colors listed under Colors, or the #RRGGBB hex value of the color. Property chchars may consist of punctuation characters only.

For example:

[ConditionalFlags]
altered = change chcolor=teal chchars=*!*

Images

You can use a conditional flag to precede and follow an element with images or with text. This can be another way to substitute for change bars in output types such as HTML that do not support change bars. The idea would be to start the revised element with an icon something like >> and end it with <<; or to specify surrounding text such as Start of change and End of change, perhaps in a contrasting color.

For example:

[ConditionalFlags]
altered = startflag endflag fgcolor=red bold

When you assign startflag and endflag, you must also provide links to the images, alternate text to display, or both; see §9.4.2 Providing images and alt text for startflag and endflag.

Previous Topic:  9.4 Configuring conditional flags

Next Topic:  9.4.2 Providing images and alt text for startflag and endflag

Parent Topic:  9.4 Configuring conditional flags

Sibling Topics:

9.4.2 Providing images and alt text for startflag and endflag

9.4.3 Highlighting conflicting flag properties

Table of ContentsIndex