Adobe 65009333 User Guide - Page 106

Planning conditional documents, Number of versions, Number of condition tags required

Page 106 highlights

USING INCOPY CS4 100 Text Planning conditional documents When planning a project with conditional text, examine the nature of the material and look at how several people can take turns working with it if the document is handed off. Plan to treat conditional text consistently to make the document easier to use and maintain. Use the following guidelines. Number of versions Define how many versions your finished project will contain. For example, if you're creating a manual that describes a program that runs on both Windows and Mac OS platforms, you might want to produce at least two versions: a Windows version and a Mac OS version. If you want to produce these versions with editorial comments sprinkled in the text during the review process, you'll want even more versions: Mac OS with comments, Mac OS without comments, Windows with comments, and Windows without comments. For documents with many conditions, you can define condition sets that can be applied to the document for quick versioning. Number of condition tags required Decide how many condition tags you need to produce the desired versions. A version of a document is defined by a unique set of condition tags. For example, a version of a finished Windows manual might be defined by having a Windows condition tag showing, a Mac OS condition tag hidden, and a Comments condition tag hidden. In this example, you would need to decide whether to use one condition tag for Windows comments and another for Mac OS comments, or whether to use a single condition tag for both Windows and Mac OS comments. Organization of content Evaluate the extent to which the document can be conditional and how you can organize the material to simplify development and maintenance. For example, you might be able to organize a book so that conditional text is limited to a few documents. Or you might choose to keep versions of a particular chapter in separate files rather than in conditional text, and then use a different book file for each version of the book. In some instances, such as when working with multiple languages, you may want to create separate layers that you can show or hide rather than using conditions, with each layer including text from a different language. Tagging strategy Determine the smallest unit of conditional text. For example, if a document will be translated to another language, a whole sentence should be the smallest amount of text you make conditional. Because word order often changes during translation, using conditional text for part of a sentence could complicate translation. Inconsistency in applying conditions to spaces and punctuation can result in extra spacing or misspelled words. Decide whether to make spaces and punctuation conditional. If conditional text begins or ends with punctuation, make the punctuation conditional too. This makes the text easier to read when you're viewing more than one version. To avoid word spacing problems, such as having an unconditional space followed by a conditional space, set standards for handling spaces following conditional text (either always conditional or always unconditional). To avoid confusion, decide the order in which conditional text will appear and use this order throughout the document. Indexes and cross-references When indexing a document, pay attention to whether index markers are placed inside or outside conditional text. Keep in mind that index markers in hidden conditional text are not included in the generated index. If you create a cross-reference to conditional text, make sure that the source text has the same condition. For example, if you add a cross-reference in a "Windows" paragraph and the text anchor appears in a "Mac" condition, the crossreference is unresolved when the "Mac" condition is hidden. "HT" appears next to the cross-reference in the Hyperlinks panel. If you create a cross-reference to a paragraph in which some text is conditional and then change the visibility settings of that condition, update the cross-reference. Updated 29 April 2009

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298

100
USING INCOPY CS4
Text
Planning conditional documents
When planning a project with conditional text, examine the nature of the material and look at how several people can
take turns working with it if the document is handed off. Plan to treat conditional text consistently to make the
document easier to use and maintain. Use the following guidelines.
Number of versions
Define how many versions your finished project will contain. For example, if you’re creating a
manual that describes a program that runs on both Windows and Mac OS platforms, you might want to produce at
least two versions: a Windows version and a Mac OS version. If you want to produce these versions with editorial
comments sprinkled in the text during the review process, you’ll want even more versions: Mac OS with comments,
Mac OS without comments, Windows with comments, and Windows without comments.
For documents with many conditions, you can define condition sets that can be applied to the document for quick
versioning.
Number of condition tags required
Decide how many condition tags you need to produce the desired versions. A
version of a document is defined by a unique set of condition tags. For example, a version of a finished Windows
manual might be defined by having a Windows condition tag showing, a Mac OS condition tag hidden, and a
Comments condition tag hidden. In this example, you would need to decide whether to use one condition tag for
Windows comments and another for Mac OS comments, or whether to use a single condition tag for both Windows
and Mac OS comments.
Organization of content
Evaluate the extent to which the document can be conditional and how you can organize the
material to simplify development and maintenance. For example, you might be able to organize a book so that
conditional text is limited to a few documents. Or you might choose to keep versions of a particular chapter in separate
files rather than in conditional text, and then use a different book file for each version of the book.
In some instances, such as when working with multiple languages, you may want to create separate layers that you can
show or hide rather than using conditions, with each layer including text from a different language.
Tagging strategy
Determine the smallest unit of conditional text. For example, if a document will be translated to
another language, a whole sentence should be the smallest amount of text you make conditional. Because word order
often changes during translation, using conditional text for part of a sentence could complicate translation.
Inconsistency in applying conditions to spaces and punctuation can result in extra spacing or misspelled words.
Decide whether to make spaces and punctuation conditional. If conditional text begins or ends with punctuation,
make the punctuation conditional too. This makes the text easier to read when you're viewing more than one version.
To avoid word spacing problems, such as having an unconditional space followed by a conditional space, set standards
for handling spaces following conditional text (either always conditional or always unconditional).
To avoid confusion, decide the order in which conditional text will appear and use this order throughout the
document.
Indexes and cross-references
When indexing a document, pay attention to whether index markers are placed inside
or outside conditional text. Keep in mind that index markers in hidden conditional text are not included in the
generated index.
If you create a cross-reference to conditional text, make sure that the source text has the same condition. For example,
if you add a cross-reference in a “Windows” paragraph and the text anchor appears in a “Mac” condition, the cross-
reference is unresolved when the “Mac” condition is hidden. “HT” appears next to the cross-reference in the
Hyperlinks panel.
If you create a cross-reference to a paragraph in which some text is conditional and then change the visibility settings
of that condition, update the cross-reference.
Updated 29 April 2009