Summary Files Commits Branches @commit @diff @stats
path: root / generate-hooks / create-file-lists.awk
blob: 4a0f2f6ed86ee2a80625cc7c374e7baf596c758d (plain) (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
# This is a really rudementary way to make making file lists less HTML-y
# I made it so:
# 1) You don't have to write quite as much HTML
# 2) The Data columns for each file get to be formatted as Markdown (<td> is not recognized as a block-level element, so the stuff inside get formatted https://kristaps.bsd.lv/lowdown/lowdown.5.html#HTML_Blocks)

# Very roughly, each file list has either this:
# <details><summary>Folder Info</summary> <table> <tr>File Data</tr> </table> </details>
# or this:
# <table> <tr>File Data</tr> </table>
# structure, the difference being that in the first, all of the files are in a folder.

# In Markdown you type in something like (without the "# " in front):
#
# &&fos
# Description
# &&fs0
# <td>Data 1</td>
# <td>Data 1.1</td>
# <td>Data 1.2</td>
# &&fs
# <td>Data 2</td>
# <td>Data 2.1</td>
# <td>Data 2.2</td>
# &&fod
#
# or
#
# &&nos
# <td>Data 1</td>
# <td>Data 1.1</td>
# <td>Data 1.2</td>
# &&fs
# <td>Data 2</td>
# <td>Data 2.1</td>
# <td>Data 2.2</td>
# &&nod

#
# And the lines starting with && (I'll call them ftags) get replaced by some HTML. The <td></td> around each file Data is mandatory.
# &&fs0 must only be used on before the very first file data, when files are in a folder. There must be no empty lines, lines mustn't start with spaces, there mustn't be anything around ftags and ftags have to be on their own lines.
# The commands have fairly intuitive abbreviations:
# &&nos    no folder start (start file list, without making a folder)
# &&fos    folder start
# &&fs0    file start of first file in folder (must only be used when items are in a folder!)
# &&fs     file start
# &&nod    no folder end (end file list, without having made a folder)
# &&fod    folder end

{
	gsub(/&#38;&#38;nos/, "<table class=\"file-list\"><tr>")
	gsub(/^<p>&#38;&#38;fos$/, "<details class=\"file-wrapper\"><summary>")
	gsub(/^&#38;&#38;fs0$/, "</summary><table class=\"file-list\"><tr>")
	gsub(/^&#38;&#38;fs$/, "</tr><tr>")
	gsub(/^&#38;&#38;nod<\/p>$/, "</tr></table>")
	gsub(/^&#38;&#38;fod<\/p>$/, "</tr></table></details>")
	print
}