Development

Changeset 12795

You must first sign up to be able to contribute.

Changeset 12795

Show
Ignore:
Timestamp:
11/09/08 05:02:01 (5 years ago)
Author:
Stephen.Ostrow
Message:
  • Made a package.xml file
  • Updated the README file to be markup
  • Added a LICENSE file
Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • plugins/sfDoctrinePollPlugin/branches/1.0/README

    r8381 r12795  
    1 = sfDoctrinePollPlugin = 
    2  
    3 [[PageOutline(2-4,,inline)]] 
     1# sfDoctrinePollPlugin # 
    42 
    53sfDoctrinePollPlugin is a Symfony plugin which make polling a piece of cake. 
    64 
    7 = Documentation = 
    8  
    9 == Installation == 
    10 === SVN repository === 
     5# Documentation # 
    116 
    127 
    13 === Plugin configuration === 
     8## Usage ## 
    149 
    15  
    16 == Usage == 
    17 ==== User Identification ==== 
     10#### User Identification #### 
    1811Currently user identification is determined by a static method  in the PluginsfPoll model. 
    1912You may change the way users are identified by overriding the method getUserIdentifier() 
    2013Currently it is a concatentation of the users IP Address and the USER_AGENT 
    2114 
     15### Modules ### 
    2216 
    23  
    24 === API === 
    25  
    26  
    27 === Modules === 
    28  
    29 The plugin provide both Back and Front office standard modules that you can  
     17The plugin provide both Back and Front office standard modules that you can 
    3018activate in the {{{settings.yml}}} of your apps. 
    3119 
    3220In front office, you can activate the sfPolls module : 
    3321 
    34 {{{ 
    35   .settings 
    36     enabled_modules: [default, ..., sfPolls] 
    37 }}} 
     22    [yaml] 
     23    # /apps/frontend/config/settings.yml 
     24    .settings 
     25      enabled_modules: [default, ..., sfPolls] 
    3826 
    3927In back office, you should activate the sf_poll module : 
    4028 
    41 {{{ 
    42   .settings 
    43     enabled_modules: [default, ..., sf_poll] 
    44 }}} 
    45 == TODO == 
    46  
    47 == Changelog == 
    48  
    49 === 2008-04-03 | v0.1.0 === 
    50   
    51  * Initial release 
     29    [yaml] 
     30    # /apps/backend/config/settings.yml 
     31    .settings 
     32      enabled_modules: [default, ..., sf_poll]