X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=build.py;h=4424f76bea483d2cfa710ec23ce64d99bca40ad8;hb=73b9d463348d3319e3e8b1f682d6d69dd8287490;hp=2345dbceb9c6e299aea61fdbea3d775e292659e1;hpb=74d200e341210baad9cc82dd974253c355fbc56e;p=ardour-manual

diff --git a/build.py b/build.py
index 2345dbc..4424f76 100755
--- a/build.py
+++ b/build.py
@@ -4,7 +4,9 @@
 # finished manual/website.
 #
 # by James Hammons
-# (C) 2017 Underground Software
+# (C) 2020 Underground Software
+#
+# Contributors: Ed Ward
 #
 
 # Remnants (could go into the master document as the first header)
@@ -13,17 +15,21 @@ import os
 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'
+from datetime import datetime
+global_today_iso = datetime.today().strftime('%Y-%m-%dT%H%M%S')
+global_today = datetime.today().strftime('%Y-%m-%d')
 
 # This matches all *non* letter/number, ' ', '.', '-', and '_' chars
 cleanString = re.compile(r'[^a-zA-Z0-9 \._-]+')
@@ -74,16 +80,16 @@ def ParseHeader(fileObj):
 # 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
 
 
 #
-# Converts a integer to a roman number
+# Converts a integer to a Roman numeral
 #
 def num2roman(num):
 	num_map = [(1000, 'M'), (900, 'CM'), (500, 'D'), (400, 'CD'), (100, 'C'), (90, 'XC'), (50, 'L'), (40, 'XL'), (10, 'X'), (9, 'IX'), (5, 'V'), (4, 'IV'), (1, 'I')]
@@ -102,7 +108,7 @@ def num2roman(num):
 #
 def GetFileStructure():
 	fs = []
-	fnames = [None]*6
+	fnames = [None] * 6
 	content = ''
 	grab = False
 	mf = open(global_master_doc)
@@ -200,15 +206,18 @@ def GetParent(fs, pos):
 
 	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))
+		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
 #
@@ -265,9 +274,9 @@ def FindInternalLinks(fs):
 			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)
 #
@@ -279,7 +288,6 @@ def FindInternalAnchors(fs):
 			linkDict['"@@' + hdr['link'] + '"'] = '"#' + hdr['link'] + '"'
 			linkDict['"@@' + hdr['link'] + '#'] = '"#' + hdr['link'] + '"'
 
-
 	return linkDict
 
 
@@ -317,7 +325,7 @@ def FixInternalLinks(links, content, title):
 # looking at currently
 #
 def BuildList(lst, fs, pagePos, cList):
-	content = '\n\n<ul>\n'
+	content = '<ul>\n'
 
 	for i in range(len(lst)):
 		curPos = lst[i]
@@ -325,7 +333,7 @@ def BuildList(lst, fs, pagePos, cList):
 
 		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:
@@ -337,7 +345,7 @@ def BuildList(lst, fs, pagePos, cList):
 		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
 
@@ -347,21 +355,25 @@ def BuildList(lst, fs, pagePos, cList):
 #
 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/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] + ' - '
 
@@ -371,8 +383,9 @@ def BuildOnePageSidebar(fs):
 			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
@@ -392,11 +405,12 @@ 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 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
@@ -404,17 +418,20 @@ parser = argparse.ArgumentParser(description='A build script for the Ardour Manu
 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('-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
+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 = ''
@@ -422,20 +439,17 @@ pdfpage = ''
 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()
@@ -443,18 +457,19 @@ temp.close()
 template = template.replace('{{page.bootstrap_path}}', global_bootstrap_path)
 template = template.replace('{{page.page_title}}', global_page_title)
 
-# 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)
 
-# 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)
+if pdf:
+	# 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 document's structure into a dictionary list
 fileStruct = GetFileStructure()
@@ -466,11 +481,11 @@ nodeChildren = FindChildren(fileStruct)
 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()
@@ -492,9 +507,10 @@ for header in fileStruct:
 	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
@@ -510,22 +526,17 @@ for header in fileStruct:
 
 		print(header['title'])
 
-	# Handle TOC scriblings and one-page titles...
-	opl = ''
-	if 'link' in header:
-		opl = ' id="' + header['link'] + '"'
-	else:
-		opl = ' id="' + header['filename'] + '"'
-
+	# Handle TOC scriblings...
 	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 + '\t<p class="chapter">Ch. ' + str(levelNums[level]) + ':&nbsp;&nbsp;<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 + '\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';
+	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):
@@ -567,6 +578,7 @@ for header in fileStruct:
 	# 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'])
@@ -589,12 +601,16 @@ for header in fileStruct:
 	# Add header information to the page if in dev mode
 	if devmode:
 		devnote ='<aside style="background-color:indigo; color:white;">'
+
 		if 'filename' in header:
 			devnote = devnote + 'filename: ' + header['filename'] + '<br>'
+
 		if 'include' in header:
 			devnote = devnote + 'include: ' + header['include'] + '<br>'
+
 		if 'link' in header:
 			devnote = devnote + 'link: ' + header['link'] + '<br>'
+
 		content = devnote + '</aside>' + content
 
 	# ----- One page and PDF version -----
@@ -603,9 +619,17 @@ for header in fileStruct:
 	opcontent = FixInternalLinks(oplinks, content, header['title'])
 	opcontent = reheader(opcontent, 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 }}')
-	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 -----
 
@@ -664,18 +688,29 @@ 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:
+if pdf:
+	if noisy:
+		print('Generating the PDF...')
+
+	# 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('{{ today_iso }}', global_today_iso)
+	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.')
+