X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=build.py;h=4424f76bea483d2cfa710ec23ce64d99bca40ad8;hb=0be5223f840432647ebaf541d904887ee0d74830;hp=5d6ecfd1fe5af0666c38f3596b12c61220826555;hpb=c26b7c1f3feb0c4124335c4e7511855543956436;p=ardour-manual diff --git a/build.py b/build.py index 5d6ecfd..4424f76 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' +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'@@[^#"]*') +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('---'): @@ -189,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.) @@ -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' + + return content + + +# +# Builds the sidebar for the one-page version +# +def BuildOnePageSidebar(fs): + + content = '\n\n
    \n' + 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 + + if len(txtlevel) > 0: + txtlevel = txtlevel[:-1] + ' - ' + + if 'link' in fs[i]: + anchor = fs[i]['link'] + else: + anchor = fs[i]['filename'] + + while lvl < level: + content = content + '\n' + lvl = lvl - 1 + + content = content + '
  • ' + txtlevel + fs[i]['title'] + '
    • \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] + '
    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('