<?tstrikethrough>
Description
This command specifies a strikethrough for text.
The command consists of a parameter to activate the strikethrough, plus a set of keywords that define the line. It can be written in two ways:
1. Activate the strikethrough, then provide the line definition in subsequent commands. Here the line definition keywords are separated from the main PI with an underscore:
<?tstrikethrough 1>
<?tstrikethrough_color red>
<?tstrikethrough_mode 1>
2. Activate the strikethrough and define it in a single instance of the PI. Note that this time the line definition keywords are separate from the main PI in a comma separated list:
<?tstrikethrough 1, color=red, mode=1>
This second method is recommended as it is more efficient for PTC ALD
Syntax
<?tstrikethrough num:n? keyword:b? ( keyword:b )*>
|
num
|
(optional)
|
1
|
Show the strikethrough
|
|
0
|
Hide the strikethrough
|
|
no parameter
|
Use the default setting for the paragraph
|
|
|
keyword
|
(optional)
|
color
|
The color to use when the line is being drawn. If the line is being drawn when the color is changed, the line color will switch to the new color from that position in the stream.
Default: black
|
|
mode
|
The position at which the line is drawn:
• 1: under the text
• 0: over the text (default)
|
|
drawmode
|
The behavior of the line when changes in leading occur:
• 0: draw using the last known values (default)
• 1: draw based on the maximum extent of the area within the rule
• 2: draw based on the leading for the entire line
• 3: draw when font size or leading changes
|
|
bgcolor
|
The color to apply behind the line being drawn when the line is not solid
Default: none.
|
|
thickness
|
The thickness of the line
Default: 0.06h
|
|
offset
|
The position, relative to the baseline, at which to draw the line. A negative value will draw the line above the baseline.
Default: -0.25h
|
|
linestyle
|
The line style to use for drawing the line
Default: solid
Must be declared in double quotes
|
|
startpattern
|
The pattern to use at the start of the line
Default: none
Must be declared in double quotes
|
|
endpattern
|
The pattern to use at the end of the line
Default: none
Must be declared in double quotes
|
|
wordsonly
|
The inclusion of the line for words and spaces
• 0: words and spaces (default)
• 1: words only
|
|
repeatpattern
|
Determines how the start and end patterns should be drawn when a rule is broken across lines, etc.
• 0: the start and end patterns are drawn once, at the appropriate end of the first and last fragment
• 1 (default): the start and end patters are drawn on each fragment of the line
|
|
ignoredir
|
Determines how the rules are drawn when a mixture of left-to-right and right-to-left text is encountered.
• 0 (default): the rule is restarted for each portion of text, start/end patterns are drawn in the appropriate order to the text direction.
• 1: the rule will be drawn as a single rule across all changes in text direction, start/end patterns are drawn in the appropriate paragraph direction.
|
If startpattern and endpattern are used, they are applied to each segment of the line that is drawn. This commonly happens on line breaks, but will also apply if drawmode is set to 3 or if wordsonly is set to 1.
|
Text strikethrough can also be activated with the <?tult> command.
Related Links