# finished manual/website.
#
# by James Hammons
-# (C) 2017 Underground Software
+# (C) 2020 Underground Software
+#
+# Contributors: Ed Ward
#
# Remnants (could go into the master document as the first header)
-#bootstrap_path: /bootstrap-2.2.2
-#page_title: The Ardour Manual
-
import os
import re
import shutil
import argparse
-
+import datetime
+
+# Global vars
+global_bootstrap_path = '/bootstrap-3.3.7'
+global_page_title = 'The Ardour Manual'
+global_site_dir = './website/'
+global_manual_url = 'http://manual.ardour.org'
+global_githuburl = 'https://github.com/Ardour/manual/edit/master/include/'
+global_screen_template = 'page-template.html'
+global_onepage_template = 'onepage-template.html'
+global_pdf_template = 'pdf-template.html'
+global_master_doc = 'master-doc.txt'
+from datetime import datetime
+global_today_iso = datetime.today().strftime('%Y-%m-%dT%H%M%S')
+global_today = datetime.today().strftime('%Y-%m-%d')
+
+# 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
# Turn a "part" name into an int
#
def PartToLevel(s):
- level = -1
+ lvl = {'part': 0, 'chapter': 1, 'subchapter': 2, 'section': 3, 'subsection': 4 }
+
+ if s in lvl:
+ return lvl[s]
- if s == 'part':
- level = 0
- elif s == 'chapter':
- level = 1
- elif s == 'subchapter':
- level = 2
- elif s == 'section':
- level = 3
- elif s == 'subsection':
- level = 4
+ return -1
- return level
#
-# Converts a integer to a roman number
+# Converts a integer to a Roman numeral
#
def num2roman(num):
num_map = [(1000, 'M'), (900, 'CM'), (500, 'D'), (400, 'CD'), (100, 'C'), (90, 'XC'), (50, 'L'), (40, 'XL'), (10, 'X'), (9, 'IX'), (5, 'V'), (4, 'IV'), (1, 'I')]
#
def GetFileStructure():
fs = []
- fnames = [None]*6
+ fnames = [None] * 6
content = ''
grab = False
- mf = open('master-doc.txt')
+ mf = open(global_master_doc)
for ln in mf:
if ln.startswith('---'):
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
+
+
+#
+# Change the hierarchy of titles : h1->hn, h2->hn+1, etc... n being delta-1
+#
+def reheader(txt, delta):
+ for i in range(6, 0, -1):
+ txt = txt.replace('<h' + str(i), '<h' + str(i + delta))
+ txt = txt.replace('</h' + str(i), '</h' + str(i + delta))
+
+ return txt
+
+
+#
+# Creates the BreadCrumbs
+#
+def GetBreadCrumbs(fs, pos):
+ 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
#
-# 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
-# them with the appropriate link.
+# Same as above, but create anchors (for the one-page version)
#
-def FixInternalLinks(links, content, title):
+def FindInternalAnchors(fs):
+ linkDict = {}
- # Make key1|key2|key3|... out of our links keys
- pattern = re.compile('|'.join(links.keys()))
+ for hdr in fs:
+ if 'link' in hdr:
+ linkDict['"@@' + hdr['link'] + '"'] = '"#' + hdr['link'] + '"'
+ linkDict['"@@' + hdr['link'] + '#'] = '"#' + hdr['link'] + '"'
- # Use a lambda callback to substitute each occurance found
- result = pattern.sub(lambda x: links[x.group()], content)
+ return linkDict
- # Check for missing link targets, and report them to the user
- match = re.findall('"@@.*"', result)
- if len(match) > 0:
- print('\nMissing link target' + ('s' if len(match) > 1 else '') + ' in "' + title + '":')
+#
+# Internal links are of the form '@@link-name', which are references to the
+# 'link:' field in the part header. We have to find all occurrences and replace
+# them with the appropriate link.
+#
+def FixInternalLinks(links, content, title):
+ global findLinks
+ match = findLinks.findall(content)
+ missing = []
+ if len(match) > 0:
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
#
# looking at currently
#
def BuildList(lst, fs, pagePos, cList):
- content = '\n\n<dl>\n'
+ content = '<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 ''
- 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 + '\t<li' + active + '><a href="/' + fs[curPos]['filename'] + '/">' + menuTitle + '</a></li>\n'
# If the current page is our page, and it has children, enumerate them
if curPos == pagePos:
elif (pagePos > curPos) and (pagePos < nextPos):
content = content + BuildList(cList[curPos], fs, pagePos, cList)
- content = content + '</dd>\n'
+ content = content + '</ul>\n'
+
+ return content
- content = content + '</dl>\n'
+
+#
+# Builds the sidebar for the one-page version
+#
+def BuildOnePageSidebar(fs):
+
+ content = '\n\n<ul class="toc">\n'
+ lvl = 0
+ levelNums = [0] * 5
+
+ for i in range(len(fs)):
+ # Handle Part/Chapter/subchapter/section/subsection numbering
+ level = fs[i]['level']
+
+ if level < 2:
+ levelNums[2] = 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 class="toc">\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.
#
# 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
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')
+parser.add_argument('-p', '--pdf', action='store_true', help='Automatically generate PDF from content')
args = parser.parse_args()
verbose = args.verbose
-quiet = args.quiet
+noisy = not args.quiet
+devmode = args.devmode
+pdf = args.pdf
-if quiet:
+# --quiet overrides --verbose, so tell it to shut up if user did both
+if not noisy:
verbose = False
-#verbose = False
level = 0
fileCount = 0
-levelNums = [0]*6
+levelNums = [0] * 5
lastFile = ''
page = ''
+onepage = ''
+pdfpage = ''
toc = ''
pageNumber = 0
-siteDir = './website/'
+if noisy and devmode:
+ print('Devmode active: scribbling extra junk to the manual...')
-if os.access(siteDir, os.F_OK):
- if not quiet:
+if os.access(global_site_dir, os.F_OK):
+ if noisy:
print('Removing stale HTML data...')
- shutil.rmtree(siteDir)
-
-shutil.copytree('./source', siteDir)
+ shutil.rmtree(global_site_dir)
+shutil.copytree('./source', global_site_dir)
# Read the template, and fix the stuff that's fixed for all pages
-temp = open('page-template.txt')
+temp = open(global_screen_template)
template = temp.read()
temp.close()
+template = template.replace('{{page.bootstrap_path}}', global_bootstrap_path)
+template = template.replace('{{page.page_title}}', global_page_title)
-template = template.replace('{{page.bootstrap_path}}', '/bootstrap-2.2.2')
-template = template.replace('{{page.page_title}}', 'The Ardour Manual')
+# Same as above, but for the "One-Page" version
+temp = open(global_onepage_template)
+onepage = temp.read()
+temp.close()
+onepage = onepage.replace('{{page.bootstrap_path}}', global_bootstrap_path)
+onepage = onepage.replace('{{page.page_title}}', global_page_title)
+if pdf:
+ # Same as above, but for the PDF version
+ temp = open(global_pdf_template)
+ pdfpage = temp.read()
+ temp.close()
+ pdfpage = pdfpage.replace('{{page.page_title}}', global_page_title)
-# Parse out the master docuemnt's structure into a dictionary list
+# Parse out the master document's structure into a dictionary list
fileStruct = GetFileStructure()
# Build a quasi-tree structure listing children at level + 1 for each node
# Create a dictionary for translation of internal links to real links
links = FindInternalLinks(fileStruct)
+oplinks = FindInternalAnchors(fileStruct)
-if not quiet:
+if noisy:
print('Found ' + str(len(links)) + ' internal link target', end='')
print('.') if len(links) == 1 else print('s.')
-if not quiet:
- master = open('master-doc.txt')
+if noisy:
+ master = open(global_master_doc)
firstLine = master.readline().rstrip('\r\n')
master.close()
level = header['level']
# Handle Part/Chapter/subchapter/section/subsection numbering
- if level == 0:
- levelNums[2] = 0
- elif level == 1:
+ if level < 2:
levelNums[2] = 0
- elif level == 2:
- levelNums[3] = 0
- elif level == 3:
- levelNums[4] = 0
levelNums[level] = levelNums[level] + 1;
if level == 0:
toc = toc + '<h2>Part ' + num2roman(levelNums[level]) + ': ' + header['title'] + '</h2>\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'
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'
elif level == 3:
- toc = toc + ' <a id=subchapter href="/' + header['filename'] + '/">' + header['title'] + '</a><br>\n'
+ toc = toc + '<p class="section"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
elif level == 4:
- toc = toc + ' <a id=subchapter href="/' + header['filename'] + '/">' + header['title'] + '</a><br>\n'
+ toc = toc + '<p class="subsection"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\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="' + global_githuburl + header['include'] + '"><img src="/images/github.png" alt="Edit in 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 and PDF version -----
+
+ # Fix up any internal links
+ opcontent = FixInternalLinks(oplinks, content, header['title'])
+ opcontent = reheader(opcontent, 2)
+
+ # Create "one page" header
+ oph = '<h' + str(level+1) + ' class="clear" id="' + header[('link' if 'link' in header else 'filename')] +'">' + header['title'] + '</h' + str(level+1) + '>\n';
+
+ # Set up the actual page from the template
+ onepage = onepage.replace('{{ content }}', oph + '\n' + opcontent + '\n{{ content }}')
+
+ if pdf:
+ if not 'pdf-exclude' in header:
+ pdfpage = pdfpage.replace('{{ content }}', oph + '\n' + opcontent + '\n{{ content }}')
+ else:
+ pdfpage = pdfpage.replace('{{ content }}', oph + '\n' + 'Please refer to the <a href="' + global_manual_url + '/' + header['filename'] + '/">online manual</a>.\n{{ 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 accomodate the 'uri' keyword)
- os.makedirs(siteDir + header['filename'], 0o775, exist_ok=True)
+ os.makedirs(global_site_dir + header['filename'], 0o775, exist_ok=True)
# Finally, write the file!
- destFile = open(siteDir + header['filename'] + '/index.html', 'w')
+ destFile = open(global_site_dir + header['filename'] + '/index.html', 'w')
destFile.write(page)
destFile.close()
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')
+os.mkdir(global_site_dir + 'toc', 0o775)
+tocFile = open(global_site_dir + 'toc/index.html', 'w')
tocFile.write(page)
tocFile.close()
-if not quiet:
+# Create the one-page version of the documentation
+onepageFile = open(global_site_dir + 'ardourmanual.html', 'w')
+opsidebar = BuildOnePageSidebar(fileStruct) # create the link sidebar
+onepage = onepage.replace('{% tree %}', opsidebar)
+onepage = onepage.replace('{{ content }}', '') # cleans up the last spaceholder
+onepageFile.write(onepage)
+onepageFile.close()
+
+if pdf:
+ if noisy:
+ print('Generating the PDF...')
+
+ # Create the PDF version of the documentation
+ pdfpage = pdfpage.replace('{% tree %}', opsidebar) # create the TOC
+ pdfpage = pdfpage.replace('{{ content }}', '') # cleans up the last spaceholder
+ pdfpage = pdfpage.replace('{{ today }}', global_today)
+ pdfpage = pdfpage.replace('{{ today_iso }}', global_today_iso)
+ pdfpage = pdfpage.replace('src="/images/', 'src="images/') # makes images links relative
+ pdfpage = pdfpage.replace('url(\'/images/', 'url(\'images/') # CSS images links relative
+ # Write it to disk (optional, can be removed)
+ pdfpageFile = open(global_site_dir + 'pdf.html', 'w')
+ pdfpageFile.write(pdfpage)
+ pdfpageFile.close()
+
+ # Generating the actual PDF with weasyprint (https://weasyprint.org/)
+ from weasyprint import HTML
+ from weasyprint.fonts import FontConfiguration
+ html_font_config = FontConfiguration()
+ doc = HTML(string = pdfpage, base_url = global_site_dir)
+ doc.write_pdf(global_site_dir + 'manual.pdf', font_config = html_font_config)
+
+if noisy:
print('Processed ' + str(fileCount) + ' files.')
+