X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=build.py;h=376204959f810b72d7c5bfe126233c36b2346e01;hb=95ba1c292ae93b762486b8d1ae9983bae97ff168;hp=6d343b61c60f50f3bfea302446a8e7ca02b05974;hpb=7a4c28bd8605e90876ebee619de364ab7001e405;p=ardour-manual

diff --git a/build.py b/build.py
index 6d343b6..3762049 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
@@ -22,7 +22,8 @@ import argparse
 # 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'@@[^#"]*')
+findLinks = re.compile(r'"@@[^#"]*[#"]')
+githuburl = 'https://github.com/Ardour/manual/edit/master/include/'
 
 #
 # Create an all lowercase filename without special characters and with spaces
@@ -207,15 +208,15 @@ def GetParent(fs, pos):
 #
 def GetBreadCrumbs(fs, pos):
 	# The <span class="divider">&gt;</span> is for Bootstrap pre-3.0
-	breadcrumbs = ' <span class="divider">&gt;</span> <li class="active">'+ fs[pos]['title'] + '</li>'
+	breadcrumbs = '<li class="active">'+ fs[pos]['title'] + '</li>'
 
 	while pos >= 0:
 		pos = GetParent(fs, pos)
 
 		if pos >= 0:
-			breadcrumbs=' <span class="divider">&gt;</span> <li><a href="/' + fs[pos]['filename'] + '/">'+ fs[pos]['title'] + '</a></li>'+ breadcrumbs
+			breadcrumbs='<li><a href="/' + fs[pos]['filename'] + '/">'+ fs[pos]['title'] + '</a></li>'+ breadcrumbs
 
-	breadcrumbs = '<ol class="breadcrumb"><li><a href="/toc/index.html">Home</a></li>' + breadcrumbs + '</ol>'
+	breadcrumbs = '<ul class="breadcrumb"><li><a href="/toc/index.html">Home</a></li>' + breadcrumbs + '</ul>'
 	return breadcrumbs
 
 
@@ -256,14 +257,30 @@ 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
+
+#
+# Same as above, but create anchors (for the one-page version)
+#
+def FindInternalAnchors(fs):
+	linkDict = {}
+
+	for hdr in fs:
+		if 'link' in hdr:
+			linkDict['"@@' + hdr['link'] + '"'] = '"#' + hdr['link'] + '"'
+			linkDict['"@@' + hdr['link'] + '#'] = '"#' + hdr['link'] + '"'
+
 
 	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):
@@ -295,15 +312,15 @@ def FixInternalLinks(links, content, title):
 # looking at currently
 #
 def BuildList(lst, fs, pagePos, cList):
-	content = '\n\n<dl>\n'
+	content = '\n\n<ul>\n'
 
 	for i in range(len(lst)):
 		curPos = lst[i]
-		nextPos = lst[i + 1] if i + 1 < len(lst)  else len(fs)
+		nextPos = lst[i + 1] if i + 1 < len(lst) else len(fs)
 
 		active = ' class=active' if curPos == pagePos else ''
 		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 + '>'
+		content = content + '<li' + active + '><a href="/' + fs[curPos]['filename'] + '/">' + menuTitle + '</a></li>'
 
 		# If the current page is our page, and it has children, enumerate them
 		if curPos == pagePos:
@@ -315,12 +332,64 @@ def BuildList(lst, fs, pagePos, cList):
 		elif (pagePos > curPos) and (pagePos < nextPos):
 			content = content + BuildList(cList[curPos], fs, pagePos, cList)
 
-		content = content + '</dd>\n'
+	content = content + '\n</ul>\n'
+
+	return content
 
