X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=build.py;h=d7753fe60a31441341bce9136b075d33032dff40;hb=4d515d515eb78944a67607f4739570070fa6510a;hp=127f43f84b01cfd19a8aaebc3de76275a99c0bdc;hpb=fdf05235b45a22d8708464841162f396ea49dc86;p=ardour-manual
diff --git a/build.py b/build.py
index 127f43f..d7753fe 100755
--- a/build.py
+++ b/build.py
@@ -4,25 +4,37 @@
# 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)
-#bootstrap_path: /bootstrap-2.2.2
-#page_title: The Ardour Manual
-
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'
+global_pdflink = ''
+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 \._-]+')
# 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
@@ -68,23 +80,16 @@ def ParseHeader(fileObj):
# Turn a "part" name into an int
#
def PartToLevel(s):
- level = -1
+ lvl = {'part': 0, 'chapter': 1, 'subchapter': 2, 'section': 3, 'subsection': 4 }
+
+ if s in lvl:
+ return lvl[s]
- 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 -1
- return level
#
-# 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')]
@@ -103,10 +108,10 @@ def num2roman(num):
#
def GetFileStructure():
fs = []
- fnames = [None]*6
+ fnames = [None] * 6
content = ''
grab = False
- mf = open('master-doc.txt')
+ mf = open(global_master_doc)
for ln in mf:
if ln.startswith('---'):
@@ -188,6 +193,7 @@ def GetChildren(fs, pos):
return children
+
#
# Get the parent at this level
#
@@ -195,25 +201,45 @@ def GetParent(fs, pos):
thisLevel = fs[pos]['level']
pos = pos - 1
- while fs[pos]['level'] >= thisLevel and pos > 0:
+ while pos >= 0 and fs[pos]['level'] >= thisLevel:
pos = pos - 1
return pos
+
+#
+#Â Change the hierarchy of titles :
->,
->, so that the
+# highest hyerarchy level is maxlevel
+#
+def remapheader(txt, maxlevel):
+ maxlvl=1
+ # find the highest hierarchy level in the content
+ while maxlvl < 7 and txt.find(''
- # The > is for Bootstrap pre-3.0
- while pos:
- pos = GetParent(fs,pos)
- if pos:
- breadcrumbs=' >
'
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.)
@@ -251,14 +277,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):
@@ -290,15 +331,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:
@@ -310,12 +351,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'
+ lvl = 0
+ 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
- content = content + '
\n'
+
+ content = content + '\n'
return content
+
#
# Create link sidebar given a position in the list.
#
@@ -323,8 +410,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)
@@ -486,9 +588,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()
@@ -504,12 +609,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 = remapheader(opcontent, level+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:
@@ -522,15 +658,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()
@@ -546,12 +683,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.')
+