]> Shamusworld >> Repos - ardour-manual-diverged/commitdiff
Version 1.0 of the final Python build script.
authorShamus Hammons <jlhamm@acm.org>
Wed, 1 Feb 2017 15:00:16 +0000 (09:00 -0600)
committerShamus Hammons <jlhamm@acm.org>
Wed, 1 Feb 2017 15:00:16 +0000 (09:00 -0600)
README.md
_config.yml [deleted file]
_layouts/bootstrap.html [deleted file]
_layouts/default.html [deleted file]
build.py
build.rb [deleted file]
master-doc.txt
page-template.txt [new file with mode: 0644]

index fd61c3b5ca408d6772596017e7333d010d7ed2b6..8853f06a761a1e64c09c9c61c1656b4ceb55284c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -152,16 +152,12 @@ The page format contained in the `_manual/` directory is different to the final
 
 The above will have to be revised eventually, but for now, here's what's what:
 
-1. All content lives in master-doc.txt and in include/ .
+1. All content lives in master-doc.txt and in `include/`.
 
-2. A little C helper program needs to be built and run. To build it, do:
+2. Run the 'build' script:
 
-        gcc munge.cpp -o munge -lstdc++ -g
+        ./build.py
 
-3. Run the 'doit' script:
-
-        ./doit
-
-4. Now _site/ should contain the correct built site. Have fun! ;-)
+3. Now `website/` contains the built site. Have fun! ;-)
 
 
diff --git a/_config.yml b/_config.yml
deleted file mode 100644 (file)
index 0ffca95..0000000
+++ /dev/null
@@ -1 +0,0 @@
-source: source
diff --git a/_layouts/bootstrap.html b/_layouts/bootstrap.html
deleted file mode 100644 (file)
index f949bbb..0000000
+++ /dev/null
@@ -1,95 +0,0 @@
----
-bootstrap_path: /bootstrap-2.2.2
-page_title: The Ardour Manual
----
-
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-      
-    <head>
-        <title>{{page.page_title}}</title>
-        <meta http-equiv="Content-type" content="text/html; charset=UTF-8" />
-
-        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-        <link href="{{page.bootstrap_path}}/css/bootstrap.min.css" rel="stylesheet" />
-        <link href="{{page.bootstrap_path}}/css/bootstrap-responsive.min.css" rel="stylesheet" />
-
-        <link href="/css/app.css" rel="stylesheet" />
-        {% if page.style %}
-        <link href="/css/{{page.style}}.css" rel="stylesheet" />
-        {% endif %}
-
-        <link href='http://fonts.googleapis.com/css?family=Junge' rel='stylesheet' type='text/css' />
-    </head>
-    <body>
-
-        <!--
-    <div class="navbar">
-        <div class="navbar-inner">
-            <div class="container">
-              <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
-                <span class="icon-bar"></span>
-                <span class="icon-bar"></span>
-                <span class="icon-bar"></span>
-              </a>
-                <a class="brand" href="#">The Ardour Manual</a>
-                <div class="nav-collapse collapse">
-                </div>
-            </div>
-        </div>
-    </div>
-    -->
-
-    <div class="container-fluid">
-        <div class="row-fluid">
-            <div id="tree">
-                <div id="tree-inner">
-                    <h1 class="title"><a href="/"><img src="/images/logo.png" alt="The Ardour Manual" /></a></h1>
-                    {% tree %}
-                </div>
-            </div>
-            <div class="span12" id="content">
-                <div id="search" class="gcse-search">
-                </div>
-                <div id="content-main">
-                    <h1 class="title">{{ page.title }}</h1>
-                    {{ content }}
-                   {% prevnext %}
-                </div>
-            </div>
-        </div>
-    </div>
-
-    <script type="text/javascript">
-    //<![CDATA[
-
-        // I'll go to hell for this
-        var isA = function(regex) { return navigator.userAgent.match(regex) };
-        var isAbout = function(regex) { return document.getElementsByTagName('h1')[1].textContent.match(regex) };
-
-        if ( (isA(/Mac/) || isAbout(/OS X/)) && (!isAbout(/Linux/)) ) {
-            var e = document.getElementsByTagName('body')[0];
-            e.className += ' mac';  // class magic for Cmd vs. Ctrl keys.
-        }
-    //]]>
-    </script>
-
-    <script type="text/javascript">
-        (function() {
-          var cx = '011950134405426689607:2lg2y9xgf3a';
-          var gcse = document.createElement('script'); gcse.type = 'text/javascript';
-          gcse.async = true;
-          gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
-              '//www.google.com/cse/cse.js?cx=' + cx;
-          var s = document.getElementsByTagName('script')[0];
-          s.parentNode.insertBefore(gcse, s);
-        })();
-    </script>
-  
-    </body>
-</html>
diff --git a/_layouts/default.html b/_layouts/default.html
deleted file mode 100644 (file)
index 8a79e18..0000000
+++ /dev/null
@@ -1,5 +0,0 @@
----
-layout: bootstrap
----
-
-{{content}}
\ No newline at end of file
index 2a8c8493530b119d41c0808ecdda7bf50d654665..e3eeef3ca8135376ada362f4b0d8262bd4b5c7f4 100755 (executable)
--- a/build.py
+++ b/build.py
@@ -1,20 +1,22 @@
 #!/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.
