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'])
117 for i in range(level + 1):
118 fullName = fullName + fnames[i] + '/'
120 hdr['filename'] = fullName.rstrip('/')
123 if ('include' not in hdr) and (level > 0):
127 content = content + ln
129 # Catch the last file, since it would be missed above
131 fs[-1]['content'] = content
138 # Determine if a particular node has child nodes
140 def HaveChildren(fs, pos):
141 # If we're at the end of the list, there can be no children
142 if pos == len(fs) - 1:
145 # If the next node is at a lower level than the current node, we have
147 if fs[pos]['level'] < fs[pos + 1]['level']:
150 # Otherwise, no children at this node.
155 # Get the children at this level, and return them in a list
157 def GetChildren(fs, pos):
160 childLevel = fs[pos]['level']
162 while fs[pos]['level'] >= childLevel:
163 if fs[pos]['level'] == childLevel:
176 # Make an array of children attached to each node in the file structure
177 # (It's a quasi-tree structure, and can be traversed as such.)
179 def FindChildren(fs):
182 for i in range(len(fs)):
183 if HaveChildren(fs, i):
184 childArray.append(GetChildren(fs, i))
186 childArray.append([])
192 # Make an array of the top level nodes in the file structure
194 def FindTopLevelNodes(fs):
197 for i in range(len(fs)):
198 if fs[i]['level'] == 0:
205 # Find all header links and create a dictionary out of them
207 def FindInternalLinks(fs):
212 linkDict['@@' + hdr['link']] = '/' + hdr['filename'] + '/'
218 # Internal links are of the form '@@link-name', which are references to the
219 # 'link:' field in the part header. We have to find all occurances and replace
220 # them with the appropriate link.
222 def FixInternalLinks(links, content, title):
224 # Make key1|key2|key3|... out of our links keys
225 pattern = re.compile('|'.join(links.keys()))
227 # Use a lambda callback to substitute each occurance found
228 result = pattern.sub(lambda x: links[x.group()], content)
230 # Check for missing link targets, and report them to the user
231 match = re.findall('"@@.*"', result)
234 print('\nMissing link target' + ('s' if len(match) > 1 else '') + ' in "' + title + '":')
245 # Recursively build a list of links based on the location of the page we're
246 # looking at currently
248 def BuildList(lst, fs, pagePos, cList):
249 content = '\n\n<dl>\n'
251 for i in range(len(lst)):
253 nextPos = lst[i + 1] if i + 1 < len(lst) else len(fs)
255 active = ' class=active' if curPos == pagePos else ''
256 content = content + '<dt' + active + '><a href="/' + fs[curPos]['filename'] + '/">' + fs[curPos]['title'] + '</a></dt><dd' + active + '>'
258 # If the current page is our page, and it has children, enumerate them
259 if curPos == pagePos:
260 if len(cList[curPos]) > 0:
261 content = content + BuildList(cList[curPos], fs, -1, cList)
263 # Otherwise, if our page lies between the current one and the next,
264 # build a list of links from those nodes one level down.
265 elif (pagePos > curPos) and (pagePos < nextPos):
266 content = content + BuildList(cList[curPos], fs, pagePos, cList)
268 content = content + '</dd>\n'
270 content = content + '</dl>\n'
275 # Create link sidebar given a position in the list.
277 def CreateLinkSidebar(fs, pos, childList):
279 # Build the list recursively from the top level nodes
280 content = BuildList(FindTopLevelNodes(fs), fs, pos, childList)
281 # Shove the TOC link in the top...
282 content = content[:7] + '<dt><a href="/toc/">Table of Contents</a></dt><dd></dd>\n' + content[7:]
289 # We have command line arguments now, so deal with them
290 parser = argparse.ArgumentParser(description='A build script for the Ardour Manual')
291 parser.add_argument('-v', '--verbose', action='store_true', help='Display the high-level structure of the manual')
292 parser.add_argument('-q', '--quiet', action='store_true', help='Suppress all output (overrides -v)')
293 args = parser.parse_args()
294 verbose = args.verbose
309 siteDir = './website/'
311 if os.access(siteDir, os.F_OK):
313 print('Removing stale HTML data...')
315 shutil.rmtree(siteDir)
317 shutil.copytree('./source', siteDir)
319 # Yeah, need to make a symlink in include/ too :-P
320 # [this will go away when the rewrite happens]
321 if (os.access('include/_manual', os.F_OK) == False):
322 os.symlink('../_manual/', 'include/_manual')
325 # Read the template, and fix the stuff that's fixed for all pages
326 temp = open('page-template.txt')
327 template = temp.read()
330 template = template.replace('{{page.bootstrap_path}}', '/bootstrap-2.2.2')
331 template = template.replace('{{page.page_title}}', 'The Ardour Manual')
334 # Parse out the master docuemnt's structure into a dictionary list
335 fileStruct = GetFileStructure()
337 # Build a quasi-tree structure listing children at level + 1 for each node
338 nodeChildren = FindChildren(fileStruct)
340 # Create a dictionary for translation of internal links to real links
341 links = FindInternalLinks(fileStruct)
344 print('Found ' + str(len(links)) + ' internal link target', end='')
345 print('.') if len(links) == 1 else print('s.')
348 master = open('master-doc.txt')
349 firstLine = master.readline().rstrip('\r\n')
352 if firstLine == '<!-- exploded -->':
353 print('Parsing exploded file...')
354 elif firstLine == '<!-- imploded -->':
355 print('Parsing imploded file...')
357 print('Parsing unknown type...')
361 for header in fileStruct:
362 fileCount = fileCount + 1
367 level = header['level']
369 # Handle Part/Chapter/subchapter/section/subsection numbering
379 levelNums[level] = levelNums[level] + 1;
381 # This is totally unnecessary, but nice; besides which, you can capture
382 # the output to a file to look at later if you like :-)
384 for i in range(level):
388 print('\nPart ' + num2roman(levelNums[0]) + ': ', end='')
390 print('\n\tChapter ' + str(levelNums[1]) + ': ', end='')
392 print(header['title'])
394 # Handle TOC scriblings...
396 toc = toc + '<h2>Part ' + num2roman(levelNums[level]) + ': ' + header['title'] + '</h2>\n';
398 toc = toc + ' <p id=chapter>Ch. ' + str(levelNums[level]) + ': <a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
400 toc = toc + ' <a id=subchapter href="/' + header['filename'] + '/">' + header['title'] + '</a><br>\n'
402 toc = toc + ' <a id=subchapter href="/' + header['filename'] + '/">' + header['title'] + '</a><br>\n'
404 toc = toc + ' <a id=subchapter href="/' + header['filename'] + '/">' + header['title'] + '</a><br>\n'
406 # Make the 'this thing contains...' stuff
407 if HaveChildren(fileStruct, pageNumber):
408 pages = GetChildren(fileStruct, pageNumber)
411 more = more + '<li>' + '<a href="/' + fileStruct[pg]['filename'] + '/">' + fileStruct[pg]['title'] + '</a>' + '</li>\n'
413 more = '<div id=subtopics>\n' + '<h2>This section contains the following topics:</h2>\n' + '<ul>\n' + more + '</ul>\n' + '</div>\n'
415 # Make the 'Previous' & 'Next' content
420 pLink = '<li><a title="' + fileStruct[pageNumber - 1]['title'] + '" href="/' + fileStruct[pageNumber - 1]['filename'] + '/" class="previous"> < Previous </a></li>'
422 if pageNumber < len(fileStruct) - 1:
423 nLink = '<li><a title="' + fileStruct[pageNumber + 1]['title'] + '" href="/' + fileStruct[pageNumber + 1]['filename'] + '/" class="next"> Next > </a></li>'
425 prevnext = '<ul class=pager>' + pLink + nLink + '</ul>'
427 # Create the link sidebar
428 sidebar = CreateLinkSidebar(fileStruct, pageNumber, nodeChildren)
430 # Parts DO NOT have any content, they are ONLY an organizing construct!
431 # Chapters, subchapters, sections & subsections can all have content,
432 # but the basic fundamental organizing unit WRT content is still the
435 if 'include' in header:
436 srcFile = open('include/' + header['include'])
437 content = srcFile.read()
440 # Get rid of any extant header in the include file
441 # (once this is accepted, we can nuke this bit, as content files
442 # will not have any headers or footers in them)
443 content = re.sub('---.*\n(.*\n)*---.*\n', '', content)
444 content = content.replace('{% children %}', '')
447 if 'content' in header:
448 content = header['content']
450 content = '[something went wrong]'
452 # Fix up any internal links
453 content = FixInternalLinks(links, content, header['title'])
455 # Set up the actual page from the template
456 if 'style' not in header:
457 page = re.sub("{% if page.style %}.*\n.*\n{% endif %}.*\n", "", template)
459 page = template.replace('{{page.style}}', header['style'])
460 page = page.replace('{% if page.style %}', '')
461 page = page.replace('{% endif %}', '')
463 page = page.replace('{{ page.title }}', header['title'])
464 page = page.replace('{% tree %}', sidebar)
465 page = page.replace('{% prevnext %}', prevnext)
466 page = page.replace('{{ content }}', content + more)
468 # Create the directory for the index.html file to go into
469 os.mkdir(siteDir + header['filename'], 0o775)
471 # Finally, write the file!
472 destFile = open(siteDir + header['filename'] + '/index.html', 'w')
476 # Save filename for next header...
477 lastFile = header['filename']
478 pageNumber = pageNumber + 1
480 # Finally, create the TOC
481 sidebar = CreateLinkSidebar(fileStruct, -1, nodeChildren)
483 page = re.sub("{% if page.style %}.*\n.*\n{% endif %}.*\n", "", template)
484 page = page.replace('{{ page.title }}', 'Ardour Table of Contents')
485 page = page.replace('{% tree %}', sidebar)
486 page = page.replace('{{ content }}', toc)
487 page = page.replace('{% prevnext %}', '')
489 os.mkdir(siteDir + 'toc', 0o775)
490 tocFile = open(siteDir + 'toc/index.html', 'w')
495 print('Processed ' + str(fileCount) + ' files.')