Mercurial > p > roundup > code
comparison doc/reference.txt @ 7357:0cb4541bad71
add welcome preface on reorg to pages
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Tue, 16 May 2023 02:23:17 -0400 |
| parents | f3c9ba5db30b |
| children | 3a98a81c6e57 |
comparison
equal
deleted
inserted
replaced
| 7356:ff5a50069822 | 7357:0cb4541bad71 |
|---|---|
| 9 | 9 |
| 10 ================= | 10 ================= |
| 11 Roundup Reference | 11 Roundup Reference |
| 12 ================= | 12 ================= |
| 13 | 13 |
| 14 .. admonition:: Welcome | |
| 15 | |
| 16 This document used to be part of the `customization document`_. The | |
| 17 customization document was getting large and unwieldy. It was a | |
| 18 combination of examples and internal information that made finding | |
| 19 information difficult. We often had questions on the mailing list that | |
| 20 were well answered in the customization document, but finding the info | |
| 21 was difficult. | |
| 22 | |
| 23 The documentation is slowly being reorganized using the `Diataxis | |
| 24 framework`_. Help with the reorganization is welcome. | |
| 25 | |
| 26 This is the document you should look at for background on a tutorial | |
| 27 or how-to guide in the customization document. | |
| 28 | |
| 29 .. _customization document: customizing.html | |
| 30 .. _diataxis framework: https://diataxis.fr/ | |
| 31 | |
| 14 .. This document borrows from the ZopeBook section on ZPT. The original is at: | 32 .. This document borrows from the ZopeBook section on ZPT. The original is at: |
| 15 http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx | 33 http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx |
| 16 | 34 |
| 17 .. contents:: | 35 .. contents:: |
| 18 :depth: 2 | 36 :depth: 2 |
| 19 :local: | 37 :local: |
| 20 | |
| 21 Welcome | |
| 22 ======= | |
| 23 | |
| 24 This document used to be part of the `customization document`_. The | |
| 25 customization document was getting large and unwieldy. It was a | |
| 26 combination of examples and internal information that made finding | |
| 27 information difficult. We often had questions on the mailing list that | |
| 28 were well answered in the customization document, but finding the info | |
| 29 was difficult. | |
| 30 | |
| 31 The documentation is slowly being reorganized using the `Diataxis | |
| 32 framework`_. Help with the reorganization is welcome. | |
| 33 | |
| 34 This is the document you should look at for background on a tutorial | |
| 35 or how-to guide in the customization document. | |
| 36 | |
| 37 .. _customization document: customizing.html | |
| 38 .. _diataxis framework: https://diataxis.fr/ | |
| 39 | 38 |
| 40 Trackers in a Nutshell | 39 Trackers in a Nutshell |
| 41 ====================== | 40 ====================== |
| 42 | 41 |
| 43 Trackers have the following structure: | 42 Trackers have the following structure: |