Changes between Version 12 and Version 13 of TracIniAdminPanelPlugin


Ignore:
Timestamp:
May 15, 2015, 3:10:18 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, rearranged paragraphs

Legend:

Unmodified
Added
Removed
Modified

  • TracIniAdminPanelPlugin

    v12 v13  
    55== Description
    66
    7 This plugin allow the Trac admininstrator to edit the `trac.ini` file using Trac's admin interface. Its goal is to provide the user with a complete and user-friendly interface.
     7This plugin allows the Trac admininstrator to edit the `trac.ini` file using Trac's admin interface. Its goal is to provide the user with a complete and user-friendly interface.
    88
    99Key features:
    1010
    1111 * Edit and/or view one section at a time or all sections together.
    12  * Each option comes with a ''lot of information'' (such as description, option type, stored value, default value).
    13  * ''Unobtrusive !JavaScript'' support; i.e. the editor works without !JavaScript but the user experience is better with !JavaScript enabled in the browser.
     12 * Each option comes with a ''lot of information'', such as description, option type, stored value, default value.
     13 * ''Unobtrusive !JavaScript'' support, so that the editor works without !JavaScript, but the user experience is better with !JavaScript enabled in the browser.
    1414 * ''Adding new sections and options'' (section entries)
    15  * Support for a ''security manager''. This manager controls which options can be modified by the user and can also reject certain values for certain options. This plugin comes with an (optional) basic security manager (see below).
    16  * Support for marking options as "password" (e.g. for `[notification]:smtp_password`) for enhanced security. Some options are already marked as "password" by default.
     15 * Support for a ''security manager''. This manager controls which options can be modified by the user and can also reject certain values for certain options. This plugin comes with an (optional) basic security manager, see below.
     16 * Support for marking options as "password", eg for `[notification]:smtp_password`, for enhanced security. Some options are already marked as "password" by default.
    1717
    1818The ini editor provides support for a pluggable security manager. A security manager has the following functions:
    1919
    20  * it can decide for each option whether the user can modify it, or whether it's read-only or ever hidden from the user.
    21  * it can check each value that is to be saved and reject it if necessary
     20 * decide for each option whether the user can modify it, or whether it's read-only or ever hidden from the user.
     21 * check each value that is to be saved and reject it if necessary.
    2222
    2323This plugin comes with two predefined security managers:
    2424
    25  * An "empty" security manager that doesn't impose any restrictions at all (i.e. it works as if no security manager was specified).
    26  * A basic security manager that lets you define restrictions via `trac.ini` (see configuration below).
     25 * An "empty" security manager that doesn't impose any restrictions at all, ie it works as if no security manager was specified.
     26 * A basic security manager that lets you define restrictions via `trac.ini`, see configuration below.
    2727
    2828[[Image(screenshot-inieditor1.png, border=3)]]
    … …  
    3636 * 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.
    3737 * Allows you to edit all sections at once.
    38  * 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).
    39  * Information about an option: the option type (list, extension list, bool), the currently stored value, the default value
    40  * Let's you easily revert an option to its default value (using a checkbox)
     38 * Only needs one entry in the admin menu. !TracIniEditor creates one entry per section, ie the more plugins you've installed the more entries you'll get.
     39 * Information about an option: the option type (list, extension list, bool), the currently stored value, the default value.
     40 * Let's you easily revert an option to its default value using a checkbox.
    4141 * !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.
    4242
    4343One last difference is the way each plugin displays the options of a section: while !IniAdminPlugin uses a groupbox per option, this plugin uses as list/table to display them. You can compare these two options here from screenshots: [attachment:compare-tracsection-iniadminplugin.png IniAdminPlugin] vs. [attachment:compare-tracsection-traciniadminpanel.png TracIniAdminPanel]
    44 
    45 == Configuration
    46 
    47 Configuration is done via `trac.ini` in the section `[ini-editor]. The following example lists the most important ones:
    48 
    49 {{{
    50 #!ini
    51 [ini-editor]
    52 ; Defines the security manager to use. Each security manager is a
    53 ; component on its own and must be enabled using the plugin admin
    54 ; panel or trac.ini.
    55 security-manager = IniEditorBasicSecurityManager
    56 
    57 ; Comma-separated list of options that are to be considered "password fields".
    58 ; All of Trac's password options are already predefined by default and don't
    59 ; need to be listed here.
    60 ;password-options = section|option
    61 }}}
    62 
    63 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`):
    64 
    65  * `default-access`: Defines the access level for options that don't get a specific access level assigned to
    66  * `section|option`: Defines the access level for a specific option in a specific section (e.g. `trac|mainnav`).
    67  * `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".
    68 
    69 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].
    70 
    71 == Requirements
    72 
    73 No dependencies.
    74 
    75 Requires Trac 1.0 (older branch available for 0.12.x also).
    7644
    7745== Bugs/Feature Requests
    … …  
    8755
    8856See 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:
    89 {{{
    90 #!sh
     57{{{#!sh
    9158easy_install TracIniAdminPanelPlugin
    9259}}}
    9360
    9461You can also obtain the code from the Trac Subversion repository:
    95 {{{
    96 #!sh
     62{{{#!sh
    9763svn co http://trac-hacks.org/svn/traciniadminpanelplugin
    9864}}}
    … …  
    10066or download [download:traciniadminpanelplugin zipped source].
    10167
     68You can [source:traciniadminpanelplugin browse the source] in Trac.
     69
     70== Installation
     71
     72This plugin requires Trac 1.0. An older branch is available for Trac 0.12.x also.
     73This plugin has no dependencies.
     74
    10275See TracPlugins for instructions on building and installing plugins.
    10376
    104 You can [source:traciniadminpanelplugin browse the source in Trac].
     77A link for [http://trac-hacks.org/svn/traciniadminpanelplugin/trunk/#egg=TracIniAdminPanelPlugin-dev setuptools to find the SVN download].
    10578
    106 ''[http://trac-hacks.org/svn/traciniadminpanelplugin/trunk/#egg=TracIniAdminPanelPlugin-dev This is a link for setuptools to find the SVN download]''[[BR]]
    107 ''[http://trac-hacks.org/svn/traciniadminpanelplugin/0.12/#egg=TracIniAdminPanelPlugin-dev This is a link for setuptools of 0.12 instances to find the SVN download]''
     79A link for [http://trac-hacks.org/svn/traciniadminpanelplugin/0.12/#egg=TracIniAdminPanelPlugin-dev setuptools of 0.12 instances to find the SVN download].
     80
     81== Configuration
     82
     83Configuration is done via `trac.ini` in the section `[ini-editor]. The following example lists the most important ones:
     84
     85{{{#!ini
     86[ini-editor]
     87; Defines the security manager to use. Each security manager is a
     88; component on its own and must be enabled using the plugin admin
     89; panel or trac.ini.
     90security-manager = IniEditorBasicSecurityManager
     91
     92; Comma-separated list of options that are to be considered "password fields".
     93; All of Trac's password options are already predefined by default and don't
     94; need to be listed here.
     95;password-options = section|option
     96}}}
     97
     98If 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`:
     99
     100 * `default-access`: Defines the access level for options that don't get a specific access level assigned to
     101 * `section|option`: Defines the access level for a specific option in a specific section (e.g. `trac|mainnav`).
     102 * `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".
     103
     104There 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].
    108105
    109106== Translation
    … …  
    125122[[ChangeLog(traciniadminpanelplugin, 3)]]
    126123
    127 == Author/Contributors ==
     124== Author/Contributors
    128125
    129126'''Author:''' [wiki:manski Sebastian Krysmanski] [[BR]]