diff options
[awk-edits] Updated documentation of multiple scripts
1 files changed, 7 insertions, 4 deletions
| -rw-r--r-- | awk-edits/Group-contents.awk | 11 |
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 |