Mercurial > p > roundup > code
comparison doc/customizing.txt @ 6174:5522c950a2e4
Add indexing for roundup-admin references.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sat, 16 May 2020 13:40:12 -0400 |
| parents | 53a674b5910f |
| children | a701c9c81597 |
comparison
equal
deleted
inserted
replaced
| 6173:82f58ae89142 | 6174:5522c950a2e4 |
|---|---|
| 1001 | 1001 |
| 1002 .. index: triple: schema; class method; setkey | 1002 .. index: triple: schema; class method; setkey |
| 1003 | 1003 |
| 1004 setkey(property) | 1004 setkey(property) |
| 1005 ~~~~~~~~~~~~~~~~ | 1005 ~~~~~~~~~~~~~~~~ |
| 1006 | |
| 1007 .. index:: roundup-admin; setting assignedto on an issue | |
| 1006 | 1008 |
| 1007 Select a String property of the class to be the key property. The key | 1009 Select a String property of the class to be the key property. The key |
| 1008 property must be unique, and allows references to the items in the class | 1010 property must be unique, and allows references to the items in the class |
| 1009 by the content of the key property. That is, we can refer to users by | 1011 by the content of the key property. That is, we can refer to users by |
| 1010 their username: for example, let's say that there's an issue in roundup, | 1012 their username: for example, let's say that there's an issue in roundup, |
| 1736 #for cl in 'issue', 'file', 'msg': | 1738 #for cl in 'issue', 'file', 'msg': |
| 1737 # db.security.addPermissionToRole('Anonymous', 'Create', cl) | 1739 # db.security.addPermissionToRole('Anonymous', 'Create', cl) |
| 1738 # db.security.addPermissionToRole('Anonymous', 'Edit', cl) | 1740 # db.security.addPermissionToRole('Anonymous', 'Edit', cl) |
| 1739 | 1741 |
| 1740 .. index:: | 1742 .. index:: |
| 1741 single: roundup-admin; class permissions | 1743 single: roundup-admin; view class permissions |
| 1742 | 1744 |
| 1743 You can use ``roundup-admin security`` to verify the permissions | 1745 You can use ``roundup-admin security`` to verify the permissions |
| 1744 defined in the schema. It also verifies that properties specified in | 1746 defined in the schema. It also verifies that properties specified in |
| 1745 permissions are valid for the class. This helps detect typos that can | 1747 permissions are valid for the class. This helps detect typos that can |
| 1746 cause baffling permission issues. | 1748 cause baffling permission issues. |
| 4029 | 4031 |
| 4030 | 4032 |
| 4031 Populating the new category class | 4033 Populating the new category class |
| 4032 ::::::::::::::::::::::::::::::::: | 4034 ::::::::::::::::::::::::::::::::: |
| 4033 | 4035 |
| 4034 If you haven't initialised the database with the ``roundup-admin`` | 4036 If you haven't initialised the database with the |
| 4035 "initialise" command, then you can add the following to the tracker | 4037 "``roundup-admin initialise``" command, then you |
| 4036 ``initial_data.py`` under the comment:: | 4038 can add the following to the tracker ``initial_data.py`` |
| 4039 under the comment:: | |
| 4037 | 4040 |
| 4038 # add any additional database creation steps here - but only if you | 4041 # add any additional database creation steps here - but only if you |
| 4039 # haven't initialised the database with the admin "initialise" command | 4042 # haven't initialised the database with the admin "initialise" command |
| 4040 | 4043 |
| 4041 Add:: | 4044 Add:: |
| 4042 | 4045 |
| 4043 category = db.getclass('category') | 4046 category = db.getclass('category') |
| 4044 category.create(name="scipy") | 4047 category.create(name="scipy") |
| 4045 category.create(name="chaco") | 4048 category.create(name="chaco") |
| 4046 category.create(name="weave") | 4049 category.create(name="weave") |
| 4050 | |
| 4051 .. index:: roundup-admin; create entries in class | |
| 4047 | 4052 |
| 4048 If the database has already been initalised, then you need to use the | 4053 If the database has already been initalised, then you need to use the |
| 4049 ``roundup-admin`` tool:: | 4054 ``roundup-admin`` tool:: |
| 4050 | 4055 |
| 4051 % roundup-admin -i <tracker home> | 4056 % roundup-admin -i <tracker home> |