Summary Files Commits Branches @commit @diff @stats
path: root / awk-edits / Group-contents.awk
diff options
context:
space:
mode:
Commit4ce746de613fd7d82db485c7b65a92bcc44ed12b (patch)
Author
 Syndamia <kamen@syndamia.com>
2023-01-24 12:00:53 +0200
Committer
 Syndamia <kamen@syndamia.com>
2023-01-24 12:00:53 +0200
Files2eb72f683dfbd90aec57e566a70db38f77c19338 /awk-edits/Group-contents.awk
syndamia.com-4ce746de613fd7d82db485c7b65a92bcc44ed12b.tar
syndamia.com-4ce746de613fd7d82db485c7b65a92bcc44ed12b.tar.gz
syndamia.com-4ce746de613fd7d82db485c7b65a92bcc44ed12b.zip
Parent4f82b9eb43d8ecb378940b4bb08951aa95953453 (diff)
[awk-edits] Updated documentation of multiple scripts
1 files changed, 7 insertions, 4 deletions
-rw-r--r--awk-edits/Group-contents.awk11
diff --git a/awk-edits/Group-contents.awk b/awk-edits/Group-contents.awk
index d984eef..7f930b6 100644
--- a/awk-edits/Group-contents.awk
+++ b/awk-edits/Group-contents.awk
@@ -1,9 +1,12 @@
#
# == About ==
-#
-# This script surrounds the "Contents" heading, as well as the list itself, in a div wrapper element
-# For it to work properly, the contents heading must be h2 and have it's id as "contents",
-# and there must be a paragraph element after the item list
+#
+# Some pages contain contents info, comprised of a "Contents" heading (h2) and a
+# (usually ordered) list of anchors to headings in the current page.
+# This script groups that heading and list into a wrapper element with id
+# "contents-container", which can then be handled more specifically.
+#
+# In my case, the contents appear on the right of remaining text.
BEGIN {
started = 0