From 9f91470ac779dd13e9bbb2b3357c6d3a89c08ae5 Mon Sep 17 00:00:00 2001
From: Kaalleen <36401965+kaalleen@users.noreply.github.com>
Date: Fri, 21 Mar 2025 19:31:25 +0100
Subject: Add batch lettering extension (#3589)

---
 templates/batch_lettering.xml      | 83 ++++++++++++++++++++++++++++++++++++++
 templates/lettering.xml            |  5 ++-
 templates/lettering_along_path.xml | 16 ++++++--
 3 files changed, 99 insertions(+), 5 deletions(-)
 create mode 100644 templates/batch_lettering.xml

(limited to 'templates')

diff --git a/templates/batch_lettering.xml b/templates/batch_lettering.xml
new file mode 100644
index 00000000..ff750f7e
--- /dev/null
+++ b/templates/batch_lettering.xml
@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<inkscape-extension translationdomain="inkstitch" xmlns="http://www.inkscape.org/namespace/inkscape/extension">
+    <name>Batch Lettering</name>
+    <id>org.{{ id_inkstitch }}.output.batch_lettering</id>
+    <param name="extension" type="string" gui-hidden="true">batch_lettering</param>
+
+    <param name="notebook" type="notebook">
+
+        <page name="options" gui-text="Options">
+          <hbox>
+            <vbox>
+                <param name="text" type="string" gui-text="Text" appearance="multiline"
+                       gui-description="Enter the text. Each line of text will be exported to a separate file." />
+                <param name="separator" type="string" gui-text="Custom separator"
+                       gui-description="Set a custom separator for multiline text export. Leave empty for line break." />
+                <spacer />
+                <separator />
+                <spacer />
+                <param name="font" type="string" gui-text="Font name"></param>
+                <param name="scale" type="int" gui-text="Scale (%)" min="1" max="800"
+                       gui-text="The scale value must be within the scale range of the specified font.">100</param>
+                <param name="color-sort" type="optiongroup" appearance="combo" gui-text="Color sort">
+                   <option value="off">Off</option>
+                   <option value="all">Whole text</option>
+                   <option value="line" >Line</option>
+                   <option value="word" >Word</option>
+                </param>
+                <param name="trim" type="optiongroup" appearance="combo" gui-text="Add trims">
+                   <option value="off">Never</option>
+                   <option value="line">after each line</option>
+                   <option value="word">after each word</option>
+                   <option value="glyph">after each letter</option>
+                </param>
+                <param name="use-command-symbols" type="boolean" gui-text="Use command symbols">false</param>
+                <param name="text-align" type="optiongroup" appearance="combo" gui-text="Align Multiline Text">
+                   <option value="left">Left</option>
+                   <option value="center">Center</option>
+                   <option value="right">Right</option>
+                   <option value="block">Block (default)</option>
+                   <option value="letterspacing">Block (letterpacing)</option>
+                </param>
+              </vbox>
+              <spacer />
+              <separator />
+              <spacer />
+              <vbox>
+                <param name="text-position" type="optiongroup" appearance="combo" gui-text="Lettering along path: text position"
+                       gui-description="Uses this text position when using lettering along path">
+                   <option value="left">Left</option>
+                   <option value="center">Center</option>
+                   <option value="right">Right</option>
+                   <option value="stretch">Stretch</option>
+                </param>
+                <spacer />
+                <separator />
+                <spacer />
+                <param name="file-formats" type="string" gui-text="File formats" gui-description="Comma separated list of file formats" />
+              </vbox>
+            </hbox>
+        </page>
+
+        <page name="info" gui-text="Help">
+            <label>Use this extension to save multiple files with the given text.</label>
+            <spacer />
+            <label>When the document contains a path element labeled as "batch lettering" it will be used to place the text along this path. The path itself will be removed and won't be rendered.</label>
+            <spacer />
+            <label>More information on our website</label>
+            <label appearance="url">https://inkstitch.org/docs/lettering/#batch-export</label>
+        </page>
+    </param>
+
+    <output>
+        <extension>.zip</extension>
+        <mimetype>application/zip</mimetype>
+        <filetypename>{{ menu_inkstitch }}: batch lettering (.zip)</filetypename>
+        <filetypetooltip>Create a zip with multiple files including embroidered text using Ink/Stitch</filetypetooltip>
+        <dataloss>true</dataloss>
+    </output>
+
+    <script>
+        {{ command_tag | safe }}
+    </script>
+</inkscape-extension>
diff --git a/templates/lettering.xml b/templates/lettering.xml
index 5eaa7e0a..c15a7488 100644
--- a/templates/lettering.xml
+++ b/templates/lettering.xml
@@ -6,8 +6,11 @@
     <effect implements-custom-gui="true" show-stderr="true">
         <object-type>all</object-type>
         <icon>{{ icon_path }}inx/lettering.svg</icon>
+        <menu-tip>Insert ready-to-embroider text into the document</menu-tip>
         <effects-menu>
-            <submenu name="{{ menu_inkstitch }}" translatable="no" />
+            <submenu name="{{ menu_inkstitch }}" translatable="no">
+                <submenu name="Lettering" />
+            </submenu>
         </effects-menu>
     </effect>
     <script>
diff --git a/templates/lettering_along_path.xml b/templates/lettering_along_path.xml
index f914c6a3..98f12c38 100644
--- a/templates/lettering_along_path.xml
+++ b/templates/lettering_along_path.xml
@@ -8,13 +8,19 @@
         <icon>{{ icon_path }}inx/lettering_along_path.svg</icon>
         <menu-tip>Shapes a line of text onto a path</menu-tip>
         <effects-menu>
-            <submenu name="{{ menu_inkstitch }}" translatable="no" />
+            <submenu name="{{ menu_inkstitch }}" translatable="no">
+                <submenu name="Lettering" />
+            </submenu>
         </effects-menu>
     </effect>
     <param name="notebook" type="notebook">
       <page name="options" gui-text="Options">
-        <param name="stretch-spaces" type="bool" gui-text="Stretch"
-               gui-description="Expand glyph and word spacing to stretch lettering over the entire path">false</param>
+        <param name="text-position" type="optiongroup" appearance="combo" gui-text="Text position">
+           <option value="left">Left</option>
+           <option value="center">Center</option>
+           <option value="right">Right</option>
+           <option value="stretch">Stretch</option>
+        </param>
       </page>
       <page name="info" gui-text="Help">
         <label appearance="header">This extension bends an Ink/Stitch text to a path.</label>
@@ -24,7 +30,9 @@
         <label indent="1">* The text consists of only one line of text</label>
         <label indent="1">* The text should not be too large for the given path</label>
         <spacer />
-        <label>The stretch option defines whether the spaces between glyphs should be expanded so that the text stretches over the entire path.</label>
+        <label>In the text position dropdown menu, you can decide how the text will be placed on the path.
+               When stretch is selected, the spaces between the glyphs will be expanded, so that the text stretches over the entire path.
+        </label>
         <spacer />
         <label>More information on our website</label>
         <label appearance="url">https://inkstitch.org/docs/lettering/#lettering-along-path</label>
-- 
cgit v1.2.3