# finished manual/website.
#
# by James Hammons
-# (C) 2017 Underground Software
+# (C) 2020 Underground Software
#
# Contributors: Ed Ward
#
import re
import shutil
import argparse
-
+import datetime
# Global vars
global_bootstrap_path = '/bootstrap-3.3.7'
global_page_title = 'The Ardour Manual'
global_site_dir = './website/'
+global_manual_url = 'http://manual.ardour.org'
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'
+global_pdflink = '<button class="btn btn-default" type="button" onclick="window.location.href=\'/manual.pdf\'"><span class="glyphicon glyphicon-book" aria-hidden="true"></span></button>'
+from datetime import datetime
+global_today = datetime.today().strftime('%Y-%m-%d')
# This matches all *non* letter/number, ' ', '.', '-', and '_' chars
cleanString = re.compile(r'[^a-zA-Z0-9 \._-]+')
# Turn a "part" name into an int
#
def PartToLevel(s):
- level = -1
- lvl = {'part': 0, 'chapter': 1, 'subchapter': 2}
+ lvl = {'part': 0, 'chapter': 1, 'subchapter': 2, 'section': 3, 'subsection': 4 }
+
if s in lvl:
return lvl[s]
- else:
- return -1
+
+ return -1
#
#
def GetFileStructure():
fs = []
- fnames = [None]*6
+ fnames = [None] * 6
content = ''
grab = False
mf = open(global_master_doc)
#
-# Change the hierarchy of titles : h1->hn, h2->hn+1, etc... n being delta-1
+# Change the hierarchy of titles : <h1>-><hn>, <h2>-><hn+1>, so that the
+# highest hyerarchy level is maxlevel
#
-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
-
+def remapheader(txt, maxlevel):
+ maxlvl=1
+ # find the highest hierarchy level in the content
+ while maxlvl < 7 and txt.find('<h' + str(maxlvl)) == -1:
+ maxlvl += 1
+ # if there is a hierarchy, remap it so that the highest level is maxlevel
+ if maxlvl < 7:
+ for i in range(6, maxlvl-1, -1):
+ txt = txt.replace('<h' + str(i), '<h' + str(i + maxlevel - maxlvl))
+ txt = txt.replace('</h' + str(i), '</h' + str(i + maxlevel - maxlvl))
+ return txt
+
#
# Creates the BreadCrumbs
#
return linkDict
+
#
# Same as above, but create anchors (for the one-page version)
#
# looking at currently
#
def BuildList(lst, fs, pagePos, cList):
+ content = '<ul>\n'
for i in range(len(lst)):
curPos = lst[i]
active = ' class=active' if curPos == pagePos else ''
menuTitle = fs[curPos]['menu_title'] if 'menu_title' in fs[curPos] else fs[curPos]['title']
- content = content + '<li' + active + '><a href="/' + fs[curPos]['filename'] + '/">' + menuTitle + '</a></li>'
+ content = content + '\t<li' + active + '><a href="/' + fs[curPos]['filename'] + '/">' + menuTitle + '</a></li>\n'
# 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 + '\n</ul>\n'
+ content = content + '</ul>\n'
return content
#
def BuildOnePageSidebar(fs):
- content = '\n\n<ul class="toc" style="white-space:nowrap;">\n'
+ content = '\n\n<ul class="toc">\n'
lvl = 0
- levelNums = [0]*3
+ levelNums = [0] * 5
for i in range(len(fs)):
- # Handle Part/Chapter/subchapter numbering
+ # 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
+ j = j - 1
+
if len(txtlevel) > 0:
txtlevel = txtlevel[:-1] + ' - '
anchor = fs[i]['filename']
while lvl < level:
- content = content + '<ul style="white-space:nowrap;">\n'
+ content = content + '<ul class="toc">\n'
lvl = lvl + 1
+
while lvl > level:
content = content + '</ul>\n'
lvl = lvl - 1
# Build the list recursively from the top level nodes
content = BuildList(FindTopLevelNodes(fs), fs, pos, childList)
# 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)
+ 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
parser.add_argument('-v', '--verbose', action='store_true', help='Display the high-level structure of the manual')
parser.add_argument('-q', '--quiet', action='store_true', help='Suppress all output (overrides -v)')
parser.add_argument('-d', '--devmode', action='store_true', help='Add content to pages to help developers debug them')
-parser.add_argument('-n', '--nopdf', action='store_true', help='Do not automatically generate PDF from content')
+parser.add_argument('-p', '--pdf', action='store_true', help='Automatically generate PDF from content')
args = parser.parse_args()
verbose = args.verbose
-quiet = args.quiet
+noisy = not args.quiet
devmode = args.devmode
-nopdf = args.nopdf
+pdf = args.pdf
-if quiet:
+# --quiet overrides --verbose, so tell it to shut up if user did both
+if not noisy:
verbose = False
level = 0
fileCount = 0
-levelNums = [0]*3
+levelNums = [0] * 5
lastFile = ''
page = ''
onepage = ''
toc = ''
pageNumber = 0
-
-
-if not quiet and devmode:
+if noisy and devmode:
print('Devmode active: scribbling extra junk to the manual...')
if os.access(global_site_dir, os.F_OK):
- if not quiet:
+ if noisy:
print('Removing stale HTML data...')
shutil.rmtree(global_site_dir)
shutil.copytree('./source', global_site_dir)
-
# Read the template, and fix the stuff that's fixed for all pages
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)
+if pdf:
+ template = template.replace('{{page.page_pdflink}}', global_pdflink)
+else:
+ template = template.replace('{{page.page_pdflink}}', '')
-# Same as above, but for the One-page version
+
+# 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)
-if not nopdf:
+if pdf:
# Same as above, but for the PDF version
temp = open(global_pdf_template)
pdfpage = temp.read()
links = FindInternalLinks(fileStruct)
oplinks = FindInternalAnchors(fileStruct)
-if not quiet:
+if noisy:
print('Found ' + str(len(links)) + ' internal link target', end='')
print('.') if len(links) == 1 else print('s.')
-if not quiet:
+if noisy:
master = open(global_master_doc)
firstLine = master.readline().rstrip('\r\n')
master.close()
lastLevel = level
level = header['level']
- # Handle Part/Chapter/subchapter numbering
+ # Handle Part/Chapter/subchapter/section/subsection numbering
if level < 2:
levelNums[2] = 0
+
levelNums[level] = levelNums[level] + 1;
# This is totally unnecessary, but nice; besides which, you can capture
toc = toc + '\t<p class="chapter">Ch. ' + str(levelNums[level]) + ': <a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
elif level == 2:
toc = toc + '\t\t<p class="subchapter"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
-
- # Handle one-page and PDF titles...
- opl = ''
- if 'link' in header:
- opl = ' id="' + header['link'] + '"'
- else:
- opl = ' id="' + header['filename'] + '"'
- oph = '<h' + str(level+1) + ' class="clear"' + opl +'>' + header['title'] + '</h' + str(level+1) + '>\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'
# Make the 'this thing contains...' stuff
if HaveChildren(fileStruct, pageNumber):
# Fix up any internal links
opcontent = FixInternalLinks(oplinks, content, header['title'])
- opcontent = reheader(opcontent, 2)
+ opcontent = remapheader(opcontent, level+2)
+
+ # Create "one page" header
+ oph = '<h' + str(level+1) + ' class="clear" id="' + header[('link' if 'link' in header else 'filename')] +'">' + header['title'] + '</h' + str(level+1) + '>\n';
# Set up the actual page from the template
onepage = onepage.replace('{{ content }}', oph + '\n' + opcontent + '\n{{ content }}')
- if not nopdf:
- pdfpage = pdfpage.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 <a href="' + global_manual_url + '/' + header['filename'] + '/">online manual</a>.\n{{ content }}')
# ----- Normal version -----
onepageFile.write(onepage)
onepageFile.close()
-if not nopdf:
- if not quiet:
+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.close()
# Generating the actual PDF with weasyprint (https://weasyprint.org/)
- from weasyprint import HTML
- #from weasyprint.fonts import FontConfiguration
- #html_font_config = FontConfiguration()
+ from weasyprint import HTML, __version__
+ if float(__version__) < 53.0: # handle an API change
+ from weasyprint.fonts import FontConfiguration
+ else:
+ from weasyprint.text.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)
+ doc.write_pdf(global_site_dir + 'manual.pdf', font_config = html_font_config)
-if not quiet:
+if noisy:
print('Processed ' + str(fileCount) + ' files.')
projects / ardour-manual / blobdiff