Documentation, written by Andrew Gilchrist
Thank you for your interest in Showcase. This provides a cost-effective and easy way to setup a website that allows everyone to become of a part of the club and gets to show off.
Showcase has many features that allows a wide range of customisation to be done, ensuring you do not lose the styling of the rest of your website by making it appear to be a fully-integrated feature.
|Full Showcase Features List|
Item Display Page
Member Profile Display Page
Join / Sign-Up Page
Member account options menu (logged in)
Admin account options menu (logged in)
|Technical Support and Bug Reports|
To request help with installing Showcase or to report a bug, please visit our home page at www.uplink.com.au or contact the author directory using email@example.com
There are 5 steps involved in installing Showcase:
1. Setup the script file.
2. Setup the HTML wrapper file.
3. Upload files to the web server.
4. Login and set your preferences.
5. Create a test account to test everything.
The following sections will discuss these steps in detail.
|Setup Showcase for Installation (step 1)|
Showcase directory structure:
Main directory (contains *.cgi, *.pm and wrapper.html files)
+--images (contains general web page image files)
+--imagesDB (will contain the member's uploaded images)
+--db (directory for database files)
+--emails (contains outgoing email template files)
+--pages (contains HTMl page files)
The main script file (index.cgi) contains 2 important variables that require setting before going any further.
1. Extract everything (retaining folder paths) to a directory on your hard drive (the directory should look like above).
2. Using a text editor, open index.cgi and edit the following variables.
3. On line 4 of index.cgi is the value of your Administrator Password. Change the value inside the quotes to the password you want.
4. On line 7 is the path to the database files. If you plan to hold the database directly under your script files, leave it as is, otherwise change it to a relative or absolute path.
|Setup the HTML Wrapper (step 2)|
Found in the same directory as the script files, wrapper.html is the HTML file that "wraps" the output of the script in the HTML you include in this file. In order to know where it must output in between HTML in the file, Showcase notices codes placed in the file. Following is a description of the codes.
Note 1: Each code MUST be placed on a line of its own in the file. Example:
Hello, this is a line of text.<br>
This is another line.<br>
Note: It is very important that the included HTML 'FORM' tag is in the file, and its exact properties remain untouched, as it is there to submit process control data and user-entered data. The form tag must be before any of the following codes discussed below, and must have a closing 'FORM' tag after all of the codes have been placed in the file. See the example wrapper.html file in the Showcase ZIP file for an example. Embedding them in between HTML table row tags (as in the example file) will prevent line breaks from appearing on the page.
Inside wrapper.html you will find several pre-defined CSS styles called by Showcase. The styles are as follows:
All CSS styles may be adjusted to your preferences. The best thing to do is experiment with the colours you like. Please make a backup of wrapper.html before changing things, in case you need to revert back for reference.
In the wrapper.html example file, there are folder tab style menu options for 'Home', 'Join' and 'FAQ'. These graphics are found in the "images" folder in the Showcase ZIP and may be altered to suit your website styling. These are included as a guide for your website. Please see the section on creating the home, join and FAQ page links.
|Creating the Main Menu (Home, FAQ, Join, Gallery) (step 3)|
The main menu allows access to the home page of your installed Showcase, the FAQ (frequently asked questions) page, the signup page and the photo gallery. The menu must be created manually so you can switch off any menu items you want, or include new ones amongst the existing ones.
The default main menu included in Showcase can be found in the HTML wrapper.html file. Below is a summary of the links and what you can include:
Note that the FAQ page is called by opening an HTML file in the database directory 'db/pages/'. It opens faq.html. By using this system, you can create other pages and call them by replacing 'faq' in 'index.cgi?act=page&f=faq' with whatever page / file name you want. For example, to display an about page, you would create a file named 'about.html' in the 'pages' directory and then call 'index.cgi?act=page&f=about'.
Using this method allows you to include whatever HTML / page you want inside the HTML wrapper.
|Showcase Installation (step 4)|
Following below are two types of installation. The first one is intended for quick installations on standard or generic webservers and the second is intended for webservers that may have tighter security and setup.
Custom Installation Procedure (for webservers with specific settings)
|Testing Showcase (step 5)|
|Administrator System Config Screen|
This screen allows the administrator to change system settings and clear databases. Be carefull when clearing databases!
Below is a run down of the admin settings available to the administrator using Showcase.
Note that the path to sendmail and ImageMagick may be obtained from your web server technical administrator / support staff.
You may need to have ImageMagick installed. ImageMagick is a collection of free image-handling utilities available on the internet.
|Admin > Categories|
The categories in Showcase are 3-level deep. This allows a flexible setup to cater for most needs. The category manager is designed to be worked through level by level.
The structure is as follows:
Top Level Category
- Mid-Level Category
- Sub-Level Category
An easy way to explain it is to use cars. Categories for a car would be setup as follows:
- Legend (mid)
- Sedan (sub)
- Coupe (sub)
In this example, Sedan and Coupe are both Sub-Level categories under the Honda > Legend categories.
You can edit and delete each category.
Another example would be:
- Honda (mid)
- Legend Sedan (sub)
- Legend Coupe (sub)
- Toyota (mid)
- Corolla Sedan (sub)
- RAV4 (sub)
- Supermarine (mid)
- Silverstream 4 (sub)
- Mightywave V8 (sub)
|Admin > Member Manager|
The Showcase member manager allows the administrator to edit a member's details, delete their account and set a Member Label for their account.
It is also used to enable a member account after screening it, if screening is enabled. To successfully screen a member, simply update their account and it will be enabled. An email will be sent to the member informing them of this. Deleting the account will reject their signup.
The Member Label can be used to insert special information about a member, such as to indicate a donating member or founder / webmaster. This label displays under their username on an item page and their member profile page. The information inserted can be plain text or any HTML, such as an image or colour and font styling, etc.
|Admin > Item Setup|
The item setup screen is where you control the customised form fields displayed when a member adds an item. At the top of the screen is the field that controls the maximum amount of items a member can have.
There is the option to allow items to be offered for sale. By setting it to yes, members can fill in a price and it will be displayed with a "for sale" note on the item display page.
Next are the item description fields.
Examples of field titles and types (using cars as a subject):
Year (text input)
Engine / Power / Torque (text input)
Colour (text input)
Standard Features (textarea)
Factory Options (textarea)
|Admin > Email manager|
This is where you can mass-send emails to members and setup your outgoing email templates.
If you select the 'Send Email to Members' option, a screen will load where you can type in an email subject and the message body. Clicking 'send' will send it to all of your enabled members.
If you select the 'Outgoing Email Templates' option, you may then select an email to modify. Select one of the emails and an editor screen will appear. Here you can edit the body of the email and use the provided codes to be inserted. A specific set of codes exist for each email. The codes begin with ! and will be replaced by the relevant data.
|Showcase > Home Page|
On the product's home page, the following sections are displayed:
Note that if there is only one item in a category when you view a category, you will be taken straight to it.
|Showcase > Item Display Page|
When an item is viewed, the following information is displayed:
The Admin Config screen allows you to modify the way this page is displayed.
|Showcase > Member Profile Page|
When a member's username is clicked on, it will display their profile page:
|Showcase > Gallery|
|The photo gallery displays all the images on the system, from new to last, broken up into a number per page (adjustable in configuration). Users may click on the thumbnail to view a larger version, or go to the itempage the image came from.|
|Showcase > Troubleshooting|
Problem: The actual Perl programming script is shown to me when I execute the script in my browser, but I
have followed all the correct setup procedures.
Solution 1: Try renaming index.cgi to index.pl and then do a mass search and replace in the file and it's .pm files for ".cgi" and replace all instances with ".pl". It may be that your server requires Perl scripts to run under *.pl extensions.
Solution 2: Try installing the script files under your dedicated "cgi-bin" directory if you have installed them elsewhere. Your server may only execute CGI scripts in your "cgi-bin" directory.
Problem: Emails are not being sent.
Solution 1: Please ensure that the path to sendmail in the admin config screen has been properly set to your server's setting. Please ensure it contains a trailing slash /.
Problem: My changes to the database or email files are not being saved.
Solution 1: The database files may require a specific file permissions setting other than a standard 660. Please check with your server admin for further information.
Solution 2: Your server may require the database files to be located under a different directory to your "cgi-bin" directory.
Problem: When I upload an image it always fails with an error.
Solution 1: Your server may not allow temporary writing of data files in your "cgi-bin" directory, which is required by Showcase using the standard CGI.pm Perl module to handle file uploading. Try relocating the scripts to a directory outside of "cgi-bin".
Problem: No matter what I try, it keeps displaying "500: Internal Server Error."
Solution 1: You may have uploaded the Perl, HTML and text files in binary file transfer mode. Please ensure your FTP program is set to ASCII transfer mode for these types of files.