-	content = content + '</dl>\n'
+
+#
+# Builds the sidebar for the one-page version
+#
+def BuildOnePageSidebar(fs):
+
+	content = '\n\n<ul style="white-space:nowrap;">\n'
+	lvl = 0
+	levelNums = [0]*6
+
+	for i in range(len(fs)):
+		# Handle Part/Chapter/subchapter/section/subsection numbering
+		level = fs[i]['level']
+		if level == 0:
+			levelNums[2] = 0
+			levelNums[3] = 0
+			levelNums[4] = 0
+		elif level == 1:
+			levelNums[2] = 0
+			levelNums[3] = 0
+			levelNums[4] = 0
+		elif level == 2:
+			levelNums[3] = 0
+			levelNums[4] = 0
+		elif level == 3:
+			levelNums[4] = 0
+		levelNums[level] = levelNums[level] + 1;
+		j = level
+		txtlevel = ''
+		while j > 0:  #level 0 is the part number which is not shown
+			txtlevel = str(levelNums[j]) + '.' + txtlevel
+			j = j-1
+		if len(txtlevel) > 0:
+			txtlevel = txtlevel[:-1] + ' - '
+
+		if 'link' in fs[i]:
+			anchor = fs[i]['link']
+		else:
+			anchor = fs[i]['filename']
+
+		while lvl < level:
+			content = content + '<ul style="white-space:nowrap;">\n'
+			lvl = lvl + 1
+		while lvl > level:
+			content = content + '</ul>\n'
+			lvl = lvl - 1
+
+		content = content + '<li><a href="#' + anchor + '">' + txtlevel + fs[i]['title'] + '</a></li>\n'
+
+	content = content + '</ul>\n'
 
 	return content
 
+
 #
 # Create link sidebar given a position in the list.
 #
@@ -328,12 +397,12 @@ def CreateLinkSidebar(fs, pos, childList):
 
 	# Build the list recursively from the top level nodes
 	content = BuildList(FindTopLevelNodes(fs), fs, pos, childList)
-	# Shove the TOC link in the top...
-	content = content[:7] + '<dt><a href="/toc/">Table of Contents</a></dt><dd></dd>\n' + content[7:]
+	# Shove the TOC link and one file link at the top...
+	active = ' class=active' if pos<0 else ''
+	content = content.replace('<ul>','<ul><li' + active + '><a href="/toc/">Table of Contents</a></li>\n',1)
 
 	return content
 
-
 # Preliminaries
 
 # We have command line arguments now, so deal with them
@@ -354,6 +423,7 @@ fileCount = 0
 levelNums = [0]*6
 lastFile = ''
 page = ''
+onepage = ''
 toc = ''
 pageNumber = 0
 
@@ -376,9 +446,16 @@ 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')
 
+# Same as above, but for the One-page version
+temp = open('onepage-template.txt')
+onepage = temp.read()
+temp.close()
+
+onepage = onepage.replace('{{page.bootstrap_path}}', '/bootstrap-3.3.7')
+onepage = onepage.replace('{{page.page_title}}', 'The Ardour Manual')
 
 # Parse out the master docuemnt's structure into a dictionary list
 fileStruct = GetFileStructure()
@@ -388,6 +465,7 @@ nodeChildren = FindChildren(fileStruct)
 
 # Create a dictionary for translation of internal links to real links
 links = FindInternalLinks(fileStruct)
+oplinks = FindInternalAnchors(fileStruct)
 
 if not quiet:
 	print('Found ' + str(len(links)) + ' internal link target', end='')
@@ -418,10 +496,15 @@ for header in fileStruct:
 	# Handle Part/Chapter/subchapter/section/subsection numbering
 	if level == 0:
 		levelNums[2] = 0
+		levelNums[3] = 0
+		levelNums[4] = 0
 	elif level == 1:
 		levelNums[2] = 0
+		levelNums[3] = 0
+		levelNums[4] = 0
 	elif level == 2:
 		levelNums[3] = 0
+		levelNums[4] = 0
 	elif level == 3:
 		levelNums[4] = 0
 
@@ -440,17 +523,32 @@ for header in fileStruct:
 
 		print(header['title'])
 
-	# Handle TOC scriblings...
+	# Handle TOC scriblings and one-page titles...
+	opl = ''
+
+	if 'link' in header:
+		opl = ' id="' + header['link'] + '"'
+	else:
+		opl = ' id="' + header['filename'] + '"'
+
 	if level == 0:
 		toc = toc + '<h2>Part ' + num2roman(levelNums[level]) + ': ' + header['title'] + '</h2>\n';
