FaderPort8 manual: add some more details, fix some typos

[ardour-manual] / build.py

diff --git a/build.py b/build.py
index 4d09afe19eb32637da05620290739c7ae848ec37..e427623a98130d4df690275f22b3f3340b6ac87b 100755 (executable)
--- a/build.py
+++ b/build.py
@@ -23,6 +23,7 @@ import argparse
 cleanString = re.compile(r'[^a-zA-Z0-9 \._-]+')
 # This matches new 'unbreakable' links, up to the closing quote or anchor
 findLinks = re.compile(r'@@[^#"]*')
+githuburl = 'https://github.com/Ardour/manual/edit/master/include/'
 
 #
 # Create an all lowercase filename without special characters and with spaces
@@ -463,23 +464,23 @@ for header in fileStruct:
 
        parent = GetParent(fileStruct, pageNumber)
 
-       # Make the 'Previous' & 'Next' content
+       # Make the 'Previous', 'Up' & 'Next' content
        nLink = ''
        pLink = ''
        uLink = ''
 
        if pageNumber > 0:
-               pLink = '<li><a title="' + fileStruct[pageNumber - 1]['title'] + '" href="/' + fileStruct[pageNumber - 1]['filename'] + '/" class="previous"> &larr; Previous </a></li>'
+               pLink = '<li class="previous"><a title="' + fileStruct[pageNumber - 1]['title'] + '" href="/' + fileStruct[pageNumber - 1]['filename'] + '/" class="previous"> &larr; Previous </a></li>'
 
        if pageNumber < len(fileStruct) - 1:
-               nLink = '<li><a title="' + fileStruct[pageNumber + 1]['title'] + '" href="/' + fileStruct[pageNumber + 1]['filename'] + '/" class="next"> Next &rarr; </a></li>'
+               nLink = '<li class="next"><a title="' + fileStruct[pageNumber + 1]['title'] + '" href="/' + fileStruct[pageNumber + 1]['filename'] + '/" class="next"> Next &rarr; </a></li>'
 
        if level > 0:
                uLink = '<li><a title="' + fileStruct[parent]['title'] + '" href="/' + fileStruct[parent]['filename'] + '/" class="active"> &uarr; Up </a></li>'
        else:
                uLink = '<li><a title="Ardour Table of Contents" href="/toc/index.html" class="active"> &uarr; Up </a></li>'
 
-       prevnext = '<ul class=pager>' + pLink + uLink + nLink + '</ul>'
+       prevnext = '<ul class="pager">' + pLink + uLink + nLink + '</ul>'
 
        # Make the BreadCrumbs
        breadcrumbs = GetBreadCrumbs(fileStruct, pageNumber)
@@ -491,9 +492,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 = '<span style="float:right;"><a title="Edit in GitHub" href="' + githuburl + header['include'] + '"><img src="/images/github.png" alt="Edit on GitHub"/></a></span>'
                        content = srcFile.read()
                        srcFile.close()
 
@@ -534,6 +537,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)
 
@@ -558,6 +562,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)