@@ -27,101 +29,291 @@ def MakeFilename(s):
        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='')
 
@@ -132,81 +324,102 @@ for line in master:
 
                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]) + ':&nbsp;&nbsp;<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]) + ':&nbsp;&nbsp;<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"> &lt; Previous </a></li>'
+
+       if pageNumber < len(fileStruct) - 1:
+               nLink = '<li><a title="' + fileStruct[pageNumber + 1]['title'] + '" href="/' + fileStruct[pageNumber + 1]['filename'] + '" class="next"> Next &gt; </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.')
 
diff --git a/build.rb b/build.rb
deleted file mode 100755 (executable)
index 4c981d2..0000000
--- a/build.rb
+++ /dev/null
@@ -1,285 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'pathname'
-require 'yaml'
-require 'optparse'
-
-begin require 'liquid'
-rescue LoadError
-    puts "Please install the 'liquid' Ruby gem (available in Debian/Ubuntu as 'ruby-liquid')"
-    exit 1
-end
-
-CONFIG = {
-    pages_dir: '_manual.munge',
-    layouts_dir: '_layouts',
-    static_dir: 'source',
-    output_dir: '_site'
-}
-
-def child_url?(a, b)
-    a.start_with?(b) && b.count('/') + 1 == a.count('/')
-end
-
-class Site
-    attr_reader :pages, :layouts
-
-    def initialize()
-        @pages = []
-        @layouts = {}
-    end
-    
-    def build()
-        print "Building... "
-
-        read_layouts()
-        read_pages()
-        copy_static()
-        process_pages()
-
-        puts "done."
-    end
-
-    def read_layouts()
-        Pathname.glob(layouts_dir + Pathname('*.html')) do |path|
-            next if !path.file?
-            layout = Layout.new(self, path)
-            layout.read
-            @layouts[path.basename('.html').to_s] = layout
-        end
-    end
-    
-    def read_pages()
-        pages_dir.find do |path|
-            if path.file? && path.extname == '.html'
-                page = Page.new(self, path)
-                page.read
-                @pages << page
-            end
-        end
-    end
-
-    def process_pages()
-        @pages.each {|page| page.process}
-    end
-    
-    def copy_static()
-        unless system("rsync -a --delete --exclude='*~' #{static_dir}/. #{output_dir}")
-            puts "Couldn't copy static files, is rsync installed?"
-        end
-    end
-    
-    def find_children(url)
-        sorted_pages.select { |p| child_url?(p.url, url) }
-    end
-    
-    def toplevel() @toplevel_memo ||= find_children('/') end
-    def sorted_pages() @sorted_pages_memo ||= @pages.sort_by{ |p| p.sort_url } end
-
-    def pages_dir() @pages_dir_memo ||= Pathname(CONFIG[:pages_dir]) end
-    def layouts_dir() @layouts_dir_memo ||= Pathname(CONFIG[:layouts_dir]) end
-    def static_dir() @static_dir_memo ||= Pathname(CONFIG[:static_dir]) end
-    def output_dir() @output_dir_memo ||= Pathname(CONFIG[:output_dir]) end
-end
-
-class Page
-    attr_reader :path, :out_path, :url, :sort_url
-
-    def initialize(site, path)
-        @site = site
-        @path = path
-
-       relative_path = @path.relative_path_from(@site.pages_dir);
-       a = relative_path.each_filename.map do |x|
-            x.sub(/^[0-9]*[-_]/, '')
-        end
-       a[-1].sub!(/\.html$/, '')
-        s = a.join('/')
-
-        @out_path = @site.output_dir + Pathname(s) + Pathname("index.html")
-        @url = "/#{s}/"
-        @sort_url = @path.to_s.sub(/\.html$/, '')
-    end
-
-    def related_to?(p)
-        # should we show p in the index on selfs page?
-        url.start_with?(p.url) || child_url?(url, p.url)
-    end
-
-    def title()
-        @page_context['title'] || ""
-    end
-
-    def menu_title()
-        @page_context['menu_title'] || title
-    end
-
-    def read()
-        content = @path.read
-        frontmatter, @content = split_frontmatter(content) || abort("File not well-formatted: #{@path}") 
-        @page_context = YAML.load(frontmatter)
-        @template = Liquid::Template.parse(@content)
-    end        
-
-    def split_frontmatter(txt)
-        @split_regex ||= /\A---[ \t\r]*\n(?<frontmatter>.*?)^---[ \t\r]*\n(?<content>.*)\z/m
-        match = @split_regex.match txt 
-        match ? [match['frontmatter'], match['content']] : nil
-    end
-    
-    def find_layout()
-        @site.layouts[@page_context['layout'] || 'default']
-    end
-
-    def children()
-        @children ||= @site.find_children(@url)
-    end
-    
-    def render()
-        registers = {page: self, site: @site}
-        context = {'page' => @page_context}
-        content = @template.render!(context, registers: registers)
-        find_layout.render(context.merge({'content' => content}), registers)
-    end
-    
-    def process()
-        path = out_path
-        path.dirname.mkpath
-        path.open('w') { |f| f.write(render) }
-    end
-end
-
-class Layout < Page
-    def render(context, registers)
-        context = context.dup
-        context['page'] = @page_context.merge(context['page'])
-        content = @template.render!(context, registers: registers)
-        if @page_context.has_key?('layout')
-            find_layout.render(context.merge({'content' => content}), registers)
-        else
-            content
-        end
-    end
-end
-
-class Tag_tree < Liquid::Tag
-    def join(children_html)
-        children_html.empty? ? "" : "<dl>\n" + children_html.join + "</dl>\n"
-    end
-
-    def render(context)
-        current = context.registers[:page]
-        site = context.registers[:site]
-
-        format_entry = lambda do |page|
-            children = page.children
-            
-            css = (page == current) ? ' class="active"' : ""
-            children_html = current.related_to?(page) ? join(children.map(&format_entry)) : ""
-            
-            %{
-          <dt#{css}>
-            <a href='#{page.url}'>#{page.menu_title}</a>
-          </dt>
-          <dd#{css}>
-            #{children_html}
-          </dd>
-        }
-        end
-
-        join(site.toplevel.map(&format_entry))
-    end
-end
-
-class Tag_children < Liquid::Tag
-    def render(context)
-        children = context.registers[:page].children
-        entries = children.map {|p| "<li><a href='#{p.url}'>#{p.title}</a></li>" }
-        
-        "<div id='subtopics'>
-        <h2>This chapter covers the following topics:</h2>
-        <ul>
-          #{entries.join}
-        </ul>
-        </div>
-      "
-    end
-end
-
-class Tag_prevnext < Liquid::Tag
-    def render(context)
-        current = context.registers[:page]
-        pages = context.registers[:site].sorted_pages
-        
-        index = pages.index { |page| page == current }
-        return '' if !index
-        
-        link = lambda do |p, cls, txt| 
-            "<li><a title='#{p.title}' href='#{p.url}' class='#{cls}'>#{txt}</a></li>"
-        end
-        prev_link = index > 0 ? link.call(pages[index-1], "previous", " &lt; Previous ") : ""
-        next_link = index < pages.length-1 ? link.call(pages[index+1], "next", " Next &gt; ") : ""
-        
-        "<ul class='pager'>#{prev_link}#{next_link}</ul>"
-    end
-end
-
-class Server
-    def start_watcher()
-        begin require 'listen'
-        rescue LoadError
-            puts "To use the --watch function, please install the 'listen' Ruby gem"
-            puts "(available in Debian/Ubuntu as 'ruby-listen')"
-            return nil
-        end
-
-        listener = Listen.to(CONFIG[:pages_dir], wait_for_delay: 1.0, only: /.html$/) do |modified, added, removed|
-            Site.new.build
-        end
-        listener.start
-        listener
-    end
-
-    def run(options)
-        require 'webrick'
-       listener = options[:watch] && start_watcher
-        port = options[:port] || 8000
-           
-        puts "Serving at http://localhost:#{port}/ ..."
-        server = WEBrick::HTTPServer.new :Port => port, :DocumentRoot => CONFIG[:output_dir]
-       trap 'INT' do 
-            server.shutdown 
-        end
-       server.start
-        listener.stop if listener
-    end  
-end
-
-def main
-    Liquid::Template.register_tag('tree', Tag_tree)
-    Liquid::Template.register_tag('children', Tag_children)
-    Liquid::Template.register_tag('prevnext', Tag_prevnext)
-
-    if defined? Liquid::Template.error_mode
-        Liquid::Template.error_mode = :strict
-    end
-
-    options = {}
-    OptionParser.new do |opts| 
-       opts.banner = %{Usage: build.rb <command> [options]
-
-Use 'build.rb' to build the manual.  Use 'build.rb serve' to also
-start a web server; setting any web server options implies "serve".
-}
-        opts.on("-w", "--watch", "Watch for changes") { options[:watch] = true }
-        opts.on("-p", "--port N", Integer, "Specify port for web server") { |p| options[:port] = p }
-    end.parse!
-
-    Site.new.build
-
-    if options[:watch] || options[:port] || (ARGV.length > 0 && "serve".start_with?(ARGV[0]))
-        Server.new.run(options)
-    end
-end
-
-main
index 14251136b078c52c2ad81f18ba8395906add3bd9..9991497efe6e3bd8a9819990b41a61d5f37fa04b 100644 (file)
@@ -1888,6 +1888,7 @@ part: subchapter
 
 ---
 title: Class Reference
