@dogsbay/format-dita 0.2.0-beta.101

package/README.md

@@ -0,0 +1,41 @@
+# @dogsbay/format-dita
+
+Convert DITA topic XML to Dogsbay's TreeNode model — and, composed with
+`@dogsbay/format-dogsbay-md`, straight to markdown.
+
+```ts
+import { ditaTopicToDogsbayMd } from "@dogsbay/format-dita";
+
+const { markdown, meta, notes } = ditaTopicToDogsbayMd(xml, {
+  topicPath: "install/t-install.dita",
+});
+// markdown: frontmatter (title, contentType, prolog, dita provenance) + body
+// notes:    conversion ledger — known loss, never silent loss
+```
+
+Or from the CLI, pairing with `import-ditamap` for a full migration:
+
+```bash
+dogsbay import-ditamap docs/root.ditamap -o topicmaps --report maps.md
+dogsbay import-dita   docs/            -o content    --report topics.md
+```
+
+Tasks become native `:::steps`, notes become callouts, CALS and
+simpletables become tables, `<xref href="x.dita">` becomes `[…](x.md)`,
+and `keyref` links become `key:` links. Nested or sibling topics in
+multi-topic files are emitted inline as anchored sections.
+
+Directory imports build a corpus-level conref plan by default: resolvable
+`conref="file.dita#topic/element"` targets are extracted once into
+`_conrefs/*.md`, then both referencing sites and defining warehouse sites
+emit `{% include %}` so one canonical copy of reused text survives. Use
+`dogsbay import-dita --no-conref-includes` to keep conrefs on the ledger
+instead.
+
+Everything that cannot map cleanly lands in the conversion ledger instead
+of disappearing: filter attributes, table spans, semantic-inline downgrades,
+`conkeyref`, conref ranges/pushes, whole-topic conrefs, unresolved targets,
+and unknown elements.
+
+See `docs/dita-migration.md` and `plans/format-dita.md` for the migration
+contract and implementation status.

package/dist/blocks.d.ts

@@ -0,0 +1,51 @@
+/**
+ * DITA body elements → TreeNode blocks, in the dialect
+ * @dogsbay/format-dogsbay-md serializes (heading/paragraph/code/callout/
+ * lists/steps/deflist/table/figure/image).
+ *
+ * DITA element @id attributes are preserved under `meta.dita.id` for
+ * provenance (the dogsbay-md round-trip contract); constructs TreeNode
+ * cannot carry are recorded as conversion notes.
+ */
+import type { Element } from "domhandler";
+import type { TreeNode } from "@dogsbay/types";
+import { type InlineContext } from "./inline.js";
+import type { ConrefSiteContext, ConrefSnippetRef } from "./types.js";
+export interface BlockContext extends InlineContext {
+    /** Current heading depth for <section>/<example> titles. */
+    headingLevel: number;
+    /**
+     * True inside per-line-prefixed or indented serialization contexts
+     * (list items, steps, table cells, GitHub-form callouts, blockquotes).
+     * Multi-line `{% include %}` content splices verbatim and would break
+     * out of such structures, so constrained sites only accept single-line
+     * snippets.
+     */
+    constrained?: boolean;
+}
+/**
+ * The include directive for a snippet, wrapped in a scoped leveloffset
+ * when the snippet carries headings and the site's heading depth differs
+ * from the snippet's baked-in base level.
+ */
+export declare const includeDirective: (snippet: ConrefSnippetRef, site: ConrefSiteContext, headingLevel: number) => string;
+/**
+ * One <step>/<substep>'s content: <cmd> as the leading inline run, the
+ * rest as block children. Shared by convertSteps (constrained context)
+ * and conref snippet extraction (standalone, unconstrained).
+ */
+export declare const convertStepContent: (stepEl: Element, ctx: BlockContext) => {
+    inline?: TreeNode["inline"];
+    children: TreeNode[];
+};
+/**
+ * Standalone content of an item-level element (<li>, <step>, …) for
+ * conref snippet extraction: leading inline as a paragraph, block
+ * children after.
+ */
+export declare const convertItemContent: (el: Element, ctx: BlockContext) => TreeNode[];
+/** Whether an element name converts as a standalone block (conref-extractable). */
+export declare const isBlockTarget: (name: string) => boolean;
+export declare function convertBlock(el: Element, ctx: BlockContext): TreeNode[];
+export declare function convertChildren(el: Element, ctx: BlockContext, skip?: Set<string>): TreeNode[];
+//# sourceMappingURL=blocks.d.ts.map

package/dist/blocks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"blocks.d.ts","sourceRoot":"","sources":["../src/blocks.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,EAAE,OAAO,EAAW,MAAM,YAAY,CAAC;AACnD,OAAO,KAAK,EAAE,QAAQ,EAAc,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAML,KAAK,aAAa,EACnB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEtE,MAAM,WAAW,YAAa,SAAQ,aAAa;IACjD,4DAA4D;IAC5D,YAAY,EAAE,MAAM,CAAC;IACrB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAsCD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAC3B,SAAS,gBAAgB,EACzB,MAAM,iBAAiB,EACvB,cAAc,MAAM,KACnB,MAOF,CAAC;AAyVF;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAC7B,QAAQ,OAAO,EACf,KAAK,YAAY,KAChB;IAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAAC,QAAQ,EAAE,QAAQ,EAAE,CAAA;CA4BrD,CAAC;AAoBF;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAAI,IAAI,OAAO,EAAE,KAAK,YAAY,KAAG,QAAQ,EAQ3E,CAAC;AAiBF,mFAAmF;AACnF,eAAO,MAAM,aAAa,GAAI,MAAM,MAAM,KAAG,OAAmC,CAAC;AAEjF,wBAAgB,YAAY,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,YAAY,GAAG,QAAQ,EAAE,CAmTvE;AAED,wBAAgB,eAAe,CAC7B,EAAE,EAAE,OAAO,EACX,GAAG,EAAE,YAAY,EACjB,IAAI,GAAE,GAAG,CAAC,MAAM,CAAa,GAC5B,QAAQ,EAAE,CA6BZ"}