# Remnants (could go into the master document as the first header)
-#bootstrap_path: /bootstrap-3.3.7
-#page_title: The Ardour Manual
-
import os
import re
import shutil
# Global vars
+global_bootstrap_path = '/bootstrap-3.3.7'
+global_page_title = 'The Ardour Manual'
+global_site_dir = './website/'
+global_githuburl = 'https://github.com/Ardour/manual/edit/master/include/'
+global_screen_template = 'page-template.html'
+global_onepage_template = 'onepage-template.html'
+global_pdf_template = 'pdf-template.html'
+global_master_doc = 'master-doc.txt'
+
# 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'"@@[^#"]*[#"]')
#
# Create an all lowercase filename without special characters and with spaces
#
def PartToLevel(s):
level = -1
+ lvl = {'part': 0, 'chapter': 1, 'subchapter': 2}
+ if s in lvl:
+ return lvl[s]
+ else:
+ return -1
- 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
#
# Converts a integer to a roman number
fnames = [None]*6
content = ''
grab = False
- mf = open('master-doc.txt')
+ mf = open(global_master_doc)
for ln in mf:
if ln.startswith('---'):
return pos
+#
+# Change the hierarchy of titles : h1->hn, h2->hn+1, etc... n being delta-1
+#
+def reheader(txt, delta):
+ for i in range(6, 0, -1):
+ txt = txt.replace('<h' + str(i),'<h' + str(i+delta))
+ txt = txt.replace('</h' + str(i),'</h' + str(i+delta))
+ return txt
#
# Creates the BreadCrumbs
#
def GetBreadCrumbs(fs, pos):
- # The <span class="divider">></span> is for Bootstrap pre-3.0
breadcrumbs = '<li class="active">'+ fs[pos]['title'] + '</li>'
while pos >= 0:
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):
# looking at currently
#
def BuildList(lst, fs, pagePos, cList):
- content = '\n\n<dl>\n'
+ content = '\n\n<ul>\n'
for i in range(len(lst)):
curPos = lst[i]
- nextPos = lst[i + 1] if i + 1 < len(lst) else len(fs)
+ nextPos = lst[i + 1] if i + 1 < len(lst) else len(fs)
active = ' class=active' if curPos == pagePos else ''
menuTitle = fs[curPos]['menu_title'] if 'menu_title' in fs[curPos] else fs[curPos]['title']
- content = content + '<dt' + active + '><a href="/' + fs[curPos]['filename'] + '/">' + menuTitle + '</a></dt><dd' + active + '>'
+ content = content + '<li' + active + '><a href="/' + fs[curPos]['filename'] + '/">' + menuTitle + '</a></li>'
# If the current page is our page, and it has children, enumerate them
if curPos == pagePos:
elif (pagePos > curPos) and (pagePos < nextPos):
content = content + BuildList(cList[curPos], fs, pagePos, cList)
- content = content + '</dd>\n'
+ content = content + '\n</ul>\n'
+
+ return content
+
+
+#
+# Builds the sidebar for the one-page version
+#
+def BuildOnePageSidebar(fs):
+
+ content = '\n\n<ul class="toc" style="white-space:nowrap;">\n'
+ lvl = 0
+ levelNums = [0]*3
+
+ for i in range(len(fs)):
+ # Handle Part/Chapter/subchapter/section/subsection numbering
+ level = fs[i]['level']
+ if level < 2:
+ levelNums[2] = 0
+ levelNums[level] = levelNums[level] + 1;
+ j = level
+ txtlevel = ''
+ while j > 0: #level 0 is the part number which is not shown
+ txtlevel = str(levelNums[j]) + '.' + txtlevel
+ j = j-1
+ if len(txtlevel) > 0:
+ txtlevel = txtlevel[:-1] + ' - '
+
+ if 'link' in fs[i]:
+ anchor = fs[i]['link']
+ else:
+ anchor = fs[i]['filename']
+
+ while lvl < level:
+ content = content + '<ul style="white-space:nowrap;">\n'
+ lvl = lvl + 1
+ while lvl > level:
+ content = content + '</ul>\n'
+ lvl = lvl - 1
- content = content + '</dl>\n'
+ content = content + '<li><a href="#' + anchor + '">' + txtlevel + fs[i]['title'] + '</a></li>\n'
+
+ content = content + '</ul>\n'
return content
+
#
# Create link sidebar given a position in the list.
#
# 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:]
+ # Shove the TOC link and one file link at the top...
+ active = ' class=active' if pos<0 else ''
+ content = content.replace('<ul>','<ul><li' + active + '><a href="/toc/">Table of Contents</a></li>\n',1)
return content
-
# Preliminaries
# We have command line arguments now, so deal with them
level = 0
fileCount = 0
-levelNums = [0]*6
+levelNums = [0]*3
lastFile = ''
page = ''
+onepage = ''
+pdfpage = ''
toc = ''
pageNumber = 0
-siteDir = './website/'
+
if not quiet and devmode:
print('Devmode active: scribbling extra junk to the manual...')
-if os.access(siteDir, os.F_OK):
+if os.access(global_site_dir, os.F_OK):
if not quiet:
print('Removing stale HTML data...')
- shutil.rmtree(siteDir)
+ shutil.rmtree(global_site_dir)
-shutil.copytree('./source', siteDir)
+shutil.copytree('./source', global_site_dir)
# Read the template, and fix the stuff that's fixed for all pages
-temp = open('page-template.txt')
+temp = open(global_screen_template)
template = temp.read()
temp.close()
+template = template.replace('{{page.bootstrap_path}}', global_bootstrap_path)
+template = template.replace('{{page.page_title}}', global_page_title)
-template = template.replace('{{page.bootstrap_path}}', '/bootstrap-3.3.7')
-template = template.replace('{{page.page_title}}', 'The Ardour Manual')
+# Same as above, but for the One-page version
+temp = open(global_onepage_template)
+onepage = temp.read()
+temp.close()
+onepage = onepage.replace('{{page.bootstrap_path}}', global_bootstrap_path)
+onepage = onepage.replace('{{page.page_title}}', global_page_title)
+# Same as above, but for the PDF version
+temp = open(global_pdf_template)
+pdfpage = temp.read()
+temp.close()
+pdfpage = pdfpage.replace('{{page.page_title}}', global_page_title)
-# Parse out the master docuemnt's structure into a dictionary list
+# Parse out the master document's structure into a dictionary list
fileStruct = GetFileStructure()
# Build a quasi-tree structure listing children at level + 1 for each node
# Create a dictionary for translation of internal links to real links
links = FindInternalLinks(fileStruct)
+oplinks = FindInternalAnchors(fileStruct)
if not quiet:
print('Found ' + str(len(links)) + ' internal link target', end='')
print('.') if len(links) == 1 else print('s.')
if not quiet:
- master = open('master-doc.txt')
+ master = open(global_master_doc)
firstLine = master.readline().rstrip('\r\n')
master.close()
lastLevel = level
level = header['level']
- # Handle Part/Chapter/subchapter/section/subsection numbering
- if level == 0:
+ # Handle Part/Chapter/subchapter numbering
+ if level < 2:
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
print(header['title'])
- # Handle TOC scriblings...
+ # Handle TOC scriblings and one-page titles...
+ opl = ''
+ if 'link' in header:
+ opl = ' id="' + header['link'] + '"'
+ else:
+ opl = ' id="' + header['filename'] + '"'
+
if level == 0:
toc = toc + '<h2>Part ' + num2roman(levelNums[level]) + ': ' + header['title'] + '</h2>\n';
+ oph = '<h1 class="clear"' + opl +'>Part ' + num2roman(levelNums[level]) + ' - ' + header['title'] + '</h1>\n';
elif level == 1:
- toc = toc + ' <p class="chapter">Ch. ' + str(levelNums[level]) + ': <a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
+ toc = toc + '\t<p class="chapter">Ch. ' + str(levelNums[level]) + ': <a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
+ oph = '<h2 class="clear"' + opl +'>' + str(levelNums[level]) + ' - ' + header['title'] + '</h3>\n';
elif level == 2:
- toc = toc + ' <p class="subchapter"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
- elif level == 3:
- toc = toc + ' <p class="section"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
- elif level == 4:
- toc = toc + ' <p class="subsection"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
+ toc = toc + '\t\t<p class="subchapter"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
+ oph = '<h3 class="clear"' + opl +'>' + str(levelNums[level-1]) + '.' + str(levelNums[level]) + ' - ' + header['title'] + '</h3>\n';
# Make the 'this thing contains...' stuff
if HaveChildren(fileStruct, pageNumber):
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"> ← Previous </a></li>'
+ pLink = '<li
class="previous"><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>'
+ nLink = '<li
class="next"><a title="' + fileStruct[pageNumber + 1]['title'] + '" href="/' + fileStruct[pageNumber + 1]['filename'] + '/" class="next"> Next → </a></li>'
if level > 0:
uLink = '<li><a title="' + fileStruct[parent]['title'] + '" href="/' + fileStruct[parent]['filename'] + '/" class="active"> ↑ Up </a></li>'
else:
uLink = '<li><a title="Ardour Table of Contents" href="/toc/index.html" class="active"> ↑ 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)
# 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="' + global_githuburl + header['include'] + '"><img src="/images/github.png" alt="Edit in GitHub"/></a></span>'
content = srcFile.read()
srcFile.close()
else:
content = '[something went wrong]'
- # Fix up any internal links
- content = FixInternalLinks(links, content, header['title'])
-
# Add header information to the page if in dev mode
if devmode:
devnote ='<aside style="background-color:indigo; color:white;">'
devnote = devnote + 'link: ' + header['link'] + '<br>'
content = devnote + '</aside>' + content
+ # ----- One page and PDF version -----
+
+ # Fix up any internal links
+ opcontent = FixInternalLinks(oplinks, content, header['title'])
+ opcontent = reheader(opcontent, 2)
+
+ # Set up the actual page from the template
+ onepage = onepage.replace('{{ content }}', oph + '\n' + opcontent + '\n{{ content }}')
+ pdfpage = pdfpage.replace('{{ content }}', oph + '\n' + opcontent + '\n{{ 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:
page = re.sub("{% if page.style %}.*\n.*\n{% endif %}.*\n", "", template)
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)
# Create the directory for the index.html file to go into (we use makedirs,
# because we have to in order to accomodate the 'uri' keyword)
- os.makedirs(siteDir + header['filename'], 0o775, exist_ok=True)
+ os.makedirs(global_site_dir + header['filename'], 0o775, exist_ok=True)
# Finally, write the file!
- destFile = open(siteDir + header['filename'] + '/index.html', 'w')
+ destFile = open(global_site_dir + header['filename'] + '/index.html', 'w')
destFile.write(page)
destFile.close()
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)
-tocFile = open(siteDir + 'toc/index.html', 'w')
+os.mkdir(global_site_dir + 'toc', 0o775)
+tocFile = open(global_site_dir + 'toc/index.html', 'w')
tocFile.write(page)
tocFile.close()
+# Create the one-page version of the documentation
+onepageFile = open(global_site_dir + 'ardourmanual.html', 'w')
+opsidebar = BuildOnePageSidebar(fileStruct) # create the link sidebar
+onepage = onepage.replace('{% tree %}', opsidebar)
+onepage = onepage.replace('{{ content }}', '') # cleans up the last spaceholder
+onepageFile.write(onepage)
+onepageFile.close()
+
+if not quiet:
+ print('Generating the PDF...')
+# Create the PDF version of the documentation
+pdfpageFile = open(global_site_dir + 'pdf.html', 'w')
+pdfpage = pdfpage.replace('{% tree %}', opsidebar) # create the TOC
+pdfpage = pdfpage.replace('{{ content }}', '') # cleans up the last spaceholder
+pdfpageFile.write(pdfpage)
+pdfpageFile.close()
+
+from weasyprint import HTML
+doc = HTML(filename = global_site_dir + 'pdf.html') #, base_url = os.path.dirname(os.path.realpath(__file__)))
+doc.write_pdf(global_site_dir + 'manual.pdf')
+
if not quiet:
print('Processed ' + str(fileCount) + ' files.')
projects / ardour-manual / blobdiff