"
- for TOCENTRY in "${TOCENTRIES[@]}";do
- echo $TOCENTRY
- done \
- | awk -f ${TOC_CONFIG})
-
- # Update table of contents inside the current file being
- # processed.
- sed -i -r '/
[^<\/div].*<\/div>/c'"$(echo -e $TOC)" $FILE
-
- # Clean up variables to receive the next file.
- unset FINAL
- unset TITLE
- unset MD5SM
- unset OPTNS
- unset LEVEL
- unset PARENT
- unset TOCENTRIES
- unset LINK
-
-}
diff --git a/Scripts/Functions/Tuneup/Backends/Xhtml/xhtml_makeToc.sh b/Scripts/Functions/Tuneup/Backends/Xhtml/xhtml_makeToc.sh
new file mode 100644
index 0000000..72b065b
--- /dev/null
+++ b/Scripts/Functions/Tuneup/Backends/Xhtml/xhtml_makeToc.sh
@@ -0,0 +1,157 @@
+#!/bin/bash
+#
+# xhtml_makeToc.sh -- This functionality transforms web page headings to
+# make them accessible through a table of contents. The table of
+# contents is expanded in place, wherever the
+# piece of code be in the page. Once the
+# piece of code has be expanded, there is no need to put anything else
+# in the page.
+#
+# In order for the tuneup functionality to transform headings, you
+# need to put headings in just one line using one of the following
+# forms:
+#
+#
+#
+#
+#
+# In the example above, h1 can vary from h1 to h6. Closing tag must be
+# present and also match the openning tag. The value of `name' and
+# `href' options from the anchor element are set dynamically using the
+# md5sum output of combining the page location, the head- string and
+# the heading string.
+#
+# Copyright (C) 2009, 2010, 2011 The CentOS Artwork SIG
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or (at
+# your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+#
+# ----------------------------------------------------------------------
+# $Id$
+# ----------------------------------------------------------------------
+
+function xhtml_makeToc {
+
+ # Define variables as local to avoid conflicts outside.
+ local COUNT=0
+ local PREVCOUNT=0
+ local -a FINAL
+ local -a TITLE
+ local -a MD5SM
+ local -a OPTNS
+ local -a LEVEL
+ local -a PARENT
+ local -a TOCENTRIES
+ local -a LINK
+
+ # Define table of content configuration file, the file used to
+ # produce the table of content XHTML output code.
+ local TOC_CONFIG=${TUNEUP_BACKEND_CONFIG}/$(cli_getRepoName ${TUNEUP_BACKEND} -f)_toc.awk
+
+ # Verify table of content configuration file.
+ cli_checkFiles ${TOC_CONFIG}
+
+ # Define html heading regular expression pattern. Use parenthisis
+ # to save html action name, action value, and heading title.
+ local PATTERN="
(]>)(.*[^<])"
+
+ # Verify list of html files. Are files really html files? If they
+ # don't, continue with the next one in the list.
+ if [[ ! $(file --brief $FILE) =~ '^(XHTML|HTML|XML)' ]];then
+ continue
+ fi
+
+ # Define list of headings to process. When building the heading,
+ # it is required to change spaces characters from its current
+ # decimal output to something different (e.g., its \040 octal
+ # alternative). This is required because the space character is
+ # used as egrep default field separator and spaces can be present
+ # inside heading strings we don't want to separate.
+ for HEADING in $(egrep "$PATTERN" $FILE \
+ | sed -r -e 's!^[[:space:]]+!!' -e "s! !\\\040!g");do
+
+ # Define previous counter value using current counter
+ # value as reference.
+ if [[ $COUNT -ne 0 ]];then
+ PREVCOUNT=$(($COUNT-1))
+ fi
+
+ # Define initial heading information.
+ FIRST[$COUNT]=$(echo $HEADING | sed -r "s!\\\040! !g")
+ TITLE[$COUNT]=$(echo ${FIRST[$COUNT]} | sed -r "s!$PATTERN!\3!")
+ MD5SM[$COUNT]=$(echo "${FILE}${FIRST[$COUNT]}" | md5sum | sed -r 's![[:space:]]+-$!!')
+ OPTNS[$COUNT]=$(echo ${FIRST[$COUNT]} | sed -r "s!$PATTERN!\2!")
+ LEVEL[$COUNT]=$(echo ${FIRST[$COUNT]} | sed -r "s!$PATTERN!\1!")
+ PARENT[$COUNT]=${LEVEL[$PREVCOUNT]}
+
+ # Transform heading information using initial heading
+ # information as reference.
+ if [[ ${OPTNS[$COUNT]} =~ '^$' ]];then
+ OPTNS[$COUNT]=''
+ elif [[ ${OPTNS[$COUNT]} =~ '^$' ]];then
+ OPTNS[$COUNT]=''
+ elif [[ ${OPTNS[$COUNT]} =~ '^$' ]];then
+ OPTNS[$COUNT]=''
+ fi
+
+ # Build final html heading structure.
+ FINAL[$COUNT]=''${OPTNS[$COUNT]}${TITLE[$COUNT]}''
+
+ # Build html heading link structure. These links are used by
+ # the table of contents later.
+ LINK[$COUNT]=''${TITLE[$COUNT]}''
+
+ # Build table of contents entry with numerical
+ # identifications. The numerical identification is what we use
+ # to determine the correct position of each heading link on
+ # the table of content.
+ TOCENTRIES[$COUNT]="$COUNT:${LEVEL[$COUNT]}:${PARENT[$COUNT]}:${LINK[$COUNT]}"
+
+ # Update heading information inside the current file being
+ # processed. Use the first and final heading information.
+ sed -i -r "s!${FIRST[$COUNT]}!${FINAL[$COUNT]}!" $FILE
+
+ # Increase heading counter.
+ COUNT=$(($COUNT + 1))
+
+ done
+
+ # Build the table of contents using heading numerical
+ # identifications as reference. The numerical identification
+ # describes the order of headings in one xhtml file. This
+ # information is processed by awk to make the appropriate
+ # replacements. Finnally, the result is stored in the TOC
+ # variable.
+ TOC=$(echo ''
+ echo "
`gettext "Table of contents"`
"
+ for TOCENTRY in "${TOCENTRIES[@]}";do
+ echo $TOCENTRY
+ done \
+ | awk -f ${TOC_CONFIG})
+
+ # Update table of contents inside the current file being
+ # processed.
+ sed -i -r '/
[^<\/div].*<\/div>/c'"$(echo -e $TOC)" $FILE
+
+ # Clean up variables to receive the next file.
+ unset FINAL
+ unset TITLE
+ unset MD5SM
+ unset OPTNS
+ unset LEVEL
+ unset PARENT
+ unset TOCENTRIES
+ unset LINK
+
+}