/*
NACC: The N.A. Cleatime Calculator
Version: 1.6.9
See changelog.txt for details of changes
This is a cooperative venture of the MAGNAWS Community Commons - http://wiki.magnaws.com/
This is a real purty cleantime calculator that displays a whole
bunch of nicely-rendered keytags to commemorate your cleantime.
This uses JavaScript. It is 100% JavaScript, so it's easy to steal
and re-use. There's no server-side technology (like PHP or ASP) involved.
You can choose among various themes including Basic Text Blue, It Works- How and Why and Just For Today.
More themes may be added later and, if you are comfortable with CSS (Cascading Style Sheets),
you can make your own theme.
HOW TO USE THIS:
You first need to include this file in your section. You also should include the base
stylesheet file and one of the theme style sheets.
This example assumes that the calling file is one directory level above the NACC directory:
.
.
.
.
.
.
NOTE: If you are on a PHP server, you can include a different file that will trim all this
text out of the JavaScript file, and give you a much smaller file. In that case, the
script would look like this:
The best way to invoke it is to put a call to this function in an onload() event:
Where:
pContainerId: string - ID of the containing div on the html page.
This needs to be a valid DOM ID of an empty
or other block level
HTML element. The contents of this element will be completely
replaced by the NACC.
For example:
Would need:
NACC_CleanTime('my_blank_div', pPathToNACC, pUseCookie, pChained, pHideTags)
pPathToNACC: string - path to location of 'nacc' directory (e.g. "/third/party/apps").
The NACC needs to have all its files kept together in one directory. This
parameter is a relative HTTP (URL address-style) path from the page that
is using the NACC to the directory that contains the NACC.
For example:
public_html
|
cleantime_calc.html <- Contains the code that calls the NACC
The code would look like this:
|
special_code <- An in-between directory
|
nacc <- The NACC directory
|
nacc.js <---
| |
nacc.css <------- These are the only files/directories
| | necessary for normal use.
nacc_theme_?.css <-------
| |
images <---
Would need:
NACC_CleanTime(pContainerId, 'special_code/nacc', pUseCookie, pChained, pHideTags)
pUseCookie boolean - store cleandate in a cookie
Some people might not like this if they have privacy concerns. By default, cookies
are not stored. What a stored cookie does is store the visitor's cleandate and
tag display preference. That's all. There's actually no danger to privacy, and no
really insidious information is stored (unless the visitor likes to use their
cleandate as a password).
In order to store cookies, you can set this to true:
NACC_CleanTime(pContainerId, pPathToNACC, true, pChained, pHideTags)
pChained: boolean - whether to display key tags vertically (chained together) or horizontally
This is the initial (default) method of arranging the tags. Chained means that they
are displayed as one long vertical chain. Not chained is what we call a "tabletop"
arrangement, where they are laid out in horizontal rows.
If the visitor has a cookie, this parameter will be ignored, and the visitor's
preference will be honored instead. If the visitor does not have a cookie, then this
will always be the initial setting.
In order to have the results specified as a chain by default:
NACC_CleanTime(pContainerId, pPathToNACC, pUseCookie, true, pHideTags)
pHideTags: boolean - whether to hide key tag display
You might not want to disply the key tags in cases where bandwidth or
other issues come into play.
In order to hide the key tags:
NACC_CleanTime(pContainerId, pPathToNACC, pUseCookie, pChained, true)
You can ignore all but the first parameter, but default values will be used. The first parameter
must always be specified.
NACC_CleanTime('my_blank_div')
Will result in no cookies, tabletop, and the file must be in the NACC directory.
NACC_CleanTime('my_blank_div', 'nacc')
Will result in no cookies, tabletop, and the file must be one above the NACC directory.
NACC_CleanTime('my_blank_div', 'nacc', true)
Will result in cookies, tabletop, and the file must be one above the NACC directory.
NACC_CleanTime('my_blank_div', 'nacc', true)
Will result in cookies, tabletop, and the file must be one above the NACC directory.
NACC_CleanTime('my_blank_div', 'nacc', true, true)
Will result in cookies, chained, and the file must be one above the NACC directory.
NACC_CleanTime('my_blank_div', 'nacc', true, true, true)
Will result in cookies, chained, hide key tags and the file must be one above the NACC directory.
The default ("NACC_CleanTime('my_blank_div')") is the equivalent of this:
NACC_CleanTime('my_blank_div', '', false, false, false, false)
THE 90-DAY ODDITY:
When the visitor passes 90 days, the calculator stops counting days for keytags, and, instead, counts dates.
For example, a visitor may have 90 days, but not 3 months, or they may have 91 days, and 3 months and 2 days.
This is actually expected behavior.
NOTE: We use an interesting system to keep all the cleantime stuff in its own context. This prevents it
from interfering with other JavaScript you may have.
Basically, the entire cleantime calculator lives inside the NACC_CleanTime() function, so the only
exposed interface is that function name, and the DOM elements generated by the code.
*/
function NACC_CleanTime ( pContainerId, pPathToNACC, pUseCookie, pChained, pHideTags ) {
// Set the globals that reflect the input parameters.
var gContainerEl = document.getElementById(pContainerId);
if (gContainerEl == null) {
alert('ERROR: There is no element on the page whose ID is "' + pContainerId + '"!');
return;
}
// Fix pPathToNACC directory param before setting global var
// Fixes missing or multiple forward slashes at end
// Gives end user leeway if they forget to add one
if (typeof(pPathToNACC) == 'string') {
// Trim white space from beginning and end
pPathToNACC = pPathToNACC.replace(/^\s+|\s*$/g, '');
if (pPathToNACC.length > 0) {
// Trim forward slash(es) from end
pPathToNACC = pPathToNACC.replace(/\/*$/, '');
// Add forward slash back
pPathToNACC += '/';
}
}
else {
pPathToNACC = '';
}
var gPathToNACC = pPathToNACC;
// Set global variable based on param passed to function
var gChained = (pChained == true);
// Set global variable based on param passed to function
var gCookieName = (pUseCookie == true) ? 'nacc_cleantime' : '';
// Set global variable based on param passed to function
var gHideTags = (pHideTags == true);
// This is one day, in milliseconds. It is needed to break down the getTime() results.
var gDay = (24 * 60 * 60 * 1000);
// These reflect the current cleandate, parsed into a simple format.
var gSelMonth;
var gSelDay;
var gSelYear;
// This is today.
var gTodayDate = new Date();
// set the date to midnight so hours, minutes and seconds don't influence calculations
gTodayDate.setHours(0);
gTodayDate.setMinutes(0);
gTodayDate.setSeconds(0);
// Determine whether the browser is IE6 or older
var gOldIE = (NACC_browser() == 'msie');
/*****************************************************
BEGIN LOCALIZATION SECTION
These globals are the displayed strings. This means they need to be changed in order to make this work in
languages other than English.
NOTE- the function BuildCleantimeMessage() has NOT been localized!!! If you need a non-Englisg message,
you'll have to change it accordingly until we get to it.
*/
var gTitle_lang = 'NA Cleantime Calculator';
var gPrompt_lang = 'Please enter your Clean Date';
var gCalcBtn_lang = 'Calculate';
var gResetLinkText_lang = new Array('Click to reset your cleantime', 'Reset Cleantime');
var gMonthsFull_lang = new Array ('January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December');
var gFutureWarning_lang = 'Error! Clean Date is in the future!';
var gChangeLinkText_lang = new Array('Click to change how key tags are laid out', 'Change Key Tag Layout');
/*****************************************************
END LOCALIZATION SECTION
*/
/********************
This function actually constructs the cleantime form. It does this by pure DOM construction, and places
everything into the container whose ID is passed in by the pContainerId element.
Parameters:
initDate string - This is the initial date and keytag setting.
It is a string in the following format:
[M]M/[D]D/YYYY-[1|0]
The first part is the month (1-12)
The second part is the day of the month (1-31)
The third part is the year, as a 4-digit number.
There is a dash. After that, is either a 1 (Chained) or a 0 (Tabletop).
If this parameter is omitted, the default values (today, pChained) will be used.
*/
function Initialize (initDate) {
// Start DOM creation section
// This is an overall wrapper
var wrapperDiv = document.createElement('div');
wrapperDiv.id = 'nacc_wrapper';
wrapperDiv.className = 'nacc_wrapper';
// Create main
- contains title, prompt and form
var mainDiv = document.createElement('div');
mainDiv.id = 'nacc_main';
// adjust class for IE peekaboo bug fix css selector
if (NACC_browser()&&NACC_browser().indexOf('msie') != -1) {
mainDiv.className = 'nacc_main nacc_pb_fix';
}
else {
mainDiv.className = 'nacc_main';
}
// Create title
var titleSpan = document.createElement('span');
titleSpan.id = 'nacc_title';
titleSpan.className = 'nacc_title';
titleSpan.innerHTML = gTitle_lang;
// Add title to main
mainDiv.appendChild(titleSpan);
// Create prompt and add it to main