X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=build.py;h=376204959f810b72d7c5bfe126233c36b2346e01;hb=1f90d2dac9c47951e3740899649fe4aa47a7a5a6;hp=8ac84d4efb4e93859685ad7fb7f0962ebad7de26;hpb=d64781b7c2d42a735d427ead67d04b3d77b2467a;p=ardour-manual diff --git a/build.py b/build.py index 8ac84d4..3762049 100755 --- a/build.py +++ b/build.py @@ -9,7 +9,7 @@ # Remnants (could go into the master document as the first header) -#bootstrap_path: /bootstrap-2.2.2 +#bootstrap_path: /bootstrap-3.3.7 #page_title: The Ardour Manual import os @@ -18,15 +18,26 @@ import shutil import argparse +# Global vars +# 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'"@@[^#"]*[#"]') +githuburl = 'https://github.com/Ardour/manual/edit/master/include/' + # # 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 @@ -112,12 +123,19 @@ def GetFileStructure(): level = PartToLevel(hdr['part']) hdr['level'] = level fnames[level] = MakeFilename(hdr['title']) - fullName = '' - for i in range(level + 1): - fullName = fullName + fnames[i] + '/' + # Ickyness--user specified URIs + if 'uri' in hdr: + hdr['filename'] = hdr['uri'] + else: + fullName = '' + + for i in range(level + 1): + fullName = fullName + fnames[i] + '/' + + # Strip trailing '/' on filename + hdr['filename'] = fullName[:-1] - hdr['filename'] = fullName.rstrip('/') fs.append(hdr) if ('include' not in hdr) and (level > 0): @@ -172,6 +190,36 @@ 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 + + +# +# Creates the BreadCrumbs +# +def GetBreadCrumbs(fs, pos): + # The > is for Bootstrap pre-3.0 + breadcrumbs = '
  • '+ fs[pos]['title'] + '
    • ' + + 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.) @@ -209,36 +257,54 @@ 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): - - # Make key1|key2|key3|... out of our links keys - pattern = re.compile('|'.join(links.keys())) - - # Use a lambda callback to substitute each occurance found - result = pattern.sub(lambda x: links[x.group()], content) - - # Check for missing link targets, and report them to the user - match = re.findall('"@@.*"', result) + global findLinks + match = findLinks.findall(content) + missing = [] if len(match) > 0: - print('\nMissing link target' + ('s' if len(match) > 1 else '') + ' in "' + title + '":') - 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 # @@ -246,14 +312,15 @@ def FixInternalLinks(links, content, title): # looking at currently # def BuildList(lst, fs, pagePos, cList): - content = '\n\n
    \n' + content = '\n\n\n' - content = content + '
    \n' + return content + + +# +# 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. # @@ -278,36 +397,41 @@ 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('