Files
indd-utils/docs/format/transparency.md
T
aiongg a299387eb0 feat: decode page item, preference and resource values
Page items:
- drop shadow KnockedOut (0x1EB6F), true where neither item nor style
  stores it
- text wrap: the u32 at 40 of 0x3703 is the master page flag and the
  wrap side (two u16, as the big-endian pair shows)
- groups get the fill, stroke and corner values all their children have
- dashes (0x5A35: list and corner code) on items whose stroke type in
  effect is Dashed
- BeforeGroupingLayerPosition (0x324) from 21.4; export SizeType
  (0x1E22B); no generated alt text attributes on groups
- anchored settings on items inside anchored items
- IgnoreWrap false without the chunk, MinimumFirstBaselineOffset 0 by
  the baseline category, InsetSpacing before DOM 11 by the general
  category; EPS contents from 0x8C23
- custom striped and dashed stroke styles (classes 0xB016, 0x5A43) and
  StrokeType code 0x5A42

Preferences: column direction (0x555, else the story orientation),
optical margin size by the text size unit, highlight flags false without
their chunk, grid and gutter defaults and print marks by the edition
code, watermark font by the assignment name, EPUB ViewDocumentAfterExport
for DOM 8 and 9, HTMLFXLExportPreference from DOM 10.1, MathML document
values from DOM 20, index header type by variant name, three more
built-in kinsoku and mojikumi tables.

Resources and text: the saving edition from the XMP black name (tints
of black, unknown users, endnote and index titles, endnote marker), TOC
style entries, PageNumberType (0x1B09), CustomGlyph (0x1B5E), alignment
codes of 0x4266, 0x1B3E and 0xB676, spot colour alias and DOM 8 section
pagination (observed values), text variable settings and result texts,
object styles' AppliedParagraphStyle without a chunk and flex spacing,
stories of frames anchored in the XML backing story.

Fixes: flattener resolutions of 0x10833 were swapped; colour group Self
follows the DOM version.

compare.py, trustworthy pairs: value coverage 98.96 % -> 99.48 %
(+150,288 values), documents >= 99 % 914 -> 1,021, story text 37,129 ->
37,147 of 37,150 (0 missing), extras 92,838 -> 92,883 (+788 from the
KnockedOut and group-corner exceptions, -744 from fixed extras). No pair
loses values against f21267f. diff_outputs.py: 5,743 of 5,765 outputs
differ, no failure or warning differs.
2026-10-10 18:34:10 +00:00

13 KiB
Raw Blame History

Transparency

Implemented in src/idml/transparency.rs.

Page items keep their transparency settings in their attribute list (chunk 0x6E03, see attributes.md), with attribute IDs in two ranges: 0x108xx and 0x1EBxx. Object styles keep a full list of the same attributes in chunk 0x1B92C (u16 count, then records).

IDML writes them as child elements of the page item: TransparencySetting (the whole object), StrokeTransparencySetting and FillTransparencySetting, each holding one element per effect (BlendingSetting, DropShadowSetting, InnerShadowSetting, GradientFeatherSetting, ...).

How the mapping was checked

IDML writes a setting on a page item only when it differs from the item's object style. So each INDD value was compared with the value in effect:

  1. the value written on the IDML item, if there is one;
  2. otherwise the value of its object style, following BasedOn;
  3. otherwise the default in Resources/Preferences.xml (TransparencyDefaultContainerObject).

The tables count page items of the pairs whose IDML is from the same InDesign version as the INDD. "On the item" means the IDML item states the value itself, which is the evidence that tells the attribute apart. The 576 object styles of the pairs (matched by name) agree with their IDML style on every attribute below.

Values equal to the object style

