summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rwxr-xr-xdoc/src/template/scripts/functions.js87
-rw-r--r--doc/src/template/scripts/narrow.js108
-rwxr-xr-xdoc/src/template/style/style.css45
3 files changed, 152 insertions, 88 deletions
diff --git a/doc/src/template/scripts/functions.js b/doc/src/template/scripts/functions.js
index 5bf8323..0bb88a8 100755
--- a/doc/src/template/scripts/functions.js
+++ b/doc/src/template/scripts/functions.js
@@ -1,11 +1,12 @@
// Removing search results
function hideSearchResults() {
+/* hiding search results as the user clicks on the different categories */
$('#resultdialog').removeClass('active');
$("#resultlist").removeClass().addClass('all');
$("#resultlinks").removeClass().addClass('all');
$("#searchcount").removeClass().addClass('all');
}
-// Closing search result box
+/* closing the searhc result dialog */
$('#resultclose').click(function(e) {
e.preventDefault();
hideSearchResults();
@@ -19,14 +20,14 @@ $('.t_button').mouseover(function() {
$('.t_button').css('cursor','pointer');
});
/* END non link areas */
-// Font size small
+/* Changing font size to smaller */
$('#smallA').click(function() {
$('.mainContent .heading,.mainContent h1, .mainContent h2, .mainContent h3, .mainContent p, .mainContent li, .mainContent table').css('font-size','smaller');
$('.t_button').removeClass('active')
$(this).addClass('active')
});
-// Font size reset
+/* Reset font size */
$('#medA').click(function() {
$('.mainContent .heading').css('font','600 16px/1 Arial');
$('.mainContent h1').css('font','600 18px/1.2 Arial');
@@ -42,8 +43,7 @@ $('#medA').click(function() {
$('.t_button').removeClass('active')
$(this).addClass('active')
});
-
-// Font size large
+/* Changing font size to bigger */
$('#bigA').click(function() {
$('.mainContent .heading,.mainContent h1, .mainContent h2, .mainContent h3, .mainContent p, .mainContent li, .mainContent table').css('font-size','large');
$('.mainContent .heading,.mainContent h1, .mainContent h2, .mainContent h3, .mainContent p, .mainContent li, .mainContent table').css('line-height','25px');
@@ -51,7 +51,7 @@ $('#bigA').click(function() {
$(this).addClass('active')
});
-// Show page content after closing feedback box
+/* Show page content after closing feedback box */
$('.feedclose').click(function() {
$('.bd').show();
$('.hd').show();
@@ -60,7 +60,7 @@ $('.feedclose').click(function() {
$('#blurpage').hide();
});
-// Hide page content and show feedback box
+/* Hide page content and show feedback box */
$('.feedback').click(function() {
$('.bd').hide();
$('.hd').hide();
@@ -68,9 +68,11 @@ $('.feedback').click(function() {
$('#feedbackBox').show();
$('#blurpage').show();
});
-// Setting URL - in this case relative to root
+/* Default search URL */
var qturl = "";
+/* The next function handles the response data (in xml) returned by the search engine */
+
// Process data sent back from the server. The data is structured as a XML.
/*
XML structure handled by function processNokiaData()
@@ -84,47 +86,62 @@ XML structure handled by function processNokiaData()
function processNokiaData(response){
+/* fetch the responce from the server using page as the root element */
var propertyTags = response.getElementsByTagName('page');
-
- var apiCount = 0;
+ /* reset counters */
+ var lookupCount = 0;
var articleCount = 0;
var exampleCount = 0;
-
var full_li_element;
+/* remove any old results */
$('#resultlist li').remove();
+ /* running through the elements in the xml structure */
for (var i=0; i<propertyTags.length; i++) {
+ /* for every element named pageWords*/
for (var j=0; j< propertyTags[i].getElementsByTagName('pageWords').length; j++) {
+ /* start a new list element */
full_li_element = '<li';
+ /* if the pageType element reads APIPage, add class name api */
if (propertyTags[j].getElementsByTagName('pageType')[0].firstChild.nodeValue == 'APIPage') {
full_li_element += ' class="api"';
apiCount++;
}
+ /* if the pageType element reads Article, add class name article */
else if (propertyTags[j].getElementsByTagName('pageType')[0].firstChild.nodeValue == 'Article') {
full_li_element += ' class="article"';
articleCount++;
}
+ /* if the pageType element reads Example, add class name example */
else if (propertyTags[j].getElementsByTagName('pageType')[0].firstChild.nodeValue == 'Example') {
full_li_element += ' class="example"';
exampleCount++;
}
+ /* adding the link element*/
full_li_element += '><a href="'+qturl;
- full_li_element += propertyTags[i].getElementsByTagName('pageUrl')[j].firstChild.nodeValue;
- full_li_element += '">' + propertyTags[i].getElementsByTagName('pageTitle')[0].firstChild.nodeValue + '</a></li>';
- $('#resultlist').append(full_li_element);
- }
+ /* adding the URL attribute*/
+ full_li_element += propertyTags[i].getElementsByTagName('pageUrl')[j].firstChild.nodeValue;
+ /* adding the link title and closing the link and list elements */
+ full_li_element += '">' + propertyTags[i].getElementsByTagName('pageTitle')[0].firstChild.nodeValue + '</a></li>';
+ /* appending the list element to the #resultlist div*/
+ $('#resultlist').append(full_li_element);
+ }
}
+ /* if the result is not empty */
if (propertyTags.length > 0) {
+ /* add class name active to show the dialog */
$('#resultdialog').addClass('active');
+ /* setting number of hits*/
$('#resultcount').html(propertyTags.length);
$('#apicount').html(apiCount);
$('#articlecount').html(articleCount);
$('#examplecount').html(exampleCount);
}
+
// Filtering results in display
$('p#resultlinks a').click(function(e) {
e.preventDefault();
@@ -157,8 +174,11 @@ function processNokiaData(response){
//build regular expression object to find empty string or any number of blank
var blankRE=/^\s*$/;
+
+
function CheckEmptyAndLoadList()
{
+ /* Start Extracting information for feedback and adding this to the feedback form */
var pageUrl = window.location.href;
var pageVal = $('title').html();
$('#feedUrl').remove();
@@ -166,50 +186,52 @@ function CheckEmptyAndLoadList()
$('.menuAlert').remove();
$('#feedform').append('<input id="feedUrl" name="feedUrl" value="'+pageUrl+'" style="display:none;">');
$('#feedform').append('<input id="pageVal" name="pageVal" value="'+pageVal+'" style="display:none;">');
- $('.liveResult').remove();
- $('.defaultLink').css('display','block');
+ /* End Extracting information for feedback and adding this to the feedback form */
+
+ /* extracts search query */
var value = document.getElementById('pageType').value;
+ /* if the search is less than three chars long remove class names and remove elements from old search*/
if((blankRE.test(value)) || (value.length < 3))
{
-
-
-
- $('.defaultLink').css('display','block');
-
$('#resultdialog').removeClass('active');
$('#resultlist li').remove();
- }else{
-
}
}
// Loads on doc ready - prepares search
$(document).ready(function () {
-
-
+ /* fetch page title*/
var pageTitle = $('title').html();
+ /* getting content from search box */
var currentString = $('#pageType').val() ;
+ /* if the search box is not empty run CheckEmptyAndLoadList*/
if(currentString.length < 1){
- $('.defaultLink').css('display','block');
CheckEmptyAndLoadList();
}
+ /* on key-up in the search box execute the following */
$('#pageType').keyup(function () {
+ /* extract the search box content */
var searchString = $('#pageType').val() ;
+ /* if the string is less than three characters */
if ((searchString == null) || (searchString.length < 3)) {
+ /* remove classes and elements*/
$('#pageType').removeClass('loading');
- $('.liveResult').remove();
$('.searching').remove();
+ /* run CheckEmptyAndLoadList */
CheckEmptyAndLoadList();
- $('.report').remove();
+ $('.report').remove();
return;
}
+ /* if timer checks out */
if (this.timer) clearTimeout(this.timer);
this.timer = setTimeout(function () {
+ /* add loading image by adding loading class */
$('#pageType').addClass('loading');
$('.searching').remove();
+ /* run the actual search */
$.ajax({
contentType: "application/x-www-form-urlencoded",
url: 'http://' + location.host + '/nokiasearch/GetDataServlet',
@@ -217,8 +239,7 @@ function CheckEmptyAndLoadList()
dataType:'xml',
type: 'post',
success: function (response, textStatus) {
-
- $('.liveResult').remove();
+ /* on success remove loading img */
$('.searching').remove();
$('#pageType').removeClass('loading');
@@ -226,6 +247,6 @@ function CheckEmptyAndLoadList()
}
});
- }, 500);
+ }, 500); /* timer set to 500 ms */
});
- });
+ }); \ No newline at end of file
diff --git a/doc/src/template/scripts/narrow.js b/doc/src/template/scripts/narrow.js
index 35c81bf..a5e8b97 100644
--- a/doc/src/template/scripts/narrow.js
+++ b/doc/src/template/scripts/narrow.js
@@ -1,17 +1,15 @@
+/* This function generates menus and search box in narrow/slim fit mode */
var narrowInit = function() {
- /* TODO:
- Could probably be more efficient, not hardcoding each element to be created
- */
- // 1: Create search form
+ /* 1: Create search form */
var narrowSearch = $('<div id="narrowsearch"></div>');
var searchform = $("#qtdocsearch");
narrowSearch.append(searchform);
$("#qtdocheader .content .qtref").after(narrowSearch);
- // 2: Create dropdowns
+ /* 2: Create dropdowns */
var narrowmenu = $('<ul id="narrowmenu" class="sf-menu"></ul>');
- // Lookup
+ /* Lookup */
var lookuptext = $("#lookup h2").attr("title");
$("#lookup ul").removeAttr("id");
$("#lookup ul li").removeAttr("class");
@@ -24,7 +22,7 @@ var narrowInit = function() {
lookuplist.append(lookupul);
narrowmenu.append(lookuplist);
- // Topics
+ /* Topics */
var topicstext = $("#topics h2").attr("title");
$("#topics ul").removeAttr("id");
$("#topics ul li").removeAttr("class");
@@ -37,7 +35,7 @@ var narrowInit = function() {
topicslist.append(topicsul);
narrowmenu.append(topicslist);
- // Examples
+ /* Examples */
var examplestext = $("#examples h2").attr("title");
$("#examples ul").removeAttr("id");
$("#examples ul li").removeAttr("class");
@@ -58,32 +56,78 @@ var narrowInit = function() {
});
}
+/* Executes on doc ready */
$(document).ready(function(){
-/* if ($('body').hasClass('narrow')) {
- narrowInit();
- }
- */
- if($(window).width()<600) {
- $('body').addClass('narrow');
-
- if ($("#narrowsearch").length == 0) {
- narrowInit();
- }
- }
- else {
- $('body').removeClass('narrow');
+ /* check if body has the narrow class */
+ if ($('body').hasClass('narrow')) {
+ /* run narrowInit */
+ narrowInit();
+ }
+
+ /* messure window width and add class if it is smaller than 600 px */
+ if($(window).width()<600) {
+ $('body').addClass('narrow');
+ /* if the search box contains */
+ if ($("#narrowsearch").length == 0) {
+ /* run narrowInit */
+ narrowInit();
+ }
+ }
+ else { /* if the window is wider than 600 px, narrow is removed */
+ $('body').removeClass('narrow');
+ if ($("#narrowsearch").length == 0) {
+ }
+ }
+});
+/* binding resize event to this funciton */
+$(window).bind('resize', function () {
+ /* if the window is wider than 600 px, narrow class is added */
+ if($(window).width()<600) {
+ $('body').addClass('narrow');
+ if ($("#narrowsearch").length == 0) {
+ narrowInit();
+ }
+ }
+ else {
+ /* else we remove the narrow class */
+ $('body').removeClass('narrow');
}
});
-$(window).bind('resize', function () {
- if($(window).width()<600) {
- $('body').addClass('narrow');
+ $('#narrowsearch').keyup(function () {
+ /* extract the search box content */
+ var searchString = $('#narrowsearch').val();
+ /* if the string is less than three characters */
+ if ((searchString == null) || (searchString.length < 3)) {
+ /* remove classes and elements*/
+ $('#narrowsearch').removeClass('loading');
+ $('.searching').remove();
+ /* run CheckEmptyAndLoadList */
+ CheckEmptyAndLoadList();
+
+ $('.report').remove();
+ return;
+ }
+ /* if timer checks out */
+ if (this.timer) clearTimeout(this.timer);
+ this.timer = setTimeout(function () {
+ /* add loading image by adding loading class */
+ $('#narrowsearch').addClass('loading');
+ $('.searching').remove();
- if ($("#narrowsearch").length == 0) {
- narrowInit();
- }
- }
- else {
- $('body').removeClass('narrow');
- }
-}); \ No newline at end of file
+ /* run the actual search */
+ $.ajax({
+ contentType: "application/x-www-form-urlencoded",
+ url: 'http://' + location.host + '/nokiasearch/GetDataServlet',
+ data: 'searchString='+searchString,
+ dataType:'xml',
+ type: 'post',
+ success: function (response, textStatus) {
+ /* on success remove loading img */
+ $('.searching').remove();
+ $('#narrowsearch').removeClass('loading');
+ processNokiaData(response);
+ }
+ });
+ }, 500); /* timer set to 500 ms */
+ }); \ No newline at end of file
diff --git a/doc/src/template/style/style.css b/doc/src/template/style/style.css
index c172e23..5833266 100755
--- a/doc/src/template/style/style.css
+++ b/doc/src/template/style/style.css
@@ -528,8 +528,6 @@
height:21px;
padding:2px 0 0 5px;
width:167px;
- _height: 23px;
- _width: 169px;
}
.sidebar .search form input#pageType
@@ -629,25 +627,11 @@
background:url("../images/spinner.gif") no-repeat scroll right center transparent;
}
-.floatingResult{
- z-index:1;
- position:relative;
- padding-top:0px;
- background-color:white;
- border:solid 1px black;
- height:250px;
- width:600px;
- overflow-x:hidden;
- overflow-y:auto;
-}
-
- .floatingResult:hover{
- display:block;
- }
- .floatingResult:hover{
+ .sidebar .search form {
+ _height: 23px;
+ _width: 169px;
}
-
-
+
#resultdialog {
display: none;
position: absolute;
@@ -720,7 +704,23 @@
#resultlinks.all a#showallresults:hover {
color: #B0ADAB;
}
-
+ .floatingResult{
+ z-index:1;
+ position:relative;
+ padding-top:0px;
+ background-color:white;
+ border:solid 1px black;
+ height:250px;
+ width:600px;
+ overflow-x:hidden;
+ overflow-y:auto;
+ }
+
+ .floatingResult:hover{
+ display:block;
+ }
+ .floatingResult:hover{
+ }
/* end sidebar elements */
/* content elements */
@@ -1421,8 +1421,7 @@
.creator .wrapper .hd,
.creator .wrapper .ft,
.creator .sidebar,
- .creator .wrap .feedback,
- .creator #resultdialog
+ .creator .wrap .feedback
{
display:none;
}
generated by cgit v0.12 at 2024-10-25 14:25:13 (GMT)