NewcalendarSP1 version 3.51

  1. Calendar Features
  2. How to Use the Calendar
  3. The Newcalendar Settings Page
  4. Adding Events List to HTML Pages (SSI)
  5. A Note on Fonts
  6. Installing the Calendar for the First Time
  7. Upgrading from a Previous Version
  8. Optional Holiday Pack
  9. Optional Form Highlighter
  10. YaBB Front End (Who's On) Addon
  11. Calendar History
  12. Credits

To get the most out of the Newcalendar mod, please read this entire file.


HELP FOR USERS

Features:

To Use:

To view events:
Click on the event name. Details for the events for that day event will open.  If a member birthday is displayed, clicking on the member's name will open that member's profile page.
 

Click on Event to View Details

 
Send Event:  Clicking on the "Send Event to a Friend" button opens up the Send Event page.  Here the user may send a quick email message, asking them to take a look at the event.  The user needs to enter the name and email address of the recipient.

 
Send Event Page
The default message sent:
The Admin may edit this message in the language file (english.lng).

 
Dear Bubba,
I want you to check out the following event notice on the MineralArts Test Forums.

Event: Geological Society
Posted by: Admin
Type of Event: Meeting
Date of Event: 1/16/2004

To view details, please click the link below

http://www.yourwebsite.com/...viewevent

Thanks,
User


To add a new event:
Click on the date text for the event date in the month view.  The date text is the "15" on the 15th of the month.
 

Click on Date to Add Events
A edit events page for that day will open.  Users can be add/modify/delete their own events through this page.
Edit Events Page


Events entered by other users will not be shown on the edit page.  Admins and Calendar Moderators can modify/delete all events.  If guest event posting is enabled by the Admin, then guests may post events.  Guests may modify/delete any guest event since all guests are user "Guest".

Name:  This is the the name of the event that will appear on the month view and Info Center listing for the event.  The maximum length is 15 characters.  YaBBC codes are allowed here so smilies can be used.  The YaBB censor function is applied to this field.

Type:  This the type of the event.  Events are organizied on the Info Center by type.

Repeat For:  To create a multiday event open the edit events page for the first day of the event.  Enter the number of days in the "Repeat for" box and select "Day(s)" from the drop down list.

To create recurring events open the edit events page for the first day the event will occur and enter the number of times the event will occur and select weeks, months, years, or 3rdTues from the drop down list.  For example,  if you have an event that occurs each Wednesday for three weeks, open the edit events page for the first Wednesday, enter 3 in the "repeat for" box and select Week(s) from the drop down menu.  The 3rdTues option allows the entry of monthly events that occur on the same day of the week and the same week of the month but not on the same date each month.  Example: a meeting that is scheduled for the third Tuesday of each month).

Description:  Enter the description of the event.  YaBBC codes are allowed here so images, formatted text, links, smilies, etc. can be used here.  The YaBB censor function is applied to this field.

Entered by:  Shows who posted the event.

Add or Change Entry:  Enter events one at a time and click the "Add or Change Entry" button for each event before adding or editing another event.

Delete:  Click to delete the event.  Note:  There is no second chance here.  If the delete button is pressed, the event is deleted.


HELP FOR THE FORUM ADMINISTRATORS


New Calendar Settings Page:

The Newcalendar Settings Page is accessed through the Admin Center.

Calendar Window Title:  This is the text that appears in the window title bar when the month view page (Main Calendar) page is accessed.

Calendar Title:  This is the title of the calendar that appears above the Main Calendar.

Type of Event Pick List Options:  This is where the Admin can enter the types of events that will appear in the drop down list on the edit events page.  Types are entered with a single space between each type and no commas or other punctuation.  If you installed the Holiday Pack, be sure to enter Holiday as an event type.

Event Types List
 

Default Event Type:  This is the  event type from the list above that should be used as the default when the user fails to select an event type.

View Event Page Window Title:  This is the text that appears in the window title bar when view events pages are accessed.

View Event Page Title:  This is the title of the view events pages.

View Event Page Window Title:  This is the text that appears in the window title bar when edit events pages are accessed.

View Event Page Title:  This is the title of the edit events pages.

Maximum Number of Events per Day:  This sets the maximum number of events that can be shown for a day.  The minimum setting is one.  This maximum number does not include recurring events set on a previous day that coincide with the current day.

Display events for how many days?  The listing of calendar events in the Info Center may be set to display events for several days into the future.  The minimum number of days is 1 (today's events) and the maximum days of events is through the end of the month following the current month.  This setting also controls the number of days for which events will be displayed in the SSI and YaBB FrontEnd (Who's On) mod display.

