[Bps-public-commit] rt-extension-formtools branch document-template-variables created. 1.04-1-gacbd10c

[BPS Git Server]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "rt-extension-formtools".

The branch, document-template-variables has been created
        at  acbd10c418d36547f84d59100609bb943e70773d (commit)

- Log -----------------------------------------------------------------
commit acbd10c418d36547f84d59100609bb943e70773d
Author: Jim Brandt <jbrandt at bestpractical.com>
Date:   Tue Feb 13 08:58:59 2024 -0500

    Document ticket variables available for HTML blocks

diff --git a/README b/README
index b8f42a9..afd43ae 100644
--- a/README
+++ b/README
@@ -50,6 +50,24 @@ USAGE
     Click the plus (+) to create new pages. To change the order of the
     pages, click the gearbox and update the sort order.
 
+   HTML Element
+    One of the available components is "HTML Element" and this accepts HTML
+    that will be displayed on the form in the location you select. This
+    allows you to place blocks of text that include additional interactive
+    elements like links (anchor tags).
+
+    If you place one of these blocks on the Result page, you can also
+    reference information about the ticket just created by the form. You can
+    use all variables defined for Simple templates
+    <https://docs.bestpractical.com/rt/latest/customizing/templates.html#Sel
+    ected-Simple-template-variables> in RT. As with RT templates, place the
+    variables in curly braces in your HTML. For example, if you wanted to
+    include a link to the created ticket, you could define it like this:
+
+        <p>You can review your ticket regarding
+        <a href="/Ticket/Display.html?id={$TicketId}">{$TicketSubject}</a>
+        and check there for status updates. You should also receive email.</p>
+
    Description
     Your forms will be made available to users on a dedicated Forms page in
     the RT web UI. Forms can be accessed by privileged users in the main RT
diff --git a/lib/RT/Extension/FormTools.pm b/lib/RT/Extension/FormTools.pm
index 06e9ed5..0609b6c 100644
--- a/lib/RT/Extension/FormTools.pm
+++ b/lib/RT/Extension/FormTools.pm
@@ -175,6 +175,25 @@ To configure elements or add text content, click the pencil icon.
 Click the plus (+) to create new pages. To change the order of the pages,
 click the gearbox and update the sort order.
 
+=head4 HTML Element
+
+One of the available components is "HTML Element" and this accepts HTML
+that will be displayed on the form in the location you select. This allows
+you to place blocks of text that include additional interactive elements
+like links (anchor tags).
+
+If you place one of these blocks on the Result page, you can also reference
+information about the ticket just created by the form. You can use all
+variables defined for
+L<Simple templates|https://docs.bestpractical.com/rt/latest/customizing/templates.html#Selected-Simple-template-variables>
+in RT. As with RT templates, place the variables in curly braces in your
+HTML. For example, if you wanted to include a link to the created ticket,
+you could define it like this:
+
+    <p>You can review your ticket regarding
+    <a href="/Ticket/Display.html?id={$TicketId}">{$TicketSubject}</a>
+    and check there for status updates. You should also receive email.</p>
+
 =head3 Description
 
 Your forms will be made available to users on a dedicated Forms page in

-----------------------------------------------------------------------


hooks/post-receive
-- 
rt-extension-formtools