Arabic typography workflow
- Preserve the user's exact Unicode text. Confirm uncertain spelling with the user before rendering. Never reverse text, replace letters, normalize marks or apply a separate reshaper.
- For Kufic, distinguish modern Kufi typography from Square/historical Kufic; ask for a reference when unclear. Diwani supports unvocalized PNG/outlined SVG only, not harakat, PDF or Al Jazeera-like composed emblems. Read capabilities. Select a genuinely implemented style for the purpose. Read only the corresponding
references/styles/<style>.md. For Square Kufic read the manual grid workflow: use labeled cells and exact source spans, never pixelate a generic font or label a maze as Arabic. Arbitrary-text Square Kufic rendering remains unavailable. Other reference-only traditions require manual artwork; offer a supported alternative explicitly. - Use the environment's installed
arabic-calligraphyCLI, or install this directory withpython -m pip install .after following installation. Native dependencies are mandatory. Installation can require network; rendering does not. - Render:
arabic-calligraphy render --text "العلم نور" --style naskh --output artwork.svg. For PNG change the extension. Useposterfor artwork andcertificatefor structured certificates. Usedocument --input examples/documents/report.md --output report.pdffor new PDFs. Read PDF layout for constraints. - Inspect the actual output for mark collisions, clipping, spelling, reading order and visual hierarchy. Report missing coverage or overflow; do not suppress errors. Review selectable PDF text separately from appearance.
- Manual grid studies use
arabic-calligraphy grid --input examples/square-kufic/allah-study.json --output study.svg. Inspect the source map against the actual image, report geometry findings, and deliver the JSON with the image. Passing checks does not verify Arabic or authenticity; do not claim the basic study is a packed emblem. - If the bundled renderer cannot run, report the missing dependency. Never replace it with image generation, hand-written SVG or another system font and claim the skill rendered it. Deliver the actual file with its capability classification. Font workflows are font-based approximations; manual grid studies are explicitly unreviewed compositions. Neither has independent authenticity certification. Request human calligraphy review for ceremonial, religious or historical fidelity.
Existing PDFs: preserve the original. This package creates new documents; it does not implement arbitrary replacement of text in supplied PDFs. See typography and poster guidance only as needed.