Limit Event Posting to Admins and Calendar Moderators Only?  Checking this box will allow only Admins and Calendar Moderators to post events.  Other users will be able to view events.

Calendar Moderators:  The members of the member groups* specified in this box will become Calendar Moderators.  As Calendar Moderators, these members will have the ability to add/edit/delete events when the check box above is checked.  In addition, Calendar Moderators can modify/delete events written by anyone.

Limit Calendar Access?  When this box is checked, all members may view the calendar.  When unchecked, only Admins and the members of the member groups specified in the Newcal Group will be able to view the calendar.

Newcal Group:  The members of the member groups* specified in this box will be granted exclusive access to the calendar when the box below is un-checked.  Tip: Unchecking box below and entering a nonexistent member group name makes calendar visible to Admin only (handy for hiding calendar during major updates).

*The member groups discussed here are the member groups defined in YaBB and created and modified through the Edit Member Groups function in the Admin Center.  Members are added to these member groups through individual member Profile pages.  Members are added as Calendar Moderators and Newcalgroup only through member groups, not as individuals.

Member group names should be entered in the boxes with a comma between each group name and no spaces between group names:

GroupOne,Group Two,Global Moderators   ==> Correct
GroupOne, Group Two, Global Moderators ==> NO! Use no spaces between group names!
GroupOne|Group Two|Global Moderators   ==> NO! Commas are the only separator used!

Enter Member Group Names


Guest Event Posting:  If checked guests may post events, if unchecked guest posting is not allowed.

Date Format:  This setting allows the date to be displayed in one of two formats.  If unchecked, the date will be shown as "Friday, November 15, 2002".  If checked, the date will be shown as Friday 15 November 2002.

First Day of Week:  If unchecked, Sunday will be shown as the first day of the week.  If checked, Monday will be shown as the first day of the week.
 

Weeks can start with Sunday or Monday
Moon Phases on Main Calendar:  If checked, the full moon and new moon will be shown on the Main Calendar.

 
Moon Phases on Main Calendar
Moon Phases on Info Center:  If checked, the current phase of the moon image will replace the calendar icon on the Upcoming Events section of the Info Center and display on the SSI and YaBB FrontEnd.  If unchecked, the regular calendar icon will appear on the Upcoming Events section of the Info Center and no moon phase images will appear on the SSI and YaBB FrontEnd.

 
Upcoming Events on BoardIndex
Show Birthdays on Calendar:  If checked, member birthdays will  appear on the Main Calendar, Info Center, SSI, and YaBB FrontEnd.
Allow Event Notices via Email:  If checked, users may send notices of events to others via email by clicking buttons on the view events pages.
Show Newcalendar Help Link?  If checked, a link to this help file will appear next to the "Search Calendar Events" link.  This help file is written in english and this file may not be appropriate where the primary language of forum users is not english.  The Calendar Help link to this file located at the top of the Newcalendar Settings Page will remain even if this box is unchecked.  The Admin may choose to replace this help file with another more appropriate file.

Rebuild Members List:  It is recommended that the Admin run "Rebuild Member List".  This will keep the member birthday info current.  This is the  same function as found on the main Admin Center page.  It is repeated here as a reminder to the Admin that the proper functioning of the calendar relies on an up-to-date member list.

All On-Screen Text not entered on the Newcalendar Settings Page is found in the english.lng file.
Calendar colors and fonts are in the template.html file .newcal settings.



To Use the Server Side Include:

To add Upcoming Events to any HTML page on the host server, add the following include tag on the page where you would like Today's Events to appear.

<!--#include virtual="/cgi-bin/yabb/YaBB.pl?action=includecal" -->

Correct the tag to reflect the path to your yabb forum from your root web directory.  Note that many servers require that an HTML page carrying an include statement like the one above have an .shtml extension instead of an .html or .htm extension.



Fonts Note:

To define the calendar fonts as you wish, be sure to have something like:

p,h1,h2,h3,h4,ul,ol,li,div,td,th,address,blockquote,nobr,b,i { font-family:Verdana,Arial,sans-serif;}

in your template.html to define the general font-family for the whole board.  Otherwise the fonts will default to the user's browser defaults.  The calendar will work either way.  To change specific fonts and colors in the calendar, modify the .newcal settings in the template.html file.



