Mercurial > p > roundup > code
comparison doc/customizing.txt @ 1832:f7b0ca3de3dc
doc fixes
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Tue, 07 Oct 2003 06:03:53 +0000 |
| parents | 4e4afbe3cd30 |
| children | 6e80f8f760a4 |
comparison
equal
deleted
inserted
replaced
| 1831:921c48ecb3f5 | 1832:f7b0ca3de3dc |
|---|---|
| 1 =================== | 1 =================== |
| 2 Customising Roundup | 2 Customising Roundup |
| 3 =================== | 3 =================== |
| 4 | 4 |
| 5 :Version: $Revision: 1.102 $ | 5 :Version: $Revision: 1.103 $ |
| 6 | 6 |
| 7 .. This document borrows from the ZopeBook section on ZPT. The original is at: | 7 .. This document borrows from the ZopeBook section on ZPT. The original is at: |
| 8 http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx | 8 http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx |
| 9 | 9 |
| 10 .. contents:: | 10 .. contents:: |
| 298 | 298 |
| 299 issue = IssueClass(db, "issue", topic=Multilink("keyword"), | 299 issue = IssueClass(db, "issue", topic=Multilink("keyword"), |
| 300 status=Link("status"), assignedto=Link("user"), | 300 status=Link("status"), assignedto=Link("user"), |
| 301 priority=Link("priority")) | 301 priority=Link("priority")) |
| 302 issue.setkey('title') | 302 issue.setkey('title') |
| 303 | |
| 304 | |
| 305 What you can't do to the schema | |
| 306 ------------------------------- | |
| 307 | |
| 308 You must never: | |
| 309 | |
| 310 **Remove the users class** | |
| 311 This class is the only *required* class in Roundup. Similarly, its | |
| 312 username, password and address properties must never be removed. | |
| 313 | |
| 314 **Change the type of a property** | |
| 315 Property types must *never* be changed - the database simply doesn't take | |
| 316 this kind of action into account. Note that you can't just remove a | |
| 317 property and re-add it as a new type either. If you wanted to make the | |
| 318 assignedto property a Multilink, you'd need to create a new property | |
| 319 assignedto_list and remove the old assignedto property. | |
| 320 | |
| 321 | |
| 322 What you can do to the schema | |
| 323 ----------------------------- | |
| 324 | |
| 325 Your schema may be changed at any time before or after the tracker has been | |
| 326 initialised (or used). You may: | |
| 327 | |
| 328 **Add new properties to classes, or add whole new classes** | |
| 329 This is painless and easy to do - there are generally no repurcussions | |
| 330 from adding new information to a tracker's schema. | |
| 331 | |
| 332 **Remove properties** | |
| 333 Removing properties is a little more tricky - you need to make sure that | |
| 334 the property is no longer used in the `web interface`_ *or* by the | |
| 335 detectors_. | |
| 336 | |
| 337 | |
| 303 | 338 |
| 304 Classes and Properties - creating a new information store | 339 Classes and Properties - creating a new information store |
| 305 --------------------------------------------------------- | 340 --------------------------------------------------------- |
| 306 | 341 |
| 307 In the tracker above, we've defined 7 classes of information: | 342 In the tracker above, we've defined 7 classes of information: |