diff --git a/build.py b/build.py index 50ff861..2e3a243 100755 --- a/build.py +++ b/build.py @@ -260,6 +260,21 @@ def FindInternalLinks(fs): 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 @@ -323,19 +338,47 @@ 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 @@ -356,6 +399,7 @@ fileCount = 0 levelNums = [0]*6 lastFile = '' page = '' +onepage = '' toc = '' pageNumber = 0 @@ -381,6 +425,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() @@ -390,6 +441,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='') @@ -442,17 +494,31 @@ 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' + oph = 'Chapter ' + str(levelNums[level]) + ': ' + header['title'] + '\n'; elif level == 2: toc = toc + '

' + header['title'] + '

\n' + oph = 'Subchapter ' + str(levelNums[level]) + ': ' + header['title'] + '\n'; elif level == 3: toc = toc + '

' + header['title'] + '

\n' + oph = 'Section ' + str(levelNums[level]) + ': ' + header['title'] + '\n'; elif level == 4: toc = toc + '

' + header['title'] + '

\n' + oph = 'Subsection ' + str(levelNums[level]) + ': ' + header['title'] + '\n'; + + + # Make the 'this thing contains...' stuff if HaveChildren(fileStruct, pageNumber): @@ -513,9 +579,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) @@ -571,5 +651,11 @@ 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') +onepageFile.write(onepage) +onepageFile.close() + + if not quiet: print('Processed ' + str(fileCount) + ' files.') diff --git a/page-template.txt b/page-template.txt index f6f0fa2..29133f9 100644 --- a/page-template.txt +++ b/page-template.txt @@ -25,6 +25,7 @@ +