]> Shamusworld >> Repos - ardour-manual/blob - build.py
More CSS simplification, hopefully no visual change. Made the left bar active title...
[ardour-manual] / build.py
1 #!/usr/bin/python3
2 #
3 # Script to take the master document and ancillary files and create the
4 # finished manual/website.
5 #
6 # by James Hammons
7 # (C) 2017 Underground Software
8 #
9
10 # Remnants (could go into the master document as the first header)
11
12 #bootstrap_path: /bootstrap-3.3.7
13 #page_title: The Ardour Manual
14
15 import os
16 import re
17 import shutil
18 import argparse
19
20
21 # Global vars
22 # This matches all *non* letter/number, ' ', '.', '-', and '_' chars
23 cleanString = re.compile(r'[^a-zA-Z0-9 \._-]+')
24 # This matches new 'unbreakable' links, up to the closing quote or anchor
25 findLinks = re.compile(r'"@@[^#"]*[#"]')
26 githuburl = 'https://github.com/Ardour/manual/edit/master/include/'
27
28 #
29 # Create an all lowercase filename without special characters and with spaces
30 # replaced with dashes.
31 #
32 def MakeFilename(s):
33         global cleanString
34         # Clean up the file name, removing all non letter/number or " .-_" chars.
35         # Also, convert to lower case and replace all spaces with dashes.
36         fn = cleanString.sub('', s).lower().replace(' ', '-')
37         # Double dashes can creep in from the above replacement, so we check for
38         # that here.
39         fn = fn.replace('--', '-')
40
41         return fn
42
43
44 #
45 # Parse headers into a dictionary
46 #
47 def ParseHeader(fileObj):
48         header = {}
49
50         while (True):
51                 hdrLine = fileObj.readline().rstrip('\r\n')
52
53                 # Break out of the loop if we hit the end of header marker
54                 if hdrLine.startswith('---'):
55                         break
56
57                 # Check to see that we have a well-formed header construct
58                 match = re.findall(': ', hdrLine)
59
60                 if match:
61                         # Parse out foo: bar pairs & put into header dictionary
62                         a = re.split(': ', hdrLine, 1)
63                         header[a[0]] = a[1]
64
65         return header
66
67
68 #
69 # Turn a "part" name into an int
70 #
71 def PartToLevel(s):
72         level = -1
73
74         if s == 'part':
75                 level = 0
76         elif s == 'chapter':
77                 level = 1
78         elif s == 'subchapter':
79                 level = 2
80         elif s == 'section':
81                 level = 3
82         elif s == 'subsection':
83                 level = 4
84
85         return level
86
87 #
88 # Converts a integer to a roman number
89 #
90 def num2roman(num):
91         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')]
92         roman = ''
93
94         while num > 0:
95                 for i, r in num_map:
96                         while num >= i:
97                                 roman += r
98                                 num -= i
99
100         return roman
101
102 #
103 # Capture the master document's structure (and content, if any) in a list
104 #
105 def GetFileStructure():
106         fs = []
107         fnames = [None]*6
108         content = ''
109         grab = False
110         mf = open('master-doc.txt')
111
112         for ln in mf:
113                 if ln.startswith('---'):
114                         # First, stuff any content that we may have read into the current
115                         # header's dictionary
116                         if grab:
117                                 fs[-1]['content'] = content
118                                 grab = False
119                                 content = ''
120
121                         # Then, get the new header and do things to it
122                         hdr = ParseHeader(mf)
123                         level = PartToLevel(hdr['part'])
124                         hdr['level'] = level
125                         fnames[level] = MakeFilename(hdr['title'])
126
127                         # Ickyness--user specified URIs
128                         if 'uri' in hdr:
129                                 hdr['filename'] = hdr['uri']
130                         else:
131                                 fullName = ''
132
133                                 for i in range(level + 1):
134                                         fullName = fullName + fnames[i] + '/'
135
136                                 # Strip trailing '/' on filename
137                                 hdr['filename'] = fullName[:-1]
138
139                         fs.append(hdr)
140
141                         if ('include' not in hdr) and (level > 0):
142                                 grab = True
143                 else:
144                         if grab:
145                                 content = content + ln
146
147         # Catch the last file, since it would be missed above
148         if grab:
149                 fs[-1]['content'] = content
150
151         mf.close()
152         return fs
153
154
155 #
156 # Determine if a particular node has child nodes
157 #
158 def HaveChildren(fs, pos):
159         # If we're at the end of the list, there can be no children
160         if pos == len(fs) - 1:
161                 return False
162
163         # If the next node is at a lower level than the current node, we have
164         # children.
165         if fs[pos]['level'] < fs[pos + 1]['level']:
166                 return True
167
168         # Otherwise, no children at this node.
169         return False
170
171
172 #
173 # Get the children at this level, and return them in a list
174 #
175 def GetChildren(fs, pos):
176         children = []
177         pos = pos + 1
178         childLevel =  fs[pos]['level']
179
180         while fs[pos]['level'] >= childLevel:
181                 if fs[pos]['level'] == childLevel:
182                         children.append(pos)
183
184                 pos = pos + 1
185
186                 # Sanity check
187                 if pos == len(fs):
188                         break
189
190         return children
191
192
193 #
194 # Get the parent at this level
195 #
196 def GetParent(fs, pos):
197         thisLevel =  fs[pos]['level']
198         pos = pos - 1
199
200         while pos >= 0 and fs[pos]['level'] >= thisLevel:
201                 pos = pos - 1
202
203         return pos
204
205
206 #
207 # Creates the BreadCrumbs
208 #
209 def GetBreadCrumbs(fs, pos):
210         # The <span class="divider">&gt;</span> is for Bootstrap pre-3.0
211         breadcrumbs = '<li class="active">'+ fs[pos]['title'] + '</li>'
212
213         while pos >= 0:
214                 pos = GetParent(fs, pos)
215
216                 if pos >= 0:
217                         breadcrumbs='<li><a href="/' + fs[pos]['filename'] + '/">'+ fs[pos]['title'] + '</a></li>'+ breadcrumbs
218
219         breadcrumbs = '<ul class="breadcrumb"><li><a href="/toc/index.html">Home</a></li>' + breadcrumbs + '</ul>'
220         return breadcrumbs
221
222
223 #
224 # Make an array of children attached to each node in the file structure
225 # (It's a quasi-tree structure, and can be traversed as such.)
226 #
227 def FindChildren(fs):
228         childArray = []
229
230         for i in range(len(fs)):
231                 if HaveChildren(fs, i):
232                         childArray.append(GetChildren(fs, i))
233                 else:
234                         childArray.append([])
235
236         return childArray
237
238
239 #
240 # Make an array of the top level nodes in the file structure
241 #
242 def FindTopLevelNodes(fs):
243         level0 = []
244
245         for i in range(len(fs)):
246                 if fs[i]['level'] == 0:
247                         level0.append(i)
248
249         return level0
250
251
252 #
253 # Find all header links and create a dictionary out of them
254 #
255 def FindInternalLinks(fs):
256         linkDict = {}
257
258         for hdr in fs:
259                 if 'link' in hdr:
260                         linkDict['"@@' + hdr['link'] + '"'] = '"/' + hdr['filename'] + '/"'
261                         linkDict['"@@' + hdr['link'] + '#'] = '"/' + hdr['filename'] + '/index.html#'
262
263
264         return linkDict
265
266 #
267 # Same as above, but create anchors (for the one-page version)
268 #
269 def FindInternalAnchors(fs):
270         linkDict = {}
271
272         for hdr in fs:
273                 if 'link' in hdr:
274                         linkDict['"@@' + hdr['link'] + '"'] = '"#' + hdr['link'] + '"'
275                         linkDict['"@@' + hdr['link'] + '#'] = '"#' + hdr['link'] + '"'
276
277
278         return linkDict
279
280
281 #
282 # Internal links are of the form '@@link-name', which are references to the
283 # 'link:' field in the part header. We have to find all occurrences and replace
284 # them with the appropriate link.
285 #
286 def FixInternalLinks(links, content, title):
287         global findLinks
288         match = findLinks.findall(content)
289         missing = []
290
291         if len(match) > 0:
292                 for s in match:
293                         if s in links:
294                                 content = content.replace(s, links[s])
295                         else:
296                                 missing.append(s)
297
298         # Report missing link targets to the user (if any)
299         if len(missing) > 0:
300                 print('\nMissing link target' + ('s' if len(missing) > 1 else '') + ' in "' + title + '":')
301
302                 for s in missing:
303                         print('  ' + s)
304
305                 print()
306
307         return content
308
309
310 #
311 # Recursively build a list of links based on the location of the page we're
312 # looking at currently
313 #
314 def BuildList(lst, fs, pagePos, cList):
315         content = '\n\n<ul>\n'
316
317         for i in range(len(lst)):
318                 curPos = lst[i]
319                 nextPos = lst[i + 1] if i + 1 < len(lst) else len(fs)
320
321                 active = ' class=active' if curPos == pagePos else ''
322                 menuTitle = fs[curPos]['menu_title'] if 'menu_title' in fs[curPos] else fs[curPos]['title']
323                 content = content + '<li' + active + '><a href="/' + fs[curPos]['filename'] + '/">' + menuTitle + '</a></li>'
324
325                 # If the current page is our page, and it has children, enumerate them
326                 if curPos == pagePos:
327                         if len(cList[curPos]) > 0:
328                                 content = content + BuildList(cList[curPos], fs, -1, cList)
329
330                 # Otherwise, if our page lies between the current one and the next,
331                 # build a list of links from those nodes one level down.
332                 elif (pagePos > curPos) and (pagePos < nextPos):
333                         content = content + BuildList(cList[curPos], fs, pagePos, cList)
334
335         content = content + '\n</ul>\n'
336
337         return content
338
339
340 #
341 # Builds the sidebar for the one-page version
342 #
343 def BuildOnePageSidebar(fs):
344
345         content = '\n\n<ul style="white-space:nowrap;">\n'
346         lvl = 0
347         levelNums = [0]*6
348
349         for i in range(len(fs)):
350                 # Handle Part/Chapter/subchapter/section/subsection numbering
351                 level = fs[i]['level']
352                 if level == 0:
353                         levelNums[2] = 0
354                         levelNums[3] = 0
355                         levelNums[4] = 0
356                 elif level == 1:
357                         levelNums[2] = 0
358                         levelNums[3] = 0
359                         levelNums[4] = 0
360                 elif level == 2:
361                         levelNums[3] = 0
362                         levelNums[4] = 0
363                 elif level == 3:
364                         levelNums[4] = 0
365                 levelNums[level] = levelNums[level] + 1;
366                 j = level
367                 txtlevel = ''
368                 while j > 0:  #level 0 is the part number which is not shown
369                         txtlevel = str(levelNums[j]) + '.' + txtlevel
370                         j = j-1
371                 if len(txtlevel) > 0:
372                         txtlevel = txtlevel[:-1] + ' - '
373
374                 if 'link' in fs[i]:
375                         anchor = fs[i]['link']
376                 else:
377                         anchor = fs[i]['filename']
378
379                 while lvl < level:
380                         content = content + '<ul style="white-space:nowrap;">\n'
381                         lvl = lvl + 1
382                 while lvl > level:
383                         content = content + '</ul>\n'
384                         lvl = lvl - 1
385
386                 content = content + '<li><a href="#' + anchor + '">' + txtlevel + fs[i]['title'] + '</a></li>\n'
387
388         content = content + '</ul>\n'
389
390         return content
391
392
393 #
394 # Create link sidebar given a position in the list.
395 #
396 def CreateLinkSidebar(fs, pos, childList):
397
398         # Build the list recursively from the top level nodes
399         content = BuildList(FindTopLevelNodes(fs), fs, pos, childList)
400         # Shove the TOC link and one file link at the top...
401         active = ' class=active' if pos<0 else ''
402         content = content.replace('<ul>','<ul><li' + active + '><a href="/toc/">Table of Contents</a></li>\n',1)
403
404         return content
405
406 # Preliminaries
407
408 # We have command line arguments now, so deal with them
409 parser = argparse.ArgumentParser(description='A build script for the Ardour Manual')
410 parser.add_argument('-v', '--verbose', action='store_true', help='Display the high-level structure of the manual')
411 parser.add_argument('-q', '--quiet', action='store_true', help='Suppress all output (overrides -v)')
412 parser.add_argument('-d', '--devmode', action='store_true', help='Add content to pages to help developers debug them')
413 args = parser.parse_args()
414 verbose = args.verbose
415 quiet = args.quiet
416 devmode = args.devmode
417
418 if quiet:
419         verbose = False
420
421 level = 0
422 fileCount = 0
423 levelNums = [0]*6
424 lastFile = ''
425 page = ''
426 onepage = ''
427 toc = ''
428 pageNumber = 0
429
430 siteDir = './website/'
431
432 if not quiet and devmode:
433         print('Devmode active: scribbling extra junk to the manual...')
434
435 if os.access(siteDir, os.F_OK):
436         if not quiet:
437                 print('Removing stale HTML data...')
438
439         shutil.rmtree(siteDir)
440
441 shutil.copytree('./source', siteDir)
442
443
444 # Read the template, and fix the stuff that's fixed for all pages
445 temp = open('page-template.txt')
446 template = temp.read()
447 temp.close()
448
449 template = template.replace('{{page.bootstrap_path}}', '/bootstrap-3.3.7')
450 template = template.replace('{{page.page_title}}', 'The Ardour Manual')
451
452 # Same as above, but for the One-page version
453 temp = open('onepage-template.txt')
454 onepage = temp.read()
455 temp.close()
456
457 onepage = onepage.replace('{{page.bootstrap_path}}', '/bootstrap-3.3.7')
458 onepage = onepage.replace('{{page.page_title}}', 'The Ardour Manual')
459
460 # Parse out the master docuemnt's structure into a dictionary list
461 fileStruct = GetFileStructure()
462
463 # Build a quasi-tree structure listing children at level + 1 for each node
464 nodeChildren = FindChildren(fileStruct)
465
466 # Create a dictionary for translation of internal links to real links
467 links = FindInternalLinks(fileStruct)
468 oplinks = FindInternalAnchors(fileStruct)
469
470 if not quiet:
471         print('Found ' + str(len(links)) + ' internal link target', end='')
472         print('.') if len(links) == 1 else print('s.')
473
474 if not quiet:
475         master = open('master-doc.txt')
476         firstLine = master.readline().rstrip('\r\n')
477         master.close()
478
479         if firstLine == '<!-- exploded -->':
480                 print('Parsing exploded file...')
481         elif firstLine == '<!-- imploded -->':
482                 print('Parsing imploded file...')
483         else:
484                 print('Parsing unknown type...')
485
486 # Here we go!
487
488 for header in fileStruct:
489         fileCount = fileCount + 1
490         content = ''
491         more = ''
492
493         lastLevel = level
494         level = header['level']
495
496         # Handle Part/Chapter/subchapter/section/subsection numbering
497         if level == 0:
498                 levelNums[2] = 0
499                 levelNums[3] = 0
500                 levelNums[4] = 0
501         elif level == 1:
502                 levelNums[2] = 0
503                 levelNums[3] = 0
504                 levelNums[4] = 0
505         elif level == 2:
506                 levelNums[3] = 0
507                 levelNums[4] = 0
508         elif level == 3:
509                 levelNums[4] = 0
510
511         levelNums[level] = levelNums[level] + 1;
512
513         # This is totally unnecessary, but nice; besides which, you can capture
514         # the output to a file to look at later if you like :-)
515         if verbose:
516                 for i in range(level):
517                         print('\t', end='')
518
519                 if (level == 0):
520                         print('\nPart ' + num2roman(levelNums[0]) + ': ', end='')
521                 elif (level == 1):
522                         print('\n\tChapter ' + str(levelNums[1]) + ': ', end='')
523
524                 print(header['title'])
525
526         # Handle TOC scriblings and one-page titles...
527         opl = ''
528
529         if 'link' in header:
530                 opl = ' id="' + header['link'] + '"'
531         else:
532                 opl = ' id="' + header['filename'] + '"'
533
534         if level == 0:
535                 toc = toc + '<h2>Part ' + num2roman(levelNums[level]) + ': ' + header['title'] + '</h2>\n';
536                 oph = '<h1 class="clear"' + opl +'>Part ' + num2roman(levelNums[level]) + ' - ' + header['title'] + '</h1>\n';
537         elif level == 1:
538                 toc = toc + '\t<p class="chapter">Ch. ' + str(levelNums[level]) + ':&nbsp;&nbsp;<a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
539                 oph = '<h1 class="clear"' + opl +'>' + str(levelNums[level]) + ' - ' + header['title'] + '</h1>\n';
540         elif level == 2:
541                 toc = toc + '\t\t<p class="subchapter"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
542                 oph = '<h1 class="clear"' + opl +'>' + str(levelNums[level-1]) + '.' + str(levelNums[level]) + ' - ' + header['title'] + '</h1>\n';
543         elif level == 3:
544                 toc = toc + '\t\t\t<p class="section"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
545                 oph = '<h1 class="clear"' + opl +'>' + str(levelNums[level-2]) + '.' + str(levelNums[level-1]) + '.' + str(levelNums[level]) + ' - ' + header['title'] + '</h1>\n';
546         elif level == 4:
547                 toc = toc + '\t\t\t\t<p class="subsection"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
548                 oph = '<h1 class="clear"' + opl +'>' + str(levelNums[level-3]) + '.'  + str(levelNums[level-2]) + '.'  + str(levelNums[level-1]) + '.' + str(levelNums[level]) + ' - ' + header['title'] + '</h1>\n';
549
550
551
552
553         # Make the 'this thing contains...' stuff
554         if HaveChildren(fileStruct, pageNumber):
555                 pages = GetChildren(fileStruct, pageNumber)
556
557                 for pg in pages:
558                         more = more + '<li>' + '<a href="/' + fileStruct[pg]['filename'] + '/">' + fileStruct[pg]['title'] + '</a>' + '</li>\n'
559
560                 more = '<div id=subtopics>\n' + '<h2>This section contains the following topics:</h2>\n' + '<ul>\n' + more + '</ul>\n' + '</div>\n'
561
562         parent = GetParent(fileStruct, pageNumber)
563
564         # Make the 'Previous', 'Up' & 'Next' content
565         nLink = ''
566         pLink = ''
567         uLink = ''
568
569         if pageNumber > 0:
570                 pLink = '<li class="previous"><a title="' + fileStruct[pageNumber - 1]['title'] + '" href="/' + fileStruct[pageNumber - 1]['filename'] + '/" class="previous"> &larr; Previous </a></li>'
571
572         if pageNumber < len(fileStruct) - 1:
573                 nLink = '<li class="next"><a title="' + fileStruct[pageNumber + 1]['title'] + '" href="/' + fileStruct[pageNumber + 1]['filename'] + '/" class="next"> Next &rarr; </a></li>'
574
575         if level > 0:
576                 uLink = '<li><a title="' + fileStruct[parent]['title'] + '" href="/' + fileStruct[parent]['filename'] + '/" class="active"> &uarr; Up </a></li>'
577         else:
578                 uLink = '<li><a title="Ardour Table of Contents" href="/toc/index.html" class="active"> &uarr; Up </a></li>'
579
580         prevnext = '<ul class="pager">' + pLink + uLink + nLink + '</ul>'
581
582         # Make the BreadCrumbs
583         breadcrumbs = GetBreadCrumbs(fileStruct, pageNumber)
584
585         # Create the link sidebar
586         sidebar = CreateLinkSidebar(fileStruct, pageNumber, nodeChildren)
587
588         # Parts DO NOT have any content, they are ONLY an organizing construct!
589         # Chapters, subchapters, sections & subsections can all have content,
590         # but the basic fundamental organizing unit WRT content is still the
591         # chapter.
592         githubedit = ''
593         if level > 0:
594                 if 'include' in header:
595                         srcFile = open('include/' + header['include'])
596                         githubedit = '<span style="float:right;"><a title="Edit in GitHub" href="' + githuburl + header['include'] + '"><img src="/images/github.png" alt="Edit on GitHub"/></a></span>'
597                         content = srcFile.read()
598                         srcFile.close()
599
600                         # Get rid of any extant header in the include file
601                         # (once this is accepted, we can nuke this bit, as content files
602                         # will not have any headers or footers in them)
603                         content = re.sub('---.*\n(.*\n)*---.*\n', '', content)
604                         content = content.replace('{% children %}', '')
605
606                 else:
607                         if 'content' in header:
608                                 content = header['content']
609                         else:
610                                 content = '[something went wrong]'
611
612         # Add header information to the page if in dev mode
613         if devmode:
614                 devnote ='<aside style="background-color:indigo; color:white;">'
615                 if 'filename' in header:
616                         devnote = devnote + 'filename: ' + header['filename'] + '<br>'
617                 if 'include' in header:
618                         devnote = devnote + 'include: ' + header['include'] + '<br>'
619                 if 'link' in header:
620                         devnote = devnote + 'link: ' + header['link'] + '<br>'
621                 content = devnote + '</aside>' + content
622
623         # ----- One page version -----
624
625         # Fix up any internal links
626         opcontent = FixInternalLinks(oplinks, content, header['title'])
627
628         # Create the link sidebar
629         opsidebar = BuildOnePageSidebar(fileStruct)
630
631         # Set up the actual page from the template
632         onepage = onepage.replace('{% tree %}', opsidebar)
633         onepage = onepage.replace('{{ content }}', oph + '\n' + opcontent + '{{ content }}')
634
635         # ----- Normal version -----
636
637         # Fix up any internal links
638         content = FixInternalLinks(links, content, header['title'])
639
640         # Set up the actual page from the template
641         if 'style' not in header:
642                 page = re.sub("{% if page.style %}.*\n.*\n{% endif %}.*\n", "", template)
643         else:
644                 page = template.replace('{{page.style}}', header['style'])
645                 page = page.replace('{% if page.style %}', '')
646                 page = page.replace('{% endif %}', '')
647
648         page = page.replace('{{ page.title }}', header['title'])
649         page = page.replace('{% tree %}', sidebar)
650         page = page.replace('{% prevnext %}', prevnext)
651         page = page.replace('{% githubedit %}', githubedit)
652         page = page.replace('{% breadcrumbs %}', breadcrumbs)
653         page = page.replace('{{ content }}', content + more)
654
655         # Create the directory for the index.html file to go into (we use makedirs,
656         # because we have to in order to accomodate the 'uri' keyword)
657         os.makedirs(siteDir + header['filename'], 0o775, exist_ok=True)
658
659         # Finally, write the file!
660         destFile = open(siteDir + header['filename'] + '/index.html', 'w')
661         destFile.write(page)
662         destFile.close()
663
664         # Save filename for next header...
665         lastFile = header['filename']
666         pageNumber = pageNumber + 1
667
668 # Finally, create the TOC
669 sidebar = CreateLinkSidebar(fileStruct, -1, nodeChildren)
670
671 page = re.sub("{% if page.style %}.*\n.*\n{% endif %}.*\n", "", template)
672 page = page.replace('{{ page.title }}', 'Ardour Table of Contents')
673 page = page.replace('{% tree %}', sidebar)
674 page = page.replace('{{ content }}', toc)
675 page = page.replace('{% prevnext %}', '')
676 page = page.replace('{% githubedit %}', '')
677 page = page.replace('{% breadcrumbs %}', '')
678
679 os.mkdir(siteDir + 'toc', 0o775)
680 tocFile = open(siteDir + 'toc/index.html', 'w')
681 tocFile.write(page)
682 tocFile.close()
683
684 # Create the one-page version of the documentation
685 onepageFile = open(siteDir + 'ardourmanual.html', 'w')
686 onepage = onepage.replace('{{ content }}', '') # cleans up the last spaceholder
687 onepageFile.write(onepage)
688 onepageFile.close()
689
690
691 if not quiet:
692         print('Processed ' + str(fileCount) + ' files.')