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

diff --git a/build.py b/build.py
index 639d8ef..5d6ecfd 100755
--- a/build.py
+++ b/build.py
@@ -18,15 +18,25 @@ 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'@@[^#"]*')
+
 #
 # 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 +132,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)
 
@@ -226,25 +237,27 @@ def FindInternalLinks(fs):
 # 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 +272,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 +310,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 +329,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...')
@@ -453,6 +471,10 @@ 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 and 'link' in header:
+		content = '<h1>link: ' + header['link'] + '</h2>\n<br><br>\n' + 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)
@@ -466,10 +488,8 @@ for header in fileStruct:
 	page = page.replace('{% prevnext %}', prevnext)
 	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!