Skip to content

Missing some titles in the jsguide.html file, under "3 Source file structure" title + seeing the table of contents with delay . #655

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open

Missing some titles in the jsguide.html file, under "3 Source file structure" title + seeing the table of contents with delay . #655

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
172 changes: 88 additions & 84 deletions include/styleguide.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,61 +1,59 @@
TocTypeEnum = {
VERTICAL: 1,
HORIZONTAL: 2
HORIZONTAL: 2,
};

function CreateTOC(tocElement) {

// Find the toc element DIV. We'll place our TOC there.
var toc = document.getElementById(tocElement);

var tocTypeClass = toc.className;
var tocType;

switch (tocTypeClass) {
case 'horizontal_toc':
tocType = TocTypeEnum.HORIZONTAL;
break;
case 'vertical_toc':
tocType = TocTypeEnum.VERTICAL;
break;
default:
tocType = TocTypeEnum.VERTICAL;
break;
case "horizontal_toc":
tocType = TocTypeEnum.HORIZONTAL;
break;
case "vertical_toc":
tocType = TocTypeEnum.VERTICAL;
break;
default:
tocType = TocTypeEnum.VERTICAL;
break;
}

// If toc_levels is defined, set headingLevels to it.
// Otherwise, use default value of "h2,h3"
var headingLevels;
if (typeof toc_levels === 'undefined') {
headingLevels = 'h2,h3';
if (typeof toc_levels === "undefined") {
headingLevels = "h2,h3";
} else {

}

// Collect all section heading elements in an array
var headings = document.querySelectorAll(headingLevels);

// Add TOC title elements
var tocHeadingDiv = document.createElement('div');
var tocHeadingDiv = document.createElement("div");
toc.appendChild(tocHeadingDiv);
tocHeadingDiv.className = 'toc_title';
var tocHeading = document.createElement('h3');
tocHeadingDiv.className = "toc_title";
var tocHeading = document.createElement("h3");
toc.appendChild(tocHeading);
tocHeading.className = 'ignoreLink';
tocHeading.id = 'toc';
var tocText = document.createTextNode('Table of Contents');
tocHeading.className = "ignoreLink";
tocHeading.id = "toc";
var tocText = document.createTextNode("Table of Contents");
tocHeading.appendChild(tocText);

// Add table and tbody
var tocTable = document.createElement('table');
var tocTable = document.createElement("table");
if (tocType == TocTypeEnum.VERTICAL) {
tocTable.className = 'columns';
tocTable.className = "columns";
}
toc.appendChild(tocTable);

var tbody_element = document.createElement('tbody');
tbody_element.setAttribute('valign', 'top');
tbody_element.className = 'toc';
var tbody_element = document.createElement("tbody");
tbody_element.setAttribute("valign", "top");
tbody_element.className = "toc";
tocTable.appendChild(tbody_element);

// Get the highest level heading
Expand All @@ -67,18 +65,21 @@ function CreateTOC(tocElement) {

switch (tocType) {
case TocTypeEnum.HORIZONTAL:
CreateHorizontalTOC(headings, masterLevel, lowestLevel, tbody_element);
break;
CreateHorizontalTOC(headings, masterLevel, lowestLevel, tbody_element);
break;
case TocTypeEnum.VERTICAL:
CreateVerticalTOC(headings, masterLevel, lowestLevel, tbody_element);
break;
CreateVerticalTOC(headings, masterLevel, lowestLevel, tbody_element);
break;
default:
}
}
}

function CreateHorizontalTOC(
headings, masterLevel, lowestLevel, tbody_element) {

headings,
masterLevel,
lowestLevel,
tbody_element
) {
// Initialize the header counter
var h = 0;
var ignoreChildren = false;
Expand All @@ -93,16 +94,16 @@ function CreateHorizontalTOC(
if (isNaN(level) || level < 1 || level > lowestLevel) continue;

// If level is a masterLevel, make it a TOC parent category
if ((level == masterLevel) && (!hasClass(heading, 'ignoreLink'))) {
if (level == masterLevel && !hasClass(heading, "ignoreLink")) {
toc_current_row = AddTOCMaster(tbody_element, heading);
ignoreChildren = false;
}

if ((level == masterLevel) && (hasClass(heading, 'ignoreLink'))) {
if (level == masterLevel && hasClass(heading, "ignoreLink")) {
ignoreChildren = true;
}

if ((level != masterLevel) && (!ignoreChildren)) {
if (level != masterLevel && !ignoreChildren) {
AddTOCElements(toc_current_row, heading);
}

Expand All @@ -113,63 +114,62 @@ function CreateHorizontalTOC(

// Adds a master Table of Content heading
function AddTOCMaster(tocTable, heading) {

// Add the table row scaffolding
var toc_tr = document.createElement('tr');
var toc_tr = document.createElement("tr");
tocTable.appendChild(toc_tr);
toc_tr.setAttribute('valign', 'top');
var toc_tr_td = document.createElement('td');
toc_tr.setAttribute("valign", "top");
var toc_tr_td = document.createElement("td");
toc_tr.appendChild(toc_tr_td);
var toc_category = document.createElement('div');
var toc_category = document.createElement("div");
toc_tr_td.appendChild(toc_category);
toc_category.className = 'toc_category';
toc_category.className = "toc_category";

// Create the link to this header
var link = document.createElement('a');
link.href = '#' + heading.id; // Create the anchor link
var link = document.createElement("a");
link.href = "#" + heading.id; // Create the anchor link
link.textContent = heading.textContent; // Link text is same as heading
toc_category.appendChild(link);

// Add the container table cell for its children
var toc_td = document.createElement('td');
var toc_td = document.createElement("td");
toc_tr.appendChild(toc_td);
var toc_td_div = document.createElement('div');
toc_td_div.className = 'toc_stylepoint';
var toc_td_div = document.createElement("div");
toc_td_div.className = "toc_stylepoint";
toc_td.appendChild(toc_td_div);

return (toc_td_div);
return toc_td_div;
}

// Adds Table of Contents element to a master heading as children
function AddTOCElements(toc_div, heading) {

if (heading.offsetParent === null) {
// The element is currently hidden, so don't create a TOC entry
} else {
// Create the list item element
var toc_list_element = document.createElement('li');
toc_list_element.className = 'toc_entry';
var toc_list_element = document.createElement("li");
toc_list_element.className = "toc_entry";
toc_div.appendChild(toc_list_element);

// Create the link to this header
var link = document.createElement('a');
link.href = '#' + heading.id; // Create the anchor link
var link = document.createElement("a");
link.href = "#" + heading.id; // Create the anchor link
link.textContent = heading.textContent; // Link text is same as heading
toc_list_element.appendChild(link);
}
}

function CreateVerticalTOC(headings, masterLevel, lowestLevel, tbody_element) {

// Create the Column scaffolding
var toc_tr = document.createElement('tr');
var toc_tr = document.createElement("tr");
tbody_element.appendChild(toc_tr);
var toc_tr_td = document.createElement('td');
toc_tr_td.className = 'two_columns';
var toc_tr_td = document.createElement("td");
toc_tr_td.className = "two_columns";
toc_tr.appendChild(toc_tr_td);

// This code is not working correctly when we have a heading like 3.1.1 ( more than one decimal point)
// so inside of the jsguide.html file, in the 3 Source file structure, we are missing 3.3.1 , 3.3.2 but we have 3.3.3,
// I guess it shows us 3.3.3 because these are all 3.(same number)

// Initialize the header counter and the current row
var h = 0;
var toc_current_col = null;
var ignoreChildren = false;
Expand All @@ -184,19 +184,19 @@ function CreateVerticalTOC(headings, masterLevel, lowestLevel, tbody_element) {
if (isNaN(level) || level < 1 || level > lowestLevel) continue;

// If level is a masterLevel, make it a TOC parent category
if ((level == masterLevel) && (!hasClass(heading, 'ignoreLink'))) {
if (level == masterLevel && !hasClass(heading, "ignoreLink")) {
if (heading.offsetParent === null) {
// The element is currently hidden, so don't create a TOC entry
} else {
var td_dl = document.createElement('dl');
var td_dl = document.createElement("dl");
toc_tr_td.appendChild(td_dl);
var td_dt = document.createElement('dt');
var td_dt = document.createElement("dt");
td_dl.appendChild(td_dt);
toc_current_col = td_dl;

// Create the link to this header
var link = document.createElement('a');
link.href = '#' + heading.id; // Create the anchor link
var link = document.createElement("a");
link.href = "#" + heading.id; // Create the anchor link
link.textContent = heading.textContent; // Link text is same as heading
td_dt.appendChild(link);
ignoreChildren = false;
Expand All @@ -205,19 +205,19 @@ function CreateVerticalTOC(headings, masterLevel, lowestLevel, tbody_element) {

// If level is a masterLevel but it's specified to ignore links, skip it
// and its children.
if ((level == masterLevel) && (hasClass(heading, 'ignoreLink'))) {
if (level == masterLevel && hasClass(heading, "ignoreLink")) {
ignoreChildren = true;
}

if ((level != masterLevel) && (!ignoreChildren)) {
if (level != masterLevel && !ignoreChildren) {
if (heading.offsetParent === null) {
// The element is currently hidden, so don't create a TOC entry
} else {
var td_dd = document.createElement('dd');
var td_dd = document.createElement("dd");
toc_current_col.appendChild(td_dd);
// Create the link to this header
var link = document.createElement('a');
link.href = '#' + heading.id; // Create the anchor link
var link = document.createElement("a");
link.href = "#" + heading.id; // Create the anchor link
link.textContent = heading.textContent; // Link text is same as heading
td_dd.appendChild(link);
}
Expand All @@ -233,7 +233,7 @@ function CreateVerticalTOC(headings, masterLevel, lowestLevel, tbody_element) {
* class.
*/
function hasClass(element, cls) {
return (' ' + element.className + ' ').indexOf(' ' + cls + ' ') > -1;
return (" " + element.className + " ").indexOf(" " + cls + " ") > -1;
}

/*
Expand All @@ -243,14 +243,18 @@ function hasClass(element, cls) {

// Add the link image to the element.
function LinkifyHeader(header, fileName, sizePixels) {
var link = document.createElement('a');
link.href = '#' + header.id;
link.setAttribute('alt', 'link to ' + header.id);
var link = document.createElement("a");
link.href = "#" + header.id;
link.setAttribute("alt", "link to " + header.id);
link.innerHTML =
'<img src="include/' + fileName + '"' +
' width=' + sizePixels +
' height=' + sizePixels +
' style="float:left;position:relative;bottom:5px;">';
'<img src="include/' +
fileName +
'"' +
" width=" +
sizePixels +
" height=" +
sizePixels +
' style="float:left;position:relative;bottom:5px;">';
header.appendChild(link);
}

Expand All @@ -261,21 +265,21 @@ function LinkifyHeadersForTag(tagName) {
var header;
for (var j = 0; j != headers.length; j++) {
header = headers[j];
if (!hasClass(header, 'ignoreLink') && ('id' in header)) {
if (header.id != '') {
LinkifyHeader(header, 'link.png', 21);
header.style.left = '-46px';
header.style.position = 'relative';
if (!hasClass(header, "ignoreLink") && "id" in header) {
if (header.id != "") {
LinkifyHeader(header, "link.png", 21);
header.style.left = "-46px";
header.style.position = "relative";
}
}
}
}

// Linkify all h2, h3, and h4s. h1s are titles.
function LinkifyHeaders() {
LinkifyHeadersForTag('h2');
LinkifyHeadersForTag('h3');
LinkifyHeadersForTag('h4');
LinkifyHeadersForTag("h2");
LinkifyHeadersForTag("h3");
LinkifyHeadersForTag("h4");
}

/*
Expand All @@ -285,5 +289,5 @@ function LinkifyHeaders() {

function initStyleGuide() {
LinkifyHeaders();
CreateTOC('tocDiv');
CreateTOC("tocDiv");
}