This document explains how to configure a CalendarView applet within an HTML document.
A brief general FAQ is available at http://www.doubleologic.com/dolfaq.html.
Additional help is available by sending email to
info@doubleologic.com.
To implement CalendarView you need a Java (TM)
enabled browser and a program to edit the HTML document like NotePad.
A CalendarView system consists of 4 files:
You can create your CalendarView system by using any of the
CalendarView demo HTML files. You should select the demo that looks like the system
you would like to design. Then modify the HTML of that demo by changing the configuration
parameters. We recommend you change one parameter at a time and then view your HTML
in your browser. This way you can quickly view your success or find your errors.
The Applet tag is used to embed the applet within the HTML page. The following
example shows that the applet is provided a 500x300 window within the HTML document.
Additional attributes of the Applet tag are listed below.
System Requirements
Quick Start
Applet Tag
<APPLET CODE=CalendarView WIDTH=500 HEIGHT=300>
</APPLET>
< APPLET
CODEBASE = codebaseURL (specifies the directory where the class is located)
CODE = appletFile (is the applet class name)
ALT = alternateText (text to show Java enabled browsers that are not enabled)
WIDTH = pixels (width of applet window)
HEIGHT = pixels (height of applet window)
ALIGN = alignment (like the IMG tag; left, right, top, texttop, middle, absmiddle, baseline, bottom, absbottom.
VSPACE = pixels (# of pixels above and below applet)
HSPACE = pixels (# of pixels on either side of applet)
>
< PARAM NAME = name1 VALUE = value1 >
< PARAM NAME = name2 VALUE = value2 >
. . .
Here is a message for non-Java enabled browsers. (This text is placed within
the applet tag block and will display only to non-Java enabled browsers.
You can include any suitable HTML tags here including URLs and images.)
</APPLET>
Configuration Parameters (all lowercase letters)
|
Parameter |
Purpose | |||
| colorbg | Background color for Java applet, use same as HTML background. Default: light gray | |||
| colorcurrentday | Background color of the day button for the currently displayed day. Default: gray | |||
| colordayfg | Color of foreground text on days of the months buttons. Default: black | |||
| colordetail | Color of detail text on the event detail screen. The detail label gets the foreground color defined in colorfg parameter. Default: blue | |||
| colorfg | Foreground color for text. Default: black | |||
| colorselectbg | Background color of day buttons that have events in that month, event titles on the list screen and the mailto and http fields on the details screen. These highlighted fields indicate clickable fields. Default: white | |||
| colorselectfg | Foreground color of text on day buttons that have events in that month, event titles on the list screen and the mailto and http fields on the details screen. These highlighted fields indicate clickable fields. Default: black | |||
| detailonly | Set to "y" to only show the detail screen and not show the list of events for a day.Default: "n" where the list screen is shown when more than one event per day exists to list. | |||
dateformat |
The format of the date field (see Date field paragraph below). Valid values are 1,2,3 1=ccyymmdd, 2=mm/dd/yy, 3=dd/mm/yy 4=mm/dd/ccyy. Default: 1 |
|||
days |
This specifies the letters to display in the days header in the calendar. This must have 7 values separated with the "|" like the Default: "S|M|T|W|T|F|S". |
|||
delimdata |
Delimiter to separate data fields in the record. Like values: "|", "," ":" or "tab". Default: "|" |
|||
| host | Name of host domain where this system will run. For example: "www.doubleologic.com". This parameter is required when testing your system on a hard drive. It is used along with the license parameter. Host is ignored when this applet runs on the Internet, instead it determines the host it is running on. | |||
| inputfile | Specifies the name of the data input file. You can specify the exact name of the file like "http://www.doubleologic.com/CalendarView/cvdemo1.txt" as long as the file is on the same domain as the applet. Or you can just list the name "cvdemo1.txt" and the applet will look for the file in the same directory as CalendarView.zip. Alternatively you can store data in the r# in the actual HTML that calls the applet. | |||
| labels | Specifies the text labels to display on the detail screen for the 8 possible fields. You can use a blank label to make a field appear to have two or more lines of text like a description field. | |||
| license | Obtain your license(s) from DoubleOLogic Software. Multiple licenses are listed separated with the delim character. This is required. Issued for a domain name. | |||
months |
This specifies the name of the months to display as the header in the calendar. This must have 12 values separated with the "|". Default is English months. |
|||
| r# | # is record number. Each parameter contains 1 data record. The fields on the records are separated with delimdata character. This is an alternative to using inputfile parameter. See additional information in the Data paragraph below | |||
| txtdetailbutton | Specifies the text on the button displayed on the detail screen. This button allows the user to return to the list screen. Default: List Events. | |||
| smalldisplay | Specifies that the right hand detail panel should be smaller. The default is for the entire applet width to be 500 pixels, when smalldisplay is "y" the width is 400 pixels. Default: n. | |||
| stripquotes | Specifies that all double quotes should be stripped from the input stream. This allows you to read input from other programs that create files with "'s around each of the fields. See cvdemo2.txt file for example format. | |||
| todayis | Specifies the text to be displayed in the Today is area of the screen. Default is: Today is | |||
| weekstarton | Specifies the day of the week to start the calendar on. Choose from "m" for Monday or "s" for Sunday Default: Sunday. | |||
These two examples show that record 1 has Email info@doubleologic.com with any questions or suggestions.
Copyright © 1998 DoubleOLogic Software All Rights Reserved Data for the CalendarView database
Each event is stored as a record with the fields separated by a delimiter character
defined in delimdata parameter. There are a maximum of 9 fields including the date
field which is required as field 1. Like:
08/19/98|The Event Title|field3|4|5|6|7|8|9|
This example uses the "|", pipe symbol for a delimiter. The first field must
be the date. The second field must be the event title. Then fields 3 through 9 can be any values.
URL and MailTo Fields
Fields 3 through 9 can be automatically turned into clickable Mailto or URL fields by
preficing the field with one of these labels "mailto:" or "http://". So in the record store:
08/19/98|The Event Title|field3|4|5|6|7|mailto:diana@doubleologic.com|http://www.doubleologic.com/calendarview.html|
CalendarView will strip off the "mailto:" and "http://" when it displays the value on the
detail screen. These two key words will force the field to be displayed in a button field
with the color defined in colorselect parameter.
Data Storage Options
There are two options for providing data to the CalendarView database. In both options the
fields are separated with the delimdata character. To skip a field you must put a
place holder of 1 character, like a blank in between the delimdata characters.
The trailing fields can be missing.
Option 1
Create a text file that has one record per line. Set the inputfile parameter
to the name of the text file, like "cvdemo1.txt".
Place the file in the same directory as the CalendarView.zip file.
Here is an example of 1 record in the data file:
08/12/98|Suzy Q's| |1441 James Lane| |Fine Art|
Option 2
Enter the data as "r#" parameters (r for record) in the HTML document that calls CalendarView.class.
Here is an example:
PARAM NAME=r1 VALUE="08/12/98|Suzy Q's| |1441 James Lane| |Fine Art|"
field1 = 08/12/98
field2 = Suzy Q's
field3 =
field4 = 1441 James Lane
field5 =
field6 = Fine Art
License Requirements
To run evaluation copy of software on hard drive
Use the license and host provided in the demo html.
To run evaluation copy of software on Network
Contact info@doubleologic.com to request an evaluation license.
To run licensed copy on your hard drive
Enter license obtained from DoubleOLogic Software for your specified domain.
You MUST also enter the host parameter for CalendarView to verify your license for
that domain.
PARAM NAME=license VALUE="xxxxxx"
PARAM NAME=host value="www.doubleologic.com"
To run licensed copy on Internet
Do the same as "to run licensed copy on your hard drive" However, CalendarView will know it is
running on the Internet and it will override the host parameter you entered.
Leaving in host in the HTML is ok, it is ignored on the Internet.
Installation
FTP the CalendarView.cab, CalendarView.zip, yournew.html and yournew.txt into a directory
on your network server.
Java and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.