changeset 6448:2bd60def4fed

Improve doc on special action vars in cusotmizing.txt. Added example html inputs to illustrate the doc. Fix position of designator in doc example. It occurs before @link@ or other edit command.
author John Rouillard <rouilj@ieee.org>
date Sat, 26 Jun 2021 22:58:56 -0400
parents 8f8f4988b856
children 335c826cc089
files CHANGES.txt doc/customizing.txt
diffstat 2 files changed, 19 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/CHANGES.txt	Sat Jun 26 20:59:33 2021 -0400
+++ b/CHANGES.txt	Sat Jun 26 22:58:56 2021 -0400
@@ -22,6 +22,10 @@
 
 - add image/svg-xml as valid mime type to serve. Was being served as
   octet-stream. (John Rouillard)
+- improve customizing.txt documentation on use of Special Form
+  Variables. Added example html inputs to illustrate the doc.
+  Fix position of designator in doc example. It occurs before
+  @link@ or other edit command.
 
 2021-06-19 2.1.0b1
 
--- a/doc/customizing.txt	Sat Jun 26 20:59:33 2021 -0400
+++ b/doc/customizing.txt	Sat Jun 26 22:58:56 2021 -0400
@@ -2445,6 +2445,11 @@
         @link@messages=msg-1
         msg-1@content=value
 
+    which is equivalent to the html::
+
+        <textarea name="msg-1@content"></textarea>
+        <input type="hidden" name="@link@messages" value="msg-1">
+
     except that in addition, the "author" and "date" properties of
     "msg-1" are set to the userid of the submitter, and the current
     time, respectively.
@@ -2455,15 +2460,22 @@
         @link@files=file-1
         file-1@content=value
 
+    by adding the HTML::
+
+        <input type="file" name="file-1@content">
+        <input type="hidden" name="@link@files" value="file-1">
+
     The String content value is handled as described above for file
     uploads.
 
 If both the "@note" and "@file" form variables are
 specified, the action::
 
-        @link@msg-1@files=file-1
-
-is also performed.
+        msg-1@link@files=file-1
+
+is also performed. This would be expressed in HTML with::
+
+        <input type="hidden" name="msg-1@link@files" value="file-1">
 
 We also check that FileClass items have a "content" property with
 actual content, otherwise we remove them from all_props before

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