Changes between Version 52 and Version 53 of SimpleMultiProjectPlugin


Ignore:
Timestamp:
May 28, 2015, 8:22:49 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes to maintain consistency with other hack's descriptions

Legend:

Unmodified
Added
Removed
Modified
  • SimpleMultiProjectPlugin

    v52 v53  
    55== Description
    66
    7 Lets you easily '''manage multiple user projects with one Trac instance''' or, respectively, one Trac database (.db file).
     7This plugin lets you easily '''manage multiple user projects with one Trac instance''' or, respectively, one Trac database (.db file).
    88
    9 This is not a meta project in front of several other Trac projects, it just implements the idea of [T:wiki:TracMultipleProjects/SingleEnvironment].
     9This is not a meta project in front of several other Trac projects. It implements the idea of [T:wiki:TracMultipleProjects/SingleEnvironment].
    1010
    11 What does this plugin extend in Trac?:
     11Key features:
    1212 * Milestones and versions are assigned to their projects, and both are displayed on the roadmap. There are several possibilities to filter by projects on that page, and also the timeline.
    1313 * Components can be assigned to all or only certain projects.
     
    1919'''Note''': The Multiple Project feature in the sense of having a meta Trac project on top of several Trac projects is discussed in T:#130 and scheduled for [T:milestone:topic-multiproject Trac topic-multiproject] which is eventually part of [T:milestone:next-dev-1.1.x Trac next-dev-1.1.x].
    2020
    21 == Plan
     21=== Plan
    2222
    2323In testing state:
     
    3333[[TicketQuery(component=SimpleMultiProjectPlugin&keywords$=planned&status!=assigned|reopened|closed)]]
    3434
    35 == Technical thoughts
     35=== Technical thoughts
    3636
    3737This plugin adds a new resource 'project' implemented by database table:
     
    4242 1. smp_component_project: the association of components to projects
    4343
    44 == Example
     44=== Example
     45
    4546All actions are also possible with the ''trac-admin'' script. See ''trac-admin <your-trac-env> project help'' for the list of available commands.
    4647
     
    8788== Bugs/Feature Requests
    8889
    89 Total issue record:
    90 [[TicketQuery(component=SimpleMultiProjectPlugin,format=progress)]]
    91 
    92 Open issues by type:
    93  [[TicketQuery(component=SimpleMultiProjectPlugin,status!=closed&group=type,format=progress)]]
     90Existing bugs and feature requests for SimpleMultiProjectPlugin are
     91[report:9?COMPONENT=SimpleMultiProjectPlugin here].
    9492
    9593If you have any issues, create a
    96 [http://trac-hacks.org/newticket?component=SimpleMultiProjectPlugin&owner=falkb new ticket].
     94[http://trac-hacks.org/newticket?component=SimpleMultiProjectPlugin new ticket].
     95
     96[[TicketQuery(component=TracTicketDepgraphPlugin&group=type,format=progress)]]
    9797
    9898== Download
     
    106106== Installation
    107107
    108  1. Add a custom ticket field 'project' in your trac.ini to give tickets the information to which project they belong. Milestones selection depends on that as well.
    109    {{{
    110    #!ini
    111    [ticket-custom]
    112    project = select
    113    project.label = Project
    114    project.value =
    115    }}}
    116  2. Generate the plugin .egg file from sources
    117    {{{
    118    #!sh
    119    python setup.py bdist_egg
    120    }}}
    121  3. Copy the plugin to Trac, e.g.
    122    {{{
    123    #!sh
    124    cp dist/SimpleMultiProject-0.0.1-py2.6.egg /instance_trac/plugins/
    125    }}}
    126  4. Restart Apache. After installation of this plugin Trac needs a database upgrade!
    127    {{{
    128    #!sh
    129    trac-admin /instance_trac/ upgrade
    130    }}}
    131  5. Give permissions to certain users. Available permissions are:
     108 1. Add a custom ticket field 'project' in your `trac.ini` file to give tickets the information to which project they belong. Milestones selection depends on that as well.
     109 {{{#!ini
     110[ticket-custom]
     111project = select
     112project.label = Project
     113project.value =
     114}}}
     115 1. Generate the plugin .egg file from sources
     116 {{{#!sh
     117python setup.py bdist_egg
     118}}}
     119 1. Copy the plugin to Trac, e.g.
     120 {{{#!sh
     121cp dist/SimpleMultiProject-0.0.1-py2.6.egg /instance_trac/plugins/
     122}}}
     123 1. Restart Apache. After installation of this plugin Trac needs a database upgrade!
     124 {{{#!sh
     125trac-admin /instance_trac/ upgrade
     126}}}
     127 1. Give permissions to certain users. Available permissions are:
    132128   - {{{ PROJECT_SETTINGS_VIEW }}} - you can see the list of projects with their description and their component mapping on the Admin panel
    133129   - {{{ PROJECT_ADMIN }}} - full access, you can also create and delete projects, and map to milestones, versions and components
    134  6. Since plugin version 0.4 we support project-wise restriction of resources to a subset of users (#11367). Switch on the plugin component ''ProjectTicketsPolicy'' to activate it, and add the following to your trac.ini
    135     {{{
    136     [trac]
    137     permission_policies = ProjectTicketsPolicy, ... any other ...
    138     }}}
    139     Define a comma-separated list of users or groups in 'Admin' -> 'Manage Projects' -> 'Projects' -> '<project name>' -> 'Retrict to users' to limit the access to certain projects (milestones, versions, tickets).[[BR]]For example, set
     130 1. Since plugin version 0.4 we support project-wise restriction of resources to a subset of users (#11367). Switch on the plugin component ''ProjectTicketsPolicy'' to activate it, and add the following to your `trac.ini` file:
     131 {{{#!ini
     132[trac]
     133permission_policies = ProjectTicketsPolicy, ... any other ...
     134}}}
     135 Define a comma-separated list of users or groups in 'Admin' -> 'Manage Projects' -> 'Projects' -> '<project name>' -> 'Restrict to users' to limit the access to certain projects, such as milestones, versions and tickets. For example, set
    140136    - {{{ john, mary, group1, authenticated }}} to restrict to this set of users
    141137    - {{{ !, bob, anonymous, group2 }}} to exclude from the project.
     
    143139== Recent Changes
    144140
    145 [[ChangeLog(simplemultiprojectplugin, 5)]]
     141[[ChangeLog(simplemultiprojectplugin, 3)]]
    146142
    147143== Author/Contributors