Tags:
twiki_application1Add my vote for this tag create new tag
, view all tags

Fundraising Plugin

Show a fundraising message with a progress bar

Introduction

This plugin defines %FUNDRAISINGMESSAGE%, using a few variables defined on FundraisingPlugin; this can be used as %BROADCASTMESSAGE% on Main.TWikiPreferences.

Example

this-ngo.org needs money:

  $120

$30 to go

before 2005-10-28: give us money

Behavior

%FUNDRAISINGMESSAGE% is not defined when one of the following conditions is verified:

  • %ENDDATE% is in the past;
  • %GOAL% has already been reached;
  • the configuration variables (defined below) values are not consistent.

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %FUNDRAISINGPLUGIN_SHORTDESCRIPTION%

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Show a fundraising message with a progress bar

  • Debug plugin: (See output in data/debug.txt)
    • Set DEBUG = 0

  • End date of the fundraising:
    • Set ENDDATE = 2012-10-28

  • Total amount to raise:
    • Set GOAL = 1000

  • Amount already pledged:
    • Set PLEDGED = 200

  • Message to display before the progress bar
    • Set PREMSG = TWiki needs money:
    • #Set PREMSG = TWiki a besoin d'argent:

  • How to display the already pledged amount
    • Set PLEDGEDMSG = $%FUNDRAISINGPLUGIN_PLEDGED%
    • #Set PLEDGEDMSG = %FUNDRAISINGPLUGIN_PLEDGED%¬†‚�¨

  • How to display the amount to raise in the progress bar (TOGO will be replaced by the missing amount)
    • Set TOGOMSG = $TOGO to go
    • #Set TOGOMSG = manque TOGO¬†‚�¨

Plugin Installation Instructions

  • Download the ZIP file from the Plugin web (see below)
  • Unzip FundraisingPlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/FundraisingPlugin.txt Plugin topic
    lib/TWiki/Plugins/FundraisingPlugin.pm Plugin Perl module
  • Edit FundraisingPlugin to suit your needs.
  • Write-protect FundraisingPlugin against modifications (with bullet * Set ALLOWTOPICCHANGE = Main.TWikiAdminGroup).
  • To enable it on all pages, set %BROADCASTMESSAGE% to %FUNDRAISINGMESSAGE% in Main.TWikiPreferences topic.

Plugin Info

Plugin Author: TWiki:Main.BenVoui
Plugin Version: 2010-10-31 - v0.3
Change History:  
2010-10-31: TWikibug:Item6530: Doc fixes (0.3)
2 Feb 2005: Replaced "euro" by the euro symbol. Use the non-breaking space Unicode char when needed. (0.2.1)
6 Nov 2005: Fixed default config (0.2)
21 Aug 2005: Initial version (0.1)
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.0
License: GPL (GNU General Public License)
TWiki:Plugins/Benchmark: GoodStyle 96%, FormattedSearch 98%, FundraisingPlugin 100%
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/FundraisingPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/FundraisingPluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/FundraisingPluginAppraisal

Related Topics: TWikiPreferences, TWikiPlugins

Topic attachments
I Attachment History Action Size Date Who Comment
Compressed Zip archivezip FundraisingPlugin-20050821.zip r1 manage 7.8 K 2005-08-22 - 00:11 BenVoui  
Compressed Zip archivezip FundraisingPlugin-20051106.zip r1 manage 5.2 K 2005-11-06 - 23:47 BenVoui 0.2
Unknown file formatmd5 FundraisingPlugin.md5 r5 r4 r3 r2 r1 manage 0.2 K 2010-11-01 - 00:26 PeterThoeny  
Compressed Zip archivetgz FundraisingPlugin.tgz r5 r4 r3 r2 r1 manage 4.9 K 2010-11-01 - 00:25 PeterThoeny  
Compressed Zip archivezip FundraisingPlugin.zip r5 r4 r3 r2 r1 manage 6.6 K 2010-11-01 - 00:25 PeterThoeny  
Unknown file formatEXT FundraisingPlugin_installer r3 r2 r1 manage 3.4 K 2010-11-01 - 00:26 PeterThoeny  
Edit | Attach | Watch | Print version | History: r20 < r19 < r18 < r17 < r16 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r20 - 2013-10-16 - PeterThoeny
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2016 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.