X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=build.py;h=dbe5448e56bdf85a8b9c42ddd07a9a3e586e59ec;hb=1bc084d882bf5792634c5fd08c35eff78de26b02;hp=4d09afe19eb32637da05620290739c7ae848ec37;hpb=b818a4a21376b64fe83a532564f66e2ad8f560af;p=ardour-manual diff --git a/build.py b/build.py index 4d09afe..dbe5448 100755 --- a/build.py +++ b/build.py @@ -22,7 +22,8 @@ import argparse # 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'"@@[^#"]*[#"]') +githuburl = 'https://github.com/Ardour/manual/edit/master/include/' # # Create an all lowercase filename without special characters and with spaces @@ -256,14 +257,30 @@ 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): @@ -321,19 +338,73 @@ def BuildList(lst, fs, pagePos, cList): 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. # def CreateLinkSidebar(fs, pos, childList): # Build the list recursively from the top level nodes + #content = BuildList(FindTopLevelNodes(fs), fs, pos, childList) 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... + content = content[:7] + '
Table of Contents
\n' + content[7:] return content - # Preliminaries # We have command line arguments now, so deal with them @@ -354,6 +425,7 @@ fileCount = 0 levelNums = [0]*6 lastFile = '' page = '' +onepage = '' toc = '' pageNumber = 0 @@ -379,6 +451,13 @@ temp.close() template = template.replace('{{page.bootstrap_path}}', '/bootstrap-3.3.7') template = template.replace('{{page.page_title}}', 'The Ardour Manual') +# Same as above, but for the One-page version +temp = open('onepage-template.txt') +onepage = temp.read() +temp.close() + +onepage = onepage.replace('{{page.bootstrap_path}}', '/bootstrap-3.3.7') +onepage = onepage.replace('{{page.page_title}}', 'The Ardour Manual') # Parse out the master docuemnt's structure into a dictionary list fileStruct = GetFileStructure() @@ -388,6 +467,7 @@ nodeChildren = FindChildren(fileStruct) # Create a dictionary for translation of internal links to real links links = FindInternalLinks(fileStruct) +oplinks = FindInternalAnchors(fileStruct) if not quiet: print('Found ' + str(len(links)) + ' internal link target', end='') @@ -418,10 +498,15 @@ for header in fileStruct: # Handle Part/Chapter/subchapter/section/subsection numbering if level == 0: levelNums[2] = 0 + levelNums[3] = 0 + levelNums[4] = 0 elif level == 1: levelNums[2] = 0 + levelNums[3] = 0 + levelNums[4] = 0 elif level == 2: levelNums[3] = 0 + levelNums[4] = 0 elif level == 3: levelNums[4] = 0 @@ -440,17 +525,32 @@ for header in fileStruct: print(header['title']) - # Handle TOC scriblings... + # Handle TOC scriblings and one-page titles... + opl = '' + + if 'link' in header: + opl = ' id="' + header['link'] + '"' + else: + opl = ' id="' + header['filename'] + '"' + if level == 0: toc = toc + '

Part ' + num2roman(levelNums[level]) + ': ' + header['title'] + '

\n'; + oph = '

Part ' + num2roman(levelNums[level]) + ' - ' + header['title'] + '

\n'; elif level == 1: - toc = toc + '

Ch. ' + str(levelNums[level]) + ':  ' + header['title'] + '

\n' + toc = toc + '\t

Ch. ' + str(levelNums[level]) + ':  ' + header['title'] + '

\n' + oph = '

' + str(levelNums[level]) + ' - ' + header['title'] + '

\n'; elif level == 2: - toc = toc + '

' + header['title'] + '

\n' + toc = toc + '\t\t

' + header['title'] + '

\n' + oph = '

' + str(levelNums[level-1]) + '.' + str(levelNums[level]) + ' - ' + header['title'] + '

\n'; elif level == 3: - toc = toc + '

' + header['title'] + '

\n' + toc = toc + '\t\t\t

' + header['title'] + '

\n' + oph = '

' + str(levelNums[level-2]) + '.' + str(levelNums[level-1]) + '.' + str(levelNums[level]) + ' - ' + header['title'] + '

\n'; elif level == 4: - toc = toc + '

' + header['title'] + '

\n' + toc = toc + '\t\t\t\t

' + header['title'] + '

\n' + oph = '

' + str(levelNums[level-3]) + '.' + str(levelNums[level-2]) + '.' + str(levelNums[level-1]) + '.' + str(levelNums[level]) + ' - ' + header['title'] + '

\n'; + + + # Make the 'this thing contains...' stuff if HaveChildren(fileStruct, pageNumber): @@ -463,23 +563,23 @@ for header in fileStruct: parent = GetParent(fileStruct, pageNumber) - # Make the 'Previous' & 'Next' content + # Make the 'Previous', 'Up' & 'Next' content nLink = '' pLink = '' uLink = '' if pageNumber > 0: - pLink = '
    • ' + pLink = '' if pageNumber < len(fileStruct) - 1: - nLink = '
    • ' + nLink = '' if level > 0: uLink = '
  • ↑ Up
    • ' else: uLink = '
  • ↑ Up
    • ' - prevnext = '' + prevnext = '' # Make the BreadCrumbs breadcrumbs = GetBreadCrumbs(fileStruct, pageNumber) @@ -491,9 +591,11 @@ 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 = 'Edit on GitHub' content = srcFile.read() srcFile.close() @@ -509,9 +611,6 @@ for header in fileStruct: else: content = '[something went wrong]' - # Fix up any internal links - content = FixInternalLinks(links, content, header['title']) - # Add header information to the page if in dev mode if devmode: devnote ='' + content + # ----- One page version ----- + + # Fix up any internal links + opcontent = FixInternalLinks(oplinks, content, header['title']) + + # Create the link sidebar + opsidebar = BuildOnePageSidebar(fileStruct) + + # Set up the actual page from the template + onepage = onepage.replace('{% tree %}', opsidebar) + onepage = onepage.replace('{{ content }}', oph + '\n' + opcontent + '{{ 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: page = re.sub("{% if page.style %}.*\n.*\n{% endif %}.*\n", "", template) @@ -534,6 +650,7 @@ 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) @@ -558,6 +675,7 @@ 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) @@ -565,5 +683,12 @@ tocFile = open(siteDir + 'toc/index.html', 'w') tocFile.write(page) tocFile.close() +# Create the one-page version of the documentation +onepageFile = open(siteDir + 'ardourmanual.html', 'w') +onepage = onepage.replace('{{ content }}', '') # cleans up the last spaceholder +onepageFile.write(onepage) +onepageFile.close() + + if not quiet: print('Processed ' + str(fileCount) + ' files.')