+		oph = '<h1 class="clear"' + opl +'>Part ' + num2roman(levelNums[level]) + ' - ' + header['title'] + '</h1>\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 + '\t<p class="chapter">Ch. ' + str(levelNums[level]) + ':&nbsp;&nbsp;<a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
+		oph = '<h1 class="clear"' + opl +'>' + str(levelNums[level]) + ' - ' + header['title'] + '</h1>\n';
 	elif level == 2:
-		toc = toc + '    <a id=subchapter href="/' + header['filename'] + '/">' + header['title'] + '</a><br>\n'
+		toc = toc + '\t\t<p class="subchapter"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
+		oph = '<h1 class="clear"' + opl +'>' + str(levelNums[level-1]) + '.' + str(levelNums[level]) + ' - ' + header['title'] + '</h1>\n';
 	elif level == 3:
-		toc = toc + '      <a id=section href="/' + header['filename'] + '/">' + header['title'] + '</a><br>\n'
+		toc = toc + '\t\t\t<p class="section"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
+		oph = '<h1 class="clear"' + opl +'>' + str(levelNums[level-2]) + '.' + str(levelNums[level-1]) + '.' + str(levelNums[level]) + ' - ' + header['title'] + '</h1>\n';
 	elif level == 4:
-		toc = toc + '      <a id=subsection href="/' + header['filename'] + '/">' + header['title'] + '</a><br>\n'
+		toc = toc + '\t\t\t\t<p class="subsection"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
+		oph = '<h1 class="clear"' + opl +'>' + str(levelNums[level-3]) + '.'  + str(levelNums[level-2]) + '.'  + str(levelNums[level-1]) + '.' + str(levelNums[level]) + ' - ' + header['title'] + '</h1>\n';
+
+
+
 
 	# Make the 'this thing contains...' stuff
 	if HaveChildren(fileStruct, pageNumber):
@@ -463,23 +561,23 @@ for header in fileStruct:
 
 	parent = GetParent(fileStruct, pageNumber)
 
-	# Make the 'Previous' & 'Next' content
+	# 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"> &larr; 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 &rarr; </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 + uLink + nLink + '</ul>'
 
 	# Make the BreadCrumbs
 	breadcrumbs = GetBreadCrumbs(fileStruct, pageNumber)
@@ -491,9 +589,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()
 
@@ -509,12 +609,33 @@ for header in fileStruct:
 			else:
 				content = '[something went wrong]'
 
+	# 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
+
+	# ----- One page version -----
+
 	# Fix up any internal links
-	content = FixInternalLinks(links, content, header['title'])
+	opcontent = FixInternalLinks(oplinks, content, header['title'])
 
-	# Add header information to the page if in dev mode
-	if devmode and 'link' in header:
-		content = '<h1>link: ' + header['link'] + '</h1>\n<br><br>\n' + content
+	# Create the link sidebar
+	opsidebar = BuildOnePageSidebar(fileStruct)
+
+	# Set up the actual page from the template
+	onepage = onepage.replace('{% tree %}', opsidebar)
+	onepage = onepage.replace('{{ content }}', oph + '\n' + opcontent + '{{ content }}')
+
+	# ----- Normal version -----
+
+	# Fix up any internal links
+	content = FixInternalLinks(links, content, header['title'])
 
 	# Set up the actual page from the template
 	if 'style' not in header:
@@ -527,6 +648,7 @@ 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)
 
@@ -551,6 +673,7 @@ 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)
@@ -558,6 +681,12 @@ tocFile = open(siteDir + 'toc/index.html', 'w')
 tocFile.write(page)
 tocFile.close()
 
+# Create the one-page version of the documentation
+onepageFile = open(siteDir + 'ardourmanual.html', 'w')
+onepage = onepage.replace('{{ content }}', '') # cleans up the last spaceholder
+onepageFile.write(onepage)
+onepageFile.close()
+
+
 if not quiet:
 	print('Processed ' + str(fileCount) + ' files.')
-