X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=build.py;h=dbe5448e56bdf85a8b9c42ddd07a9a3e586e59ec;hb=1bc084d882bf5792634c5fd08c35eff78de26b02;hp=6109782fadc1cec153d2b408d32fc9fa94ddf71e;hpb=2a78650ae3df3a17c9c33f07aea597eb5f36da61;p=ardour-manual
diff --git a/build.py b/build.py
index 6109782..dbe5448 100755
--- a/build.py
+++ b/build.py
@@ -9,7 +9,7 @@
# Remnants (could go into the master document as the first header)
-#bootstrap_path: /bootstrap-2.2.2
+#bootstrap_path: /bootstrap-3.3.7
#page_title: The Ardour Manual
import os
@@ -22,7 +22,8 @@ import argparse
# 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'@@[^#"]*')
+findLinks = re.compile(r'"@@[^#"]*[#"]')
+githuburl = 'https://github.com/Ardour/manual/edit/master/include/'
#
# Create an all lowercase filename without special characters and with spaces
@@ -188,6 +189,7 @@ def GetChildren(fs, pos):
return children
+
#
# Get the parent at this level
#
@@ -200,20 +202,24 @@ def GetParent(fs, pos):
return pos
+
#
# Creates the BreadCrumbs
#
def GetBreadCrumbs(fs, pos):
- breadcrumbs = ' >
'+ fs[pos]['title'] + '
'
# The > is for Bootstrap pre-3.0
+ breadcrumbs = '
'
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.)
@@ -251,14 +257,30 @@ def FindInternalLinks(fs):
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
+
+#
+# Same as above, but create anchors (for the one-page version)
+#
+def FindInternalAnchors(fs):
+ linkDict = {}
+
+ for hdr in fs:
+ if 'link' in hdr:
+ linkDict['"@@' + hdr['link'] + '"'] = '"#' + hdr['link'] + '"'
+ linkDict['"@@' + hdr['link'] + '#'] = '"#' + hdr['link'] + '"'
+
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
+# 'link:' field in the part header. We have to find all occurrences and replace
# them with the appropriate link.
#
def FixInternalLinks(links, content, title):
@@ -316,19 +338,73 @@ def BuildList(lst, fs, pagePos, cList):
return content
+
+#
+# Builds the sidebar for the one-page version
+#
+def BuildOnePageSidebar(fs):
+
+ content = '\n\n
\n'
+
+ return content
+
+
#
# 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)
content = BuildList(FindTopLevelNodes(fs), fs, pos, childList)
- # Shove the TOC link in the top...
- content = content[:7] + '
'
# Make the BreadCrumbs
breadcrumbs = GetBreadCrumbs(fileStruct, pageNumber)
@@ -486,9 +591,11 @@ for header in fileStruct:
# 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 = ''
content = srcFile.read()
srcFile.close()
@@ -504,12 +611,33 @@ for header in fileStruct:
else:
content = '[something went wrong]'
+ # Add header information to the page if in dev mode
+ if devmode:
+ devnote ='' + content
+
+ # ----- One page version -----
+
# Fix up any internal links
- content = FixInternalLinks(links, content, header['title'])
+ opcontent = FixInternalLinks(oplinks, content, header['title'])
- # Add header information to the page if in dev mode
- if devmode and 'link' in header:
- content = '
link: ' + header['link'] + '
\n
\n' + content
+ # Create the link sidebar
+ opsidebar = BuildOnePageSidebar(fileStruct)
+
+ # Set up the actual page from the template
+ onepage = onepage.replace('{% tree %}', opsidebar)
+ onepage = onepage.replace('{{ content }}', oph + '\n' + opcontent + '{{ content }}')
+
+ # ----- Normal version -----
+
+ # Fix up any internal links
+ content = FixInternalLinks(links, content, header['title'])
# Set up the actual page from the template
if 'style' not in header:
@@ -522,6 +650,7 @@ for header in fileStruct:
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)
@@ -546,6 +675,7 @@ page = page.replace('{{ page.title }}', 'Ardour Table of Contents')
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)
@@ -553,5 +683,12 @@ tocFile = open(siteDir + 'toc/index.html', 'w')
tocFile.write(page)
tocFile.close()
+# Create the one-page version of the documentation
+onepageFile = open(siteDir + 'ardourmanual.html', 'w')
+onepage = onepage.replace('{{ content }}', '') # cleans up the last spaceholder
+onepageFile.write(onepage)
+onepageFile.close()
+
+
if not quiet:
print('Processed ' + str(fileCount) + ' files.')
