diff options
1 files changed, 48 insertions, 0 deletions
| -rw-r--r-- | generate-hooks/create-file-lists.awk | 48 |
diff --git a/generate-hooks/create-file-lists.awk b/generate-hooks/create-file-lists.awk index c94ad71..4a0f2f6 100644 --- a/generate-hooks/create-file-lists.awk +++ b/generate-hooks/create-file-lists.awk @@ -1,3 +1,51 @@ +# 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(/&&nos/, "<table class=\"file-list\"><tr>") gsub(/^<p>&&fos$/, "<details class=\"file-wrapper\"><summary>") |