X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=build.py;h=4424f76bea483d2cfa710ec23ce64d99bca40ad8;hb=0be5223f840432647ebaf541d904887ee0d74830;hp=639d8ef75c3108e853ae291a4d66e49dab3ce866;hpb=2098e011e638b5c86c56e68df7757975fc4d728f;p=ardour-manual diff --git a/build.py b/build.py index 639d8ef..4424f76 100755 --- a/build.py +++ b/build.py @@ -4,29 +4,51 @@ # 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' +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 \._-]+') +# This matches new 'unbreakable' links, up to the closing quote or anchor +findLinks = re.compile(r'"@@[^#"]*[#"]') # # Create an all lowercase filename without special characters and with spaces # replaced with dashes. # def MakeFilename(s): - # Cleans up the file name, removing all non ASCII or .-_ chars - fn = re.sub(r'[^.\-_a-zA-Z0-9 ]', '', s) - fn = fn.lower() - fn = fn.replace(' ', '-') + global cleanString + # Clean up the file name, removing all non letter/number or " .-_" chars. + # Also, convert to lower case and replace all spaces with dashes. + fn = cleanString.sub('', s).lower().replace(' ', '-') + # Double dashes can creep in from the above replacement, so we check for + # that here. + fn = fn.replace('--', '-') + return fn @@ -58,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')] @@ -93,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('---'): @@ -122,7 +137,8 @@ def GetFileStructure(): for i in range(level + 1): fullName = fullName + fnames[i] + '/' - hdr['filename'] = fullName.rstrip('/') + # Strip trailing '/' on filename + hdr['filename'] = fullName[:-1] fs.append(hdr) @@ -178,6 +194,46 @@ def GetChildren(fs, pos): return children +# +# Get the parent at this level +# +def GetParent(fs, pos): + thisLevel = fs[pos]['level'] + pos = pos - 1 + + while pos >= 0 and fs[pos]['level'] >= thisLevel: + pos = pos - 1 + + 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('' + + while pos >= 0: + pos = GetParent(fs, pos) + + if pos >= 0: + breadcrumbs='
  • '+ fs[pos]['title'] + '
    • '+ breadcrumbs + + 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.) @@ -215,36 +271,53 @@ 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 # -# 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 -# them with the appropriate link. +# Same as above, but create anchors (for the one-page version) # -def FixInternalLinks(links, content, title): +def FindInternalAnchors(fs): + linkDict = {} - # Make key1|key2|key3|... out of our links keys - pattern = re.compile('|'.join(links.keys())) + for hdr in fs: + if 'link' in hdr: + linkDict['"@@' + hdr['link'] + '"'] = '"#' + hdr['link'] + '"' + linkDict['"@@' + hdr['link'] + '#'] = '"#' + hdr['link'] + '"' - # Use a lambda callback to substitute each occurance found - result = pattern.sub(lambda x: links[x.group()], content) + return linkDict - # Check for missing link targets, and report them to the user - match = re.findall('"@@.*"', result) - if len(match) > 0: - print('\nMissing link target' + ('s' if len(match) > 1 else '') + ' in "' + title + '":') +# +# Internal links are of the form '@@link-name', which are references to the +# 'link:' field in the part header. We have to find all occurrences and replace +# them with the appropriate link. +# +def FixInternalLinks(links, content, title): + global findLinks + match = findLinks.findall(content) + missing = [] + if len(match) > 0: for s in match: - print(' ' + s[3:-1]) + if s in links: + content = content.replace(s, links[s]) + else: + missing.append(s) + + # Report missing link targets to the user (if any) + if len(missing) > 0: + print('\nMissing link target' + ('s' if len(missing) > 1 else '') + ' in "' + title + '":') + + for s in missing: + print(' ' + s) print() - return result + return content # @@ -252,14 +325,15 @@ def FixInternalLinks(links, content, title): # looking at currently # def BuildList(lst, fs, pagePos, cList): - content = '\n\n
    \n' + content = '\n' + + return content - content = content + '
    \n' + +# +# Builds the sidebar for the one-page version +# +def BuildOnePageSidebar(fs): + + content = '\n\n\n' return content + # # Create link sidebar given a position in the list. # @@ -284,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] + '
    Table of Contents
    \n' + content[7:] + # Shove the TOC link and one file link at the top... + active = ' class=active' if pos < 0 else '' + content = content.replace('