randogoth/wapdown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Extract the WML exporter from md2txt into wapdown

Browse source 
md2txt is a suite of minimal text-based markup exporters, and every other
renderer in it (text, micron, ama, gemini, nex) is a straight transform of
a document into a flat text format. The WML renderer is neither: it emits
an XML tree, and it restructures the document rather than transforming it
-- splitting one file into many <card>s, inventing navigation between
them, building a menu card that exists in no source document, and
paginating on a byte budget. That is why it needed levers no sibling
renderer needed, and why it alone forced a CARD_BREAK block kind and a
{.card} directive into the shared parser that every other renderer
ignores.

wapdown is that renderer given a repository of its own, where
restructuring a document into a navigable deck is the point.

Ported: the Markdown parser, block event models, and pipeline core, each
trimmed to what a deck compiler actually uses (no FIGlet, no hyphenation,
no ASCII-art includes, no text-layout frontmatter), plus the eight inline
regexes the renderer had been borrowing from a 1039-line text renderer.
The plugin registry comes along so other WAP-era targets can register
alongside wml later. Zero runtime dependencies.

Config is now first-class: every lever is an argparse flag with
validation and a frontmatter equivalent, layered CLI > frontmatter >
default, replacing the generic --renderer-option KEY=VALUE passthrough.

Five defects found while reading the code, each with a regression test:

- Link and image URLs were shredded by the emphasis patterns, which ran
  before LINK_RE: a path like /v1_2_3/ became /v1<i>2</i>3/ inside the
  href. Links and images are now resolved and stashed first.
- <table> was emitted as a direct child of <card>. The WML 1.3 content
  model is (onevent*, timer?, (do | p | pre)*), so it must sit in a <p>.
