Summary Files Commits Branches @commit @diff @stats
diff options
context:
space:
mode:
Commit44c24c520dcab5ec3448bd7d041aed729779434c (patch)
Author
 Syndamia <kamen@syndamia.com>
2022-07-17 16:09:29 +0300
Committer
 Syndamia <kamen@syndamia.com>
2022-07-17 16:09:29 +0300
Files565d25183e28452bfdd6005ccc155d5a59defc21
syndamia.com-44c24c520dcab5ec3448bd7d041aed729779434c.tar
syndamia.com-44c24c520dcab5ec3448bd7d041aed729779434c.tar.gz
syndamia.com-44c24c520dcab5ec3448bd7d041aed729779434c.zip
Parent8bcd5b8c243c3474dcc43612a45b2d0aa1195a56 (diff)
Improved file-lists documentation
1 files changed, 6 insertions, 6 deletions
-rwxr-xr-xgenerate-hooks/make-file-lists.sh12
diff --git a/generate-hooks/make-file-lists.sh b/generate-hooks/make-file-lists.sh
index 58a5aa2..33b5e48 100755
--- a/generate-hooks/make-file-lists.sh
+++ b/generate-hooks/make-file-lists.sh
@@ -9,7 +9,7 @@
# <details><summary>Folder Info</summary> <table> <tr>File Data</tr> </table> </details>
# or this:
# <table> <tr>File Data</tr> </table>
-# structure.
+# 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):
#
@@ -39,13 +39,13 @@
#
# 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. 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 intuitive abbreviations:
-# &&nos no folder start
+# &&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
+# &&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
+# &&nod no folder end (end file list, without having made a folder)
# &&fod folder end
if [ -z "$1" ]; then