# 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
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
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)
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">></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.)
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):
-
- # 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
#
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:
return content
+
+#
+# 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.
#
def CreateLinkSidebar(fs, pos, childList):
# Build the list recursively from the top level nodes
+ #content = BuildList(FindTopLevelNodes(fs), fs, pos, childList)
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...
+ content = content[:7] + '<dt><dt><a href="/toc/">Table of Contents</a></dt><dd></dd>\n' + content[7:]
return content
-
# Preliminaries
# We have command line arguments now, so deal with them
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
lastFile = ''
page = ''
+onepage = ''
toc = ''
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...')
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()
# 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='')
# 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
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]) + ': <a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
+ toc = toc + '\t<p class="chapter">Ch. ' + str(levelNums[level]) + ': <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=subchapter 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=subchapter 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):
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"> < Previous </a></li>'
+ pLink = '<li class="previous"><a title="' + fileStruct[pageNumber - 1]['title'] + '" href="/' + fileStruct[pageNumber - 1]['filename'] + '/" class="previous"> ← Previous </a></li>'
if pageNumber < len(fileStruct) - 1:
- nLink = '<li><a title="' + fileStruct[pageNumber + 1]['title'] + '" href="/' + fileStruct[pageNumber + 1]['filename'] + '/" class="next"> Next > </a></li>'
+ nLink = '<li class="next"><a title="' + fileStruct[pageNumber + 1]['title'] + '" href="/' + fileStruct[pageNumber + 1]['filename'] + '/" class="next"> Next → </a></li>'
+
+ if level > 0:
+ uLink = '<li><a title="' + fileStruct[parent]['title'] + '" href="/' + fileStruct[parent]['filename'] + '/" class="active"> ↑ Up </a></li>'
+ else:
+ uLink = '<li><a title="Ardour Table of Contents" href="/toc/index.html" class="active"> ↑ 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)
# 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()
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
+ opcontent = FixInternalLinks(oplinks, content, header['title'])
+
+ # 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'])
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!
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')
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.')
projects / ardour-manual / blobdiff