@sushichan044/kg-core 0.11.1 → 0.11.3

package/README.md

@@ -271,13 +271,17 @@ Its line gap is 1.825mm, stage gap 10mm, top margin 12mm, bottom margin 16.55mm,
 inner margin 21.825mm, and outer margin 13mm. `NovelCompositionSettings.defaults`
 contains this format. Typeface and reserved lines remain configurable.
 
-`NovelCompositionSettings.forPaper(paperSize, settings)` selects the fixed A5
-format or centres the current grid on another paper size. For non-A5 formats,
+A6 is fixed at 12Q, 41 characters per line, 17 lines, and one stage. Its line
+gap is 7H (1.75mm), giving a 19H (4.75mm) line pitch, with 12.5mm
+top/bottom margins, a 16mm inner margin, and a 10mm outer margin.
+
+`NovelCompositionSettings.forPaper(paperSize, settings)` selects the fixed A5 or A6
+format or centres the current grid on another paper size. For other formats,
 `ManuscriptPageSettings.centered(flow, appearance)` computes millimetre settings
 with half-cell line gaps and two-cell stage gaps. These helpers calculate values;
 validate the result before persisting or rendering an oversized grid.
 
-Custom non-A5 page settings can provide explicit millimetre gaps and margins.
+Custom page settings on other paper sizes can provide explicit millimetre gaps and margins.
 The settings schema checks that text dimensions plus margins equal the paper
 size within 0.000001mm. Gaps and margins must be nonnegative, and the line gap
 must accommodate the existing half-size annotation area. A mismatch returns
@@ -406,3 +410,42 @@ does not include polyfills.
 ## License
 
 MIT
+
+## Sentence-ending symbols
+
+`♡`, `♪`, and `☆` follow the same line-breaking and separator-space rules as
+Japanese question and exclamation marks. Each symbol remains a separate cell.
+Set `additionalSentenceEndingMarks` on composition settings to add Unicode symbols:
+
+```ts
+const settings = {
+  ...NovelCompositionSettings.defaults,
+  additionalSentenceEndingMarks: "★",
+};
+```
+
+For proofreading, import `createSpaceAfterQuestionOrExclamationRule` from
+`@sushichan044/kg-core/lint` and pass the same option. The factory returns a
+`ManuscriptResult`. Replace the default rule with ID
+`kg/space-after-question-or-exclamation` with the successful result's value.
+An empty string adds nothing; built-in marks remain enabled. Each Unicode code
+point is a separate symbol. Non-symbol characters are rejected.
+
+## Font preparation
+
+Parsing preserves the source independently of the selected font. Before composition,
+call `prepareManuscriptForFont(parsed, fontPreset)`. Its `parsed` value contains the
+prepared display text and annotations; `mapRange` maps existing parser diagnostics
+into its grapheme coordinates while preserving source and display UTF-16 offsets.
+Always prepare from the original parse when changing fonts.
+
+`prepareTextForFont(text, fontPreset)` applies the same rules to standalone titles
+and author names. `mincho` selects Rin Mincho and combines spacing kana voicing
+marks; `genei-koburi` and `gothic` preserve them. Existing combining marks stay intact.
+Preparation preserves notation, style and per-character ruby boundaries. The current
+built-in transforms preserve UTF-16 length and do not normalize the whole source.
+
+Font profiles declare ordered text transforms, measurement policy and OpenType
+features. Add a profile and its browser assets to support another built-in font;
+parsers remain independent of font selection. Browser shaping is provided by
+`@sushichan044/kg-viewer/typography`; core remains synchronous and DOM independent.