/*
Techdoc Builder
Last revised: 6/8/05: Jason Bonthron
*/
// ============================================================== techdoc_Builder()
function techdoc_Builder()
{
this.jumpLinks = false;
this.sortAlpha = false;
this.categoriesArr = [];
this.add_Jump_Links = function(){ this.jumpLinks = true; };
this.sort_Alpha = function(){ this.sortAlpha = true; };
this.add_Category = add_Cat;
this.add_Doc = add_Doc;
this.add_Sub_Heading = add_Sub;
this.create_page = create_page;
this.alphaSorter = alphaSorter;
this.createJumpLinks = createJumpLinks;
};
// ------------------------------------------------------- add_Cat
function add_Cat(catName, jumpName)
{
this.categoriesArr[this.categoriesArr.length] = new Category(catName, jumpName);
};
// ------------------------------------------------------- add_Doc
function add_Doc(category, title, URL, fileFormat, fileSize)
{
for(var i=0; i < this.categoriesArr.length; i++)
{
var loopingCat = this.categoriesArr[i];
if(loopingCat.name == category)
{
loopingCat.docs[loopingCat.docs.length] = new techDoc(title, URL, fileFormat, fileSize);
};
};
};
// ------------------------------------------------------- add_Sub
// !? SUB_HEADING is treated like a special type of Doc
function add_Sub(category, subName)
{
this.add_Doc(category, "SUB_HEADING", subName, "", "");
};
// ------------------------------------------------------- create_page
function create_page()
{
var returnHTML = new String();
if( this.sortAlpha ){ this.alphaSorter(); };
if( this.jumpLinks ){ returnHTML += this.createJumpLinks(); };
for(var i=0; i < this.categoriesArr.length; i++)
{
var loopingCat = this.categoriesArr[i];
// category title
returnHTML += category_title_HTML;
returnHTML = returnHTML.replace( "%__catName__%", loopingCat.name );
returnHTML = returnHTML.replace( "%__jumpName__%", loopingCat.jumpName );
// start table
returnHTML += category_table_HTML1;
// doc listings
for(var j=0; j < loopingCat.docs.length; j++)
{
var loopingDoc = loopingCat.docs[j];
if(loopingDoc.title == "SUB_HEADING")
{
returnHTML += subheading(loopingDoc); // subhead
}
else
{
returnHTML += docListing(loopingDoc); // ordinary doc
};
};
// end table
returnHTML += category_table_HTML2;
};
document.write(returnHTML);
return;
};
// ------------------------------------------------------- createJumpLinks
function createJumpLinks()
{
var returnHTML = jump_start_HTML;
// math: calculate # full rows needed
var fullRows = Math.floor( this.categoriesArr.length / linksPerRow );
var remainder = this.categoriesArr.length % linksPerRow
if(remainder != 0 ){ fullRows += 1 };
var categoryCounter = 0;
for(var i = 0; i < fullRows; i++ )
{
returnHTML += jump_row_start; // --------- Row start
for(var jab=0; jab < linksPerRow; jab++)
{
currentCat = this.categoriesArr[categoryCounter];
if(currentCat != null)
{
// if no jump link name was provided, I create one
if(currentCat.jumpName == ""){ createJumpName(currentCat); };
var tempHTML = jump_row_link;
tempHTML = tempHTML.replace( "%__name__%", currentCat.name );
tempHTML = tempHTML.replace( "%__jumpName__%", currentCat.jumpName);
returnHTML += tempHTML;
categoryCounter++;
}
else // currentCat == null, add spacers to finish off
{
returnHTML += jump_row_blank;
};
};
returnHTML += jump_row_end; // --------- Row end
};
returnHTML += jump_end_HTML;
return returnHTML;
};
// ------------------------------------------------------- alphaSorter
function alphaSorter()
{
this.categoriesArr = this.categoriesArr.sort(function (x,y){
x1 = x.name.toLowerCase();
y1 = y.name.toLowerCase();
x2 = x1.replace(/\s/g,"");
y2 = y1.replace(/\s/g,"");
if (x2 < y2) { return -1; }
else if (x2 > y2) { return 1; }
else { return 0; };
});
};
// ============================================================== Category()
function Category(catName, jumpName)
{
this.name = catName;
this.jumpName = jumpName;
this.docs = [];
};
// ============================================================== techDoc()
function techDoc(title, URL, fileFormat, fileSize)
{
this.title = title;
this.URL = URL;
this.fileFormat = fileFormat;
this.fileSize = fileSize;
};
// ============================================================== docListing()
function docListing(docObject)
{
var returnHTML = doc_HTML;
returnHTML = returnHTML.replace( "%__URL__%", docObject.URL );
returnHTML = returnHTML.replace( "%__title__%", docObject.title );
returnHTML = returnHTML.replace( "%__fileFormat__%", docObject.fileFormat );
returnHTML = returnHTML.replace( "%__fileSize__%", docObject.fileSize );
return returnHTML;
};
// ============================================================== subheading()
function subheading(docObject)
{
var returnHTML = sub_HTML;
// not really adding a URL !, see add_sub method
returnHTML = returnHTML.replace( "%__subhead__%", docObject.URL );
return returnHTML;
};
// ============================================================== createJumpName
function createJumpName(category)
{
var tempName = category.name.toLowerCase();
tempName = tempName.replace(/\s/g,""); //remove whitespace
category.jumpName = tempName;
};
// ============================================================== HTML templates
// variables in this format: %__something__%
// are replaced out by the script
// category title HTML
var category_title_HTML = ""
// category start table
var category_table_HTML1 = "";
// category end table
var category_table_HTML2 = " |
";
// doc listing rows
var doc_HTML = "
 | %__title__% %__fileFormat__% %__fileSize__% |
|
";
// subheading rows
var sub_HTML = " |
| %__subhead__% |
|
";
// jump links start table
var jump_start_HTML = "";
// jump links end table
var jump_end_HTML = "
";
// jump link rows
var linksPerRow = 4;
// if you change this value, consider modifying the HTML templates below so
// your table widths add up correctly ;-)
var jump_row_start = "";
var jump_row_link = " | %__name__% | ";
var jump_row_blank = " | | ";
var jump_row_end = "
";
