X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=build.py;h=50ff861f471e7ed9912e677d590c36540fd54283;hb=88d6f39b5f8b0f791b6833bb1512aa774b59d4f8;hp=980ececb386e34dcb061ccae953e4dbfeb40e7f2;hpb=f1607b3d2534e99ad5b8e1f38cd0296a891412c2;p=ardour-manual

diff --git a/build.py b/build.py
index 980ecec..50ff861 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
@@ -18,15 +18,26 @@ import shutil
 import argparse
 
 
+# Global vars
+# This matches all *non* letter/number, ' ', '.', '-', and '_' chars
+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
 # replaced with dashes.
 #
 def MakeFilename(s):
-	# Cleans up the file name, removing all non ASCII or .-_ chars
-	fn = re.sub(r'[^.\-_a-zA-Z0-9 ]', '', s)
-	fn = fn.lower()
-	fn = fn.replace(' ', '-')
+	global cleanString
+	# Clean up the file name, removing all non letter/number or " .-_" chars.
+	# Also, convert to lower case and replace all spaces with dashes.
+	fn = cleanString.sub('', s).lower().replace(' ', '-')
+	# Double dashes can creep in from the above replacement, so we check for
+	# that here.
+	fn = fn.replace('--', '-')
+
 	return fn
 
 
@@ -122,7 +133,8 @@ def GetFileStructure():
 				for i in range(level + 1):
 					fullName = fullName + fnames[i] + '/'
 
-				hdr['filename'] = fullName.rstrip('/')
+				# Strip trailing '/' on filename
+				hdr['filename'] = fullName[:-1]
 
 			fs.append(hdr)
 
@@ -178,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.)
@@ -215,36 +257,39 @@ def FindInternalLinks(fs):
 
 	for hdr in fs:
 		if 'link' in hdr:
-			linkDict['@@' + hdr['link']] = '/' + hdr['filename'] + '/'
+			linkDict['"@@' + hdr['link'] + '"'] = '"/' + hdr['filename'] + '/"'
+			linkDict['"@@' + hdr['link'] + '#'] = '"/' + hdr['filename'] + '/index.html#'
 
 	return linkDict
 
 
 #
 # Internal links are of the form '@@link-name', which are references to the
-# 'link:' field in the part header. We have to find all occurances and replace
+# 'link:' field in the part header. We have to find all occurrences and replace
 # them with the appropriate link.
 #
 def FixInternalLinks(links, content, title):
-
-	# Make key1|key2|key3|... out of our links keys
-	pattern = re.compile('|'.join(links.keys()))
-
-	# Use a lambda callback to substitute each occurance found
-	result = pattern.sub(lambda x: links[x.group()], content)
-
-	# Check for missing link targets, and report them to the user
-	match = re.findall('"@@.*"', result)
+	global findLinks
+	match = findLinks.findall(content)
+	missing = []
 
 	if len(match) > 0:
-		print('\nMissing link target' + ('s' if len(match) > 1 else '') + ' in "' + title + '":')
-
 		for s in match:
-			print('  ' + s[3:-1])
+			if s in links:
+				content = content.replace(s, links[s])
+			else:
+				missing.append(s)
+
+	# Report missing link targets to the user (if any)
+	if len(missing) > 0:
+		print('\nMissing link target' + ('s' if len(missing) > 1 else '') + ' in "' + title + '":')
+
+		for s in missing:
+			print('  ' + s)
 
 		print()
 
-	return result
+	return content
 
 
 #
@@ -259,7 +304,8 @@ def BuildList(lst, fs, pagePos, cList):
 		nextPos = lst[i + 1] if i + 1 < len(lst)  else len(fs)
 
 		active = ' class=active' if curPos == pagePos else ''
-		content = content + '<dt' + active + '><a href="/' + fs[curPos]['filename'] + '/">' + fs[curPos]['title'] + '</a></dt><dd' + active + '>'
+		menuTitle = fs[curPos]['menu_title'] if 'menu_title' in fs[curPos] else fs[curPos]['title']
+		content = content + '<dt' + active + '><a href="/' + fs[curPos]['filename'] + '/">' + menuTitle + '</a></dt><dd' + active + '>'
 
 		# If the current page is our page, and it has children, enumerate them
 		if curPos == pagePos:
@@ -296,14 +342,15 @@ def CreateLinkSidebar(fs, pos, childList):
 parser = argparse.ArgumentParser(description='A build script for the Ardour Manual')
 parser.add_argument('-v', '--verbose', action='store_true', help='Display the high-level structure of the manual')
 parser.add_argument('-q', '--quiet', action='store_true', help='Suppress all output (overrides -v)')
+parser.add_argument('-d', '--devmode', action='store_true', help='Add content to pages to help developers debug them')
 args = parser.parse_args()
 verbose = args.verbose
 quiet = args.quiet
+devmode = args.devmode
 
 if quiet:
 	verbose = False
 
-#verbose = False
 level = 0
 fileCount = 0
 levelNums = [0]*6
@@ -314,6 +361,9 @@ pageNumber = 0
 
 siteDir = './website/'
 
+if not quiet and devmode:
+	print('Devmode active: scribbling extra junk to the manual...')
+
 if os.access(siteDir, os.F_OK):
 	if not quiet:
 		print('Removing stale HTML data...')
@@ -322,18 +372,13 @@ if os.access(siteDir, os.F_OK):
 
 shutil.copytree('./source', siteDir)
 
-# Yeah, need to make a symlink in include/ too :-P
-# [this will go away when the rewrite happens]
-if (os.access('include/_manual', os.F_OK) == False):
-	os.symlink('../_manual/', 'include/_manual')
-
 
 # Read the template, and fix the stuff that's fixed for all pages
 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')
 
 
@@ -401,13 +446,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):
@@ -418,17 +463,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>'
+
+	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>'
 
-	prevnext = '<ul class=pager>' + pLink + nLink + '</ul>'
+	# Make the BreadCrumbs
+	breadcrumbs = GetBreadCrumbs(fileStruct, pageNumber)
 
 	# Create the link sidebar
 	sidebar = CreateLinkSidebar(fileStruct, pageNumber, nodeChildren)
@@ -437,9 +493,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" alt="Edit on GitHub"/></a></span>'
 			content = srcFile.read()
 			srcFile.close()
 
@@ -458,6 +516,17 @@ for header in fileStruct:
 	# Fix up any internal links
 	content = FixInternalLinks(links, content, header['title'])
 
+	# Add header information to the page if in dev mode
+	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:
 		page = re.sub("{% if page.style %}.*\n.*\n{% endif %}.*\n", "", template)
@@ -469,12 +538,12 @@ 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, because we have to in order to accomadate the 'uri'
-	# keyword
-#	os.mkdir(siteDir + header['filename'], 0o775)
+	# Create the directory for the index.html file to go into (we use makedirs,
+	# because we have to in order to accomodate the 'uri' keyword)
 	os.makedirs(siteDir + header['filename'], 0o775, exist_ok=True)
 
 	# Finally, write the file!
@@ -494,6 +563,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')