+style: luadoc
 include: _manual/27_lua-scripting/02_class_reference.html
 exclude: yes
 part: subchapter
diff --git a/page-template.txt b/page-template.txt
new file mode 100644 (file)
index 0000000..2e963dc
--- /dev/null
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+      
+<head>
+       <title>{{page.page_title}}</title>
+       <meta http-equiv="Content-type" content="text/html; charset=UTF-8" />
+
+       <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+       <link href="{{page.bootstrap_path}}/css/bootstrap.min.css" rel="stylesheet" />
+       <link href="{{page.bootstrap_path}}/css/bootstrap-responsive.min.css" rel="stylesheet" />
+
+       <link href="/css/app.css" rel="stylesheet" />
+{% if page.style %}
+       <link href="/css/{{page.style}}.css" rel="stylesheet" />
+{% endif %}
+
+       <link href='http://fonts.googleapis.com/css?family=Junge' rel='stylesheet' type='text/css' />
+</head>
+
+<body>
+<div class="container-fluid"><div class="row-fluid">
+       <div id="tree"><div id="tree-inner">
+               <h1 class="title"><a href="/"><img src="/images/logo.png" alt="The Ardour Manual" /></a></h1>
+{% tree %}
+       </div></div>
+       <div class="span12" id="content">
+               <div id="search" class="gcse-search"></div>
+               <div id="content-main">
+               <h1 class="title">{{ page.title }}</h1>
+{{ content }}
+{% prevnext %}
+               </div>
+       </div>
+</div></div>
+
+<script type="text/javascript">
+// I'll go to hell for this
+var isA = function(regex) { return navigator.userAgent.match(regex) };
+var isAbout = function(regex) { return document.getElementsByTagName('h1')[1].textContent.match(regex) };
+
+if ( (isA(/Mac/) || isAbout(/OS X/)) && (!isAbout(/Linux/)) ) {
+       var e = document.getElementsByTagName('body')[0];
+       e.className += ' mac';  // class magic for Cmd vs. Ctrl keys.
+}
+</script>
+
+<!-- Google search bar == failure  -->
+<script type="text/javascript">
+(function()
+{
+       var cx = '011950134405426689607:2lg2y9xgf3a';
+       var gcse = document.createElement('script'); gcse.type = 'text/javascript';
+       gcse.async = true;
+       gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
+               '//www.google.com/cse/cse.js?cx=' + cx;
+       var s = document.getElementsByTagName('script')[0];
+       s.parentNode.insertBefore(gcse, s);
+})();
+</script>
+
+</body>
+</html>
+