Mercurial > p > roundup > code
comparison doc/customizing.txt @ 7299:4890692dd0b7
Change ordered list to use numbers.
Orderd list was using letters, but sphynx was numbering it. The block
after the list was using letters to refer to items in the list.
Make everything use numbers.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Thu, 04 May 2023 20:57:38 -0400 |
| parents | f25f47c3c624 |
| children | bee24b37a90f |
comparison
equal
deleted
inserted
replaced
| 7298:f25f47c3c624 | 7299:4890692dd0b7 |
|---|---|
| 2264 | 2264 |
| 2265 where tracker root is ``/tracker/`` or ``/cgi-bin/roundup.cgi/tracker/`` | 2265 where tracker root is ``/tracker/`` or ``/cgi-bin/roundup.cgi/tracker/`` |
| 2266 We're looking at "issue", "issue1", "@@file/style.css", "file1" and | 2266 We're looking at "issue", "issue1", "@@file/style.css", "file1" and |
| 2267 "file1/kitten.png" in the cases above. | 2267 "file1/kitten.png" in the cases above. |
| 2268 | 2268 |
| 2269 a. with is no path we are in the "home" context. See `the "home" | 2269 1. with is no path we are in the "home" context. See `the "home" |
| 2270 context`_ below for details. "index" or "home" paths may also be used | 2270 context`_ below for details. "index" or "home" paths may also be used |
| 2271 to switch into "home" context. | 2271 to switch into "home" context. |
| 2272 b. for paths starting with "@@file" the additional path entry ("style.css" | 2272 2. for paths starting with "@@file" the additional path entry ("style.css" |
| 2273 in the example above) specifies the static file to be served | 2273 in the example above) specifies the static file to be served |
| 2274 from the tracker TEMPLATES directory (or STATIC_FILES, if configured). | 2274 from the tracker TEMPLATES directory (or STATIC_FILES, if configured). |
| 2275 This is usually the tracker's "html" directory. Internally this works | 2275 This is usually the tracker's "html" directory. Internally this works |
| 2276 by raising SendStaticFile exception. | 2276 by raising SendStaticFile exception. |
| 2277 c. if there is something in the path (as in example 1, "issue"), it | 2277 3. if there is something in the path (as in example 1, "issue"), it |
| 2278 identifies the tracker class to display. | 2278 identifies the tracker class to display. |
| 2279 d. if the path is an item designator (as in examples 2 and 4, "issue1" | 2279 4. if the path is an item designator (as in examples 2 and 4, "issue1" |
| 2280 and "file1"), then we're to display a specific item. | 2280 and "file1"), then we're to display a specific item. |
| 2281 :ref:`Note. <strip_zeros>` | 2281 :ref:`Note. <strip_zeros>` |
| 2282 e. if the path starts with an item designator and is longer than one | 2282 5. if the path starts with an item designator and is longer than one |
| 2283 entry (as in example 5, "file1/kitten.png"), then we're assumed to be | 2283 entry (as in example 5, "file1/kitten.png"), then we're assumed to be |
| 2284 handling an item of a ``FileClass``, and the extra path information | 2284 handling an item of a ``FileClass``, and the extra path information |
| 2285 gives the filename that the client is going to label the download | 2285 gives the filename that the client is going to label the download |
| 2286 with (i.e. "file1/kitten.png" is nicer to download than "file1"). | 2286 with (i.e. "file1/kitten.png" is nicer to download than "file1"). |
| 2287 This raises a ``SendFile`` exception. | 2287 This raises a ``SendFile`` exception. |
| 2288 | 2288 |
| 2289 Neither b. or e. use templates and stop before the template is | 2289 Neither 2. or 5. use templates and stop before the template is |
| 2290 determined. For other contexts the template used is specified by the | 2290 determined. For other contexts the template used is specified by the |
| 2291 ``@template`` variable, which defaults to: | 2291 ``@template`` variable, which defaults to: |
| 2292 | 2292 |
| 2293 - only classname supplied: "index" | 2293 - only classname supplied: "index" |
| 2294 - full item designator supplied: "item" | 2294 - full item designator supplied: "item" |