| 22 | | == Source and Tickets == |
| 23 | | You'll find all information about this plug-in [https://svn.mayastudios.de/mtpp/wiki/Plugins/TracIniAdminPanel here]. Please file tickets only there. |
| | 29 | === Difference to IniAdminPlugin === #IniAdminPlugin |
| | 30 | |
| | 31 | There is a similar plugin, the IniAdminPlugin. There are some features that this plugin provides and that don't exist in the !IniAdminPlugin: |
| | 32 | |
| | 33 | * Creating new sections and (more important) new options. This allows you to even edit the sections `[ticket-custom]` or `[ticket-workflow]` which can't be done with !IniAdminPlugin. |
| | 34 | * Allows you to edit all sections at once. |
| | 35 | * Only needs one entry in the admin menu. !TracIniEditor creates one entry per section (i.e. the more plugins you've installed the more entries you'll get). |
| | 36 | * Information about an option: the option type (list, extension list, bool), the currently stored value, the default value |
| | 37 | * Let's you easily revert an option to its default value (using a checkbox) |
| | 38 | * !IniAdminOnly allows you to hide certain options. This plugin allows you to mark options as "read-only" thereby allowing the user to see its value but don't allowing him/her to change it. |
| | 39 | |
| | 40 | One last difference is the way each plugin displays the options of a section: while !IniAdminPlugin uses a groupbox per option, my plugin uses as list/table to display them. I find the latter option better but I guess this is a matter of taste. You can compare these two options here from screenshots I've made: [attachment:compare-tracsection-iniadminplugin.png IniAdminPlugin] vs. [attachment:compare-tracsection-traciniadminpanel.png TracIniAdminPanel] |
| | 41 | |
| | 42 | == Configuration == |
| | 43 | Configuration is done via `trac.ini` in the section `[ini-editor]. The following example lists the most important ones: |
| | 44 | |
| | 45 | {{{ |
| | 46 | #!text |
| | 47 | [ini-editor] |
| | 48 | ; Defines the security manager to use. Each security manager is a |
| | 49 | ; component on its own and must be enabled using the plugin admin |
| | 50 | ; panel or trac.ini. |
| | 51 | security-manager = IniEditorBasicSecurityManager |
| | 52 | |
| | 53 | ; Comma-separated list of options that are to be considered "password fields". |
| | 54 | ; All of Trac's password options are already predefined by default and don't |
| | 55 | ; need to be listed here. |
| | 56 | ;password-options = section|option |
| | 57 | }}} |
| | 58 | |
| | 59 | If you want to use the `IniEditorBasicSecurityManager` you need to configure it via `trac.ini`, too. The permissions are configured in the section `[ini-editor-restrictions]`. The following "options kinds" are available here (where "access level" is one of `modifiable`, `readonly`, or `hidden`): |
| | 60 | |
| | 61 | * `default-access`: Defines the access level for options that don't get a specific access level assigned to |
| | 62 | * `section|option`: Defines the access level for a specific option in a specific section (e.g. `trac|mainnav`). |
| | 63 | * `section|*`: Defines the default access level for all options in the specified section (e.g. `trac|*`). This can be overwritten with the previous "option kind". |
| | 64 | |
| | 65 | There is an example configuration provided by this plugin which resembles a white-list of "secure" options. You can find it [source:traciniadminpanelplugin/0.12/safe-restrictions.ini here]. |
| | 66 | |
| | 67 | == Requirements == |
| | 68 | |
| | 69 | No dependencies. |
| | 70 | |
| | 71 | Requires Trac 0.12.x. |
| | 72 | |
| | 73 | == Bugs/Feature Requests == |
| | 74 | |
| | 75 | Existing bugs and feature requests for !TracIniAdminPanelPlugin are [report:9?COMPONENT=TracIniAdminPanelPlugin here]. |
| | 76 | |
| | 77 | If you have any issues, create a |
| | 78 | [http://trac-hacks.org/newticket?component=TracIniAdminPanelPlugin&owner=stoecker new ticket]. |
| | 79 | |
| | 80 | == Get the Plugin == |
| | 81 | |
| | 82 | See the [wiki:TracPlugins#Requirements Trac plugin requirements] for instructions on installing `setuptools`. `Setuptools` includes the `easy_install` application which you can use to install the TracIniAdminPanelPlugin: |
| | 83 | {{{ |
| | 84 | easy_install TracIniAdminPanelPlugin |
| | 85 | }}} |
| | 86 | |
| | 87 | You can also obtain the code from the Trac Subversion repository: |
| | 88 | {{{ |
| | 89 | svn co http://trac-hacks.org/svn/traciniadminpanelplugin |
| | 90 | }}} |
| | 91 | |
| | 92 | or download [download:traciniadminpanelplugin zipped source]. |
| | 93 | |
| | 94 | See TracPlugins for instructions on building and installing plugins. |
| | 95 | |
| | 96 | You can [source:traciniadminpanelplugin browse the source in Trac]. |
| | 97 | |
| | 98 | ''[http://trac-hacks.org/svn/traciniadminpanelplugin/trunk/#egg=TracIniAdminPanelPlugin-dev This is a link for setuptools to find the SVN download]'' |
| | 99 | |
| | 100 | == Known Issues == |
| | 101 | |
| | 102 | [[TicketQuery(component=TracIniAdminPanelPlugin,status=!closed)]] |
| | 103 | |
| | 104 | == Recent Changes == |
| | 105 | |
| | 106 | [[ChangeLog(traciniadminpanelplugin, 3)]] |
