From be0d9f8c658e8697b665d901582451983b12d33c Mon Sep 17 00:00:00 2001 From: John Rouillard Date: Tue, 13 Feb 2024 13:07:57 -0500 Subject: [PATCH] doc: clean table for "the request variable" alphabetize the keys, also remove second form key from first table. --- doc/reference.txt | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/doc/reference.txt b/doc/reference.txt index 373153d8..d470b0f2 100644 --- a/doc/reference.txt +++ b/doc/reference.txt @@ -3393,13 +3393,12 @@ request. =========== ============================================================ Variable Holds =========== ============================================================ -form the CGI form as a cgi.FieldStorage -env the CGI environment variables base the base URL for this tracker -user a HTMLUser instance for this user classname the current classname (possibly None) +env the CGI environment variables +form the current CGI form variables in a cgi.FieldStorage template the current template (suffix, also possibly None) -form the current CGI form variables in a FieldStorage +user a HTMLUser instance for this user =========== ============================================================ **Index page specific variables (indexing arguments)** @@ -3408,14 +3407,14 @@ form the current CGI form variables in a FieldStorage Variable Holds =========== ============================================================ columns dictionary of the columns to display in an index page -show a convenience access to columns - request/show/colname will - be true if the columns should be displayed, false otherwise -sort index sort columns [(direction, column name)] -group index grouping properties [(direction, column name)] filter properties to filter the index on filterspec values to filter the index on (property=value, eg ``priority=1`` or ``messages.author=42`` +group index grouping properties [(direction, column name)] search_text text to perform a full-text search on for an index +show a convenience access to columns - request/show/colname will + be true if the columns should be displayed, false otherwise +sort index sort columns [(direction, column name)] =========== ============================================================ There are several methods available on the request variable: @@ -3423,15 +3422,15 @@ There are several methods available on the request variable: =============== ======================================================== Method Description =============== ======================================================== -description render a description of the request - handle for the - page title -indexargs_form render the current index args as form elements -indexargs_url render the current index args as a URL base_javascript render some javascript that is used by other components of the templating batch run the current index args through a filter and return a list of items (see `hyperdb item wrapper`_, and `batching`_) +description render a description of the request - handle for the + page title +indexargs_form render the current index args as form elements +indexargs_url render the current index args as a URL =============== ======================================================== The form variable