3 # Script to take the master document and ancillary files and create the
4 # finished manual/website.
7 # (C) 2017 Underground Software
10 # Remnants (could go into the master document as the first header)
12 #bootstrap_path: /bootstrap-2.2.2
13 #page_title: The Ardour Manual
22 # Create an all lowercase filename without special characters and with spaces
23 # replaced with dashes.
26 # Cleans up the file name, removing all non ASCII or .-_ chars
27 fn = re.sub(r'[^.\-_a-zA-Z0-9 ]', '', s)
29 fn = fn.replace(' ', '-')
34 # Parse headers into a dictionary
36 def ParseHeader(fileObj):
40 hdrLine = fileObj.readline().rstrip('\r\n')
42 # Break out of the loop if we hit the end of header marker
43 if hdrLine.startswith('---'):
46 # Check to see that we have a well-formed header construct
47 match = re.findall(': ', hdrLine)
50 # Parse out foo: bar pairs & put into header dictionary
51 a = re.split(': ', hdrLine, 1)
58 # Turn a "part" name into an int
67 elif s == 'subchapter':
71 elif s == 'subsection':
77 # Converts a integer to a roman number
80 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')]
92 # Capture the master document's structure (and content, if any) in a list
94 def GetFileStructure():
99 mf = open('master-doc.txt')
102 if ln.startswith('---'):
103 # First, stuff any content that we may have read into the current
104 # header's dictionary
106 fs[-1]['content'] = content
110 # Then, get the new header and do things to it
111 hdr = ParseHeader(mf)
112 level = PartToLevel(hdr['part'])
114 fnames[level] = MakeFilename(hdr['title'])
116 # Ickyness--user specified URIs
118 hdr['filename'] = hdr['uri']
122 for i in range(level + 1):
123 fullName = fullName + fnames[i] + '/'
125 hdr['filename'] = fullName.rstrip('/')
129 if ('include' not in hdr) and (level > 0):
133 content = content + ln
135 # Catch the last file, since it would be missed above
137 fs[-1]['content'] = content
144 # Determine if a particular node has child nodes
146 def HaveChildren(fs, pos):
147 # If we're at the end of the list, there can be no children
148 if pos == len(fs) - 1:
151 # If the next node is at a lower level than the current node, we have
153 if fs[pos]['level'] < fs[pos + 1]['level']:
156 # Otherwise, no children at this node.
161 # Get the children at this level, and return them in a list
163 def GetChildren(fs, pos):
166 childLevel = fs[pos]['level']
168 while fs[pos]['level'] >= childLevel:
169 if fs[pos]['level'] == childLevel:
182 # Make an array of children attached to each node in the file structure
183 # (It's a quasi-tree structure, and can be traversed as such.)
185 def FindChildren(fs):
188 for i in range(len(fs)):
189 if HaveChildren(fs, i):
190 childArray.append(GetChildren(fs, i))
192 childArray.append([])
198 # Make an array of the top level nodes in the file structure
200 def FindTopLevelNodes(fs):
203 for i in range(len(fs)):
204 if fs[i]['level'] == 0:
211 # Find all header links and create a dictionary out of them
213 def FindInternalLinks(fs):
218 linkDict['@@' + hdr['link']] = '/' + hdr['filename'] + '/'
224 # Internal links are of the form '@@link-name', which are references to the
225 # 'link:' field in the part header. We have to find all occurances and replace
226 # them with the appropriate link.
228 def FixInternalLinks(links, content, title):
230 # Make key1|key2|key3|... out of our links keys
231 pattern = re.compile('|'.join(links.keys()))
233 # Use a lambda callback to substitute each occurance found
234 result = pattern.sub(lambda x: links[x.group()], content)
236 # Check for missing link targets, and report them to the user
237 match = re.findall('"@@.*"', result)
240 print('\nMissing link target' + ('s' if len(match) > 1 else '') + ' in "' + title + '":')
251 # Recursively build a list of links based on the location of the page we're
252 # looking at currently
254 def BuildList(lst, fs, pagePos, cList):
255 content = '\n\n<dl>\n'
257 for i in range(len(lst)):
259 nextPos = lst[i + 1] if i + 1 < len(lst) else len(fs)
261 active = ' class=active' if curPos == pagePos else ''
262 content = content + '<dt' + active + '><a href="/' + fs[curPos]['filename'] + '/">' + fs[curPos]['title'] + '</a></dt><dd' + active + '>'
264 # If the current page is our page, and it has children, enumerate them
265 if curPos == pagePos:
266 if len(cList[curPos]) > 0:
267 content = content + BuildList(cList[curPos], fs, -1, cList)
269 # Otherwise, if our page lies between the current one and the next,
270 # build a list of links from those nodes one level down.
271 elif (pagePos > curPos) and (pagePos < nextPos):
272 content = content + BuildList(cList[curPos], fs, pagePos, cList)
274 content = content + '</dd>\n'
276 content = content + '</dl>\n'
281 # Create link sidebar given a position in the list.
283 def CreateLinkSidebar(fs, pos, childList):
285 # Build the list recursively from the top level nodes
286 content = BuildList(FindTopLevelNodes(fs), fs, pos, childList)
287 # Shove the TOC link in the top...
288 content = content[:7] + '<dt><a href="/toc/">Table of Contents</a></dt><dd></dd>\n' + content[7:]
295 # We have command line arguments now, so deal with them
296 parser = argparse.ArgumentParser(description='A build script for the Ardour Manual')
297 parser.add_argument('-v', '--verbose', action='store_true', help='Display the high-level structure of the manual')
298 parser.add_argument('-q', '--quiet', action='store_true', help='Suppress all output (overrides -v)')
299 args = parser.parse_args()
300 verbose = args.verbose
315 siteDir = './website/'
317 if os.access(siteDir, os.F_OK):
319 print('Removing stale HTML data...')
321 shutil.rmtree(siteDir)
323 shutil.copytree('./source', siteDir)
325 # Yeah, need to make a symlink in include/ too :-P
326 # [this will go away when the rewrite happens]
327 if (os.access('include/_manual', os.F_OK) == False):
328 os.symlink('../_manual/', 'include/_manual')
331 # Read the template, and fix the stuff that's fixed for all pages
332 temp = open('page-template.txt')
333 template = temp.read()
336 template = template.replace('{{page.bootstrap_path}}', '/bootstrap-2.2.2')
337 template = template.replace('{{page.page_title}}', 'The Ardour Manual')
340 # Parse out the master docuemnt's structure into a dictionary list
341 fileStruct = GetFileStructure()
343 # Build a quasi-tree structure listing children at level + 1 for each node
344 nodeChildren = FindChildren(fileStruct)
346 # Create a dictionary for translation of internal links to real links
347 links = FindInternalLinks(fileStruct)
350 print('Found ' + str(len(links)) + ' internal link target', end='')
351 print('.') if len(links) == 1 else print('s.')
354 master = open('master-doc.txt')
355 firstLine = master.readline().rstrip('\r\n')
358 if firstLine == '<!-- exploded -->':
359 print('Parsing exploded file...')
360 elif firstLine == '<!-- imploded -->':
361 print('Parsing imploded file...')
363 print('Parsing unknown type...')
367 for header in fileStruct:
368 fileCount = fileCount + 1
373 level = header['level']
375 # Handle Part/Chapter/subchapter/section/subsection numbering
385 levelNums[level] = levelNums[level] + 1;
387 # This is totally unnecessary, but nice; besides which, you can capture
388 # the output to a file to look at later if you like :-)
390 for i in range(level):
394 print('\nPart ' + num2roman(levelNums[0]) + ': ', end='')
396 print('\n\tChapter ' + str(levelNums[1]) + ': ', end='')
398 print(header['title'])
400 # Handle TOC scriblings...
402 toc = toc + '<h2>Part ' + num2roman(levelNums[level]) + ': ' + header['title'] + '</h2>\n';
404 toc = toc + ' <p id=chapter>Ch. ' + str(levelNums[level]) + ': <a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
406 toc = toc + ' <a id=subchapter href="/' + header['filename'] + '/">' + header['title'] + '</a><br>\n'
408 toc = toc + ' <a id=subchapter href="/' + header['filename'] + '/">' + header['title'] + '</a><br>\n'
410 toc = toc + ' <a id=subchapter href="/' + header['filename'] + '/">' + header['title'] + '</a><br>\n'
412 # Make the 'this thing contains...' stuff
413 if HaveChildren(fileStruct, pageNumber):
414 pages = GetChildren(fileStruct, pageNumber)
417 more = more + '<li>' + '<a href="/' + fileStruct[pg]['filename'] + '/">' + fileStruct[pg]['title'] + '</a>' + '</li>\n'
419 more = '<div id=subtopics>\n' + '<h2>This section contains the following topics:</h2>\n' + '<ul>\n' + more + '</ul>\n' + '</div>\n'
421 # Make the 'Previous' & 'Next' content
426 pLink = '<li><a title="' + fileStruct[pageNumber - 1]['title'] + '" href="/' + fileStruct[pageNumber - 1]['filename'] + '/" class="previous"> < Previous </a></li>'
428 if pageNumber < len(fileStruct) - 1:
429 nLink = '<li><a title="' + fileStruct[pageNumber + 1]['title'] + '" href="/' + fileStruct[pageNumber + 1]['filename'] + '/" class="next"> Next > </a></li>'
431 prevnext = '<ul class=pager>' + pLink + nLink + '</ul>'
433 # Create the link sidebar
434 sidebar = CreateLinkSidebar(fileStruct, pageNumber, nodeChildren)
436 # Parts DO NOT have any content, they are ONLY an organizing construct!
437 # Chapters, subchapters, sections & subsections can all have content,
438 # but the basic fundamental organizing unit WRT content is still the
441 if 'include' in header:
442 srcFile = open('include/' + header['include'])
443 content = srcFile.read()
446 # Get rid of any extant header in the include file
447 # (once this is accepted, we can nuke this bit, as content files
448 # will not have any headers or footers in them)
449 content = re.sub('---.*\n(.*\n)*---.*\n', '', content)
450 content = content.replace('{% children %}', '')
453 if 'content' in header:
454 content = header['content']
456 content = '[something went wrong]'
458 # Fix up any internal links
459 content = FixInternalLinks(links, content, header['title'])
461 # Set up the actual page from the template
462 if 'style' not in header:
463 page = re.sub("{% if page.style %}.*\n.*\n{% endif %}.*\n", "", template)
465 page = template.replace('{{page.style}}', header['style'])
466 page = page.replace('{% if page.style %}', '')
467 page = page.replace('{% endif %}', '')
469 page = page.replace('{{ page.title }}', header['title'])
470 page = page.replace('{% tree %}', sidebar)
471 page = page.replace('{% prevnext %}', prevnext)
472 page = page.replace('{{ content }}', content + more)
474 # Create the directory for the index.html file to go into
475 # (we use makedirs, because we have to in order to accomadate the 'uri'
477 # os.mkdir(siteDir + header['filename'], 0o775)
478 os.makedirs(siteDir + header['filename'], 0o775, exist_ok=True)
480 # Finally, write the file!
481 destFile = open(siteDir + header['filename'] + '/index.html', 'w')
485 # Save filename for next header...
486 lastFile = header['filename']
487 pageNumber = pageNumber + 1
489 # Finally, create the TOC
490 sidebar = CreateLinkSidebar(fileStruct, -1, nodeChildren)
492 page = re.sub("{% if page.style %}.*\n.*\n{% endif %}.*\n", "", template)
493 page = page.replace('{{ page.title }}', 'Ardour Table of Contents')
494 page = page.replace('{% tree %}', sidebar)
495 page = page.replace('{{ content }}', toc)
496 page = page.replace('{% prevnext %}', '')
498 os.mkdir(siteDir + 'toc', 0o775)
499 tocFile = open(siteDir + 'toc/index.html', 'w')
504 print('Processed ' + str(fileCount) + ' files.')