X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=build.py;h=1645b0accaee0e56cd4312356c675d178deba9a5;hb=031e7590c9ea3c32f329f1efb9b96ac7df790f2e;hp=5d6ecfd1fe5af0666c38f3596b12c61220826555;hpb=c26b7c1f3feb0c4124335c4e7511855543956436;p=ardour-manual

diff --git a/build.py b/build.py
index 5d6ecfd..1645b0a 100755
--- a/build.py
+++ b/build.py
@@ -9,7 +9,7 @@
 
 # Remnants (could go into the master document as the first header)
 
-#bootstrap_path: /bootstrap-2.2.2
+#bootstrap_path: /bootstrap-3.3.7
 #page_title: The Ardour Manual
 
 import os
@@ -23,6 +23,7 @@ import argparse
 cleanString = re.compile(r'[^a-zA-Z0-9 \._-]+')
 # This matches new 'unbreakable' links, up to the closing quote or anchor
 findLinks = re.compile(r'@@[^#"]*')
+githuburl = 'https://github.com/Ardour/manual/edit/master/include/'
 
 #
 # Create an all lowercase filename without special characters and with spaces
@@ -189,6 +190,36 @@ def GetChildren(fs, pos):
 	return children
 
 
+#
+# Get the parent at this level
+#
+def GetParent(fs, pos):
+	thisLevel =  fs[pos]['level']
+	pos = pos - 1
+
+	while pos >= 0 and fs[pos]['level'] >= thisLevel:
+		pos = pos - 1
+
+	return pos
+
+
+#
+# Creates the BreadCrumbs
+#
+def GetBreadCrumbs(fs, pos):
+	# The <span class="divider">&gt;</span> is for Bootstrap pre-3.0
+	breadcrumbs = '<li class="active">'+ fs[pos]['title'] + '</li>'
+
+	while pos >= 0:
+		pos = GetParent(fs, pos)
+
+		if pos >= 0:
+			breadcrumbs='<li><a href="/' + fs[pos]['filename'] + '/">'+ fs[pos]['title'] + '</a></li>'+ breadcrumbs
+
+	breadcrumbs = '<ul class="breadcrumb"><li><a href="/toc/index.html">Home</a></li>' + breadcrumbs + '</ul>'
+	return breadcrumbs
+
+
 #
 # Make an array of children attached to each node in the file structure
 # (It's a quasi-tree structure, and can be traversed as such.)
@@ -346,7 +377,7 @@ temp = open('page-template.txt')
 template = temp.read()
 temp.close()
 
-template = template.replace('{{page.bootstrap_path}}', '/bootstrap-2.2.2')
+template = template.replace('{{page.bootstrap_path}}', '/bootstrap-3.3.7')
 template = template.replace('{{page.page_title}}', 'The Ardour Manual')
 
 
@@ -414,13 +445,13 @@ for header in fileStruct:
 	if level == 0:
 		toc = toc + '<h2>Part ' + num2roman(levelNums[level]) + ': ' + header['title'] + '</h2>\n';
 	elif level == 1:
-		toc = toc + '  <p id=chapter>Ch. ' + str(levelNums[level]) + ':&nbsp;&nbsp;<a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
+		toc = toc + '  <p class="chapter">Ch. ' + str(levelNums[level]) + ':&nbsp;&nbsp;<a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
 	elif level == 2:
-		toc = toc + '    <a id=subchapter href="/' + header['filename'] + '/">' + header['title'] + '</a><br>\n'
+		toc = toc + '    <p class="subchapter"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
 	elif level == 3:
-		toc = toc + '      <a id=subchapter href="/' + header['filename'] + '/">' + header['title'] + '</a><br>\n'
+		toc = toc + '      <p class="section"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
 	elif level == 4:
-		toc = toc + '      <a id=subchapter href="/' + header['filename'] + '/">' + header['title'] + '</a><br>\n'
+		toc = toc + '      <p class="subsection"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
 
 	# Make the 'this thing contains...' stuff
 	if HaveChildren(fileStruct, pageNumber):
@@ -431,17 +462,28 @@ for header in fileStruct:
 
 		more = '<div id=subtopics>\n' + '<h2>This section contains the following topics:</h2>\n' + '<ul>\n' + more + '</ul>\n' + '</div>\n'
 
