Changeset 5577

Show
Ignore:
Timestamp:
10/22/08 12:58:50 (3 months ago)
Author:
Gustavo
Message:

Improved the metadata and markup of the documentation for tgext.authorization

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • docs/2.0/docs/main/Extensions/Authorization/index.rst

    r5568 r5577  
    1 :mod:`tgext.authorization` -- Authorization in TurboGears 2 
    2 =========================================================== 
     1:mod:`tgext.authorization` -- Authorization for TurboGears 2 applications 
     2========================================================================= 
     3.. module:: tgext.authorization 
     4    :synopsis: Authorization framework for TG2 
     5.. moduleauthor:: Gustavo Narea <me@gustavonarea.net> 
     6.. moduleauthor:: Florent Aide <florent.aide@gmail.com> 
     7.. moduleauthor:: Agendaless Consulting and Contributors 
    38 
    49:Status: Work in progress 
    …… 
    813-------- 
    914 
    10 ``tgext.authorization`` is an `authorization framework` for TurboGears 2, 
     15:mod:`tgext.authorization` is an `authorization framework` for TurboGears 2, 
    1116based on `repoze.who` (which deals with `authentication`). 
    1217 
    …… 
    2833 
    2934Because you may store your groups and permissions where you would like to, not 
    30 only in a database, ``tgext.authorization`` uses a generic terminology: 
     35only in a database, :mod:`tgext.authorization` uses a generic terminology: 
    3136 
    32   * ``Source``: Where authorization data (groups and/or permissions) is stored. 
    33     It may be a database or a file (an Htgroups file, an Ini file, etc), for 
    34     example.  
    35   * ``Group source``: A `source` that stores groups. For example, an Htgroups 
    36     file or an Ini file. 
    37   * ``Permission source``: A `source` that stores permissions. For example, an 
    38     Ini file. 
    39   * ``Source adapter``: An object that manages a given type of source to add, 
    40     edit and delete entries under an API independent of the source type. 
    41   * ``Section``: Sections are the groups that make up a source -- this is, in a 
    42     `permission source`, the sections are the permissions, and in a `group  
    43     source`, the sections are the groups. 
    44   * ``Item``: The elements that are contained in a section. In a `permission 
    45     source`, the items are the groups that are granted the permission  
    46     represented in their parent section; likewise, in a `group source`, the 
    47     items are the Ids of the users that belong to the group represented in the 
    48     parent section. 
     37.. glossary:: 
     38 
     39    source 
     40        Where authorization data (groups and/or permissions) is stored. 
     41        It may be a database or a file (an Htgroups file, an Ini file, etc), for 
     42        example. 
     43    group source 
     44        A :term:`source` that stores groups. For example, an Htgroups 
     45        file or an Ini file. 
     46    permission source 
     47        A :term:`source` that stores permissions. For example, an 
     48        Ini file. 
     49    source adapter 
     50        An object that manages a given type of :term:`source` to add, 
     51        edit and delete entries under an API independent of the source type. 
     52    section 
     53        Sections are the groups that make up a source -- this is, in a 
     54        `permission source`, the sections are the permissions, and in a `group  
     55        source`, the sections are the groups. 
     56    item 
     57        The elements that are contained in a :term:`section`. In a  
     58        :term:`permission source`, the items are the groups that are granted  
     59        the permission represented in their parent section; likewise, in a  
     60        :term:`group source`, the items are the Ids of the users that belong to 
     61        the group represented in the parent section. 
    4962 
    5063In your TurboGears 2 applications you may use any amount of group and  
    …… 
    179192    :maxdepth: 2 
    180193 
     194    Quickstart 
     195    Plugins 
    181196    ManagingSources 
    182197    WritingSourceAdapters