Files
indd-utils/docs/format/preferences.md
T
aiongg 8b0f46837b feat: write unnamed colours and gradients only when something refers to them
IDML writes a colour or gradient without a name only if a value in the
package refers to it, a gradient stop or tint uses the colour, or the
page item defaults name it in one of the two entry tables of chunk
0x6E07 (objects.md, colours; preferences.md). The graphic part is now
written last, from the references in the other parts; the second table
of chunk 0x6E07 is read.

compare.py, trustworthy pairs: extra values 155,956 -> 33,181 (unnamed
Color -114,734, Gradient -3,498, GradientStop -4,543). 463 values are
no longer reproduced: 10 unnamed colours and 22 unnamed gradients with
their stops that IDML writes though nothing refers to them (open, see
objects.md). Value coverage 92.46 % -> 92.45 %. No conversion or schema
failures; story text 18,509/18,610.

The previous commit (09e87fa), measured alone: extra values 635,511 ->
155,956, value coverage 92.41 % -> 92.46 %; 39 values lost (7 opacity
stops and 8 drop shadows IDML writes with values equal to the style,
5 StrokeWeight, 1 TextColumnFixedWidth).
2026-10-07 22:33:58 +00:00

269 lines
13 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Preferences
Document preferences are chunks of the preferences object (class 0x2202,
one per document). The converter reads them in `src/model/prefs.rs` and
writes them to `Resources/Preferences.xml` and `designmap.xml`. Values it
does not read stay as observed (`idml-values.md`).
**Evidence.** Each field was compared with the IDML of every corpus pair
(654 pairs, 495 of them trustworthy; `docs/measurement.md`). The counts
below are pairs whose IDML has the value the field gives. Where a pair
disagrees, it is a stale pair unless stated. The layouts are those of
InDesign 7 (CS5) to 21, the versions the pairs show; the converter reads
them for little-endian files of version 7 and later only.
Booleans stored as a u16 are 0 (`false`) or 1 (`true`). Several of them
are chunks that only some documents have; a document without the chunk
has the value given as "absent".
## Colour settings (`Document` in designmap.xml)
| Chunk | Layout | IDML |
|---|---|---|
| 0x7C44 (12 bytes) | Three four-character codes, each stored reversed. The first is `off ` in all 654 files. The second is the RGB policy, the third the CMYK policy | `RGBPolicy`, `CMYKPolicy` |
| 0x7C04 | u16 0, u32 *n*, *n* UIDs of profile objects (class 0x7D03), u32 6, then 6 UIDs: the RGB working profile, the CMYK working profile, and four more | `RGBProfile`, `CMYKProfile` |
| 0x7C08 (6 bytes) | u16 at 2: rendering intent | `SolidColorIntent`, `AfterBlendingIntent`, `DefaultImageIntent` |
Policy codes (as read, reversed): `off ` `ColorPolicyOff`, `pres`
`PreserveEmbeddedProfiles`, `pdil` `CombinationOfPreserveAndSafeCmyk`,
`conv` `ConvertToWorkingSpace`. Both policies match in 495 of 495
trustworthy pairs and 654 of 654 pairs.
A profile is the in-object string at offset 1 of chunk 0x13C of its
0x7D03 object (`U.S. Web Coated (SWOP) v2`, `sRGB IEC61966-2.1`, ...).
UID 0 is written `$ID/`. Matches: RGB 495 of 495 trustworthy and 653 of
654 pairs, CMYK 495 of 495 and 654 of 654. The profile names are stored
in the INDD, so they describe the document, not the computer that
exported it.
Intent codes: 11 `UseColorSettings` (136 files), 0 `Perceptual` (1
file), 2 `RelativeColorimetric` (1 file). The 516 files without the
chunk all have `UseColorSettings`. In every file the three intents are
equal, so the one code is written for all three.
`AccurateLABSpots` is `false` in all 654 IDML files; no field for it was
looked for. The converter writes `false`.
## View (`ViewPreference`)
Chunk 0x1202 (56 bytes in all 654 files):
| Offset | Type | Attribute |
|---|---|---|
| 0 | u32 unit | `HorizontalMeasurementUnits` |
| 4 | u32 unit | `VerticalMeasurementUnits` |
| 8 | u32 unit | `TypographicMeasurementUnits` |
| 12 | u32 unit | `TextSizeMeasurementUnits` |
| 16 | u32 unit | `PrintDialogMeasurementUnits` |
| 20 | u32 unit | `LineMeasurementUnits` and `StrokeMeasurementUnits` |
| 24 | f64 | `HorizontalCustomPoints` |
| 32 | f64 | `VerticalCustomPoints` |
| 40 | f64 | `CursorKeyIncrement` |
| 48 | f64 | `PointsPerInch` |
Unit codes: 0x1201 `Points`, 0x1202 `Picas`, 0x1203 `Inches`, 0x1205
`Millimeters`, 0x1206 `Centimeters`, 0x120B `Pixels`, 0x5101 `Ha`,
0x510F `Q`. Every field matches 495 of 495 trustworthy pairs; the
horizontal, vertical, line and stroke units match 653 of 654 pairs (one
stale pair differs).
## Flags in their own chunks
| Chunk | Attribute | Absent | Matches (trustworthy, all) |
|---|---|---|---|
| 0x593 | `ViewPreference` `ShowFrameEdges` | `true` | 490 of 495, 649 of 654 |
| 0x803 | `ViewPreference` `ShowRulers` | `true` | 493 of 495, 642 of 654 |
| 0x56A | `GridPreference` `BaselineGridShown` | `false` | 495 of 495, 654 of 654 |
| 0x569 | `GuidePreference` `GuidesLocked` | `false` | 495 of 495, 654 of 654 |
| 0x56B | `DocumentPreference` `ColumnGuideLocked` | `true` | 495 of 495, 654 of 654 |
| 0xCAC7 | `TextPreference` `ShowInvisibles` | `false` | 495 of 495, 654 of 654 |
Every file with the chunk matches. The mismatches are files without it
whose IDML has the other value (5 and 12 files), so these two settings
are stored somewhere else as well in some documents; that place is not
known.
## Document setup (`DocumentPreference`)
Chunk 0x533 (146 bytes) also holds the page size, facing pages, intent
and page binding (`objects.md`, document preferences). Its bleed and
slug offsets are rectangles in the order inside (left), top, outside
(right), bottom:
| Offset | Type | Attribute |
|---|---|---|
| 70, 78, 86, 94 | f64 | `DocumentBleedInsideOrLeftOffset`, `…TopOffset`, `…OutsideOrRightOffset`, `…BottomOffset` |
| 102 | u8 | `DocumentBleedUniformSize` |
| 104, 112, 120, 128 | f64 | `SlugInsideOrLeftOffset`, `SlugTopOffset`, `SlugRightOrOutsideOffset`, `SlugBottomOffset` |
| 136 | u8 | `DocumentSlugUniformSize` |
In the 645 files with the 146-byte chunk, 42 have bleeds that are not
all equal. The inside and outside bleeds match only at 70 and 86 (645 of
645 files but one stale pair), and the slugs: inside only at 104, bottom
only at 128. No sample has top and bottom bleeds that differ, or top and
outside slugs that differ; the order of those pairs follows the order
the other fields show. Uniform flags: 645 of 645 files (`DocumentBleedUniformSize`
false in 42, `DocumentSlugUniformSize` true in 3).
## Grids (`GridPreference`)
Chunk 0x55F (36 bytes in all 654 files): f64 at 2 `BaselineDivision`,
f64 at 10 `BaselineStart`, f64 at 18 the view threshold as a fraction
(`BaselineViewThreshold` is it times 100). 654 of 654 pairs each.
Chunk 0x545 (16 files): f64 at 8 `HorizontalGridlineDivision`, u32 at
16 `HorizontalGridSubdivision`, f64 at 20 `VerticalGridlineDivision`,
u32 at 28 `VerticalGridSubdivision`; 16 of 16. Of the 638 files without
it, 627 have 72 and 8 for both directions, which the converter writes;
11 have other values stored elsewhere.
## Watermark (`WatermarkPreference` in designmap.xml)
Chunk 0x16344 (621 files): from offset 10, the font family and the font
style, each a u32 length in code units followed by text segments, then
u32 point size and u32 UID of an interface colour (`objects.md`,
interface colours), written as `WatermarkFontColor`. Family, style and
size match 621 of 621. The 33 files without the chunk are left with the
observed values only.
## Text defaults (`TextDefault`)
Chunk 0x23F of the preferences object is a text attribute list in the
layout of a style's list (u16 count, then records; `attributes.md`). The
converter writes it as `TextDefault` with the same attribute table as
styles. Over all pairs this reproduces 182,742 of 196,543 `TextDefault`
values, against 159,982 from the observed values alone; no attribute
reproduced before is lost. As for paragraph styles, `KerningValue` is
left out: the schema does not allow it there.
## Text (`TextPreference`, `TextFramePreference`)
Chunk 0x280 (174 bytes in InDesign 7, 212 in 8 to 14, 214 from 15):
| Offset | Type | Attribute |
|---|---|---|
| 0 | f64 | `SmallCap` |
| 8, 16 | f64 | `SuperscriptSize`, `SubscriptSize` |
| 24, 32 | f64 | `SuperscriptPosition`, `SubscriptPosition` |
| 40 | f64 | `TextFramePreference` `TextColumnGutter` |
| 88 | f64 | `LeadingKeyIncrement` |
| 96 | f64 | `BaselineShiftKeyIncrement` |
| 104 | f64 | `KerningKeyIncrement` divided by 1000 |
| 112 | u32 | `TextFramePreference` `TextColumnCount` |
| 118 | u8 | `TypographersQuotes` |
| 130 | u8 | `LinkTextFilesWhenImporting` |
| 142 | u8 | `TextFramePreference` `FirstBaselineOffset`: 0 `LeadingOffset`, 1 `AscentOffset`, 2 `CapHeight`, 3 `EmboxHeight`, 4 `XHeight` |
| 162 | u8 | `UseParagraphLeading` |
| 184 | u8 | `QuoteCharactersRotatedInVertical` (212 bytes and more) |
| 212 | u8 | `ShapeIndicAndLatinWithHarbuzz` (214 bytes) |
Each matches all 654 pairs that have the attribute (288 for the last,
645 for the one before), and the two positions match each other's
attribute too, except where the files show different values: positions
differ in 2 files, which tells 24 from 32; the sizes are equal in every
file, so 8 and 16 follow the order of the positions. Offsets 168 and 170
match both `UseCidMojikumi` and `UseNewVerticalScaling`, which are equal
in every file; they are not written.
Chunk 0x28BE (14 bytes, 16 from InDesign 18), u8 flags: 4
`SmartTextReflow`, 6 `LimitToMasterTextFrames`, 8 `DeleteEmptyPages`, 10
`PreserveFacingPageSpreads`, 12 `SmartTextReflowSync` (16 bytes). 620 of
620 files with the chunk (283 of 283 for the last). The 34 files without
it have `SmartTextReflow="false"` and `LimitToMasterTextFrames="true"`.
Chunk 0x3768 (4 bytes), u8 at 2: `ZOrderTextWrap`; 654 of 654.
## Margins and columns of new pages (`MarginPreference`)
Chunk 0x550: f64 `Left`, `Top`, `Right`, `Bottom` at 0, 8, 16, 24 (528
of 528 files). The 126 files without it have 36 for all four.
Chunk 0x555: u32 `ColumnCount` at 0, f64 `ColumnGutter` at 4 (119 of
119). Without it, `ColumnCount` is 1 (535 of 535) and `ColumnGutter` 12
(526 of 535; 9 files have another gutter stored elsewhere).
## Anchored objects (`AnchoredObjectSetting`)
Chunk 0x2800, as anchors and object styles have (`objects.md`): 527
files. `VerticalAlignment` and the two groups of fields described there
match 527 of 527. The 127 files without the chunk have
`VerticalAlignment="TopAlign"`.
## Pasteboard (`PasteboardPreference`)
Chunk 0x5D2: f64 horizontal and vertical margin at 0 and 8, written as
`PasteboardMargins`; the vertical one is also
`MinimumSpaceAboveAndBelow`. 130 of 130 files with the chunk; the 524
without it have `-1 72` and 72, except one stale pair. Four u32 UIDs of
interface colours follow; the IDML colours (`LightGray`, `GridBlue`) are
not in the table of `objects.md`, so they are not written.
## Default XML tags (`XMLPreference`)
Chunk 0xBF4F: five entries, each a name (u32 length, text segments) and
the u32 UID of an interface colour: the story, table, untagged
(`[None]`, not in IDML), cell and image tags. `DefaultStoryTagName`,
`DefaultTableTagName`, `DefaultCellTagName` and `DefaultImageTagName`
match 654 of 654; the names are in the language of the InDesign that
made the document (`Story`, `Article`, `Textabschnitt`, ...). The
colours are written as `Default…TagColor`.
## Grids in back
Chunk 0x567 (u16, 53 files): `GridPreference` `GridsInBack`; 53 of 53.
The 601 files without it have `true`.
## Page item defaults (`PageItemDefault`, `FrameFittingOption`)
The object of class 0x6E07 has a chunk 0x6E07: u32, u32, u32 *n*, *n*
12-byte entries, then a page item attribute list (u32 count, records;
`attributes.md`), then u32, u32, u32 *m* and *m* entries of the same
layout. An entry is u32 class, u32 UID, u32 UID. In every sample the
first table has entries for classes 0x1F05 (colour), 0x5503 (gradient),
0x5533, 0x6E0B (`None`) and 0x6E11. The entries name the unnamed colours
and gradients that IDML writes though nothing refers to them
(`objects.md`, colours). The list has the attribute IDs of page
items. Written with the page item attribute table, it gives
`PageItemDefault` `StrokeWeight` in 628 of 628 files in which an
analysis script found the list; over all pairs the converter reproduces
`StrokeWeight`, `CornerRadius` and `MiterLimit` of every file, and the
frame fitting attributes of the list are written to the preference
`FrameFittingOption`.
## Print settings (`PrintPreference`, `PrintBookletPrintPreference`)
Chunk 0xA4C holds the print settings and chunk 0xAF2 those of booklet
printing, in the same layout. Its start, in order (a "string" is a flag
byte, 1 for a built-in key, then an in-object string):
| Field | IDML |
|---|---|
| u8 1 if a print record follows, u8, u32 length *n*, *n* bytes | `PrintRecord`: `$ID/` and the bytes in base64, 76 characters per line, a line feed after every full line |
| 6 bytes with a print record, 2 without | |
| String | `ActivePrinterPreset`: built-in `kPrSt_DefaultName` is `Default`, built-in empty `Custom`, otherwise the name (string) |
| u32 | `PrintTo`; `PrintToDisk` is `true` when it is 2 |
| String | `Printer`: built-in `kPrepress File` is `PostscriptFile`, otherwise the name |
| String | not identified (empty in every file) |
| String | `PPD`: built-in `kDevice Independent` is `DeviceIndependent`, built-in empty the string `$ID/`, otherwise the name |
| String | `PPDFile` (`$ID/` and the text for a built-in string) |
| u32 | `PostScriptLevel`: 2 `Level2`, 3 `Level3` |
| f64 | `PrintResolution` |
| 4 f64 | `PaperSizeRect`: left, top, right, bottom |
| 4 f64 | `ImageablePaperSizeRect`: left, top, right, bottom |
| i32, then a string | `PaperSize`: −3 the string, −2 `DefinedByDriver`, −1 `Custom` |
After that string, at these offsets from its end: f64 −1 at 0 and 24
(`PaperWidth` and `PaperHeight` are `Auto` in every file), f64 pairs at 8
and 32 (`PaperWidthRange`, `PaperHeightRange`), u16 at 84
(`PrintPageOrientation`: 0 `Portrait`, 1 `Landscape`), u32 at 104
(`Copies`), u8 at 118 (`PrintBlankPages`). The rest of the chunk (marks,
bleeds, screening, colour output, scaling and the paper size selector) is
not decoded.
Evidence: every field above matches in all 654 pairs for both chunks,
except `PPD` (653, one built-in key written as a string in IDML),
`Printer` of booklets (653) and `PPDFile` of booklets (652). The paper rectangles are written as IDML
writes them: with the digits of the shortest form that reads back, the
last rounded half to even from the exact value (583.2000122070312, not
…313).