Changes between Version 5 and Version 6 of TracCaptchaPlugin


Ignore:
Timestamp:
Mar 12, 2015, 4:55:39 PM (7 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with license

Legend:

Unmodified
Added
Removed
Modified
  • TracCaptchaPlugin

    v5 v6  
    11[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = !TracCaptcha =
     3= !TracCaptcha
    44
    5 == Description ==
     5== Description
    66
    7 !TracCaptcha is a trac plugin to embed a captcha in the ticket page in addition to Trac's regular permission checks so that spammers are kept out.
     7This plugin embeds a captcha in the ticket page in addition to Trac's regular permission checks. Its purpose is to keep spammers out of the Trac environment.
    88
    9 '''Batteries included:''' The popular reCAPTCHA system is supported out of the box. Technically it's a plugin - if you don't like it you're free to use any other plugin while still leverage the benefits from the general captcha
    10 infrastructure.
     9'''Fully functional:''' The popular reCAPTCHA system is supported out of the box. Technically it's a plugin: if you don't like it, you are free to use any other plugin while still leverage the benefits from the general captcha infrastructure.
    1110
    1211'''Does not annoy users:''' After the user entered the captcha once, he does not have to solve the captcha again for the same ticket when he just clicks 'preview'. Also you can configure exempt certain users or groups (e.g. 'all authenticated users') from the captchas just by using Trac's permission system.
    1312
    14 '''Generic Infrastructure:''' !TracCaptcha takes care about embedding a
    15 given captcha in the appropriate places which means that building a different
    16 captcha plugin is easy - you just have to build the captcha itself while this
    17 code will take care of the trac integration.
     13'''Generic Infrastructure:''' !TracCaptcha takes care about embedding a given captcha in the appropriate places which means that building a different captcha plugin is easy - you just have to build the captcha itself while this code will take care of the Trac integration.
    1814
    19 The whole code is licensed under the very liberal [http://en.wikipedia.org/wiki/MIT_License MIT license] so you can use the API in your own code without problems.
     15The whole code is licensed under the very liberal [http://en.wikipedia.org/wiki/MIT_License MIT license], so you can use the API in your own code without problems.
    2016
    21 == See it in Action ==
     17== See it in Action
     18
    2219[[Image(wiki:TracCaptchaPlugin:captcha_example.png)]]
    2320
    24 The macro is also used on the '''[http://www.schwarz.eu/opensource/projects/trac_captcha/ project page]''' - but please keep in mind that this is not a online demo, so do not create tickets to test the captcha!
     21The macro is also used on the '''[http://www.schwarz.eu/opensource/projects/trac_captcha/ project page]''', but please keep in mind that this is not an online demo, so do not create tickets to test the captcha!
    2522
    26 == Download ==
     23== Download
    2724
    28 The latest sources are available from the [http://www.schwarz.eu/opensource/projects/trac_captcha/ project page] and [http://pypi.python.org/pypi/TracCaptcha pypi].
     25The latest sources are available from the [http://www.schwarz.eu/opensource/projects/trac_captcha/ project page] and [pypi:TracCaptcha].
    2926
    30 === Configuration ===
    31 Enable the macro in your trac.ini:
     27=== Configuration
     28
     29Enable the macro in your `trac.ini`:
    3230{{{
     31#!ini
    3332[components]
    3433trac_captcha.* = enabled
     
    3736
    3837[recaptcha]
    39 # add here the keys you got from http://recaptcha.net/api/getkey
     38# add here the keys you obtained from http://recaptcha.net/api/getkey
    4039public_key = ...
    4140private_key = ...
    4241}}}
    4342
    44 If you want to exempt some users from the captcha, grant them the CAPTCHA_SKIP privilege. TICKET_ADMINs and TRAC_ADMINs automatically have this privilege so they will never see a captcha. Also a user only needs to solve the captcha once per modification (so you can click 'preview' as often as you like without having to solve the captcha all over again).
     43If you want to exempt some users from the captcha, grant them the `CAPTCHA_SKIP` privilege. TICKET_ADMINs and TRAC_ADMINs automatically have this privilege, so they will never see a captcha. Also a user only needs to solve the captcha once per modification, so you can click 'preview' as often as you like without having to solve the captcha all over again.
    4544
    46 === Dependencies and Compatibility ===
     45=== Dependencies and Compatibility
     46
    4747 * Python 2.3-2.7
    4848 * [trac: Trac] 0.11, 0.12, 0.13
    49  * ''optional'': [http://www.pycrypto.org PyCrypto] for better security on Python 2.3 and 2.4
     49 * Optional: [http://www.pycrypto.org PyCrypto] for better security on Python 2.3 and 2.4
    5050
    51 == Bugs/Feature Requests ==
     51== Bugs/Feature Requests
    5252
    5353Existing bugs and feature requests for the !TracCaptcha plugin are stored on the [http://www.schwarz.eu/opensource/projects/trac_captcha/ project page]. Please do not file bugs in the trac-hacks bug tracker.
    5454
    55 
    56 == Author/Contributors ==
     55== Author/Contributors
    5756
    5857'''Author:''' [wiki:felix_schwarz] [[BR]]
    59 '''Maintainer:''' [wiki:felix_schwarz] [[BR]]
     58'''Maintainer:''' [[Maintainer]] [[BR]]
    6059'''Contributors:'''