Skip to content

DesignCraft: An open-source page and layout design editor written by scratch in pure Rust

Autoflow: one frame per column, as the page's columns are set

aionggcb388628466f
diff --git a/ROADMAP.md b/ROADMAP.md
index f826a3767..554f44a74 100644
--- a/ROADMAP.md
+++ b/ROADMAP.md
@@ -129,6 +129,7 @@ list) · [roadmap.md](docs/roadmap.md) (milestones, plan) · [parity-checklist.m
Newest first.
+- **2026-10-12** · Autoflow on Place threads one frame per page column (right to left in a right-to-left story), so text no longer runs across the gutter; pages Smart Text Reflow adds get a primary frame with the page's columns (#625). No readiness percentage change.
- **2026-10-12** · Orderly native exit writes the latest recovery state after finalizing current quit approvals; incomplete or stale plans keep their documents, and Undo to the saved state clears stale recovery. Unavailable or failed recovery is reported. Cancelable macOS Dock Quit remains open (#544). No readiness percentage change.
- **2026-10-12** · Recovered documents keep a checkpoint until saved, closed or reverted, including a second crash before autosave. Restarted document IDs and explicit recovery folders preserve other snapshots; failed republishing retains the original. No readiness percentage change.
- **2026-10-12** · Book numbering and style updates prepare every chapter before saving. Only closed native chapters are changed; imported IDML remains a read-only style/PDF source. If a later disk write fails, the error names the completed chapters; the batch is not a whole-book transaction. No readiness percentage change.
diff --git a/crates/engine/src/cmd/file.rs b/crates/engine/src/cmd/file.rs
index 692c363e8..f1e690209 100644
--- a/crates/engine/src/cmd/file.rs
+++ b/crates/engine/src/cmd/file.rs
@@ -102,7 +102,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Place…",
["File"],
Some("Cmd+D"),
- "{path?|base64?, name?, frame?: id (place into), spread?, x?, y?, width?, pdfPage?: n (1-based, Image Import Options), pdfCrop?: crop|trim|bleed|art|media, layoutPage?: n (IDML / .designcraft: that page's objects as a group)} — places an image (into the selected empty frame if any); text files (.txt, .docx, .rtf, .md) and Excel workbooks (.xlsx, as a table) go into the insertion point, the selected frame or a new frame on `page`/`rect` — {autoflow?: adds pages with threaded frames until the text fits, removeStyles?, styleMap?: {imported name: document style}, styleConflicts?: useExisting|redefine|autoRename}",
+ "{path?|base64?, name?, frame?: id (place into), spread?, x?, y?, width?, pdfPage?: n (1-based, Image Import Options), pdfCrop?: crop|trim|bleed|art|media, layoutPage?: n (IDML / .designcraft: that page's objects as a group)} — places an image (into the selected empty frame if any); text files (.txt, .docx, .rtf, .md) and Excel workbooks (.xlsx, as a table) go into the insertion point, the selected frame or a new frame on `page`/`rect` — {autoflow?: threads one frame per page column (from the first frame on), adding pages until the text fits, removeStyles?, styleMap?: {imported name: document style}, styleConflicts?: useExisting|redefine|autoRename}",
has_doc,
file_place
),
diff --git a/crates/engine/src/cmd/place_text.rs b/crates/engine/src/cmd/place_text.rs
index 97917ee3b..8d3e1ba3b 100644
--- a/crates/engine/src/cmd/place_text.rs
+++ b/crates/engine/src/cmd/place_text.rs
@@ -2,7 +2,7 @@
//! selected frame, or a new frame on the page; with autoflow, pages and threaded frames are added
//! until the whole story fits (InDesign's Shift-click with a loaded text cursor).
-use designcraft_doc::{CharacterStyle, Content, Document, ParaFormat, ParagraphStyle, SpreadRef, Story, StoryId, TextSel};
+use designcraft_doc::{CharacterStyle, Content, Document, ParaFormat, ParagraphStyle, SpreadRef, Story, StoryId, TextDirection, TextSel};
use designcraft_geom::Rect;
use serde_json::{Value, json};
@@ -123,35 +123,102 @@ fn fit(d: &Document, sid: StoryId) -> (Option<usize>, usize, usize) {
(cs.overset_at, held, full)
}
-/// Thread new frames on new pages (margin rectangles) until the story fits. Returns pages added.
-pub(crate) fn autoflow(d: &mut Document, sid: StoryId, max_pages: usize) -> Result<usize> {
+/// The frames autoflow sets on a page: one per column inside the margins, in the order a story
+/// of direction `dir` runs through them. A vertical story gets one frame on the live area.
+fn flow_rects(d: &Document, dir: TextDirection, vertical: bool, page: usize) -> Vec<Rect> {
+ let Some(p) = d.page(page) else { return Vec::new() };
+ if vertical {
+ return vec![p.margin_rect()];
+ }
+ let mut cols = p.column_rects();
+ if dir == TextDirection::RightToLeft {
+ cols.reverse();
+ }
+ cols
+}
+
+fn same_rect(a: Rect, b: Rect) -> bool {
+ [a.x0 - b.x0, a.y0 - b.y0, a.x1 - b.x1, a.y1 - b.y1].iter().all(|v| v.abs() < 0.01)
+}
+
+/// Thread new frames until the story fits: first into the columns after the last frame's column
+/// on its page (when it sits in one), then one frame per column on each page it adds. With
+/// `primary` (Smart Text Reflow of the primary text frame), each added page gets one frame on the
+/// live area with the page's columns instead. Empty frames it made at the end of the thread are
+/// removed again, except the first on a page. Returns pages added.
+pub(crate) fn autoflow(d: &mut Document, sid: StoryId, max_pages: usize, primary: bool) -> Result<usize> {
+ let (dir, story_vertical) = d.story(sid).map(|s| (s.direction, s.vertical)).ok_or_else(|| bad("file.place", "no such story"))?;
+ // One frame per page: on the live area, its columns those of the page.
+ let vertical = story_vertical || primary;
let mut added = 0;
+ let mut made = Vec::new();
+ let mut first = true;
loop {
let (overset, held, full) = fit(d, sid);
- let Some(at) = overset else { return Ok(added) };
- if added >= max_pages {
- return Err(bad("file.place", format!("autoflow stopped after {max_pages} pages")));
- }
+ let Some(at) = overset else { break };
let len = d.story(sid).map_or(0, |s| s.len());
// Frames still needed at the rate the full ones are filled (at least one); with no full
- // frame to go by yet, one more page.
- let want = held.checked_div(full).map_or(1, |per_frame| len.saturating_sub(at).div_ceil(per_frame.max(1))).clamp(1, max_pages - added);
+ // frame to go by yet, one more.
+ let want = held.checked_div(full).map_or(1, |per_frame| len.saturating_sub(at).div_ceil(per_frame.max(1))).max(1);
let last = *d.story(sid).and_then(|s| s.frames.last()).ok_or_else(|| bad("file.place", "the story has no frame"))?;
- let mut page = d.page_of_item(last).unwrap_or(d.page_count().saturating_sub(1));
- let parent = d.page_loc(page).and_then(|(si, pi)| d.spreads[si].pages[pi].parent);
- d.insert_pages(Some(page), want, parent)?;
+ let page = d.page_of_item(last).unwrap_or(d.page_count().saturating_sub(1));
let layer = d.default_layer();
let mut prev = last;
- for _ in 0..want {
- page += 1;
- let (si, pi) = d.page_loc(page).ok_or_else(|| bad("file.place", "page insert failed"))?;
- let r = d.spreads[si].pages[pi].margin_rect();
- let (fid, _) = d.add_text_frame(SpreadRef::Doc(si), r, layer, "", ParaFormat::default())?;
- d.thread(prev, fid)?;
- prev = fid;
+ if std::mem::take(&mut first) {
+ let rects = flow_rects(d, dir, vertical, page);
+ let next = d.item(last).and_then(|it| rects.iter().position(|r| same_rect(*r, it.bounds()))).map_or(rects.len(), |k| k + 1);
+ if let (Some(rest), Some((si, _))) = (rects.get(next..).filter(|r| !r.is_empty()), d.page_loc(page)) {
+ for r in rest.iter().take(want) {
+ prev = add_flow_frame(d, si, *r, layer, prev)?;
+ made.push(prev);
+ }
+ continue;
+ }
}
- added += want;
+ if added >= max_pages {
+ return Err(bad("file.place", format!("autoflow stopped after {max_pages} pages")));
+ }
+ let per_page = if vertical { 1 } else { d.page(page).map_or(1, |p| p.columns.count.max(1) as usize) };
+ let pages = want.div_ceil(per_page).clamp(1, max_pages - added);
+ let parent = d.page_loc(page).and_then(|(si, pi)| d.spreads[si].pages[pi].parent);
+ d.insert_pages(Some(page), pages, parent)?;
+ for pg in page + 1..=page + pages {
+ let (si, pi) = d.page_loc(pg).ok_or_else(|| bad("file.place", "page insert failed"))?;
+ let columns = d.spreads[si].pages[pi].columns.clone();
+ for r in flow_rects(d, dir, vertical, pg) {
+ prev = add_flow_frame(d, si, r, layer, prev)?;
+ made.push(prev);
+ if primary && let Some(tf) = d.item_mut(prev).and_then(|it| it.text_frame_mut()) {
+ tf.options.columns = columns.count.max(1);
+ tf.options.gutter = columns.gutter;
+ }
+ }
+ }
+ added += pages;
}
+ let cs = designcraft_compose::compose_story(d, sid, &Default::default());
+ while let Some(&f) = made.last() {
+ let frames = d.story(sid).map_or(&[][..], |s| s.frames.as_slice());
+ let [.., before, tail] = frames else { break };
+ if *tail != f || cs.frame(f).is_some_and(|ft| !ft.range.is_empty()) || d.page_of_item(*before) != d.page_of_item(f) {
+ break;
+ }
+ d.remove_item(f)?;
+ made.pop();
+ }
+ Ok(added)
+}
+
+fn add_flow_frame(
+ d: &mut Document,
+ si: usize,
+ r: Rect,
+ layer: designcraft_doc::LayerId,
+ prev: designcraft_doc::ItemId,
+) -> Result<designcraft_doc::ItemId> {
+ let (fid, _) = d.add_text_frame(SpreadRef::Doc(si), r, layer, "", ParaFormat::default())?;
+ d.thread(prev, fid)?;
+ Ok(fid)
}
pub(super) fn place_text(s: &mut Session, p: &Value, name: &str, bytes: &[u8]) -> Result<Value> {
@@ -199,7 +266,9 @@ pub(super) fn place_text(s: &mut Session, p: &Value, name: &str, bytes: &[u8]) -
None => {
let pg = page.unwrap_or(0).min(d.page_count().saturating_sub(1));
let (si, pi) = d.page_loc(pg).ok_or_else(|| bad("file.place", "no such page"))?;
- let r: Rect = rect.unwrap_or_else(|| d.spreads[si].pages[pi].margin_rect());
+ // An autoflowed story starts in the first column; a placed one on the live area.
+ let first_column = autoflow_on.then(|| flow_rects(d, d.new_story_direction(), false, pg).first().copied()).flatten();
+ let r: Rect = rect.or(first_column).unwrap_or_else(|| d.spreads[si].pages[pi].margin_rect());
let layer = d.default_layer();
d.add_text_frame(SpreadRef::Doc(si), r, layer, "", ParaFormat::default())?.0
}
@@ -230,7 +299,7 @@ pub(super) fn place_text(s: &mut Session, p: &Value, name: &str, bytes: &[u8]) -
*sel = designcraft_doc::Selection::items(vec![fid]);
sid
};
- let pages = if autoflow_on { autoflow(d, sid, 2000)? } else { 0 };
+ let pages = if autoflow_on { autoflow(d, sid, 2000, false)? } else { 0 };
let overset = fit(d, sid).0.is_some();
Ok(json!({"story": sid.0, "pagesAdded": pages, "overset": overset, "warnings": warnings}))
})
@@ -269,6 +338,68 @@ mod tests {
let _ = std::fs::remove_dir_all(&dir);
}
+ #[test]
+ fn autoflow_sets_one_frame_per_column() {
+ // Regression (#625): autoflow set one frame across the margins, over the gutter.
+ let dir = std::env::temp_dir().join(format!("dc-place-columns-{}", std::process::id()));
+ std::fs::create_dir_all(&dir).unwrap();
+ let path = dir.join("long.txt");
+ let para = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. ".repeat(12);
+ std::fs::write(&path, vec![para.as_str(); 40].join("\n")).unwrap();
+ for binding in ["leftToRight", "rightToLeft"] {
+ let mut s = Session::new();
+ s.execute("file.new", &json!({"preset": "Letter", "pages": 1, "columns": 2, "gutter": 18, "margins": 54})).unwrap();
+ s.execute("layout.documentSetup", &json!({"binding": binding})).unwrap();
+ let r = s.execute("file.place", &json!({"path": path.to_string_lossy(), "page": 1, "autoflow": true})).unwrap();
+ assert_eq!(r["overset"], false, "{r}");
+ let d = &s.doc().unwrap().doc;
+ let frames = &d.story(StoryId(r["story"].as_u64().unwrap())).unwrap().frames;
+ assert!(d.page_count() >= 3, "{binding}: {r}");
+ // Two frames on every page but maybe the last, in column order, each on its column.
+ assert!(frames.len() > 2 * (d.page_count() - 1), "{binding}: {} frames", frames.len());
+ for (i, f) in frames.iter().enumerate() {
+ let page = d.page_of_item(*f).unwrap();
+ assert_eq!(page, i / 2, "{binding}: frame {i}");
+ let mut cols = d.page(page).unwrap().column_rects();
+ if binding == "rightToLeft" {
+ cols.reverse();
+ }
+ assert_eq!(d.item(*f).unwrap().bounds(), cols[i % 2], "{binding}: frame {i}");
+ }
+ }
+ // One column: one frame on the live area per page, as before.
+ let mut s = Session::new();
+ s.execute("file.new", &json!({"preset": "Letter", "pages": 1, "margins": 54})).unwrap();
+ let r = s.execute("file.place", &json!({"path": path.to_string_lossy(), "page": 1, "autoflow": true})).unwrap();
+ let d = &s.doc().unwrap().doc;
+ let frames = &d.story(StoryId(r["story"].as_u64().unwrap())).unwrap().frames;
+ assert_eq!(frames.len(), d.page_count());
+ for f in frames {
+ assert_eq!(d.item(*f).unwrap().bounds(), d.page(d.page_of_item(*f).unwrap()).unwrap().margin_rect());
+ }
+ let _ = std::fs::remove_dir_all(&dir);
+ }
+
+ #[test]
+ fn autoflow_keeps_the_frame_the_user_drew() {
+ let dir = std::env::temp_dir().join(format!("dc-place-drawn-{}", std::process::id()));
+ std::fs::create_dir_all(&dir).unwrap();
+ let path = dir.join("long.txt");
+ std::fs::write(&path, vec!["Lorem ipsum dolor sit amet, consectetur adipiscing elit. ".repeat(12); 30].join("\n")).unwrap();
+ let mut s = Session::new();
+ s.execute("file.new", &json!({"preset": "Letter", "pages": 1, "columns": 2, "gutter": 18, "margins": 54})).unwrap();
+ let r = s.execute("file.place", &json!({"path": path.to_string_lossy(), "rect": [100, 100, 400, 300], "autoflow": true})).unwrap();
+ assert_eq!(r["overset"], false, "{r}");
+ let d = &s.doc().unwrap().doc;
+ let frames = &d.story(StoryId(r["story"].as_u64().unwrap())).unwrap().frames;
+ assert_eq!(d.item(frames[0]).unwrap().bounds(), Rect::new(100.0, 100.0, 400.0, 300.0));
+ let cols = d.page(1).unwrap().column_rects();
+ assert_eq!(d.page_of_item(frames[1]), Some(1));
+ assert_eq!(d.item(frames[1]).unwrap().bounds(), cols[0]);
+ assert_eq!(d.item(frames[2]).unwrap().bounds(), cols[1]);
+ let _ = std::fs::remove_dir_all(&dir);
+ }
+
#[test]
fn autoflow_adds_only_the_pages_breaks_ask_for() {
// Regression (#262): a frame a break ends early made autoflow take it for a frame that
@@ -401,6 +532,29 @@ mod reflow_tests {
s.execute("text.insert", &json!({"text": long})).unwrap();
assert_eq!(s.doc().unwrap().doc.page_count(), 1);
}
+
+ #[test]
+ fn smart_text_reflow_adds_primary_frames_with_the_page_columns() {
+ let mut s = Session::new();
+ s.execute("file.new", &json!({"pages": 1, "columns": 2, "gutter": 18, "primaryTextFrame": true})).unwrap();
+ let sid = s.doc().unwrap().doc.settings.primary_story.expect("primary story");
+ s.execute("text.select", &json!({"story": sid.0, "anchor": 0, "focus": 0})).unwrap();
+ s.execute("text.insert", &json!({"text": "Words keep coming and the page fills up quickly with them. ".repeat(250)})).unwrap();
+ let d = s.doc().unwrap().doc.clone();
+ let frames = &d.story(sid).unwrap().frames;
+ assert!(d.page_count() >= 2);
+ assert_eq!(frames.len(), d.page_count());
+ for f in frames {
+ let it = d.item(*f).unwrap();
+ assert_eq!(it.bounds(), d.page(d.page_of_item(*f).unwrap()).unwrap().margin_rect());
+ let tf = it.text_frame().unwrap();
+ assert_eq!((tf.options.columns, tf.options.gutter), (2, 18.0));
+ }
+ let n = d.story(sid).unwrap().len();
+ s.execute("text.select", &json!({"story": sid.0, "anchor": 0, "focus": n})).unwrap();
+ s.execute("text.delete", &json!({})).unwrap();
+ assert_eq!(s.doc().unwrap().doc.page_count(), 1);
+ }
}
#[cfg(test)]
diff --git a/crates/engine/src/lib.rs b/crates/engine/src/lib.rs
index 2165eebc4..f640daaa9 100644
--- a/crates/engine/src/lib.rs
+++ b/crates/engine/src/lib.rs
@@ -472,24 +472,20 @@ impl Session {
}
let mut d = (*st.doc).clone();
if overset {
- let _ = cmd::place_text_autoflow(&mut d, sid, 500);
+ let _ = cmd::place_text_autoflow(&mut d, sid, 500, true);
} else {
- // Drop empty trailing frames on the last pages (one frame, nothing else there).
+ // Drop the last pages while all they hold is empty frames of the story.
while let Some(story) = d.story(sid) {
- if story.frames.len() < 2 {
- break;
- }
let Some(&last) = story.frames.last() else { break };
- let cs = designcraft_compose::compose_story(&d, sid, &Default::default());
- if cs.frame(last).is_some_and(|ft| !ft.range.is_empty()) {
- break;
- }
let Some(page) = d.page_of_item(last) else { break };
- let alone = d.spreads.iter().flat_map(|sp| sp.items.iter()).filter(|i| d.page_of_item(i.id) == Some(page)).count() == 1;
- if page + 1 != d.page_count() || !alone || d.page_count() < 2 {
+ let cs = designcraft_compose::compose_story(&d, sid, &Default::default());
+ let on_page: Vec<_> =
+ d.spreads.iter().flat_map(|sp| sp.items.iter()).map(|i| i.id).filter(|id| d.page_of_item(*id) == Some(page)).collect();
+ let empty = |id: &designcraft_doc::ItemId| story.frames.contains(id) && cs.frame(*id).is_none_or(|ft| ft.range.is_empty());
+ if page + 1 != d.page_count() || d.page_count() < 2 || !on_page.iter().all(empty) || on_page.len() >= story.frames.len() {
break;
}
- if d.remove_item(last).is_err() || d.delete_pages(&[page]).is_err() {
+ if on_page.iter().any(|id| d.remove_item(*id).is_err()) || d.delete_pages(&[page]).is_err() {
break;
}
}
diff --git a/docs/target-app-parity.md b/docs/target-app-parity.md
index 9095faf50..07d1eefa9 100644
--- a/docs/target-app-parity.md
+++ b/docs/target-app-parity.md
@@ -295,7 +295,7 @@ It is evidence of breadth: each item exists. It is not a claim of InDesign-level
- Graphics backend chosen before the window exists (DirectX 12 on Windows, Vulkan on Linux, Metal on macOS, OpenGL as the fallback; `WGPU_BACKEND` overrides) with a start-up fallback: a backend whose start never showed a frame is skipped at the next start and the status bar says so (`gpu.json`). Found on an AMD hybrid-graphics laptop whose Vulkan driver faulted at the first present.
- Edit › Paste Into (copied objects become a frame's content, clipped by it; rendered, PDF and IDML both ways — verified in InDesign 2026); Polygon Settings (sides, star inset; double-click the Polygon tool).
- Color panel (fill/stroke proxy, CMYK/RGB/Lab sliders with channel ramps, tint slider for swatches, spectrum ramp, Add to Swatches) and Color Picker (double-click the proxy); mixed colours are unnamed (not listed in Swatches until added); `object.color`, `swatch.addToSwatches`, `swatch.addUnnamed`.
-- Place text files: Word (.docx: styles by name with their attributes, bold/italic/underline/size/font, footnotes, tables, tabs, breaks), RTF and plain text, into the insertion point, the selected frame or a new frame; autoflow adds pages and threaded frames until the text fits; Remove Styles option (`designcraft-textimport`).
+- Place text files: Word (.docx: styles by name with their attributes, bold/italic/underline/size/font, footnotes, tables, tabs, breaks), RTF and plain text, into the insertion point, the selected frame or a new frame; autoflow threads one frame per page column and adds pages until the text fits; Remove Styles option (`designcraft-textimport`).
- Gradient Feather (⇧G tool, `object.gradientFeather`): objects fade along a linear or radial opacity gradient, on screen and as a soft mask in PDF.
- Script Label (`object.label`, `object.findByLabel`), alt text (`object.altText`), Isolate Blending / Knockout Group (`object.transparencyGroup`; on screen, PDF isolates), Table ▸ Sort (`table.sortRows`, numeric-aware, header/footer fixed).
- File ▸ Export Text (`file.exportText`): a story as Text Only or RTF (fonts, styles, alignment, indents, tables as tab-separated rows); Export EPUB now asks for a path in the UI.