'
+ 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.)
@@ -226,14 +271,29 @@ 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):
@@ -265,15 +325,15 @@ def FixInternalLinks(links, content, title):
# looking at currently
#
def BuildList(lst, fs, pagePos, cList):
- content = '\n\n
\n'
+ content = '
\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 + '
\n'
# If the current page is our page, and it has children, enumerate them
if curPos == pagePos:
@@ -285,12 +345,58 @@ def BuildList(lst, fs, pagePos, cList):
elif (pagePos > curPos) and (pagePos < nextPos):
content = content + BuildList(cList[curPos], fs, pagePos, cList)
- content = content + '
\n'
+ content = content + '
\n'
+
+ return content
+
+
+#
+# Builds the sidebar for the one-page version
+#
+def BuildOnePageSidebar(fs):
+
+ content = '\n\n
\n'
+
+ content = content + '\n'
return content
+
#
# Create link sidebar given a position in the list.
#
@@ -298,8 +404,9 @@ 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] + '
'
+
+ # Make the BreadCrumbs
+ breadcrumbs = GetBreadCrumbs(fileStruct, pageNumber)
# Create the link sidebar
sidebar = CreateLinkSidebar(fileStruct, pageNumber, nodeChildren)
@@ -450,9 +582,12 @@ 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()
@@ -468,12 +603,43 @@ 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 and PDF version -----
+
# Fix up any internal links
- content = FixInternalLinks(links, content, header['title'])
+ opcontent = FixInternalLinks(oplinks, content, header['title'])
+ opcontent = reheader(opcontent, 2)
- # Add header information to the page if in dev mode
- if devmode and 'link' in header:
- content = '
link: ' + header['link'] + '\n
\n' + content
+ # Create "one page" header
+ oph = '' + header['title'] + '\n';
+
+ # Set up the actual page from the template
+ onepage = onepage.replace('{{ content }}', oph + '\n' + opcontent + '\n{{ content }}')
+
+ if pdf:
+ if not 'pdf-exclude' in header:
+ pdfpage = pdfpage.replace('{{ content }}', oph + '\n' + opcontent + '\n{{ content }}')
+ else:
+ pdfpage = pdfpage.replace('{{ content }}', oph + '\n' + 'Please refer to the online manual.\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:
@@ -486,14 +652,16 @@ 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)
# 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()
@@ -509,11 +677,48 @@ 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)
-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()
-if not quiet:
+# 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 pdf:
+ if noisy:
+ print('Generating the PDF...')
+ import logging
+ logger = logging.getLogger('weasyprint')
+ logger.addHandler(logging.StreamHandler())
+
+ # Create the PDF version of the documentation
+ pdfpage = pdfpage.replace('{% tree %}', opsidebar) # create the TOC
+ pdfpage = pdfpage.replace('{{ content }}', '') # cleans up the last spaceholder
+ pdfpage = pdfpage.replace('{{ today }}', global_today)
+ pdfpage = pdfpage.replace('src="/images/', 'src="images/') # makes images links relative
+ pdfpage = pdfpage.replace('url(\'/images/', 'url(\'images/') # CSS images links relative
+ # Write it to disk (optional, can be removed)
+ pdfpageFile = open(global_site_dir + 'pdf.html', 'w')
+ pdfpageFile.write(pdfpage)
+ pdfpageFile.close()
+
+ # Generating the actual PDF with weasyprint (https://weasyprint.org/)
+ from weasyprint import HTML
+ from weasyprint.fonts import FontConfiguration
+
+ html_font_config = FontConfiguration()
+ doc = HTML(string = pdfpage, base_url = global_site_dir)
+ doc.write_pdf(global_site_dir + 'manual.pdf', font_config = html_font_config)
+
+if noisy:
print('Processed ' + str(fileCount) + ' files.')
+