The converter writes only the values that differ from the object style's (its chunk 0x1B92C, then the styles it is based on), and an effect element only when it has such a value or its opacity stops differ from the style's. Per effect element the converter wrote before this rule, over the 489 trustworthy pairs (D = the attributes whose value differs from the style's effective value; style values followed through BasedOn, then TransparencyDefaultContainerObject):

Element D empty, IDML writes nothing D empty, IDML writes it D not empty, IDML writes exactly D or more
GradientFeatherSetting 6,251 53 2,604
InnerShadowSetting 2,884 0 17
DropShadowSetting 44 8 289
BlendingSetting 1 0 1,616

Where IDML writes more than D (349 elements), the converter already wrote those values. The 53 + 8 elements with D empty that IDML still writes are not explained.

Object transparency (TransparencySetting)

The drop shadow rows of 0x1081B, 0x1081C, 0x1081E, 0x1081F and 0x1084A come from the items of the 1,251 trustworthy pairs of the corpus after 2026-10 that have a DropShadowSetting in IDML, groups included: each ID is the only one whose value equals the IDML value in every item where both exist (after resolving the value through the object style, as below). In the item list 0x1081F is the drop shadow's blend mode; in the document preference list the same number is BlendingSpace, a separate list. With the write rule below, the converter reproduces over the trustworthy pairs 580 of 580 XOffset and YOffset values, 397 of 397 Opacity, 62 of 62 BlendMode and 3 of 3 Spread, with no extra value.

Comparison with the style. IDML writes an item's value when it differs from the style's in any digit: one 15.0 document has 23 text frames with YOffset 7.000000133081193 and a style value of 7, and IDML writes all 23. Comparing the full text of the values changes nothing else in the transparency settings of the trustworthy pairs.

ID IDML Encoding On the item
0x10816 BlendingSetting/Opacity f64, percent 57 items in 4 files (40, 49, 50, 57, 69, 70)
0x10817 BlendingSetting/BlendMode i32 code (below) 56 items in 4 files
0x1081A DropShadowSetting/Mode i32: 0 None, 1 Drop 8 items with 1 in 2 files
0x1081F DropShadowSetting/BlendMode i32 code (below): 0 Normal, 4 SoftLight seen 89 of 89 items in 16 files
0x1081E DropShadowSetting/Opacity f64, percent 424 of 424 items in 78 files
0x1081B DropShadowSetting/XOffset f64 649 of 649 items in 88 files
0x1081C DropShadowSetting/YOffset f64 649 of 649; 256 of these items have X ≠ Y
0x10820 DropShadowSetting/Size f64 6 items, two values; 406 of 406 rectangles and text frames over the 654 pairs of the later corpus
0x1084A DropShadowSetting/Spread f64, percent 28 of 28 items in 9 files
0x10837 DropShadowSetting/EffectColor swatch UID 11 of 11 items in 6 files (below)
0x1EB6F DropShadowSetting/KnockedOut u16: 1 true, 0 false; true where not stored 30,692 of 30,692 items (below)
0x1084D InnerShadowSetting/Applied u16: 1 true, 0 false 10 items with 1
0x1084E InnerShadowSetting/EffectColor swatch UID 10 items (below)
0x10852 InnerShadowSetting/Distance f64 10 items with 0
0x10855 InnerShadowSetting/Size f64 10 items with 2.83
0x1EB8A GradientFeatherSetting/Applied u16: 1 true, 0 false 56 items in 2 files
0x1EB8C GradientFeatherSetting stops list (below) 59 items, 170 stops
0x1EB8D GradientFeatherSetting/Angle f64 1 item (−90)
0x1EB8E GradientFeatherSetting/Length f64 96 items in 3 files
0x1EB8F GradientFeatherSetting/GradientStart two f64 96 items in 3 files
0x1EB91 GradientFeatherSetting/HiliteAngle f64 1 item (−62.2)
0x1EB92 GradientFeatherSetting/HiliteLength f64 1 item (1)

More IDs, found over the 489 trustworthy pairs before 2026-10 by matching the item's attribute list with the IDML value after resolving the value through the object style, BasedOn and TransparencyDefaultContainerObject (each ID is the only one whose value maps one to one onto the IDML value in all rows):

ID IDML Encoding Items
0x10819 BlendingSetting/IsolateBlending u16: 1 true 46 of 46
0x10857 OuterGlowSetting/Applied u16: 1 true 157 of 157
0x10858 OuterGlowSetting/BlendMode i32 code (below; 0, 1, 3, 9 seen) 79 of 79
0x10859 OuterGlowSetting/Opacity f64 144 of 144
0x1085B OuterGlowSetting/EffectColor swatch UID 73 of 73
0x1085D OuterGlowSetting/Spread f64 106 of 106
0x1085E OuterGlowSetting/Size f64 172 of 172
0x1085F InnerGlowSetting/Applied u16 6 of 6
0x10860 InnerGlowSetting/BlendMode i32 code (0, 1 seen) 10 of 10
0x10866 InnerGlowSetting/Size f64 10 of 10
0x108D8 FillTransparencySetting/BlendingSetting/Opacity f64 6 of 6 (100, 40)

IDML writes OuterGlowSetting and InnerGlowSetting after InnerShadowSetting, as the schema lists them. Not identified: the inner glow's Opacity, Spread and EffectColor and the outer glow's Noise. Drop shadow KnockedOut is 0x1EB6F (below).

All items whose value is not on the IDML item (it comes from the style or the default) match as well: for example 743 items for InnerShadowSetting and the gradient feather attributes, with the default values (Applied="false", Distance="7", Size="7", Length="0").

In pairs whose IDML is from an older version, 14 more items match on opacity and blend mode. One item there has 50 where the IDML says 100; that file was probably saved again after the export.

Values outside the schema's range. Four items in a file without an IDML store a drop shadow size of −2.83; the schema allows 0 to 1000. The converter leaves out any value of the attributes above that is outside the schema's range, with a warning: sizes and distances 0–1000, opacity 0–100, angles −180–180.

Blend mode codes. The code is the position of the value in the IDML schema's BlendMode enumeration (Normal, Multiply, Screen, Overlay, SoftLight, HardLight, ColorDodge, ColorBurn, Darken, Lighten, Difference, Exclusion, Hue, Saturation, Color, Luminosity, from 0). Seen: 1 Multiply (3 items), 3 Overlay (62), 9 Lighten (5), and 0 Normal in all 576 object styles, whose IDML blend mode is Normal; over the 489 trustworthy pairs before 2026-10 also 2 Screen (7 items), 4 SoftLight (10), 5 HardLight (12), 7 ColorBurn (3), 14 Color (3) and 15 Luminosity (7), 42 of 42. The converter writes all sixteen positions.

Inner shadow colour. The 10 items with the effect applied name the swatch that IDML writes as EffectColor. Items without the effect store UID 0xB, where the IDML default is n (no colour). The converter writes the colour only when the effect is applied.

Drop shadow colour. Item attribute 0x10837 is the swatch of the drop shadow, IDML EffectColor. With the write rule above, the converter reproduces all 11 EffectColor values of the trustworthy pairs (8 polygons, 2 rectangles, 1 text frame; swatches such as Color/Paper and named colours), with no extra value. In 7 of these items the object style chain stores 0 for the attribute, which names no swatch, so every item colour differs from it. The one other item whose style stores 0 has the Black swatch, and its IDML has no EffectColor. One item cannot show whether IDML compares with Black or leaves the value out for another reason; the converter leaves out Black when the style stores 0.

Drop shadow knockout. Page item attribute 0x1EB6F is DropShadowSetting/KnockedOut: a u16, 1 true, 0 false (value type 0x6E65). Object styles hold it in their transparency list (chunk 0x1B92C); [None] stores 1, and the styles that store 0 are mostly [Normal Graphics Frame], [Normal Text Frame] and user styles of older documents. The document's base list (class 0x6E02) does not have it. An item or a style chain that does not store it has true, the value of TransparencyDefaultContainerObject in every corpus IDML. IDML writes KnockedOut on the item when this value differs from the style's, by the rule above; an item without an object style gets no value it does not store.

With this rule the converter reproduces, over the trustworthy pairs, every KnockedOut of the items: 17,543 of 17,543 rectangles, 9,505 of 9,505 text frames, 1,911 of 1,911 polygons, 1,578 of 1,578 graphic lines and 155 of 155 ovals. Before the rule, 25, 13, 14, 23 and 8 documents missed these DropShadowSetting elements. It also writes 380 elements that IDML does not have (760 extra values in 3 documents): items that store nothing, whose style stores 0, and whose IDML has no KnockedOut. Nothing stored in the items or their styles separates them from the items that follow the rule; they stay open (unknowns.md).

Not covered: items whose drop shadow is off (Mode="None") for which IDML still writes a DropShadowSetting (the "D empty, IDML writes it" column above).

Stroke and fill transparency

Only the gradient feather has values that tell its attributes apart:

ID IDML On the item
0x1EB93 StrokeTransparencySetting/GradientFeatherSetting/Applied 2 items through their style, and the style
0x1EB95 stroke gradient feather stops 2 items
0x1EB96 StrokeTransparencySetting/GradientFeatherSetting/Angle 2 items through their style (90), and the style
0x1EB97 StrokeTransparencySetting/GradientFeatherSetting/Length 4 items in 2 files
0x1EB98 StrokeTransparencySetting/GradientFeatherSetting/GradientStart 4 items in 2 files
0x1EB9C FillTransparencySetting/GradientFeatherSetting/Applied 10 items, 1 through its style
0x1EB9E fill gradient feather stops 11 items
0x1EB9F FillTransparencySetting/GradientFeatherSetting/Angle 10 items (−90)
0x1EBA0 FillTransparencySetting/GradientFeatherSetting/Length 3 items in 2 files
0x1EBA1 FillTransparencySetting/GradientFeatherSetting/GradientStart 3 items in 2 files

The stroke, fill and object gradient feathers of the same item can hold the same length and start, so each ID was taken from items where only one of the three is set (for example 0x1EB97 matches the stroke value in 4 items and the fill value in only 2).

Opacity gradient stops

Value type 0x1085F. A u32 stop count, then three f64 per stop:

Field Contents
f64 Location, 0–1 (IDML Location in percent)
f64 Position of the midpoint between this stop and the next, 0–1, measured from the start of the gradient; 1 for the last stop
f64 Opacity in percent (IDML Opacity)

IDML writes a Midpoint on every stop but the first: the midpoint between the previous stop and this one, in percent of the distance between them. So for stop i, Midpoint = (midpoint of stop i−1 − location of stop i−1) / (location of stop i − location of stop i−1) × 100. A list with count 0 is stored as a 4-byte value.

All 170 stops of the items above match on Opacity, Location and Midpoint; so do the 5 stops of two object styles. IDML names an item's stops <item>TransparencySetting1GradientFeatherSetting1OpacityGradientStop<i> (with StrokeTransparencySetting or FillTransparencySetting for those settings), 170 of 170.

Not converted

  • Drop shadow Noise and UseGlobalLight.
  • Stroke, fill and content blending (opacity and blend mode) and the other effects (feather, outer and inner glow, bevel and emboss, satin, directional feather): no item or style in the pairs has a value other than the default, so their attributes cannot be told apart. One text frame has ContentTransparencySetting with an inner glow and a satin effect applied, and two attributes set to 1, so it cannot show which is which.
  • GradientFeatherSetting/Type: Linear in every sample.
  • Transparency of placed graphics and object styles.