Improve examples, use wordwrap

Author: dannyadair

examples/custom_locations/other_pages/custom_page.yaml

@@ -2,5 +2,10 @@ title: "Custom Location Example"
 description: "This page uses custom directory structure"
 template:
   # If you just wrote this directly it would be relative to the templates directory
-  # We want it to be relative to the config file:
+  # We want it to be relative to the config file, so use path:
   path: "../other_templates/custom_page.svg.j2"
+detailed_description:
+  "This example demonstrates custom file locations in pdfbaker. The template file is in
+  a custom directory (other_templates/), the page configuration file is in another
+  custom directory (other_pages/), and the document configuration uses a path-based page
+  reference with custom location."

examples/custom_locations/other_templates/custom_page.svg.j2

@@ -1,5 +1,19 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <svg width="210mm" height="297mm" viewBox="0 0 210 297" version="1.1">
-  <text x="105" y="50" text-anchor="middle" font-size="20">{{ title }}</text>
-  <text x="105" y="80" text-anchor="middle" font-size="14">{{ description }}</text>
+  <!-- Background -->
+  <rect width="210" height="297" fill="#ffffff"/>
+
+  <!-- Light blue header background -->
+  <rect x="0" y="0" width="210" height="70" fill="#e0f0ff"/>
+
+  <!-- Title with smaller font -->
+  <text x="105" y="40" text-anchor="middle" font-family="Arial" font-size="14" font-weight="bold">{{ title }}</text>
+
+  <!-- Description with smaller font -->
+  <text x="105" y="60" text-anchor="middle" font-family="Arial" font-size="8">{{ description }}</text>
+
+  <!-- Detailed description using wordwrap filter -->
+  {% for line in detailed_description | wordwrap(45) %}
+  <text x="20" y="{{ 100 + loop.index0 * 15 }}" font-family="Arial" font-size="8">{{ line }}</text>
+  {% endfor %}
 </svg>

examples/custom_locations/your_directory/pages/standard_page.yaml

@@ -1,3 +1,7 @@
 title: "Standard Location Example"
 subtitle: "This page uses conventional directory structure"
 template: "standard_page.svg.j2"
+description:
+  "This example demonstrates how pdfbaker organizes files with standard locations.
+  Templates are in the standard templates/ directory, page configuration files are in
+  the standard pages/ directory, and the document uses simple page references."

examples/custom_locations/your_directory/templates/standard_page.svg.j2

@@ -1,5 +1,19 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <svg width="210mm" height="297mm" viewBox="0 0 210 297" version="1.1">
-  <text x="105" y="50" text-anchor="middle" font-size="20">{{ title }}</text>
-  <text x="105" y="80" text-anchor="middle" font-size="14">{{ subtitle }}</text>
+  <!-- Background -->
+  <rect width="210" height="297" fill="#ffffff"/>
+
+  <!-- Gray header background -->
+  <rect x="0" y="0" width="210" height="70" fill="#f0f0f0"/>
+
+  <!-- Title with smaller font -->
+  <text x="105" y="40" text-anchor="middle" font-family="Arial" font-size="14" font-weight="bold">{{ title }}</text>
+
+  <!-- Subtitle with smaller font -->
+  <text x="105" y="60" text-anchor="middle" font-family="Arial" font-size="8">{{ subtitle }}</text>
+
+  <!-- Description text using wordwrap filter -->
+  {% for line in description | wordwrap(45) %}
+  <text x="20" y="{{ 100 + loop.index0 * 15 }}" font-family="Arial" font-size="8">{{ line }}</text>
+  {% endfor %}
 </svg>

examples/custom_processing/bake.py

@@ -7,6 +7,7 @@
 
 from pdfbaker.document import PDFBakerDocument
 from pdfbaker.errors import PDFBakerError
+from pdfbaker.processing import wordwrap
 
 
 def process_document(document: PDFBakerDocument) -> None:
@@ -23,10 +24,15 @@ def process_document(document: PDFBakerDocument) -> None:
                 f"data:image/png;base64,{base64.b64encode(img_data).decode('utf-8')}"
             )
 
-        # Update config with XKCD info
+        # Get the alt text and split it into lines using the wordwrap function
+        # Note: This is for demonstration. Could use the wordwrap filter in template.
+        wrapped_alt_text = wordwrap(data["alt"], max_chars=60)
+
+        # Update config/template context with XKCD info
         document.config["xkcd"] = {
             "title": data["title"],
             "alt_text": data["alt"],
+            "alt_text_lines": wrapped_alt_text,
             "fetched_at": datetime.now().strftime("%Y-%m-%d %H:%M:%S"),
             "image_data": image_data,
         }

examples/custom_processing/templates/main.svg.j2

@@ -15,6 +15,8 @@
   <!-- XKCD Image -->
   <image x="20" y="120" width="170" height="120" xlink:href="{{ xkcd.image_data }}"/>
 
-  <!-- Alt Text -->
-  <text x="105" y="260" font-family="Arial" font-size="6" fill="#666" text-anchor="middle">Alt text: {{ xkcd.alt_text }}</text>
+  <!-- Centered Alt Text (Pre-wrapped in Python) -->
+  {% for line in xkcd.alt_text_lines %}
+  <text x="105" y="{{ 260 + loop.index0 * 8 }}" font-family="Arial" font-size="5" fill="#666" text-anchor="middle">{{ line }}</text>
+  {% endfor %}
 </svg>

examples/examples.yaml

@@ -2,5 +2,5 @@ documents:
   - minimal
   - regular
   - variants
-  - "./custom_locations/your_directory"
+  - ./custom_locations/your_directory
   - custom_processing

examples/minimal/pages/main.yaml

@@ -4,4 +4,4 @@ content: |-
   This is a minimal example of pdfbaker usage.
   - Single page document
   - One custom variable (text_color)
-  - Basic SVG template using variable for text color
+  - Basic SVG template uses variable for styling

examples/regular/config.yaml

@@ -6,3 +6,4 @@ pages:
   - benefits
 style:
   highlight_color: "#30987c"
+header_title: "pdfbaker Example"

examples/regular/pages/features.yaml

@@ -10,5 +10,10 @@ items:
     desc: "Same template used by multiple pages"
   - title: "Consistent Styling"
     desc: "Shared styles across pages"
+  - title: "Wrapping Long Text"
+    desc:
+      "SVG doesn't have text wrapping containers, but pdfbaker lets you store long text
+      in config and use the wordwrap filter to split it into lines. Adjust max_chars to
+      fit narrower spaces."
 images:
   - name: pythonnz.png