ctrl-kd 4.8.1__tar.gz → 4.10.0__tar.gz

{ctrl_kd-4.8.1/src/ctrl_kd.egg-info → ctrl_kd-4.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ctrl-kd
-Version: 4.8.1
+Version: 4.10.0
 Summary: Convert WordStar 4-7 documents and print-to-disk files to text, Markdown, HTML, RTF, or PDF. ^KD: save and done.
 Author: Jon Michaels
 License: MIT
@@ -46,6 +46,8 @@ $ ctrl-kd --diagnose MYSTERY.FIL        # what IS this file?
 $ ctrl-kd --comments MEMO.WS            # include the author's hidden comments
 $ ctrl-kd --no-notes PAPER.WS           # body text only, no notes
 $ ctrl-kd --samples DIR                 # write 4 bundled public-domain sample .WS files into DIR
+$ ctrl-kd --list-quirks ESSAY.WS        # which known quirks this file has, and why
+$ ctrl-kd --quirk sawyer-strikeout NOVEL.WS   # turn one on
 ```
 
 ## Modes
@@ -70,6 +72,31 @@ Download Windows x86_64: [Latest Version](https://github.com/jonmichaels/ctrl-kd
 
 Python ≥ 3.9, no dependencies. Library API: `ctrlkd.convert(data, to='html')`.
 
+## Quirks
+
+Some WordStar files ask for something the bytes do not quite mean. A file's own
+header names the printer it was last printed through, and some of those
+printers were modified so that a character prints as something else — a peseta
+printing as a euro sign, an underscore printing as an em dash. Other files
+carry a setting somebody left switched on by accident, like a paragraph style
+that crosses out every line it touches.
+
+ctrl-kd is faithful by default and never quietly cleans anything up. Instead
+each such departure is a named **quirk** you can see and switch:
+
+```console
+$ ctrl-kd --list-quirks           # every quirk, with a plain-language description
+$ ctrl-kd --list-quirks NOVEL.WS  # which of them apply to this file, and why
+$ ctrl-kd --quirk NAME FILE       # turn one on           (repeatable)
+$ ctrl-kd --no-quirk NAME FILE    # turn one off          (repeatable)
+$ ctrl-kd --quirks off FILE       # none at all: the most literal reading
+```
+
+Quirks whose evidence is in the file itself (its own printer header) are on by
+default; ones that are somebody's judgement rather than the file's own evidence
+are off until you ask. Writing your own — including as a pip-installable
+plugin — is in **[EXTENDING.md](EXTENDING.md)**.
+
 ## Adding an output format
 
 An output format is one function over the parsed document — register it with the

{ctrl_kd-4.8.1 → ctrl_kd-4.10.0}/README.md

@@ -27,6 +27,8 @@ $ ctrl-kd --diagnose MYSTERY.FIL        # what IS this file?
 $ ctrl-kd --comments MEMO.WS            # include the author's hidden comments
 $ ctrl-kd --no-notes PAPER.WS           # body text only, no notes
 $ ctrl-kd --samples DIR                 # write 4 bundled public-domain sample .WS files into DIR
+$ ctrl-kd --list-quirks ESSAY.WS        # which known quirks this file has, and why
+$ ctrl-kd --quirk sawyer-strikeout NOVEL.WS   # turn one on
 ```
 
 ## Modes
@@ -51,6 +53,31 @@ Download Windows x86_64: [Latest Version](https://github.com/jonmichaels/ctrl-kd
 
 Python ≥ 3.9, no dependencies. Library API: `ctrlkd.convert(data, to='html')`.
 
+## Quirks
+
+Some WordStar files ask for something the bytes do not quite mean. A file's own
+header names the printer it was last printed through, and some of those
+printers were modified so that a character prints as something else — a peseta
+printing as a euro sign, an underscore printing as an em dash. Other files
+carry a setting somebody left switched on by accident, like a paragraph style
+that crosses out every line it touches.
+
+ctrl-kd is faithful by default and never quietly cleans anything up. Instead
+each such departure is a named **quirk** you can see and switch:
+
+```console
+$ ctrl-kd --list-quirks           # every quirk, with a plain-language description
+$ ctrl-kd --list-quirks NOVEL.WS  # which of them apply to this file, and why
+$ ctrl-kd --quirk NAME FILE       # turn one on           (repeatable)
+$ ctrl-kd --no-quirk NAME FILE    # turn one off          (repeatable)
+$ ctrl-kd --quirks off FILE       # none at all: the most literal reading
+```
+
+Quirks whose evidence is in the file itself (its own printer header) are on by
+default; ones that are somebody's judgement rather than the file's own evidence
+are off until you ask. Writing your own — including as a pip-installable
+plugin — is in **[EXTENDING.md](EXTENDING.md)**.
+
 ## Adding an output format
 
 An output format is one function over the parsed document — register it with the

{ctrl_kd-4.8.1 → ctrl_kd-4.10.0/src/ctrl_kd.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ctrl-kd
-Version: 4.8.1
+Version: 4.10.0
 Summary: Convert WordStar 4-7 documents and print-to-disk files to text, Markdown, HTML, RTF, or PDF. ^KD: save and done.
 Author: Jon Michaels
 License: MIT
@@ -46,6 +46,8 @@ $ ctrl-kd --diagnose MYSTERY.FIL        # what IS this file?
 $ ctrl-kd --comments MEMO.WS            # include the author's hidden comments
 $ ctrl-kd --no-notes PAPER.WS           # body text only, no notes
 $ ctrl-kd --samples DIR                 # write 4 bundled public-domain sample .WS files into DIR
+$ ctrl-kd --list-quirks ESSAY.WS        # which known quirks this file has, and why
+$ ctrl-kd --quirk sawyer-strikeout NOVEL.WS   # turn one on
 ```
 
 ## Modes
@@ -70,6 +72,31 @@ Download Windows x86_64: [Latest Version](https://github.com/jonmichaels/ctrl-kd
 
 Python ≥ 3.9, no dependencies. Library API: `ctrlkd.convert(data, to='html')`.
 
+## Quirks
+
+Some WordStar files ask for something the bytes do not quite mean. A file's own
+header names the printer it was last printed through, and some of those
+printers were modified so that a character prints as something else — a peseta
+printing as a euro sign, an underscore printing as an em dash. Other files
+carry a setting somebody left switched on by accident, like a paragraph style
+that crosses out every line it touches.
+
+ctrl-kd is faithful by default and never quietly cleans anything up. Instead
+each such departure is a named **quirk** you can see and switch:
+
+```console
+$ ctrl-kd --list-quirks           # every quirk, with a plain-language description
+$ ctrl-kd --list-quirks NOVEL.WS  # which of them apply to this file, and why
+$ ctrl-kd --quirk NAME FILE       # turn one on           (repeatable)
+$ ctrl-kd --no-quirk NAME FILE    # turn one off          (repeatable)
+$ ctrl-kd --quirks off FILE       # none at all: the most literal reading
+```
+
+Quirks whose evidence is in the file itself (its own printer header) are on by
+default; ones that are somebody's judgement rather than the file's own evidence
+are off until you ask. Writing your own — including as a pip-installable
+plugin — is in **[EXTENDING.md](EXTENDING.md)**.
+
 ## Adding an output format
 
 An output format is one function over the parsed document — register it with the

{ctrl_kd-4.8.1 → ctrl_kd-4.10.0}/src/ctrl_kd.egg-info/SOURCES.txt

@@ -19,6 +19,7 @@ src/ctrlkd/pdf.py
 src/ctrlkd/pictures.py
 src/ctrlkd/pix.py
 src/ctrlkd/piximg.py
+src/ctrlkd/quirks.py
 src/ctrlkd/symbolmap.py
 src/ctrlkd/typestyles.py
 src/ctrlkd/writer.py
@@ -40,6 +41,7 @@ tests/test_graphic_cell_ops.py
 tests/test_graphic_cells.py
 tests/test_head_foot_placement_m16.py
 tests/test_head_foot_timing.py
+tests/test_html_column_sections.py
 tests/test_html_print_stylesheet.py
 tests/test_justification.py
 tests/test_layout_marks.py
@@ -54,11 +56,14 @@ tests/test_lj6dtp_shading_table_rules.py
 tests/test_lj6dtp_table_rule_weight.py
 tests/test_load_plugins.py
 tests/test_mailmerge_data_files.py
+tests/test_markdown_escaping_and_breaks.py
 tests/test_merge_page_number_variable.py
 tests/test_modern_blank_after_tightened_line.py
 tests/test_modern_box_regions.py
+tests/test_modern_bullet_gap.py
 tests/test_modern_centring_clip.py
 tests/test_modern_columns.py
+tests/test_modern_html_measure.py
 tests/test_modern_line_spacing.py
 tests/test_modern_lint.py
 tests/test_modern_page_baseline.py
@@ -66,6 +71,7 @@ tests/test_modern_page_number.py
 tests/test_modern_rtf_structure_rows.py
 tests/test_modern_sheet_height.py
 tests/test_modern_verse_defrow.py
+tests/test_no_syntax_warnings.py
 tests/test_note_rulings_20260824.py
 tests/test_page_parity.py
 tests/test_paper_verdicts.py
@@ -77,6 +83,7 @@ tests/test_pcl_transparent_print.py
 tests/test_pcl_v4_column_geometry.py
 tests/test_pcl_v4_untriaged_fixes.py
 tests/test_pcl_vertical_wraparound.py
+tests/test_per_page_orientation.py
 tests/test_peseta_euro_driver.py
 tests/test_pf_print_reformat.py
 tests/test_pictures.py
@@ -85,6 +92,10 @@ tests/test_pn_page_timing.py
 tests/test_polarity_gate.py
 tests/test_print_control_labels_invisible.py
 tests/test_printed_fidelity.py
+tests/test_printed_html_single_break.py
+tests/test_printed_rtf_ruler_column.py
+tests/test_quirks.py
+tests/test_reverse_video_ground.py
 tests/test_rtf_facing_pages.py
 tests/test_rtf_head_style_attrs.py
 tests/test_rtf_keep_with_next.py

{ctrl_kd-4.8.1 → ctrl_kd-4.10.0}/src/ctrlkd/__init__.py

@@ -4,8 +4,11 @@ from .core import (detect, parse, parse_ws, parse_printstream, merged_lines,
 from .emit import (emit_text, emit_markdown, emit_html, emit_rtf,
                    emitter, get_emitter, formats, load_plugins)
 from .layout import modern_flow, emit_layout    # registers the 'layout' format
+from . import quirks                             # registers the built-in quirks
+from .quirks import (Quirk, quirk, apply_quirks, list_quirks,
+                     UnknownQuirk)
 from .pdf import emit_pdf                        # registers the 'pdf' format
 from .convert import convert, select_notes, DEFAULT_NOTE_KINDS, ALL_NOTE_KINDS
 from .info import document_info
 
-__version__ = '4.8.1'
+__version__ = '4.10.0'

{ctrl_kd-4.8.1 → ctrl_kd-4.10.0}/src/ctrlkd/cli.py

@@ -22,7 +22,7 @@ BANNER = r"""        __       __      __       __
 # because the name never changes; no .flf machinery needed.
 
 
-from . import core, emit, pictures
+from . import core, emit, pictures, quirks
 from .convert import DEFAULT_NOTE_KINDS   # module attr, not the re-exported convert()
 
 def diagnose(path, data):
@@ -51,8 +51,21 @@ def write_samples(outdir):
         written.append(dest)
     return written
 
+def _quirked(ap, doc, a):
+    """`doc` with this run's quirks resolved and applied. A bad NAME is a
+    usage error (a typo, or a plugin that isn't installed), not something to
+    swallow -- silently ignoring it would hand back output the caller did not
+    ask for."""
+    try:
+        return quirks.apply_quirks(doc, enable=a.quirk, disable=a.no_quirk,
+                                   mode=a.quirks)
+    except quirks.UnknownQuirk as e:
+        ap.error(str(e))
+
+
 def main(argv=None):
     emit.load_plugins()          # third-party emitters (ctrlkd.emitters entry points)
+    quirks.load_plugins()        # third-party quirks (ctrlkd.quirks entry points)
     ap = argparse.ArgumentParser(
         prog='ctrl-kd',
         formatter_class=argparse.RawDescriptionHelpFormatter,
@@ -130,17 +143,23 @@ def main(argv=None):
                     help='omit paragraph-style pass-through (HTML classes + '
                          'generated CSS, RTF stylesheet) from the output')
     ap.add_argument('--headers', choices=('on', 'off'), default='on',
-                    help="the document's own running heads and feet (.he/.fo) "
-                         'in the paged surfaces -- Printed PDF, Modern PDF and '
-                         "both RTF modes. WordStar's own automatic page number "
-                         'is --page-numbers\' business alone. Default: on')
+                    help="the document's own running heads and feet (.he/.fo). "
+                         'PDF AND RTF ONLY -- those are the page formats; '
+                         'text, Markdown and HTML are unpaged by design and '
+                         'carry no running heads, feet or page numbers at '
+                         'all, so this flag is accepted and ignored for them '
+                         "(no error). WordStar's own automatic page number is "
+                         "--page-numbers' business alone. Default: on")
     ap.add_argument('--page-numbers', choices=('auto', 'on', 'off'),
                     default='auto',
                     help="WordStar's own AUTOMATIC page number -- the one "
                          '.pc positions, a separate mechanism from a # the '
                          'author placed inside a real .he/.fo (that goes '
                          'with its head, under --headers, never this flag). '
-                         'Every paged surface. auto (DEFAULT): the '
+                         'PDF AND RTF ONLY, for the same reason --headers is: '
+                         'text, Markdown and HTML are unpaged by design, so '
+                         'the flag is accepted and ignored for them (no '
+                         'error). auto (DEFAULT): the '
                          'document\'s own dot '
                          'commands decide -- .pn/.pg turn it on, .op turns '
                          'it off, exactly like real WordStar; a document '
@@ -179,9 +198,9 @@ def main(argv=None):
                          'each entry to a real page number, every other '
                          'format lists entries without one. Default: off')
     ap.add_argument('--inline-styling', choices=('on', 'off'), default='on',
-                    help='inline colour (^A) and font-size (^B... a symmetric '
+                    help='inline color (^A) and font-size (^B... a symmetric '
                          'type-2 font block) changes the author placed mid-'
-                         'text -- RTF gets \\cf from a 16-colour screen '
+                         'text -- RTF gets \\cf from a 16-color screen '
                          'palette and \\fsN; HTML gets a span with color/'
                          'font-size. Default: on')
     ap.add_argument('--pictures', choices=('off', 'embed', 'export'), default='embed',
@@ -202,6 +221,36 @@ def main(argv=None):
     ap.add_argument('--comments', action='store_true',
                     help="include WordStar comments, which it never printed "
                          "(author's asides, hidden since the file was written)")
+    ap.add_argument('--quirk', action='append', metavar='NAME', default=[],
+                    help='turn a named quirk ON for this conversion '
+                         '(repeatable). A quirk is a NAMED departure from a '
+                         'literal reading of the bytes -- see --list-quirks '
+                         'for every name this build knows, what it does, and '
+                         'whether it applies to your file. Naming a quirk '
+                         'the document does not trip does nothing (so one '
+                         'standing list can be passed to every file); naming '
+                         'one that does not exist is an error.')
+    ap.add_argument('--no-quirk', action='append', metavar='NAME', default=[],
+                    help='turn a named quirk OFF (repeatable). The quirks '
+                         'that are on by default are the ones the document '
+                         "itself points at -- its own last-used printer "
+                         'driver changed what some characters print as -- so '
+                         'this is how you see the raw character instead.')
+    ap.add_argument('--quirks', choices=('auto', 'off', 'all'), default='auto',
+                    help='the baseline --quirk/--no-quirk then adjust. auto '
+                         '(DEFAULT): the quirks the document itself points '
+                         'at, and no others. off: none at all, the most '
+                         'literal reading of the bytes this converter can '
+                         'give. all: every quirk that applies to this '
+                         'document, including the ones that are off by '
+                         'default because they are somebody\'s judgement '
+                         'rather than the file\'s own evidence.')
+    ap.add_argument('--list-quirks', action='store_true',
+                    help='list every quirk this build knows as JSON -- name, '
+                         'one-line description, and whether it is on by '
+                         'default; WITH file arguments, also whether each '
+                         'applies to that file, why, and whether it is in '
+                         'force. No conversion.')
     ap.add_argument('--diagnose', action='store_true',
                     help='report what the file is (variant, margin, dot commands, '
                          'unknown codes) as JSON; no conversion')
@@ -210,6 +259,27 @@ def main(argv=None):
         for dest in write_samples(a.samples):
             print(f'-> {dest}', file=sys.stderr)
         return 0
+    if a.list_quirks:
+        if not a.files:
+            print(json.dumps(quirks.list_quirks(), indent=2, ensure_ascii=False,
+                             sort_keys=True))
+            return 0
+        status = 0
+        for path in a.files:
+            try:
+                data = open(path, 'rb').read()
+                doc = core.parse(data, encoding=a.encoding, variant=a.variant)
+            except (OSError, ValueError) as e:
+                print(f'ctrl-kd: {path}: {e}', file=sys.stderr)
+                status = 1
+                continue
+            doc = _quirked(ap, doc, a)
+            # sort_keys/ensure_ascii chosen to MATCH sr's own JSON writer exactly,
+            # so the two CLIs' --list-quirks output is byte-identical.
+            print(json.dumps({'file': os.path.basename(path),
+                              'quirks': quirks.list_quirks(doc)},
+                             indent=2, ensure_ascii=False, sort_keys=True))
+        return status
     if not a.files:
         ap.error('the following arguments are required: files')
     mode_explicit = a.mode is not None
@@ -284,6 +354,10 @@ def main(argv=None):
                   f'--variant to force)', file=sys.stderr)
             status = 1
             continue
+        # Quirks are resolved ONCE per document, here, before any emitter
+        # reads it -- so every requested format renders the same decision and
+        # the layout JSON's own report can never disagree with what ran.
+        doc = _quirked(ap, doc, a)
         # D5 notice (ruled 2026-08-05): when the user EXPLICITLY asked for
         # modern and the input can only render printed, say so once instead
         # of silently disobeying the flag. The override itself stands -- a
@@ -320,7 +394,7 @@ def main(argv=None):
         if (a.mode == 'modern'
                 and doc.meta.get('printer_driver') == 'LJ6DTP'):
             print(f'ctrl-kd: {path}: LJ6DTP driver document -- its '
-                  f'print-time page art (boxes, rules, colour) does not '
+                  f'print-time page art (boxes, rules, color) does not '
                   f'reflow; character substitutions applied. '
                   f'--mode printed reproduces the page', file=sys.stderr)
         # --page-settings applies ONCE to the resolved page dict, so every