X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;ds=sidebyside;f=build.py;h=f422df1474b0e77d0e4379b5d7d21799c2b281c0;hb=6a43fc94680f64625921728dddc8453dba42ae64;hp=b53b439f13bcd0039ec09e9cb0f8a9390a4ffcb5;hpb=389c23a3b50bf6d50ce832b87a66f624e32d43f8;p=ardour-manual
diff --git a/build.py b/build.py
index b53b439..f422df1 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)
@@ -178,6 +189,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 > is for Bootstrap pre-3.0
+ breadcrumbs = ' >
' + breadcrumbs + ''
+ 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.)
@@ -226,25 +267,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
#
@@ -297,14 +340,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
@@ -315,6 +359,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...')
@@ -401,9 +448,9 @@ for header in fileStruct:
elif level == 2:
toc = toc + ' ' + header['title'] + ' \n'
elif level == 3:
- toc = toc + ' ' + header['title'] + ' \n'
+ toc = toc + ' ' + header['title'] + ' \n'
elif level == 4:
- toc = toc + ' ' + header['title'] + ' \n'
+ toc = toc + ' ' + header['title'] + ' \n'
# Make the 'this thing contains...' stuff
if HaveChildren(fileStruct, pageNumber):
@@ -414,17 +461,28 @@ for header in fileStruct:
more = '