X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=build.py;h=127f43f84b01cfd19a8aaebc3de76275a99c0bdc;hb=fdf05235b45a22d8708464841162f396ea49dc86;hp=10c047597a534ca9980a76d8c787928052b961b8;hpb=e6123839d20de4f903ed74820cc087fc8401f625;p=ardour-manual
diff --git a/build.py b/build.py
index 10c0475..127f43f 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)
@@ -177,6 +188,31 @@ def GetChildren(fs, pos):
return children
+#
+# Get the parent at this level
+#
+def GetParent(fs, pos):
+ thisLevel = fs[pos]['level']
+ pos = pos - 1
+
+ while fs[pos]['level'] >= thisLevel and pos > 0:
+ pos = pos - 1
+
+ return pos
+
+#
+# Creates the BreadCrumbs
+#
+def GetBreadCrumbs(fs, pos):
+ breadcrumbs = ' >
'+ fs[pos]['title'] + ''
+ # The > is for Bootstrap pre-3.0
+ while pos:
+ pos = GetParent(fs,pos)
+ if pos:
+ breadcrumbs=' > '+ fs[pos]['title'] + ''+ breadcrumbs
+
+ breadcrumbs = '- Home
' + breadcrumbs + '
'
+ return breadcrumbs
#
# Make an array of children attached to each node in the file structure
@@ -226,25 +262,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 +297,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 + '' + fs[curPos]['title'] + ''
+ menuTitle = fs[curPos]['menu_title'] if 'menu_title' in fs[curPos] else fs[curPos]['title']
+ content = content + '' + menuTitle + ''
# If the current page is our page, and it has children, enumerate them
if curPos == pagePos:
@@ -296,14 +335,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 +354,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...')
@@ -413,17 +456,28 @@ for header in fileStruct:
more = '\n' + '
This section contains the following topics:
\n' + '
\n' + '
\n'
+ parent = GetParent(fileStruct, pageNumber)
+
# Make the 'Previous' & 'Next' content
nLink = ''
pLink = ''
+ uLink = ''
if pageNumber > 0:
- pLink = ' < Previous '
+ pLink = ' ← Previous '
if pageNumber < len(fileStruct) - 1:
- nLink = ' Next > '
+ nLink = ' Next → '
+
+ if level > 0:
+ uLink = ' ↑ Up '
+ else:
+ uLink = ' ↑ Up '
+
+ prevnext = ''
- prevnext = ''
+ # Make the BreadCrumbs
+ breadcrumbs = GetBreadCrumbs(fileStruct, pageNumber)
# Create the link sidebar
sidebar = CreateLinkSidebar(fileStruct, pageNumber, nodeChildren)
@@ -453,6 +507,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 = 'link: ' + header['link'] + '
\n
\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)
@@ -464,6 +522,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('{% breadcrumbs %}', breadcrumbs)
page = page.replace('{{ content }}', content + more)
# Create the directory for the index.html file to go into (we use makedirs,
@@ -487,6 +546,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('{% breadcrumbs %}', '')
os.mkdir(siteDir + 'toc', 0o775)
tocFile = open(siteDir + 'toc/index.html', 'w')