-	# Make the 'Previous' & 'Next' content
+	parent = GetParent(fileStruct, pageNumber)
+
+	# Make the 'Previous', 'Up' & 'Next' content
 	nLink = ''
 	pLink = ''
+	uLink = ''
 
 	if pageNumber > 0:
-		pLink = '<li><a title="' + fileStruct[pageNumber - 1]['title'] + '" href="/' + fileStruct[pageNumber - 1]['filename'] + '/" class="previous"> &lt; Previous </a></li>'
+		pLink = '<li class="previous"><a title="' + fileStruct[pageNumber - 1]['title'] + '" href="/' + fileStruct[pageNumber - 1]['filename'] + '/" class="previous"> &larr; Previous </a></li>'
 
 	if pageNumber < len(fileStruct) - 1:
-		nLink = '<li><a title="' + fileStruct[pageNumber + 1]['title'] + '" href="/' + fileStruct[pageNumber + 1]['filename'] + '/" class="next"> Next &gt; </a></li>'
+		nLink = '<li class="next"><a title="' + fileStruct[pageNumber + 1]['title'] + '" href="/' + fileStruct[pageNumber + 1]['filename'] + '/" class="next"> Next &rarr; </a></li>'
 
-	prevnext = '<ul class=pager>' + pLink + nLink + '</ul>'
+	if level > 0:
+		uLink = '<li><a title="' + fileStruct[parent]['title'] + '" href="/' + fileStruct[parent]['filename'] + '/" class="active"> &uarr; Up </a></li>'
+	else:
+		uLink = '<li><a title="Ardour Table of Contents" href="/toc/index.html" class="active"> &uarr; Up </a></li>'
+
+	prevnext = '<ul class="pager">' + pLink + uLink + nLink + '</ul>'
+
+	# Make the BreadCrumbs
+	breadcrumbs = GetBreadCrumbs(fileStruct, pageNumber)
 
 	# Create the link sidebar
 	sidebar = CreateLinkSidebar(fileStruct, pageNumber, nodeChildren)
@@ -450,9 +492,11 @@ for header in fileStruct:
 	# Chapters, subchapters, sections & subsections can all have content,
 	# but the basic fundamental organizing unit WRT content is still the
 	# chapter.
+	githubedit = ''
 	if level > 0:
 		if 'include' in header:
 			srcFile = open('include/' + header['include'])
+			githubedit = '<span style="float:right;"><a title="Edit in GitHub" href="' + githuburl + header['include'] + '"><img src="/images/github.png"></a></span>'
 			content = srcFile.read()
 			srcFile.close()
 
@@ -472,8 +516,15 @@ for header in fileStruct:
 	content = FixInternalLinks(links, content, header['title'])
 
 	# Add header information to the page if in dev mode
-	if devmode and 'link' in header:
-		content = '<h1>link: ' + header['link'] + '</h2>\n<br><br>\n' + content
+	if devmode:
+		devnote ='<aside style="background-color:indigo; color:white;">'
+		if 'filename' in header:
+			devnote = devnote + 'filename: ' + header['filename'] + '<br>'
+		if 'include' in header:
+			devnote = devnote + 'include: ' + header['include'] + '<br>'
+		if 'link' in header:
+			devnote = devnote + 'link: ' + header['link'] + '<br>'
+		content = devnote + '</aside>' + content
 
 	# Set up the actual page from the template
 	if 'style' not in header:
@@ -486,6 +537,8 @@ for header in fileStruct:
 	page = page.replace('{{ page.title }}', header['title'])
 	page = page.replace('{% tree %}', sidebar)
 	page = page.replace('{% prevnext %}', prevnext)
+	page = page.replace('{% githubedit %}', githubedit)
+	page = page.replace('{% breadcrumbs %}', breadcrumbs)
 	page = page.replace('{{ content }}', content + more)
 
 	# Create the directory for the index.html file to go into (we use makedirs,
@@ -509,6 +562,8 @@ page = page.replace('{{ page.title }}', 'Ardour Table of Contents')
 page = page.replace('{% tree %}', sidebar)
 page = page.replace('{{ content }}', toc)
 page = page.replace('{% prevnext %}', '')
+page = page.replace('{% githubedit %}', '')
+page = page.replace('{% breadcrumbs %}', '')
 
 os.mkdir(siteDir + 'toc', 0o775)
 tocFile = open(siteDir + 'toc/index.html', 'w')