=== StageShow ===
Contributors: Malcolm-OPH
Donate link: http://www.corondeck.co.uk/StageShow/donate.html
Tags: admin, calendar, cart, e-commerce, events, pages, payments, paypal, posts, theater, theatre, tickets, user
Requires at least: 3.0
Tested up to: 3.6
Stable tag: 2.2
StageShow adds the facility for an online Box-Office for Small Theatres/Drama Groups, records sales, validates tickets and provides sales downloads.
== Description ==
StageShow provides a simple interface to define your Shows and then a single Wordpress shortcode adds a online BoxOffice to your website.
StageShow uses either the PayPal Shopping Cart or its’ own integrated Shopping Trolley to collect orders, and the PayPal checkout to collect payments, which can be made using either a PayPal account or a credit/debit card. PayPal IPN (Instant Payment Notification) is used to record sales and to collect buyer information.
Each sale is fully recorded, with contact and payment details, tickets purchased and PayPal transaction number all saved to the Wordpress database. Confirmation emails, which can be customised as required, are sent to each purchaser and can be copied to the system administrator.
EMails are in text only format, and the PayPal transaction number if included for validation purposes. StageShow includes the facility on the admin pages to verify the transaction number for use at show time
StageShow includes the facility to export sales to a "TAB Separated Text" file for further analysis or processing by other programs (i.e. Spreadsheets etc.).
StageShow Features Summary
* Adds a online BoxOffice for a Single Show
* Up to 4 Performances with Specified start Date/Time and Maximum Number of Tickets
* Unlimited number of Ticket Types for each performance with individually defined prices
* Choice of Integrated Shopping Cart or PayPal Shopping Cart
* Integrated PayPal Payment Collection
* Payments accepted using Credit/Debit cards or from PayPal account
* EMail confirmation of Booking to Client and Administrator
* Manual entry of ticket sales for telephone sales etc.
* Online and Offline Sale Transaction ID validation
* Export of Ticket Sales and Settings as "TAB Separated Text" format file
* Access to StageShow Admin pages/features controlled by custom capabilities
* Extensive Help (in PDF format) file shipped with plugin
Additional Features in StageShow+ (available here)
* No limit on number of Shows or Performances
* Unlimited number of User defined "Price Plans" to set prices when adding a performance
* Optional ticket Reservations for logged in users (i.e. Unpaid ticket sales)
* Allows ticket prices to be defined as "Admin Only" (only available via Admin menus)
* Reservation Client Details captured from Users Profile extended by any 3rd party plugin
* MIME Encoded EMails so HTML/Text mixed format emails supported
* Optional Barcode of Transaction ID in sale confirmation emails
* Logging of Online Ticket Validation attempts
* Multiple Terminal Support for Verification
* Editing of Sale Entries
* Show title output on Box Office page customisable per show (text/HTML)
* Performance title output on Box Office page customisable per performance (text/HTML)
* Optional EMail with sales summary (to a specified email address) on each new sale
* Booking Closing Time can be specified for each performance
== Installation ==
First Time Installation
* Download the stageshow plugin archive
* Open the Wordpress Dashboard for you site
* Select the "Upload" option
* Click "Add New" under the "Plugins" menu
* Under "Install a plugin in .zip format" browse to the stageshow plugin archive file you downloaded
* Click Install Now.
* After it has installed, activate the plugin.
Upgrade
* On the WP Plugins Page deactivate StageShow
* Using FTP (or your ISPs file manager) delete the stageshow plugins folder in wp-content/plugins folder
* Now Proceed as for the First Time Installation
== Frequently Asked Questions ==
= How do I set up StageShow? =
* Install the plugin and activate it
* Go to the StageShow - Settings page and enter your PayPal details and click "Save Settings"
* Now go to the show, performance and prices pages and set up your show!
* Create a page on your website for the Box Office (or edit an existing one) and add the tag [sshow-boxoffice] to it
= What PayPal settings are required? =
PayPal API Access must be enabled - and the associated User, Password, Signature and EMail entries added to "Stageshow" settings.
IPN (Instant Payment Notification) must be enabled for Sales to be recorded by the PlugIn. Payment will still be accepted and the sale will be recorded by PayPal if IPN is disabled.
Set the "IPN Listener" URL to http://{Your Site URL}/wp-content/plugins/stageshow/stageshow_NotifyURL.php.
StageShow can be used with a PayPal developer account (the "SandBox"). Select "SandBox" as the Environment option, and then enter the PayPal account parameters in the usual way.
= Why can't I edit the PayPal settings? =
PayPal Login details cannot be changed if one or more performance entries are present.
The StageShow plugin creates a PayPal "Saved Button" when a performance is added to the show. There is currently no mechanism to recreate these buttons if the PayPal configuration is changed, hence the limitation.
= What WordPress settings are required? =
StageShow needs the WordPress setting of TimeZone to be correctly set-up (i.e. to a City) for time-sensitive functionality to operate correctly. The current value can be found on the Settings->General admin page.
= Why can't I delete a show or performances? =
A performance cannot be deleted if there are sales recorded for it and the show start time has not yet been reached. A show cannot be deleted if performances are still configured for it.
= How do I add a Booking Form to my site? =
Add the tag [sshow-boxoffice] to either a new or existing page on your site. This will be replaced by the booking form when the page is viewed by a user.
= Do my purchasers have to have a PayPal account? =
No. Turning on the "PayPal Account Optional" setting on the sellers PayPal account allows purchasers to use a Credit or Debit card without the need for a PayPal account. Details are in the StageShow help file.
= How can I customise the EMails? =
The EMails generated by the StageShow plugin are defined by a template file.
Template defaults are in the {Plugins Folder}/{Plugin Name}/templates/email folder, which is copied to the {Uploads Folder}/stageshow/email when the plugin is Activated or Updated. The default email template is stageshow_EMail.php.
The default template can be copied to new a file in the uploads folder, which can then be used to create a custom template, which can then in turn be selected using the Admin->Settings page.
The template file can be modified as required. A number of "Tags" can be included in the EMail template, which will be replaced by data relating to the sale extracted from the database.
= What tags can be used in the EMail template? =
The following tags can be used in the EMail template:
* [salePPName] Buyer PayPal Account Details: Name
* [salePPStreet] Buyer PayPal Account Details: Street
* [salePPCity] Buyer PayPal Account Details: City
* [salePPState] Buyer PayPal Account Details: State
* [salePPZip] Buyer PayPal Account Details: Zip/Post Code
* [salePPCountry] Buyer PayPal Account Details: Country
* [saleDateTime] Sale Details: Date and Time
* [saleName] Sale Details: Buyer Name
* [saleEMail] Sale Details: Buyer EMail
* [salePaid] Sale Details: Paid
* [saleTxnId] Sale Details: PayPal Transaction ID (TxnId)
* [saleStatus] Sale Details: PayPal Transaction Status
* [saleBarcode] Sale Details: PayPal Transaction ID converted to a Barcodes (Only for StageShow+)
* [startloop] Marker for the start of a loop for each ticket type purchased
* [endloop] Marker for the end of the loop
* [ticketName] Sale Details: Ticket Name
* [ticketType] Sale Details: Ticket Type ID
* [ticketQty] Sale Details: Ticket Quantity
* [organisation] The Organsiation ID (as on the Settings Page)
* [adminEMail] The Admin EMail (as on the Settings Page)
* [url] The Site Home Page URL
= How can I use my own images on the Checkout page? =
Default Images in the {Plugins Folder}/{Plugin Name}/templates/images folder are copied to the {Uploads Folder}/{Plugin Name}/images when the plugin is Activated or Updated.
Custom images can be copied to this folder (using FTP) and can then be selected using the Admin->Settings page.
= Where is the User Guide? =
A copy of the User Guide, as a pdf file, is included with StageShow distributions. This can be accessed via a link on the Overview page.
The User Guide can also be downloaded or viewed here.
== Screenshots ==
1. Screenshot 1: Overview Page
2. Screenshot 2: Shows Setup
3. Screenshot 3: Performances Setup
4. Screenshot 4: Ticket Types and Prices Setup
5. Screenshot 5: Sales Log Summary
6. Screenshot 6: Sales Log Summary (Showing Details)
7. Screenshot 7: Admin Tools Page
8. Screenshot 8: PayPal Settings Page
9. Screenshot 9: General Settings Page
10. Screenshot 10: Advanced Settings Page
11. Screenshot 11: Shows Box Office Page
12. Screenshot 12: Sample EMail
== Changelog ==
* Version History for StageShow Plugin
= 2.2 (07/09/2013) =
* Bug Fix: "Add" button not translated
* Bug Fix: DB error generating SaleSummary email when there are no sales
* Bug Fix: Offline Validator needs keyboard input when used with Barcode reader
* Bug Fix: Offline Validator download filename has incorrect file extension
* Support for PayPal Checkout removed
* StageShow styles loaded after theme style
* Added limited duplicate scan detection to Offline Validator
* Added translations to Offline Validator
= 2.1.6 (15/08/2013) =
* Bug Fix: Translations missing on Box Office and Shopping Trolley output
* Bug Fix: Purge Pending sales ignored daylight saving time
* Now checks WP_LANG_DIR for translation files in addition to plugin 'lang' directory
= 2.1.5 (04/08/2013) =
* Added "Contact Phone" to Sale Log details
* Updated for compatibility with WP 3.6 - depracated split() recoded
* Separated FirstName and LastName in DB and Export files
* Removed seconds from performance time display
= 2.1.4 (31/07/2013) =
* Bug Fix: Admin URLs with _wpnonce arg may have html encoded arg separator
* Added Search Sales facility to sales page
= 2.1.3 (12/07/2013) =
* Bug Fix: Styles did not format Shopping Trolley output on Box Office page
* Bug Fix: Invalid WP Date/Time format gives blank performance dates on Box Office page
* Confirm action on Delete or Set Completed Actions
= 2.1.2 (11/07/2013) =
* Bug Fix: Price Plans not checked for valid prices (StageShow+ only)
* Bug Fix: Bottom Bulk Action Apply button uses Selected Top Bulk Action when valid
* Zero prices permitted with Integrated Checkout
= 2.1.1 (05/07/2013) =
* Bug Fix: Checkout total is zero when currency symbol is enabled
= 2.1 (04/07/2013) =
* Bug Fix: Performance name not shown when Performance sales log has no sales
* Bug Fix: Shows Lists have inoperative pagination controls (sometimes)
* Bug Fix: Performance Lists have inoperative pagination controls (sometimes)
* Bug Fix: Sales Lists have inoperative pagination controls (sometimes)
* Bug Fix: Show name not shown when Show sales log has no sales
* Bug Fix: Bulk actions do not report error if nothing changed
* Bug Fix: Status message not shown for Activate/Deactivate Show action
* Bug Fix: Prices entires for unchanged show(s) blank after duplicate price ref error (StageShow+ only)
* Bug Fix: Default Performance Expires time does not track changes in performance time
* Bug Fix: Incorrect value for Sample Sales total paid values
* Added Reservations (StageShow+ only)
* EMail Template File renamed "Sale EMail Template" in settings
* Fuctions in one or both of PayPal mode and Reservation mode (StageShow+ only)
* Implemented "Visibility" setting for prices (StageShow+ only)
* Performance Expiry time made editable (StageShow+ only)
* Sales use "local time" for sale time/date
* Leading and trailing spaces removed from text settings entries
* Settings tabs renamed
* Paid/Due column added to Sales List
* Added Checkout Notes
= 2.0.6 (30/06/2013) =
* Bug Fix: Currency codes in text emails changed to three letter currency code
* Bug Fix: Surplus /table tag in empty sales list
= 2.0.5 (06/06/2013) =
* Bug Fix: Undefined stockPrice in Sale Editor fixed
* Bug Fix: Inconsistant visibility of Merchant ID, and API ***** fields in PayPal Settings
* Bug Fix: Edit box for TxnID in Auto-Update Settings too small
* Bug Fix: Plugin version number check inconsistent
* Bug Fix: Daylight saving time handling inconsistent
* Bug Fix: Box Office shows inactive/expired shows
* Deleted Shows, Performances and Prices only removed from DB when not referenced by Sales
* Integrated Checkout syles rationised
* Added salePaid and saleFee to Sales Summary export (StageShow+ only)
* Flush Sales removed from Tools Menu
= 2.0.4 (21/05/2013) =
* Bug Fix: Fix for WP wp_mail() bug ... no HTML email content for Outlook/iPhone
= 2.0.3 (05/04/2013) =
* Bug Fix: PayPal Checkout failures - Cannot process transaction error
= 2.0.2 =
* Bug Fix: TDT Export MIME type changed to text/tab-separated-values
* Bug Fix: (StageShow+) Plugin Version check gave undefined error if Internet unavailable
* Added Logging of PayPal Transaction Fees
* Ticket Price logged with each sale
* Export File Field Names now defined by translatable table
* Added OFX format export (StageShow+ only)
* Checkout Timeout added to settings
* Box Office columns widths set by style sheet (stageshow.css)
* Implemented Checkout Complete and Checkout Cancelled URLs in settings
* IPN "Callback" URL changed to stageshow_ipn_callback.php (was stageshow_NotifyURL.php)
= 2.0.1 (04/03/2013) =
* Bug Fix: Integrated Checkout fails for performances with unlimited ticket quantities
= 2.0 (20/02/2013) =
* Bug Fix: Templates not always copied to uploads folder
* Implements Integrated Checkout
* Added Checkout Type and MerchantID to Settings
* Corrected spelling of "perfarmance" on prices admin page
* Blocks edit of PayPal settings once a Show has been defined
* Added Currency Formatting
* Admin Javascript moved to stageshow_admin.js
* Added "Sold Out" message on BoxOffice output when all tickets sold
* Added missing <div> tag to Sales Admin page
* Added Users Guide (in PDF format)
= 1.2.1 (18/12/2012) =
* Bug Fix: Export Data gives 404 error - stageshow_export.php file has incorrect case
* New prices are added for a specified performance which cannot then be edited
= 1.2 (04/12/2012) =
* Bug Fix: StageShow_Validate capability not deleted on uninstall
* Admin Pages code optimised
* Separators added between tabs on settings page(s)
* Added support for translations
* Added stageshow.pot file to distribution
* Added PayPal login error code reports
* Moved "EMail Template File" option to StageShow settings
* Sample Sales are always for only one show
* New Shows are always initialised as ACTIVE
* Added Settings Page URL param to select tab
= 1.1.7 (23/10/2012) =
* Activate function explicitly called on version update
* Email and Images Templates moved to uploads/{pluginID}/****** folders
* Test Send Email added to Tools admin page
* Admin Pages - Redundant <form> tag action parameters removed
* Admin Pages CSS - stageshow-settings-**** classes changed to mjslib-settings-****
= 1.1.6 (07/09/2012) =
* Bug Fix: Custom templates and images are deleted on plugin update
* Bug Fix: Custom roles not deleted on plugin uninstall
* Emails templates moved to uploads/stageshow/emails folder
* PayPal Logo and Header Images moved to uploads/stageshow/images folder
* PayPal Logo and Header Images now selected using drop-down box on settings page
* Deletes uploads/stageshow folder when plugin is deleted
* Settings page default tab changes once PayPal settings are added
= 1.1.5 (23/08/2012) =
* Bug Fix: Version update code does not check database version
* Bug Fix: Ticket Types can be omitted from Sale Summary Export
* Ticket types for some samples changed to "All"
* Added stageshow-boxoffice-add class to Box Office Add buttons
* Renamed 'StageShow+ Auto Update Settings' as Auto Update Settings'
* Sales quantities on overview page are now links to show and performance sales pages
* Sample performance dates altered to make shows visible on setup
* Settings sections displayed as tabs on admin page
* Add New Performance status messages improved
= 1.1.4 (18/07/2012) =
* Added "Sales Summary" option to Export Data on Tools admin page
* Added Offline Sales Verififier
* Bug Fix: Tools Admin page - Footer appears in middle of page
* Bug Fix: Settings Export permitted for users without 'StageShow_Admin' capability
* Bug Fix: Performances or Prices with associated sales can still be deleted
* Add New Performance uses local date/time as performance date/time
= 1.1.3 (05/07/2012) =
* Bug Fix: (Benign) Overview page generates "Undefined offset" error for Shows without any Performances
* Total Sales values added to Overview Page
* Effenciency improved on Overview page database queries
* Settings page layout improved
* StageShow admin email defaults to WP admin email
* StageShow Organisation ID defaults to WP Site Name
* EMail template paths default to stageshow/templates folder
= 1.1.2 (30/06/2012) =
* Bug Fix: IPN Fails when sale has quotes in any field (including the Show name)
* ReadMe changelog changed to reverse chronological order
= 1.1.1 (24/06/2012) =
* Added Performance Sales Summaries to Overview Page
* Added "booking confirmed" message to email template
* Missing Configuration messages now include links to the relevant admin page
* Sales page accessible (non-edit) to users with StageShow_Validate capability
= 1.1.0 (15/06/2012) =
* Bug Fix: Activate/Deactivate Show not working ...
* Compatible with WP 3.4
= 1.0.7 (13/06/2012) =
* Bug Fix: Sale Ticket Type was always recorded as the same type
* Renamed "Presets" as "Price Plans"
* Coding of Admin Pages restructured
* Error notifications on Admin Pages improved
* StageShow specific styles now defined in stageshow-admin.css
* File Names rationised
* Bug Fix: "Validate" Capability implemented
= 1.0.6 (24/04/2012) =
* Implemented "Hidden Rows" for Details Fields in Sales Screen
* Bug Fix: Inventory Control not working in v1.0.5 - Fixed (includes PayPal buttons update on activation)
* Added check for zero ticket prices - new price entries initialised to 1.00
= 1.0.5 (20/04/2012) =
* Bug Fix: "Add New Show" not displayed on Shows Admin Page (Add New Price ahown instead)
= 1.0.4 (14/04/2012) =
* Added Currency Symbols to currency options
* Added option to output currency symbol in Box Office
* Cosmetic: Added separator line between admin screen entries
* Bug Fix: HTML Select element options on some admin screens not retrieved
* Bug Fix: Undefined variable error generated on Performances update error
* Class of BoxOffice output HTML elements changed from boxoffice-**** to stageshow-boxoffice-****
= 1.0.3 (02/04/2012) =
* Bug Fix: Input Edit box size value fixed
* Bug Fix: Box Office shortcode output was always at top of page.
* Max Ticket Count added to settings
* Items per page added to settings
* Negative/Non-Numeric max number of seats converted to unlimited (displayed as infinite)
* New Performance defaults to unlimited number of seats
* Number of seats available can be set to unlimited using negative value (default value)
= 1.0.1 (12/03/2012) =
* Bug Fix: include folder missing from archive in 1.0.0
= 1.0.0 =
* Bug Fix: Call to wp_enqueue_style() updated for compatibility with WP 3.3
* AutoComplete disabled on Settings page
* PayPal Account EMail address added to settings (PayPal may not report it correctly)
* Shortcodes Summary added to Overview page
* Added support of "User Roles" to admin pages
* Added Ticket Sale Reference Validation to "Tools" Admin page
* Added Pagination to all admin screen lists
= 0.9.5 =
* Dual PayPal Credentials merged - Live or Test (Sandbox) mode must be set before adding performances
* StageShow-Plus renamed StageShow+
= 0.9.4 =
* Added StageShow specific capabilities (StageShow_Sales, StageShow_Admin and StageShow_Settings) to WP roles
* Added Facility to manually add a sale
* Added Facility to activate/deactivate selected performances
* Box Office page elements formatted by stageshow.css stylesheet
* Duplicate dates on BoxOffice output supressed (STAGESHOW_BOXOFFICE_ALLDATES overrides)
= 0.9.3.1 =
* Fixed "Function name must be a string" error when changing Admin EMail ( stageshow_manage_settings.php)
= 0.9.3 =
* Fixed Distribution Error in ver0.9.1
* Added Style Sheet (stageshow.css)
* Added styles to BoxOffice page and updated default style
= 0.9.2 =
* Bug Fix: Malformed <form> tag on BoxOffice page fixed
* BoxOffice time/date format now uses WordPress settings
* (Note: Private release)
= 0.9.1 =
* Added Pagination to Sales Summary
* Added Uninstall
* Added Activate/Deactivate options for shows and performances
= 0.9 =
* First public release
== Upgrade Notice ==
= 1.0.7 =
* Bug Fix: Sales were always recorded as the same Ticket Type
= 1.0.0 =
* Earlier versions not compatible with WP 3.3 - Style sheets may not load
= 0.9 =
* First public release