diff doc/glossary.txt @ 8384:e0e3212c1e80

doc: better document the template property in the request object.
author John Rouillard <rouilj@ieee.org>
date Sat, 12 Jul 2025 17:25:03 -0400
parents dc136e237fa6
children 8eee280eddc3
line wrap: on
line diff
--- a/doc/glossary.txt	Sat Jul 12 17:07:50 2025 -0400
+++ b/doc/glossary.txt	Sat Jul 12 17:25:03 2025 -0400
@@ -81,13 +81,19 @@
 
    template
 
-      this term has two meanings depending on context.
+      this term has three meanings depending on context.
 
       It refers to files that are processed by a templating engine to
       produce output suitable for machine or human consumption. For
       example a template could produce a html page that includes the
       name of the user.
 
+      It is an property of the request object in the templating
+      system. Templates that are used with a specific class (e.g.
+      ``issue.item.html``) will have this entry set to the middle
+      element (``item`` in this example). For templates like
+      ``home.html`` the element will be set to the empty string.
+
       It also can mean a **Tracker template**. This is a set of files
       used to install a new tracker. Tracker templates define a
       tracker with a particular look and feel, :term:`schema`,

Roundup Issue Tracker: http://roundup-tracker.org/