- Link labels carried emphasis, but <a> is declared (#PCDATA | br | img)*
  -- there is nowhere valid for a <b> inside one. Markers are now stripped.
- The menu card was built directly and never byte-packed, so the one card
  most likely to be large was the one card exempt from the budget.
- Output was written with CRLF line endings. WML is XML served over HTTP.

New, WAP-idiomatic rather than Markdown-idiomatic:

- deck-level <template> hoisting nav that would otherwise repeat per card
- <select> menus, picked with a keypad digit instead of scrolled to
- --deck-per-card, one file per section cross-linked by filename, which
  is the real answer to per-deck cache limits
- <head> metadata: Cache-Control max-age and <access>
- a Home options softkey, which <prev/> alone cannot provide
- an image policy (keep/alt/drop) for the WBMP-only reality of WAP 1.x
  browsers -- no conversion is performed

186 tests, where neither repo had any. Golden files pin whole-document
output; every deck is validated against the real WML 1.3 DTD, vendored at
tests/dtd/wml13.dtd. Rendering examples/trail.md still matches md2txt's
committed output byte for byte, modulo the CRLF fix.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
randogoth 2026-09-23 09:27:49 +03:00
commit b83e24e2f7
51 changed files with 4016 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

30
tests/golden/kitchen-sink.wml Normal file
View file

@ -0,0 +1,30 @@
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN" "http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<template>
<do type="prev" label="Back"><prev/></do>
</template>
<card id="menu" title="Kitchen Sink">
<do type="prev"><noop/></do>
<p><b><big>Kitchen Sink</big></b></p>
<p>A deck exercising every block and inline construct wapdown understands.</p>
<p><select title="Kitchen Sink"><option onpick="#card1">Links and emphasis</option><option onpick="#card2">A table</option><option onpick="#card3">Other blocks</option></select></p>
</card>
<card id="card1" title="Links and emphasis">
<p><b><big>Links and emphasis</big></b></p>
<p>Tricky URL: <a href="https://example.com/docs/v1_2_3/notes.html">release notes</a> and a starred path <a href="https://ci.example.com/job/a*b*c/log">build log</a>.</p>
<p><b>Bold</b>, <i>italic</i>, inline code, struck, and a literal $$5 fee.</p>
</card>
<card id="card2" title="A table">
<p><b><big>A table</big></b></p>
<p><table columns="3"><tr><td><b>Trail</b></td><td><b>Status</b></td><td><b>Fee</b></td></tr><tr><td>North Loop</td><td>open</td><td>$$2</td></tr><tr><td>Summit Spur</td><td>icy</td><td>$$5</td></tr></table></p>
</card>
<card id="card3" title="Other blocks">
<p><b><big>Other blocks</big></b></p>
<p><i>A quoted warning.</i></p>
<p>1. First</p>
<p>2. Second</p>
<p>------------</p>
<p>indented code $$HOME</p>
</card>
</wml>

12
tests/golden/trail-decks/contact.wml Normal file
View file

@ -0,0 +1,12 @@
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN" "http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<template>
<do type="prev" label="Back"><prev/></do>
<do type="options" label="Home"><go href="index.wml#menu"/></do>
</template>
<card id="card3" title="Contact">
<p>Ranger station: <a href="tel:+15555550123">call dispatch</a></p>
<p><img src="https://example.com/map.png" alt="Trail map"/></p>
</card>
</wml>

16
tests/golden/trail-decks/index.wml Normal file
View file

@ -0,0 +1,16 @@
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN" "http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<template>
<do type="prev" label="Back"><prev/></do>
<do type="options" label="Home"><go href="index.wml#menu"/></do>
</template>
<card id="menu">
<do type="prev"><noop/></do>
<do type="options"><noop/></do>
<p>Live updates for the ridge trail network. Reception is spotty past the tree line, check before you go.</p>
<p><a href="weather.wml#card1">Weather</a></p>
<p><a href="trail-status.wml#card2">Trail Status</a></p>
<p><a href="contact.wml#card3">Contact</a></p>
</card>
</wml>

13
tests/golden/trail-decks/trail-status.wml Normal file
View file

@ -0,0 +1,13 @@
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN" "http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<template>
<do type="prev" label="Back"><prev/></do>
<do type="options" label="Home"><go href="index.wml#menu"/></do>
</template>
<card id="card2" title="Trail Status">
<p>- North Loop: open</p>
<p>- South Loop: closed</p>
<p>- Summit Spur: open, ice above 2000m</p>
</card>
</wml>

11
tests/golden/trail-decks/weather.wml Normal file
View file

@ -0,0 +1,11 @@
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN" "http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<template>
<do type="prev" label="Back"><prev/></do>
<do type="options" label="Home"><go href="index.wml#menu"/></do>
</template>
<card id="card1" title="Weather">
<p>Cold and clear. Wind: <b>15 mph</b> gusting from the <i>northwest</i>. Permit fee: $$5.</p>
</card>
</wml>

30
tests/golden/trail-head.wml Normal file
View file

@ -0,0 +1,30 @@
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN" "http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<head>
<access domain="example.com"/>
<meta http-equiv="Cache-Control" content="max-age=0"/>
</head>
<template>
<do type="prev" label="Back"><prev/></do>
</template>
<card id="menu">
<do type="prev"><noop/></do>
<p>Live updates for the ridge trail network. Reception is spotty past the tree line, check before you go.</p>
<p><a href="#card1">Weather</a></p>
<p><a href="#card2">Trail Status</a></p>
<p><a href="#card3">Contact</a></p>
</card>
<card id="card1" title="Weather">
<p>Cold and clear. Wind: <b>15 mph</b> gusting from the <i>northwest</i>. Permit fee: $$5.</p>
</card>
<card id="card2" title="Trail Status">
<p>- North Loop: open</p>
<p>- South Loop: closed</p>
<p>- Summit Spur: open, ice above 2000m</p>
</card>
<card id="card3" title="Contact">
<p>Ranger station: <a href="tel:+15555550123">call dispatch</a></p>
<p><img src="https://example.com/map.png" alt="Trail map"/></p>
</card>
</wml>

28
tests/golden/trail-home.wml Normal file
View file

@ -0,0 +1,28 @@
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN" "http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<template>
<do type="prev" label="Back"><prev/></do>
<do type="options" label="Home"><go href="#menu"/></do>
</template>
<card id="menu">
<do type="prev"><noop/></do>
<do type="options"><noop/></do>
<p>Live updates for the ridge trail network. Reception is spotty past the tree line, check before you go.</p>
<p><a href="#card1">Weather</a></p>
<p><a href="#card2">Trail Status</a></p>
<p><a href="#card3">Contact</a></p>
</card>
<card id="card1" title="Weather">
<p>Cold and clear. Wind: <b>15 mph</b> gusting from the <i>northwest</i>. Permit fee: $$5.</p>
</card>
<card id="card2" title="Trail Status">
<p>- North Loop: open</p>
<p>- South Loop: closed</p>
<p>- Summit Spur: open, ice above 2000m</p>
</card>
<card id="card3" title="Contact">
<p>Ranger station: <a href="tel:+15555550123">call dispatch</a></p>
<p><img src="https://example.com/map.png" alt="Trail map"/></p>
</card>
</wml>

26
tests/golden/trail-images-alt.wml Normal file
View file

@ -0,0 +1,26 @@
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN" "http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<template>
<do type="prev" label="Back"><prev/></do>
</template>
<card id="menu">
<do type="prev"><noop/></do>
<p>Live updates for the ridge trail network. Reception is spotty past the tree line, check before you go.</p>
<p><a href="#card1">Weather</a></p>
<p><a href="#card2">Trail Status</a></p>
<p><a href="#card3">Contact</a></p>
</card>
<card id="card1" title="Weather">
<p>Cold and clear. Wind: <b>15 mph</b> gusting from the <i>northwest</i>. Permit fee: $$5.</p>
</card>
<card id="card2" title="Trail Status">
<p>- North Loop: open</p>
<p>- South Loop: closed</p>
<p>- Summit Spur: open, ice above 2000m</p>
</card>
<card id="card3" title="Contact">
<p>Ranger station: <a href="tel:+15555550123">call dispatch</a></p>
<p>Trail map</p>
</card>
</wml>

27
tests/golden/trail-linear.wml Normal file
View file

@ -0,0 +1,27 @@
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN" "http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<template>
<do type="prev" label="Back"><prev/></do>
</template>
<card id="card1" title="Trail Conditions">
<do type="prev"><noop/></do>
<do type="accept" label="More"><go href="#card2"/></do>
<p><b><big>Trail Conditions</big></b></p>
<p>Live updates for the ridge trail network. Reception is spotty past the tree line, check before you go.</p>
<p><b>Weather</b></p>
<p>Cold and clear. Wind: <b>15 mph</b> gusting from the <i>northwest</i>. Permit fee: $$5.</p>
</card>
<card id="card2" title="Trail Status">
<do type="accept" label="More"><go href="#card3"/></do>
<p><b><big>Trail Status</big></b></p>
<p>- North Loop: open</p>
<p>- South Loop: closed</p>
<p>- Summit Spur: open, ice above 2000m</p>
</card>
<card id="card3" title="Contact">
<p><b><big>Contact</big></b></p>
<p>Ranger station: <a href="tel:+15555550123">call dispatch</a></p>
<p><img src="https://example.com/map.png" alt="Trail map"/></p>
</card>
</wml>

26
tests/golden/trail-manual.wml Normal file
View file

@ -0,0 +1,26 @@
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN" "http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<template>
<do type="prev" label="Back"><prev/></do>
</template>
<card id="menu">
<do type="prev"><noop/></do>
<p>Live updates for the ridge trail network. Reception is spotty past the tree line, check before you go.</p>
<p><a href="#card1">Weather</a></p>
<p><a href="#card2">Trail Status</a></p>
<p><a href="#card3">Contact</a></p>
</card>
<card id="card1" title="Weather">
<p>Cold and clear. Wind: <b>15 mph</b> gusting from the <i>northwest</i>. Permit fee: $$5.</p>
</card>
<card id="card2" title="Trail Status">
<p>- North Loop: open</p>
<p>- South Loop: closed</p>
<p>- Summit Spur: open, ice above 2000m</p>
</card>
<card id="card3" title="Contact">
<p>Ranger station: <a href="tel:+15555550123">call dispatch</a></p>
<p><img src="https://example.com/map.png" alt="Trail map"/></p>
</card>
</wml>

25
tests/golden/trail-no-template.wml Normal file
View file

@ -0,0 +1,25 @@
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN" "http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<card id="menu">
<p>Live updates for the ridge trail network. Reception is spotty past the tree line, check before you go.</p>
<p><a href="#card1">Weather</a></p>
<p><a href="#card2">Trail Status</a></p>
<p><a href="#card3">Contact</a></p>
</card>
<card id="card1" title="Weather">
<do type="prev" label="Back"><prev/></do>
<p>Cold and clear. Wind: <b>15 mph</b> gusting from the <i>northwest</i>. Permit fee: $$5.</p>
</card>
<card id="card2" title="Trail Status">
<do type="prev" label="Back"><prev/></do>
<p>- North Loop: open</p>
<p>- South Loop: closed</p>
<p>- Summit Spur: open, ice above 2000m</p>
</card>
<card id="card3" title="Contact">
<do type="prev" label="Back"><prev/></do>
<p>Ranger station: <a href="tel:+15555550123">call dispatch</a></p>
<p><img src="https://example.com/map.png" alt="Trail map"/></p>
</card>
</wml>

38
tests/golden/trail-paginated.wml Normal file
View file

@ -0,0 +1,38 @@
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN" "http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<template>
<do type="prev" label="Back"><prev/></do>
</template>
<card id="menu">
<do type="prev"><noop/></do>
<do type="accept" label="More"><go href="#menu-p2"/></do>
<p>Live updates for the ridge trail network. Reception is spotty past the tree line, check before you go.</p>
</card>
<card id="menu-p2">
<do type="prev" label="Prev"><prev/></do>
<do type="accept" label="More"><go href="#menu-p3"/></do>
<p><a href="#card1">Weather</a></p>
<p><a href="#card2">Trail Status</a></p>
</card>
<card id="menu-p3">
<do type="prev" label="Prev"><prev/></do>
<p><a href="#card3">Contact</a></p>
</card>
<card id="card1" title="Weather">
<p>Cold and clear. Wind: <b>15 mph</b> gusting from the <i>northwest</i>. Permit fee: $$5.</p>
</card>
<card id="card2" title="Trail Status">
<p>- North Loop: open</p>
<p>- South Loop: closed</p>
<p>- Summit Spur: open, ice above 2000m</p>
</card>
<card id="card3" title="Contact">
<do type="accept" label="More"><go href="#card3-p2"/></do>
<p>Ranger station: <a href="tel:+15555550123">call dispatch</a></p>
</card>
<card id="card3-p2">
<do type="prev" label="Prev"><prev/></do>
<p><img src="https://example.com/map.png" alt="Trail map"/></p>
</card>
</wml>

24
tests/golden/trail-select.wml Normal file
View file

@ -0,0 +1,24 @@
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN" "http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<template>
<do type="prev" label="Back"><prev/></do>
</template>
<card id="menu">
<do type="prev"><noop/></do>
<p>Live updates for the ridge trail network. Reception is spotty past the tree line, check before you go.</p>
<p><select title="Menu"><option onpick="#card1">Weather</option><option onpick="#card2">Trail Status</option><option onpick="#card3">Contact</option></select></p>
</card>
<card id="card1" title="Weather">
<p>Cold and clear. Wind: <b>15 mph</b> gusting from the <i>northwest</i>. Permit fee: $$5.</p>
</card>
<card id="card2" title="Trail Status">
<p>- North Loop: open</p>
<p>- South Loop: closed</p>
<p>- Summit Spur: open, ice above 2000m</p>
</card>
<card id="card3" title="Contact">
<p>Ranger station: <a href="tel:+15555550123">call dispatch</a></p>
<p><img src="https://example.com/map.png" alt="Trail map"/></p>
</card>
</wml>

30
tests/golden/trail-split.wml Normal file
View file

@ -0,0 +1,30 @@
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN" "http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<template>
<do type="prev" label="Back"><prev/></do>
</template>
<card id="menu" title="Trail Conditions">
<do type="prev"><noop/></do>
<p><b><big>Trail Conditions</big></b></p>
<p>Live updates for the ridge trail network. Reception is spotty past the tree line, check before you go.</p>
<p><a href="#card1">Weather</a></p>
<p><a href="#card2">Trail Status</a></p>
<p><a href="#card3">Contact</a></p>
</card>
<card id="card1" title="Weather">
<p><b><big>Weather</big></b></p>
<p>Cold and clear. Wind: <b>15 mph</b> gusting from the <i>northwest</i>. Permit fee: $$5.</p>
</card>
<card id="card2" title="Trail Status">
<p><b><big>Trail Status</big></b></p>
<p>- North Loop: open</p>
<p>- South Loop: closed</p>
<p>- Summit Spur: open, ice above 2000m</p>
</card>
<card id="card3" title="Contact">
<p><b><big>Contact</big></b></p>
<p>Ranger station: <a href="tel:+15555550123">call dispatch</a></p>
<p><img src="https://example.com/map.png" alt="Trail map"/></p>
</card>
</wml>

17
tests/golden/trail.wml Normal file
View file

@ -0,0 +1,17 @@
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN" "http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<card id="card1">
<p><b><big>Trail Conditions</big></b></p>
<p>Live updates for the ridge trail network. Reception is spotty past the tree line, check before you go.</p>
<p><b>Weather</b></p>
<p>Cold and clear. Wind: <b>15 mph</b> gusting from the <i>northwest</i>. Permit fee: $$5.</p>
<p><b>Trail Status</b></p>
<p>- North Loop: open</p>
<p>- South Loop: closed</p>
<p>- Summit Spur: open, ice above 2000m</p>
<p><b>Contact</b></p>
<p>Ranger station: <a href="tel:+15555550123">call dispatch</a></p>
<p><img src="https://example.com/map.png" alt="Trail map"/></p>
</card>
</wml>