git @ Cat's Eye Technologies The-Dossier / master script / make-toc.py
master

Tree @master (Download .tar.gz)

make-toc.py @master — raw · history · blame 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
#!/usr/bin/env python3


import json
import re
import subprocess
import sys
from urllib.parse import quote


def generate_toc_line(document):
    title = document['title']
    filename = quote(document['filename'])
    sections = document.get('sections', [])
    properties = document.get('properties', {})

    signs = []
    section_count = len(sections)
    if title not in (
        "Retrospective on Language Design",
        "Programming Languages as an Artistic Medium",
        "The Aesthetics of Esolangs",
        "A Basic Theory of Video Games",
        "Perspective on Text Adventures",
        "Blurry Memories of DOS Programming",
        "Befunge Silver Jubilee Retrospective",
        "Some Notes on Drawing",
        "Some Notes on Proving Programs Correct",
    ):
        signs.append('({})'.format(section_count))

    if properties.get('status') == 'under construction':
        signs.append('*(U)*')

    if properties.get('publication-date'):
        pubdate = properties['publication-date']
        match = re.search(r'(\w+\s+\d\d\d\d)', pubdate)
        if match:
            pubdate = match.group(1)
        signs.append('({})'.format(pubdate))

    return '*   [{}]({}) {}\n'.format(title, filename, ' '.join(signs))


def output_toc(heading, filenames):
    sys.stdout.write('{}\n\n'.format(heading))
    filenames = ['article/' + filename for filename in filenames]
    data = json.loads(
        subprocess.check_output(["feedmark", "--output-json"] + filenames)
    )
    for document in data['documents']:
        line = generate_toc_line(document)
        sys.stdout.write(line)
    sys.stdout.write('\n')


if __name__ == '__main__':
    output_toc('### Programming Languages and Programming', [
        "Retrospective on Language Design.md",
        "Programming Languages as an Artistic Medium.md",
        "The Aesthetics of Esolangs.md",
        "An Esolang Reading List.md",
        "Some Production Programming Languages.md",
        "Blurry Memories of DOS Programming.md",
        "Befunge Silver Jubilee Retrospective.md",
        "Some Notes on Proving Programs Correct.md",
    ])
    output_toc('### Games', [
        "A Basic Theory of Video Games.md",
        "Perspective on Text Adventures.md",
    ])
    output_toc('#### Games of Note', [
        "Video Games of Note.md",
        "Commodore 64 Games of Note.md",
        "Apple II Games of Note.md",
        "Atari 2600 Games of Note.md",
        "Computer Sports Games of Note.md",
        "Computer Games of Note.md",
        "Role-Playing Games of Note.md",
        "Text Adventures of Note.md",
        "Classic Computer Games.md",
        "Classic Text Adventures.md",
        "Lost Games.md",
        "Recollected Games.md",
        "Some Modern Retrogames.md",
    ])
    output_toc('### Art', [
        "20th-Century Visual Artists of Note.md",
        "Some Notes on Drawing.md",
    ])