مرحباً بالعالم
+رقم الفاتورة INV-2048 +مستحق في 2026-10-21.
+''' +css = ''' +@page { size: A4; margin: 20mm; } +body { font-family: "Noto Sans Arabic", Inter; font-size: 18pt; line-height: 1.8; } +p { text-align: right; } +bdi { font-family: Inter; } +''' +pdf, missing = engine.render_pdf_with_glyph_report(html, css) +if missing: + raise RuntimeError(f"Project fonts lack required characters: {missing}") +Path("arabic.pdf").write_bytes(pdf) +engine.render_finalized_pdf_image_pages_to_dir("arabic.pdf", "preview", 110, "arabic") +``` + +`text-align: right` chooses an edge; `direction: rtl` establishes the text's base +direction. An inline `direction: ltr` declaration alone does not isolate a date. +Use ``, or combine `direction: ltr` with `unicode-bidi: isolate` +in CSS. Fullbleed resolves styled siblings in the surrounding paragraph's bidi +context. See the [HTML bidirectional-text defaults](https://html.spec.whatwg.org/multipage/rendering.html#bidi-rendering). + +Do not manually reverse Arabic strings. Keep a connected Arabic word together +when styling it; this example does not test splitting its letters into separate +styled spans. Save Python, JSON, HTML and CSS as UTF-8. + +## Fonts and output checks + +Naming a CSS font family does not install it. This project registers the exact +regular and bold files included in its [font manifest](../assets/arabic-invoice/source.json). +`render.py` verifies their hashes before rendering. Keep the included OFL notice +when distributing those fonts. Inter is registered from the installed Fullbleed +package. `document_lang="ar"` describes the document language; it supplies no glyphs. + +The [retained checks](../assets/arabic-invoice/verification.json) exercise the ZIP, +an edited invoice and theme, exact-input replay, the guide snippet, missing and +changed fonts, and an unsupported character. Independent readers inspect the +Arabic and English text, dates, total, embedded fonts and page bounds; native and +PDFium previews are retained too. + +Inspect the final pages after customization. PDF readers can reconstruct a +mixed Arabic/English line differently on copy/paste; one reader's full extracted +line is not a substitute for checking field geometry and text with another. +This recipe verifies its sample, without a general language-coverage or PDF +standards-conformance claim. + +[Invoices from data](invoices.md) · [Font registration](../engine/font-registration.md) · +[Chinese text and fonts](chinese-pdf.md) diff --git a/docs/guides/invoices.md b/docs/guides/invoices.md index dec2ede..64d4137 100644 --- a/docs/guides/invoices.md +++ b/docs/guides/invoices.md @@ -10,6 +10,9 @@ Edit the sample data, render a preview, and download the PDF in Colab or local J To return an invoice from your app, see the [FastAPI, Flask, and Django examples](web-frameworks.md). +For a bilingual layout, download the [Arabic and English invoice](arabic-pdf.md) +with its fonts included, or the [Chinese and English example](chinese-pdf.md). + ## A compact JSON invoice The [agent-workflow invoice](https://github.com/fullbleed-engine/fullbleed-official/tree/v2.4.0/examples/agent_workflows) loads JSON, escapes text, builds an HTML table, embeds Inter, writes a PDF, and checks that the invoice ID, customer, and total survived rendering. diff --git a/docs/index.md b/docs/index.md index 77e6cf9..009cb44 100644 --- a/docs/index.md +++ b/docs/index.md @@ -234,7 +234,7 @@ Pick your application stack. Generate a PDF locally or download one from the bro Turn JSON or CSV into itemized invoices. Keep data, layout, and font assets explicit. - [Invoice guide →](guides/invoices.md) + [Invoice guide →](guides/invoices.md) · [Arabic and English example](guides/arabic-pdf.md) - **Reports that flow across pages** diff --git a/examples/arabic-invoice/LICENSE b/examples/arabic-invoice/LICENSE new file mode 100644 index 0000000..4c99bbd --- /dev/null +++ b/examples/arabic-invoice/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Fullbleed Contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/examples/arabic-invoice/README.md b/examples/arabic-invoice/README.md new file mode 100644 index 0000000..deaf2e5 --- /dev/null +++ b/examples/arabic-invoice/README.md @@ -0,0 +1,41 @@ +# Arabic and English invoice + +A fictional A4 invoice using Fullbleed, local Noto Sans Arabic regular/bold +faces, and the Inter font bundled with Fullbleed. All names and amounts are +sample data. The template code is MIT-licensed; keep `fonts/OFL.txt` with the +bundled Arabic fonts. + +Use a Python 3.11 or newer virtual environment: + +```sh +python -m pip install -r requirements.txt +python render.py +``` + +Open `output/invoice.pdf` and `output/preview/invoice_page1.png`. Font files +are already in the ZIP. Rendering needs no network access or system fonts. + +Edit `data.json` for the studio, customer, reference, dates and services. +Amounts use integer USD cents; quantities are positive integers. The script +calculates line totals and escapes inserted HTML text. Edit `invoice.css` +for colors, type, spacing and layout, or `render.py` for the HTML structure. + +```sh +python render.py --data data.json --out output/custom +``` + +Keep Arabic strings in logical Unicode order. Do not reverse them manually. +Use `direction: rtl` for Arabic blocks and `` around dates, +references and other fields that must retain their LTR order. Keep an Arabic +word together when styling its text; this sample does not test styling +individual connected letters as separate spans. + +The renderer verifies pinned font bytes, writes a glyph report and refuses to +write a new PDF if a registered font lacks a character. If you intentionally +replace a font, update its manifest hash and CSS family name. Inspect every +page after changing the content or styling. Readers can reconstruct mixed RTL +and LTR text differently on copy/paste even when the page looks correct. + +`render.json` records the engine version, calculated total, PDF size and hash. +The guide and independent output checks are at +https://docs.fullbleed.dev/guides/arabic-pdf/ . diff --git a/examples/arabic-invoice/data.json b/examples/arabic-invoice/data.json new file mode 100644 index 0000000..129be00 --- /dev/null +++ b/examples/arabic-invoice/data.json @@ -0,0 +1,16 @@ +{ + "reference": "NW-2048", + "issued": "2026-10-07", + "due": "2026-10-21", + "studio_ar": "نوى للتصميم", + "studio_en": "NAWA STUDIO", + "customer_ar": "شركة أفق", + "customer_en": "Ufuq Company", + "project_ar": "هوية بصرية ونظام مستندات", + "project_en": "Brand identity & document system", + "items": [ + {"ar": "تصميم الهوية البصرية", "en": "Brand identity design", "quantity": 1, "unit_cents": 87500}, + {"ar": "قوالب المستندات", "en": "Document templates", "quantity": 1, "unit_cents": 32500}, + {"ar": "جلسات التسليم", "en": "Handover sessions", "quantity": 2, "unit_cents": 9500} + ] +} diff --git a/examples/arabic-invoice/font-source.json b/examples/arabic-invoice/font-source.json new file mode 100644 index 0000000..8a44f31 --- /dev/null +++ b/examples/arabic-invoice/font-source.json @@ -0,0 +1,10 @@ +{ + "license": "SIL Open Font License 1.1", + "repository": "https://github.com/notofonts/noto-fonts", + "commit": "6cfca385c8757fadf537923d59a671116a865d48", + "files": [ + {"file": "fonts/NotoSansArabic-Regular.ttf", "sha256": "ceea25b464a656dc3b26849bab9356740401af62aedf1bfa8b7f0d9b75925b1b", "source": "hinted/ttf/NotoSansArabic/NotoSansArabic-Regular.ttf"}, + {"file": "fonts/NotoSansArabic-Bold.ttf", "sha256": "ed2711b387750ae991b6a980b8dd16fdd65e6702b97e9f52adf3a8edf09ef4df", "source": "hinted/ttf/NotoSansArabic/NotoSansArabic-Bold.ttf"}, + {"file": "fonts/OFL.txt", "sha256": "0dab92d0544f7b233403f14b84a663bdbfa746982eda629e7f4f9ffe1b036feb", "source": "LICENSE"} + ] +} diff --git a/examples/arabic-invoice/fonts/NotoSansArabic-Bold.ttf b/examples/arabic-invoice/fonts/NotoSansArabic-Bold.ttf new file mode 100644 index 0000000..8819e4d Binary files /dev/null and b/examples/arabic-invoice/fonts/NotoSansArabic-Bold.ttf differ diff --git a/examples/arabic-invoice/fonts/NotoSansArabic-Regular.ttf b/examples/arabic-invoice/fonts/NotoSansArabic-Regular.ttf new file mode 100644 index 0000000..ce21d4f Binary files /dev/null and b/examples/arabic-invoice/fonts/NotoSansArabic-Regular.ttf differ diff --git a/examples/arabic-invoice/fonts/OFL.txt b/examples/arabic-invoice/fonts/OFL.txt new file mode 100644 index 0000000..c82d72e --- /dev/null +++ b/examples/arabic-invoice/fonts/OFL.txt @@ -0,0 +1,94 @@ +Copyright 2018 The Noto Project Authors (github.com/googlei18n/noto-fonts) + +This Font Software is licensed under the SIL Open Font License, +Version 1.1. + +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font +creation efforts of academic and linguistic communities, and to +provide a free and open framework in which fonts may be shared and +improved in partnership with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply to +any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software +components as distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, +deleting, or substituting -- in part or in whole -- any of the +components of the Original Version, by changing formats or by porting +the Font Software to a new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, +modify, redistribute, and sell modified and unmodified copies of the +Font Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, in +Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the +corresponding Copyright Holder. This restriction only applies to the +primary font name as presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created using +the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/examples/arabic-invoice/invoice.css b/examples/arabic-invoice/invoice.css new file mode 100644 index 0000000..6582782 --- /dev/null +++ b/examples/arabic-invoice/invoice.css @@ -0,0 +1,42 @@ +@page { size: A4; margin: 14mm; } +* { box-sizing: border-box; } +body { margin: 0; font-family: "Noto Sans Arabic", Inter; font-size: 10pt; line-height: 1.65; color: #213c37; } +h1, h2, p { margin: 0; } +.latin { font-family: Inter; direction: ltr; } +.rtl { direction: rtl; text-align: right; } +.masthead { display: flex; justify-content: space-between; align-items: center; padding-bottom: 6mm; border-bottom: 1.2pt solid #213c37; } +.brand-ar { font-size: 22pt; font-weight: 700; line-height: 1.25; } +.brand-en { font-size: 8pt; letter-spacing: 2pt; } +.edition { font-size: 8pt; color: #62726b; } +.hero { margin-top: 7mm; padding: 8mm 9mm; background: #213c37; color: #fffaf0; border-right: 3mm solid #dd7853; display: flex; justify-content: space-between; align-items: center; } +.hero h1 { font-size: 43pt; font-weight: 700; line-height: 1.3; } +.hero .subtitle { font-size: 10pt; letter-spacing: 2pt; color: #c7d5bd; } +.ref-label { font-size: 8pt; color: #c7d5bd; } +.reference { font-size: 19pt; font-weight: 700; margin-top: 1mm; } +.parties { display: flex; gap: 8mm; margin: 8mm 0; } +.project { width: 53%; } +.customer { width: 47%; padding-right: 5mm; border-right: 2pt solid #dd7853; } +.eyebrow { font-size: 8pt; color: #62726b; margin-bottom: 2mm; } +.customer h2 { font-size: 20pt; font-weight: 700; line-height: 1.45; } +.secondary { color: #62726b; font-size: 9pt; } +.project-name { font-size: 13pt; font-weight: 700; } +.dates { border-top: 0.6pt solid #ccd3c7; border-bottom: 0.6pt solid #ccd3c7; padding: 3.5mm 0; margin-bottom: 6mm; display: flex; justify-content: space-between; } +.dates p { font-size: 9pt; } +.dates bdi { font-family: Inter; font-size: 10pt; } +table { border-collapse: collapse; width: 100%; table-layout: fixed; } +th { background: #edf0e6; font-size: 9pt; font-weight: 400; padding: 3mm; text-align: right; border-bottom: 1pt solid #213c37; } +th .latin { display: block; font-size: 7pt; color: #62726b; } +td { padding: 4.5mm 3mm; border-bottom: 0.6pt solid #d6dcd0; vertical-align: middle; } +.money { font-family: Inter; font-size: 10pt; text-align: right; direction: ltr; } +.qty { text-align: center; } +.service { font-size: 12pt; font-weight: 700; line-height: 1.65; } +.service-en { font-size: 8pt; font-weight: 400; color: #62726b; } +.summary { display: flex; gap: 9mm; margin-top: 7mm; align-items: flex-start; } +.total { width: 46%; background: #213c37; color: #fffaf0; padding: 5mm 6mm; } +.total-label { display: flex; justify-content: space-between; font-size: 9pt; color: #c7d5bd; } +.total-value { font-size: 29pt; font-weight: 700; margin-top: 2mm; line-height: 1.3; } +.currency { font-size: 10pt; margin-right: 2mm; } +.note { width: 54%; padding-top: 1mm; } +.thanks { font-size: 18pt; font-weight: 700; margin-bottom: 2mm; } +.note p { font-size: 9pt; } +.footer { margin-top: 10mm; padding-top: 3mm; border-top: 0.6pt solid #ccd3c7; display: flex; justify-content: space-between; font-size: 7pt; color: #62726b; } diff --git a/examples/arabic-invoice/render.py b/examples/arabic-invoice/render.py new file mode 100644 index 0000000..6c644f5 --- /dev/null +++ b/examples/arabic-invoice/render.py @@ -0,0 +1,82 @@ +"""Render a fictional bilingual invoice from local, explicitly registered fonts.""" +from hashlib import sha256 +from html import escape +from importlib.metadata import version +from importlib.resources import files +from pathlib import Path +import argparse +import json + +import fullbleed + +ROOT = Path(__file__).resolve().parent + + +def money(cents): + return f"{cents // 100:,}.{cents % 100:02}" + + +def render(data_path, out): + data = json.loads(Path(data_path).read_text(encoding="utf-8")) + manifest = json.loads((ROOT / "font-source.json").read_text(encoding="utf-8")) + for asset in manifest["files"]: + path = ROOT / asset["file"] + if not path.is_file() or sha256(path.read_bytes()).hexdigest() != asset["sha256"]: + raise ValueError("Missing or changed project font asset: " + asset["file"]) + out = Path(out) + out.mkdir(parents=True, exist_ok=True) + e = lambda key: escape(str(data[key])) + rows = [] + total = 0 + for item in data["items"]: + quantity, unit = item["quantity"], item["unit_cents"] + if type(quantity) is not int or quantity <= 0 or type(unit) is not int or unit < 0: + raise ValueError("Use positive integer quantities and nonnegative integer USD cents") + amount = quantity * unit + total += amount + rows.append(f'''{escape(item['ar'])}
+{escape(item['en'])}
DESIGN / DOCUMENTS
EST. 2026
{e('studio_ar')}
{e('studio_en')}
REFERENCE
{e('reference')}
INVOICE
المشروع / PROJECT
+{e('project_ar')}
{e('project_en')}
فاتورة إلى / BILL TO
{e('customer_en')}
تاريخ الاستحقاق {e('due')}
+تاريخ الإصدار {e('issued')}
المبلغ AMOUNT / USD | السعر RATE / USD |
+ العدد QTY | الخدمة SERVICE |
|---|
USD{money(total)}
شكراً لثقتكم
يُرجى استخدام رقم الفاتورة {e('reference')} عند التواصل معنا.
+Please include the invoice reference in your correspondence.