#!/usr/bin/python
#
-# Script to take the master document and create something that build.rb wants.
-# Eventually, this will replace build.rb
-#
-# Ultimately, we will write directly to the finished web site structure instead
-# of creating this half-assed thing that we then rely on the other ruby script
-# to handle. It works, but isn't optimal. :-P
+# Script to take the master document and ancillary files and create the
+# finished manual/website.
#
# by James Hammons
# (C) 2017 Underground Software
#
+# 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
+
#
# Create an all lowercase filename without special characters and with spaces
# replaced with dashes.
return fn
-# Preliminaries
+#
+# Parse headers into a dictionary
+#
+def ParseHeader(fileObj):
+ header = {}
-buildDir = './_manual.munge/'
+ while (True):
+ hdrLine = fileObj.readline().rstrip('\r\n')
-if os.access(buildDir, os.F_OK):
- print('Removing stale manual data...')
- shutil.rmtree(buildDir)
+ # Break out of the loop if we hit the end of header marker
+ if hdrLine.startswith('---'):
+ break
-os.mkdir(buildDir, 0o774)
+ # Parse out foo: bar pairs & put into header dictionary
+ a = re.split(': ', hdrLine, 1)
+ header[a[0]] = a[1]
-# Yeah, need to make a symlink in include/ too :-P
-# [this will go away when the rewrite happens]
-if (os.access('include/_manual', os.F_OK) == False):
- os.symlink('../_manual/', 'include/_manual')
+ return header
-# Here we go!
+#
+# Turn a "part" name into an int
+#
+def PartToLevel(s):
+ level = -1
-master = open('master-doc.txt')
+ 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 level
+
+
+#
+# Capture the master document's structure (and content, if any) in a list
+#
+def GetFileStructure():
+ fs = []
+ fnames = [None]*6
+ content = ''
+ grab = False
+ mf = open('master-doc.txt')
+
+ for ln in mf:
+ if ln.startswith('---'):
+ # First, stuff any content that we may have read into the current
+ # header's dictionary
+ if grab:
+ fs[-1]['content'] = content
+ grab = False
+ content = ''
+
+ # Then, get the new header and do things to it
+ hdr = ParseHeader(mf)
+ level = PartToLevel(hdr['part'])
+ hdr['level'] = level
+ fnames[level] = MakeFilename(hdr['title'])
+ fullName = ''
+
+ for i in range(level + 1):
+ fullName = fullName + fnames[i] + '/'
+
+ hdr['filename'] = fullName.rstrip('/')
+ fs.append(hdr)
+
+ if ('include' not in hdr) and (level > 0):
+ grab = True
+ else:
+ if grab:
+ content = content + ln
+
+ # Catch the last file, since it would be missed above
+ if grab:
+ fs[-1]['content'] = content
+
+ mf.close()
+ return fs
+
+
+#
+# Determine if a particular node has child nodes
+#
+def HaveChildren(fs, pos):
+ # If we're at the end of the list, there can be no children
+ if pos == len(fs) - 1:
+ return False
+
+ # If the next node is at a lower level than the current node, we have
+ # children.
+ if fs[pos]['level'] < fs[pos + 1]['level']:
+ return True
+
+ # Otherwise, no children at this node.
+ return False
+
+
+#
+# Get the children at this level, and return them in a list
+#
+def GetChildren(fs, pos):
+ children = []
+ pos = pos + 1
+ childLevel = fs[pos]['level']
+
+ while fs[pos]['level'] >= childLevel:
+ if fs[pos]['level'] == childLevel:
+ children.append(pos)
+
+ pos = pos + 1
+
+ # Sanity check
+ if pos == len(fs):
+ break
+
+ return children
+
+
+#
+# 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.)
+#
+def FindChildren(fs):
+ childArray = []
+
+ for i in range(len(fs)):
+ if HaveChildren(fs, i):
+ childArray.append(GetChildren(fs, i))
+ else:
+ childArray.append([])
+
+ return childArray
+
+
+#
+# Make an array of the top level nodes in the file structure
+#
+def FindTopLevelNodes(fs):
+ level0 = []
+
+ for i in range(len(fs)):
+ if fs[i]['level'] == 0:
+ level0.append(i)
+
+ return level0
+
+
+#
+# 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.
+#
+def FixInternalLinks(content):
+#make a dictionary ahead of time of <link:, filename:> pairs
+ return content
+
+
+#
+# Recursively build a list of links based on the location of the page we're
+# looking at currently
+#
+def BuildList(lst, fs, pagePos, cList):
+ content = '\n\n<dl>\n'
+
+ for i in range(len(lst)):
+ curPos = lst[i]
+ 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 + '>'
+
+ # If the current page is our page, and it has children, enumerate them
+ if curPos == pagePos:
+ if len(cList[curPos]) > 0:
+ content = content + BuildList(cList[curPos], fs, -1, cList)
+
+ # Otherwise, if our page lies between the current one and the next,
+ # build a list of links from those nodes one level down.
+ elif (pagePos > curPos) and (pagePos < nextPos):
+ content = content + BuildList(cList[curPos], fs, pagePos, cList)
+
+ content = content + '</dd>\n'
+
+ content = content + '</dl>\n'
+
+ return content
-toc = open(buildDir + '00_toc.html', 'w')
-toc.write('---\n' + 'title: Ardour Table of Contents\n' + '---\n\n')
+#
+# 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)
+ # Shove the TOC link in the top...
+ content = content[:7] + '<dt><a href="/toc/">Table of Contents</a></dt><dd></dd>\n' + content[7:]
+
+ return content
+# Preliminaries
+
roman = [ '0', 'I', 'II', 'III', 'IV', 'V', 'VI', 'VII', 'VIII', 'IX', 'X',
'XI', 'XII', 'XIII', 'XIV', 'XV', 'XVI', 'XVII', 'XVIII', 'XIX', 'XX',
'XXI', 'XXII', 'XXIII', 'XXIV', 'XXV', 'XXVI', 'XXVII', 'XXVIII', 'XXIX', 'XXX' ]
+
+verbose = True
level = 0
-lastLevel = 0
-lineCount = 0
-levelNames = [None]*6
+fileCount = 0
levelNums = [0]*6
-writingToFile = False
-# This is a shitty way of getting a filehandle...
-htmlFile = open('master-doc.txt')
-htmlFile.close()
lastFile = ''
+page = ''
+toc = ''
+pageNumber = 0
+
+siteDir = './website/'
+
+if os.access(siteDir, os.F_OK):
+ print('Removing stale HTML data...')
+ shutil.rmtree(siteDir)
+
+shutil.copytree('./source', siteDir)
+
+# Yeah, need to make a symlink in include/ too :-P
+# [this will go away when the rewrite happens]
+if (os.access('include/_manual', os.F_OK) == False):
+ os.symlink('../_manual/', 'include/_manual')
+
+
+# Read the template, and fix the stuff that's fixed for all pages
+temp = open('page-template.txt')
+template = temp.read()
+temp.close()
+
+template = template.replace('{{page.bootstrap_path}}', '/bootstrap-2.2.2')
+template = template.replace('{{page.page_title}}', 'The Ardour Manual')
+
+
+# Parse out the master docuemnt's structure into a dictionary list
+fileStruct = GetFileStructure()
+nodeChildren = FindChildren(fileStruct)
+# Here we go!
+
+master = open('master-doc.txt')
firstLine = master.readline().rstrip('\r\n')
+master.close()
if firstLine == '<!-- exploded -->':
- print('Parsing exploded file...\n')
+ print('Parsing exploded file...')
elif firstLine == '<!-- imploded -->':
- print('Parsing imploded file...\n')
+ print('Parsing imploded file...')
else:
- print('Parsing unknown type...\n')
-
-for line in master:
- lineCount = lineCount + 1
-
- # Do any header parsing if needed...
- if line.startswith('---'):
-
- # Close any open files that may have been opened from the last header...
- if writingToFile:
- htmlFile.close()
- writingToFile = False
-
- header = {}
-
- while (True):
- hdrLine = master.readline().rstrip('\r\n')
- lineCount = lineCount + 1
-
- # Break out of the loop if we hit the end of header marker
- if hdrLine.startswith('---'):
- break
-
- # Parse out foo: bar pairs & put into header dictionary
- a = re.split(': ', hdrLine, 1)
- header[a[0]] = a[1]
-
- # Header has been parsed, now do something about it...
- lastLevel = level
-
- # Handle Part/Chapter/subchapter/section/subsection numbering
- if (header['part'] == 'part'):
- level = 0
- levelNums[2] = 0
- elif (header['part'] == 'chapter'):
- level = 1
- levelNums[2] = 0
- elif (header['part'] == 'subchapter'):
- level = 2
- levelNums[3] = 0
- elif (header['part'] == 'section'):
- level = 3
- levelNums[4] = 0
- elif (header['part'] == 'subsection'):
- level = 4
-
- levelNums[level] = levelNums[level] + 1;
-
- # This is totally unnecessary, but nice; besides which, you can capture
- # the output to a file to look at later if you like :-)
+ print('Parsing unknown type...')
+
+for header in fileStruct:
+ fileCount = fileCount + 1
+ content = ''
+ more = ''
+
+ lastLevel = level
+ level = header['level']
+
+ # Handle Part/Chapter/subchapter/section/subsection numbering
+ if level == 0:
+ levelNums[2] = 0
+ elif level == 1:
+ levelNums[2] = 0
+ elif level == 2:
+ levelNums[3] = 0
+ elif level == 3:
+ levelNums[4] = 0
+
+ levelNums[level] = levelNums[level] + 1;
+
+ # This is totally unnecessary, but nice; besides which, you can capture
+ # the output to a file to look at later if you like :-)
+ # [TODO: add command line switch, default to False]
+ if verbose:
for i in range(level):
print('\t', end='')
print(header['title'])
- # Make a filename from the title...
- levelNames[level] = MakeFilename(header['title'])
- path = ''
-
- for i in range(level):
- path = path + str(levelNums[i]).zfill(2) + '_' + levelNames[i] + '/'
-
- path = path + str(levelNums[level]).zfill(2) + '_' + levelNames[level]
-
- # Append the appropriate footer to the last file, if the current file
- # is one level down from the previous...
- if ((level > 0) and (level > lastLevel)):
- nfile = open(buildDir + lastFile + '.html', 'a')
- nfile.write('\n{% children %}\n\n')
- nfile.close()
-
- # Handle TOC scriblings...
- if level == 0:
- toc.write('<h2>Part ' + roman[levelNums[level]] + ': ' + header['title'] + '</h2>\n');
- elif level == 1:
- toc.write(' <p id=chapter>Ch. ' + str(levelNums[level]) + ': <a href="/' + levelNames[0] + '/' + levelNames[1] + '/">' + header['title'] + '</a></p>\n')
- elif level == 2:
- toc.write(' <a id=subchapter href="/' + levelNames[0] + '/' + levelNames[1] + '/' + levelNames[2] + '/">' + header['title'] + '</a><br>\n')
- elif level == 3:
- toc.write(' <a id=subchapter href="/' + levelNames[0] + '/' + levelNames[1] + '/' + levelNames[2] + '/' + levelNames[3] + '/">' + header['title'] + '</a><br>\n')
- elif level == 4:
- toc.write(' <a id=subchapter href="/' + levelNames[0] + '/' + levelNames[1] + '/' + levelNames[2] + '/' + levelNames[3] + '/' + levelNames[4] + '/">' + header['title'] + '</a><br>\n')
-
- # Parts DO NOT have any content, they are ONLY an organizing construct!
- if (level == 0):
- os.mkdir(buildDir + path, 0o774)
- nfile = open(buildDir + path + '.html', 'w')
- nfile.write('---\n' + 'title: ' + header['title'] + '\n')
-
- if ('menu_title' in header):
- nfile.write('menu_title: ' + header['menu_title'] + '\n')
+ # Handle TOC scriblings...
+ if level == 0:
+ toc = toc + '<h2>Part ' + roman[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'
+ elif level == 2:
+ toc = toc + ' <a id=subchapter href="/' + header['filename'] + '/">' + header['title'] + '</a><br>\n'
+ elif level == 3:
+ toc = toc + ' <a id=subchapter href="/' + header['filename'] + '/">' + header['title'] + '</a><br>\n'
+ elif level == 4:
+ toc = toc + ' <a id=subchapter href="/' + header['filename'] + '/">' + header['title'] + '</a><br>\n'
+
+ # Make the 'this thing contains...' stuff
+ if HaveChildren(fileStruct, pageNumber):
+ pages = GetChildren(fileStruct, pageNumber)
+
+ for pg in pages:
+ more = more + '<li>' + '<a href="/' + fileStruct[pg]['filename'] + '/">' + fileStruct[pg]['title'] + '</a>' + '</li>\n'
+
+ 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
+ nLink = ''
+ pLink = ''
+
+ if pageNumber > 0:
+ pLink = '<li><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>'
+
+ prevnext = '<ul class=pager>' + pLink + nLink + '</ul>'
+
+ # Create the link sidebar
+ sidebar = CreateLinkSidebar(fileStruct, pageNumber, nodeChildren)
+
+ # Parts DO NOT have any content, they are ONLY an organizing construct!
+ # Chapters, subchapters, sections & subsections can all have content,
+ # but the basic fundamental organizing unit WRT content is still the
+ # chapter.
+ if level > 0:
+ if 'include' in header:
+ srcFile = open('include/' + header['include'])
+ content = srcFile.read()
+ srcFile.close()
+
+ # Get rid of any extant header in the include file
+ # (once this is accepted, we can nuke this bit, as content files
+ # will not have any headers or footers in them)
+ content = re.sub('---.*\n(.*\n)*---.*\n', '', content)
+ content = content.replace('{% children %}', '')
- nfile.write('---\n\n')
- nfile.close()
-
- # Chapters, subchapters, sections & subsections all can have content.
- # But the basic fundamental organizing unit WRT content is still the
- # chapter.
else:
- os.mkdir(buildDir + path, 0o774)
-
- if ('include' in header):
- shutil.copy('include/' + header['include'], buildDir + path + '.html')
+ if 'content' in header:
+ content = header['content']
else:
- htmlFile = open(buildDir + path + '.html', 'w')
- writingToFile = True
- htmlFile.write('---\n' + 'title: ' + header['title'] + '\n')
-
- if ('menu_title' in header):
- htmlFile.write('menu_title: ' + header['menu_title'] + '\n')
-
- if ('style' in header):
- htmlFile.write('style: ' + header['style'] + '\n')
-
- htmlFile.write('---\n\n')
+ content = '[something went wrong]'
- # Save filename for next header...
- lastFile = path
-
- # No header, in that case, just dump the lines into the currently open file
+ # Set up the actual page from the template
+ if 'style' not in header:
+ page = re.sub("{% if page.style %}.*\n.*\n{% endif %}.*\n", "", template)
else:
- if (writingToFile and (level > 0)):
- htmlFile.write(line)
-
-
-master.close()
-toc.close()
-
-if writingToFile:
- htmlFile.close()
-
-print('\nProcessed ' + str(lineCount) + ' lines.')
+ page = template.replace('{{page.style}}', header['style'])
+ page = page.replace('{% if page.style %}', '')
+ page = page.replace('{% endif %}', '')
+
+ page = page.replace('{{ page.title }}', header['title'])
+ page = page.replace('{% tree %}', sidebar)
+ page = page.replace('{% prevnext %}', prevnext)
+ page = page.replace('{{ content }}', content + more)
+
+ # Create the directory for the index.html file to go into
+ os.mkdir(siteDir + header['filename'], 0o775)
+
+ # Finally, write the file!
+ destFile = open(siteDir + header['filename'] + '/index.html', 'w')
+ destFile.write(page)
+ destFile.close()
+
+ # Save filename for next header...
+ lastFile = header['filename']
+ pageNumber = pageNumber + 1
+
+# Finally, create the TOC
+sidebar = CreateLinkSidebar(fileStruct, -1, nodeChildren)
+
+page = re.sub("{% if page.style %}.*\n.*\n{% endif %}.*\n", "", template)
+page = page.replace('{{ page.title }}', 'Ardour Table of Contents')
+page = page.replace('{% tree %}', sidebar)
+page = page.replace('{{ content }}', toc)
+page = page.replace('{% prevnext %}', '')
+
+os.mkdir(siteDir + 'toc', 0o775)
+tocFile = open(siteDir + 'toc/index.html', 'w')
+tocFile.write(page)
+tocFile.close()
+
+print('Processed ' + str(fileCount) + ' files.')
projects / ardour-manual-diverged / blobdiff