Mercurial > p > roundup > code
comparison doc/reference.txt @ 7737:2b0164ac5cfa
doc: clean table for "the request variable"
alphabetize the keys, also remove second form key from first table.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Tue, 13 Feb 2024 13:07:57 -0500 |
| parents | f14409a760e3 |
| children | 315f40fd0e67 |
comparison
equal
deleted
inserted
replaced
| 7736:f14409a760e3 | 7737:2b0164ac5cfa |
|---|---|
| 3391 .. taken from ``roundup.cgi.templating.HTMLRequest`` docstring | 3391 .. taken from ``roundup.cgi.templating.HTMLRequest`` docstring |
| 3392 | 3392 |
| 3393 =========== ============================================================ | 3393 =========== ============================================================ |
| 3394 Variable Holds | 3394 Variable Holds |
| 3395 =========== ============================================================ | 3395 =========== ============================================================ |
| 3396 form the CGI form as a cgi.FieldStorage | 3396 base the base URL for this tracker |
| 3397 classname the current classname (possibly None) | |
| 3397 env the CGI environment variables | 3398 env the CGI environment variables |
| 3398 base the base URL for this tracker | 3399 form the current CGI form variables in a cgi.FieldStorage |
| 3400 template the current template (suffix, also possibly None) | |
| 3399 user a HTMLUser instance for this user | 3401 user a HTMLUser instance for this user |
| 3400 classname the current classname (possibly None) | |
| 3401 template the current template (suffix, also possibly None) | |
| 3402 form the current CGI form variables in a FieldStorage | |
| 3403 =========== ============================================================ | 3402 =========== ============================================================ |
| 3404 | 3403 |
| 3405 **Index page specific variables (indexing arguments)** | 3404 **Index page specific variables (indexing arguments)** |
| 3406 | 3405 |
| 3407 =========== ============================================================ | 3406 =========== ============================================================ |
| 3408 Variable Holds | 3407 Variable Holds |
| 3409 =========== ============================================================ | 3408 =========== ============================================================ |
| 3410 columns dictionary of the columns to display in an index page | 3409 columns dictionary of the columns to display in an index page |
| 3410 filter properties to filter the index on | |
| 3411 filterspec values to filter the index on (property=value, eg | |
| 3412 ``priority=1`` or ``messages.author=42`` | |
| 3413 group index grouping properties [(direction, column name)] | |
| 3414 search_text text to perform a full-text search on for an index | |
| 3411 show a convenience access to columns - request/show/colname will | 3415 show a convenience access to columns - request/show/colname will |
| 3412 be true if the columns should be displayed, false otherwise | 3416 be true if the columns should be displayed, false otherwise |
| 3413 sort index sort columns [(direction, column name)] | 3417 sort index sort columns [(direction, column name)] |
| 3414 group index grouping properties [(direction, column name)] | |
| 3415 filter properties to filter the index on | |
| 3416 filterspec values to filter the index on (property=value, eg | |
| 3417 ``priority=1`` or ``messages.author=42`` | |
| 3418 search_text text to perform a full-text search on for an index | |
| 3419 =========== ============================================================ | 3418 =========== ============================================================ |
| 3420 | 3419 |
| 3421 There are several methods available on the request variable: | 3420 There are several methods available on the request variable: |
| 3422 | 3421 |
| 3423 =============== ======================================================== | 3422 =============== ======================================================== |
| 3424 Method Description | 3423 Method Description |
| 3425 =============== ======================================================== | 3424 =============== ======================================================== |
| 3426 description render a description of the request - handle for the | |
| 3427 page title | |
| 3428 indexargs_form render the current index args as form elements | |
| 3429 indexargs_url render the current index args as a URL | |
| 3430 base_javascript render some javascript that is used by other components | 3425 base_javascript render some javascript that is used by other components |
| 3431 of the templating | 3426 of the templating |
| 3432 batch run the current index args through a filter and return a | 3427 batch run the current index args through a filter and return a |
| 3433 list of items (see `hyperdb item wrapper`_, and | 3428 list of items (see `hyperdb item wrapper`_, and |
| 3434 `batching`_) | 3429 `batching`_) |
| 3430 description render a description of the request - handle for the | |
| 3431 page title | |
| 3432 indexargs_form render the current index args as form elements | |
| 3433 indexargs_url render the current index args as a URL | |
| 3435 =============== ======================================================== | 3434 =============== ======================================================== |
| 3436 | 3435 |
| 3437 The form variable | 3436 The form variable |
| 3438 ::::::::::::::::: | 3437 ::::::::::::::::: |
| 3439 | 3438 |