New Installation:
(read upgrade section below if you are upgrading from another Newcalendar version)
 
  1. Install the mod (manually with a text editor or using Boardmod).  If you don't know how to install a mod, please visit the BoardMod website for assistance before attempting to install this calendar, a short time spent reading the FAQ file there will save you a great deal of frustration here.
  2. Upload the modified YaBB.pl, english.lng, Subs.pl, Admin.pl, BoardIndex.pl, and template.html files (use ASCII mode).  Chmod as normal.
  3. Upload Newcalendar.pl, MoonPhase.pl, and SendEvent.pl to your Sources directory (use ASCII mode).
  4. Upload all gif files in the images folder to your YaBB images directory (use binary mode).
  5. Upload eventcal.txt and eventcaldb to your Variables directory in ASCII mode and chmod both to 666.
  6. Upload NewcalendarHelp.html to your YaBB help directory (use ASCII mode).
  7. Upload all the gif files in the help folder to your YaBB help directory (use binary mode).
  8. Edit the Newcalendar Settings in the Admin Center.  Read the NewcalendarHelp.html file (this file) to learn about the various settings


Upgrading the Calendar from a Previous Version:

Upgrading from Newcalendar 1.x:
No good upgrade path exists, uninstall older Newcalendar version and install this version.  The database file has changed in format so you will lose all current entries.
 

Upgrade from Newcalendar version 2.x or 3.x:

  1. Backup your eventcaldb file.
  2. Uninstall old version.
  3. Install new version.
  4. Restore your backup copy of eventcaldb to your variables directory.


Note: Color settings are now in template.html instead of eventcal.txt.



Optional Holiday Pack:

The holiday.txt file is an optional database file for Newcalendar that is pre-loaded with a number of holidays.  The holiday information is written in english and there is a bias toward US holidays.  The holiday information was volunteered by members of the Boardmod forum.  If you have favorite holidays you would like to see on the next version of the holiday pack, please post your request here:  Ironwing's Forum

If you are installing Newcalendar for the first time or don't want to keep any events currently on your calendar then rename the file holidays.txt to eventcaldb and load this eventcaldb file to your Variables directory and chmod to 666.

If you want to add the holiday pack to an existing Newcalendar calendar and want to keep the events currently on your calendar then:
 

  1. Open both holidays.txt and your current eventcaldb files.
  2. Copy the contents of the holiday.txt file and paste into your eventcaldb file.  Note: If you paste the holiday text at the top of the eventcaldb file, for any days where you already have an event entered, the holiday information will be lost but the event information will be saved.  Conversely, if you paste the holiday text at the bottom of the eventcaldb file, for any days where you already have an event entered, the event information will be lost but the holiday will be saved.
  3. Be sure to leave one empty line at the bottom of the eventcaldb file.
  4. Save the eventcaldb file.
  5. Load the modified eventcaldb to your Variables directory and chmod to 666.
  6. Be sure to add a "Holiday" entry to the event type list in the Newcalendar Settings section of the Admin Center.


Optional Form Highlighter:

An optional set of script files (NewcalendarHighlight.pl and SendEventHighlight.pl) is included for forums using the form highlighter effect.  The calendar script in these files has the form highlighter code pre-loaded.  To use, rename these files to Newcalendar.pl and SendEvent.pl and upload them following the normal installation instructions above.  If you do not have the form highlighter loaded on your forum, the use of these files will produce errors on your forum.  The form highlighter script is available here. You can read about its use in YaBB here.



YaBB FrontEnd (Who's On) mod Addon:

The Newcalendar came with an additional mod file called:

newcal addon for whoson mod.mod

This is an optional addon mod is for the YaBB FrontEnd (Who's On) mod version 1.0.  It will place Upcoming Events from the Newcalendar database into the YaBB FrontEnd mod display.  The YaBB FrontEnd mod must be installed and working correctly before installing this addon.  If your forum is running version 1.1 or greater, this script is already included and this addon should not be used.

To install, install the mod file using BoardMod or manually, and upload the modified whoson.pl file.  If you are already using the birthdays addon for the Who's On mod, you may wish to deactivate it as this addon also provides member birthday info.



Mod History:

Version 3.51 Final

Version 3.5beta7


Version 3.5beta6


Version 3.5beta5


Version 3.5beta4


Version 3.5beta3


Version 3.5beta2


Version 3.4


Version 3.3


Version 3.2


Version 3.1


Version 3.0


Version 3.0beta2


Version 3.0beta


Version 2.64


Version 2.63


Version 2.62


Version 2.6


Version 2.5


Version 2.4


Version 2.3


Version 2.2


Version 2.1


Version 2.0


Version 1.1: First Release Version


Betas:



Credits:

Authors: Ironwing, GauGau, & Nermware

This mod is based on the eventcalendar.pl script by NermWare.
Converted to YaBB mod by Ironwing.

Thanks also to chrishartmann, Demon Slayer, and Max for code snippets from the Birthday mod.

Direct questions about this mod to Ironwing.

Homepages:
Ironwing
GauGau
Nermware