docs: fix stale attribute notes and misplaced doc comments

This commit is contained in:
aiongg committed 2026-10-07 20:00:23 +00:00
1 parent bb6fb3ef61
commit f314de906d
5 files changed
+29 -16

No files matched your search

+18 -10
View File
@@ -1,7 +1,9 @@
# Attribute lists
Formatting is stored as attribute lists (on page items: chunk 0x6E03).
Implemented in `src/model/attrs.rs`.
Decoded in `src/model/attrs.rs`. The IDML name and value kind of each ID
are in the tables of `src/idml/attrs.rs`; `src/idml/kind.rs` converts
each kind.
## Layout
@@ -56,9 +58,10 @@ Transparency attributes (IDs 0x108xx and 0x1EBxx) are described in
Object styles (class 0x1B901) hold a full page item attribute list in
chunk 0x1B92B, with the same record layout as chunk 0x6E03 but a u16
count. The converter does not read object style attributes yet, but they
add evidence: the corpus pairs have 576 object styles whose name matches
an IDML `ObjectStyle`.
count. The converter reads them (`object style` lists in `indd audit`)
and writes them with the page item table. They also add evidence: the
corpus pairs have 576 object styles whose name matches an IDML
`ObjectStyle`.
**Stroke type (0x6E6E).** The record has three values: a reference (type
0x117), a code (type 0x6E64, 4 bytes) and the usual 6-byte value. The
@@ -113,10 +116,15 @@ appears in:
count and records. These are the run's local overrides.
Value types are specific to each attribute (for example 0x1B05 for swatch
references, 0x1B28 for point size), so the converter decodes text values
by length: 8 bytes f64, 4 bytes u32, 2 bytes u16, other lengths raw.
String values (`FontStyle`) are a flag byte followed by an in-object
string.
references, 0x1B28 for point size), so the converter decodes a text value
by the layout of its attribute. The attributes whose value is not a
single number have their layout listed in `text_layout`
(`src/model/attrs.rs`): string values (`FontStyle`) are a flag byte
followed by an in-object string; tab lists, nested styles, bullet
characters, points, ruby text and cell edge stroke types are described
below. Other values are numbers, decoded by length: 8 bytes f64, 4 bytes
u32, 2 bytes u16. A value that does not fit its attribute's layout is
kept undecoded and not written.
### Mapping and evidence
@@ -413,8 +421,8 @@ vertically and its print PDF:
- In the PDF, each such text appears in small type in a narrow column
right beside the run's characters and centred on them, as ruby is set
beside vertical text.
- Values of 8 bytes cannot be told from a number by their length, so the
converter rebuilds the bytes before reading the text.
- The converter decodes the value of 0x422E by this layout, whatever its
length.
The converter writes `RubyString` and writes `RubyFlag` with the stored
number (1 in every such run; the schema type is an integer). The other
+2 -1
View File
@@ -210,7 +210,6 @@ pub(super) fn style_name(s: &Style) -> String {
}
}
/// Escape a style name for use in a `Self` reference (`:` separates groups).
/// A text variable name as IDML writes it: control characters (U+001B in
/// the built-in cross-reference variables) become `<?AID 00xx?>`.
pub(super) fn variable_name(name: &str) -> String {
@@ -225,6 +224,8 @@ pub(super) fn variable_name(name: &str) -> String {
out
}
/// Escape a name for use in a `Self` reference (`:` separates style
/// groups there).
pub(super) fn self_name(name: &str) -> String {
name.replace('%', "%25").replace(':', "%3a")
}
+3 -3
View File
@@ -104,9 +104,9 @@ impl Writer<'_> {
}
}
/// Write `doc` as an IDML package. `name` is the document name (file name).
/// Write `doc` as an IDML package. Returns warnings about values left out
/// because the IDML schema does not allow them.
/// Write `doc` as an IDML package. `name` is the document name (file
/// name). Returns warnings about values left out because the IDML schema
/// does not allow them.
pub fn write(doc: &Document, name: &str, out: impl std::io::Write) -> std::io::Result<Vec<String>> {
let w = Writer {
doc,
+2 -2
View File
@@ -153,8 +153,6 @@ pub(super) fn page_names(doc: &Document) -> Vec<String> {
out
}
/// The number shown on each document page, from the sections. Pages
/// not covered by a section are numbered by their position.
/// The section and page number of each document page.
pub(super) fn page_sections(doc: &Document) -> Vec<(Section, u32)> {
let numbers = page_numbers(doc);
@@ -167,6 +165,8 @@ pub(super) fn page_sections(doc: &Document) -> Vec<(Section, u32)> {
out
}
/// The number shown on each document page, from the sections. Pages
/// not covered by a section are numbered by their position.
pub(super) fn page_numbers(doc: &Document) -> Vec<u32> {
let count = document_pages(doc).len();
let mut out: Vec<u32> = (1..=count as u32).collect();
+4
View File
@@ -1,3 +1,7 @@
//! The `indd` command: converts INDD files to IDML and prints what is
//! inside an INDD file (header, objects, chunks, XMP, audit). Run it
//! without arguments for the list of subcommands.
use std::io::Write;
use std::process::ExitCode;