From 0ca0ad41128c0c114abba4007cb11880f8626b85 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Aug 05 2011 15:23:48 +0000 Subject: Update `help' functionality: - Rename variable from FLAG_BACKEND to MANUAL_BACKEND. --- diff --git a/Scripts/Functions/Help/Texinfo/texinfo.sh b/Scripts/Functions/Help/Texinfo/texinfo.sh index fb63c97..2c60f84 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo.sh @@ -38,7 +38,7 @@ function texinfo { # where we store locale directories (e.g., en_US, es_ES, etc.) # used to build manuals in texinfo format. MANUAL_TEMPLATE=${CLI_FUNCDIR}/${CLI_FUNCDIRNAM}/$(cli_getRepoName \ - ${FLAG_BACKEND} -d)/Templates + ${MANUAL_BACKEND} -d)/Templates # Define absolute path to language-specific template directory. # This is the place where we store locale-specific files used to @@ -67,7 +67,7 @@ function texinfo { fi # Initialize document structure for new manuals. - ${FLAG_BACKEND}_createStructure + ${MANUAL_BACKEND}_createStructure # Define documentation entry default values. To build the # documentation entry, we combine the manual's name, the chapter's @@ -83,7 +83,7 @@ function texinfo { # When chapter option is provided whith out a section name, # verify chapter's directory inside the manual, - ${FLAG_BACKEND}_createChapter + ${MANUAL_BACKEND}_createChapter # and define documentation entry based on chapter's main # definition file. @@ -94,7 +94,7 @@ function texinfo { # When both the chapter option and non-option arguments are # provided, define documentation entries based on manual, # chapter and non-option arguments. - MANUAL_ENTRY="$(${FLAG_BACKEND}_getEntry "$MANUAL_SECTION_NAME")" + MANUAL_ENTRY="$(${MANUAL_BACKEND}_getEntry "$MANUAL_SECTION_NAME")" else cli_printMessage "`gettext "The parameters you provided are not supported."`" --as-error-line @@ -113,7 +113,7 @@ function texinfo { # terminate the script execution once the reading is done. # Update manual's output files. - ${FLAG_BACKEND}_updateOutputFiles + ${MANUAL_BACKEND}_updateOutputFiles # Read manual's Top node from info output file. info --node="Top" --file=${MANUAL_BASEFILE}.info.bz2 @@ -127,7 +127,7 @@ function texinfo { # arguments passed to `centos-art.sh' script in a special way. # In this configuration, only two non-option arguments are # processed in the first loop of their interpretation. - ${FLAG_BACKEND}_${ACTIONNAM} + ${MANUAL_BACKEND}_${ACTIONNAM} # Break interpretation of non-option arguments, to prevent the # second and further non-option arguments from being @@ -145,7 +145,7 @@ function texinfo { # flow) nor commit any change form working copy to central # repository (e.g., output files are not under version # control). - ${FLAG_BACKEND}_${ACTIONNAM} + ${MANUAL_BACKEND}_${ACTIONNAM} # Terminate script execution right here. Actions realized in # this configuration doesn't need to update manual output @@ -157,7 +157,7 @@ function texinfo { # Execute action names that follow help's execution flow as it # is, without any modification. - ${FLAG_BACKEND}_${ACTIONNAM} + ${MANUAL_BACKEND}_${ACTIONNAM} fi diff --git a/Scripts/Functions/Help/Texinfo/texinfo_copyEntry.sh b/Scripts/Functions/Help/Texinfo/texinfo_copyEntry.sh index a77b721..5f52d69 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_copyEntry.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_copyEntry.sh @@ -39,7 +39,7 @@ function texinfo_copyEntry { # In this configuration, the section name is specified in # first non-option argument and optionally in the second # non-option arugment. - ${FLAG_BACKEND}_copyEntrySection + ${MANUAL_BACKEND}_copyEntrySection elif [[ ${MANUAL_CHAN[${MANUAL_DOCENTRY_ID}]} != '' ]] \ && [[ ${MANUAL_CHAN[((${MANUAL_DOCENTRY_ID} + 1))]} != '' ]];then @@ -49,7 +49,7 @@ function texinfo_copyEntry { # perform a copying action for the chapter directory itself. # In this configuration, the whole chapter directory and all # the content inside are duplicated from source to target. - ${FLAG_BACKEND}_copyEntryChapter + ${MANUAL_BACKEND}_copyEntryChapter elif [[ ${MANUAL_DIRN[${MANUAL_DOCENTRY_ID}]} != '' ]] \ && [[ ${MANUAL_DIRN[((${MANUAL_DOCENTRY_ID} + 1))]} != '' ]];then @@ -58,7 +58,7 @@ function texinfo_copyEntry { # neither in first or second non-option argument. So, we # perform copying actions on manual directory itself. Notice # that, in this configuration, the whole manual is duplicated. - ${FLAG_BACKEND}_copyEntryManual + ${MANUAL_BACKEND}_copyEntryManual # In this configuration, there is no need to update section # menus, nodes and cross refereces. The section definition diff --git a/Scripts/Functions/Help/Texinfo/texinfo_copyEntryChapter.sh b/Scripts/Functions/Help/Texinfo/texinfo_copyEntryChapter.sh index aebaba0..956729a 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_copyEntryChapter.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_copyEntryChapter.sh @@ -32,7 +32,7 @@ function texinfo_copyEntryChapter { MANUAL_ENTRY_DST=${MANUAL_BASEDIR_L10N}/${MANUAL_CHAN[((${MANUAL_DOCENTRY_ID} + 1))]} # Verify entry source and target locations. - ${FLAG_BACKEND}_checkEntrySrcDst "${MANUAL_ENTRY_SRC}" "${MANUAL_ENTRY_DST}" + ${MANUAL_BACKEND}_checkEntrySrcDst "${MANUAL_ENTRY_SRC}" "${MANUAL_ENTRY_DST}" # When we are copying chapters, document structure actualization # needs to be performed against the target chapter not the source @@ -48,7 +48,7 @@ function texinfo_copyEntryChapter { # source chapter must be copied one by one to the recently created # chapter. At this point then, is when menu, nodes and cross # references for the new chapter are updated. - ${FLAG_BACKEND}_createChapter + ${MANUAL_BACKEND}_createChapter # Create list of sections from source chapter that need to be # copied to target chapter. Don't include chapter's main @@ -64,11 +64,11 @@ function texinfo_copyEntryChapter { # Update section menu, nodes and cross reference definitions # inside target chapter where all section entries were copied to. - ${FLAG_BACKEND}_updateStructureSection "${MANUAL_ENTRY_DST}/.+\.${MANUAL_EXTENSION}" + ${MANUAL_BACKEND}_updateStructureSection "${MANUAL_ENTRY_DST}/.+\.${MANUAL_EXTENSION}" # Update chapter menu and node definitions inside the manual # structure. - ${FLAG_BACKEND}_updateChapterMenu - ${FLAG_BACKEND}_updateChapterNodes + ${MANUAL_BACKEND}_updateChapterMenu + ${MANUAL_BACKEND}_updateChapterNodes } diff --git a/Scripts/Functions/Help/Texinfo/texinfo_copyEntryManual.sh b/Scripts/Functions/Help/Texinfo/texinfo_copyEntryManual.sh index eb9349e..1f799e6 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_copyEntryManual.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_copyEntryManual.sh @@ -50,7 +50,7 @@ function texinfo_copyEntryManual { local MANUAL_BASEFILE="${MANUAL_BASEDIR_L10N}/${MANUAL_NAME}" # Create manual structure - ${FLAG_BACKEND}_createStructure + ${MANUAL_BACKEND}_createStructure # Print action maessage. cli_printMessage "`gettext "Updating chapter menus and nodes inside manual structure."`" --as-response-line @@ -67,8 +67,8 @@ function texinfo_copyEntryManual { # Update chapter information inside the manual's texinfo # structure. - ${FLAG_BACKEND}_updateChapterMenu - ${FLAG_BACKEND}_updateChapterNodes + ${MANUAL_BACKEND}_updateChapterMenu + ${MANUAL_BACKEND}_updateChapterNodes done diff --git a/Scripts/Functions/Help/Texinfo/texinfo_copyEntrySection.sh b/Scripts/Functions/Help/Texinfo/texinfo_copyEntrySection.sh index 35a2a86..338b24a 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_copyEntrySection.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_copyEntrySection.sh @@ -32,8 +32,8 @@ function texinfo_copyEntrySection { # When the section name is specified in first and second # non-option arguments, source and target are set as specified # in first and second non-option arguments respectively. - MANUAL_ENTRY_SRC=$(${FLAG_BACKEND}_getEntry ${MANUAL_SECN[${MANUAL_DOCENTRY_ID}]}) - MANUAL_ENTRY_DST=$(${FLAG_BACKEND}_getEntry ${MANUAL_SECN[((${MANUAL_DOCENTRY_ID} + 1))]}) + MANUAL_ENTRY_SRC=$(${MANUAL_BACKEND}_getEntry ${MANUAL_SECN[${MANUAL_DOCENTRY_ID}]}) + MANUAL_ENTRY_DST=$(${MANUAL_BACKEND}_getEntry ${MANUAL_SECN[((${MANUAL_DOCENTRY_ID} + 1))]}) elif [[ ${MANUAL_SECN[((${MANUAL_DOCENTRY_ID} + 1))]} == '' ]] \ && [[ ${MANUAL_CHAN[((${MANUAL_DOCENTRY_ID} + 1))]} != '' ]];then @@ -43,7 +43,7 @@ function texinfo_copyEntrySection { # in the second non-option argument, use the section name # passed in first argument to build the section name that will # be used as target. - MANUAL_ENTRY_SRC=$(${FLAG_BACKEND}_getEntry ${MANUAL_SECN[${MANUAL_DOCENTRY_ID}]}) + MANUAL_ENTRY_SRC=$(${MANUAL_BACKEND}_getEntry ${MANUAL_SECN[${MANUAL_DOCENTRY_ID}]}) MANUAL_ENTRY_DST=$(echo $MANUAL_ENTRY_SRC \ | sed -r "s!${MANUAL_CHAN[${MANUAL_DOCENTRY_ID}]}!${MANUAL_CHAN[((${MANUAL_DOCENTRY_ID} + 1))]}!") @@ -56,7 +56,7 @@ function texinfo_copyEntrySection { cli_printMessage "${MANUAL_ENTRY_DST}" --as-creating-line # Verify entry source and target locations. - ${FLAG_BACKEND}_checkEntrySrcDst "${MANUAL_ENTRY_SRC}" "${MANUAL_ENTRY_DST}" + ${MANUAL_BACKEND}_checkEntrySrcDst "${MANUAL_ENTRY_SRC}" "${MANUAL_ENTRY_DST}" # Copy section entry from source to target using subversion. svn cp "${MANUAL_ENTRY_SRC}" "${MANUAL_ENTRY_DST}" --quiet @@ -77,6 +77,6 @@ function texinfo_copyEntrySection { # At this point, all copying actions and chapter related # redefinitions have took place. It is time, then, to update the # document structure using the information collected so far. - ${FLAG_BACKEND}_updateStructureSection "${MANUAL_ENTRY_DST}" + ${MANUAL_BACKEND}_updateStructureSection "${MANUAL_ENTRY_DST}" } diff --git a/Scripts/Functions/Help/Texinfo/texinfo_createChapter.sh b/Scripts/Functions/Help/Texinfo/texinfo_createChapter.sh index b11ce58..46b0225 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_createChapter.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_createChapter.sh @@ -48,9 +48,9 @@ function texinfo_createChapter { read MANUAL_CHAPTER_TITLE # Sanitate chapter node, chapter index and chapter title. - MANUAL_CHAPTER_NODE=$(${FLAG_BACKEND}_getEntryNode "$MANUAL_CHAPTER_NAME") - MANUAL_CHAPTER_CIND=$(${FLAG_BACKEND}_getEntryIndex "$MANUAL_CHAPTER_TITLE") - MANUAL_CHAPTER_TITLE=$(${FLAG_BACKEND}_getEntryTitle "$MANUAL_CHAPTER_TITLE") + MANUAL_CHAPTER_NODE=$(${MANUAL_BACKEND}_getEntryNode "$MANUAL_CHAPTER_NAME") + MANUAL_CHAPTER_CIND=$(${MANUAL_BACKEND}_getEntryIndex "$MANUAL_CHAPTER_TITLE") + MANUAL_CHAPTER_TITLE=$(${MANUAL_BACKEND}_getEntryTitle "$MANUAL_CHAPTER_TITLE") # Print action message. cli_printMessage "-" --as-separator-line @@ -113,7 +113,7 @@ function texinfo_createChapter { # Update chapter information inside the manual's texinfo # structure. - ${FLAG_BACKEND}_updateChapterMenu - ${FLAG_BACKEND}_updateChapterNodes + ${MANUAL_BACKEND}_updateChapterMenu + ${MANUAL_BACKEND}_updateChapterNodes } diff --git a/Scripts/Functions/Help/Texinfo/texinfo_createStructure.sh b/Scripts/Functions/Help/Texinfo/texinfo_createStructure.sh index d188c22..96441d7 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_createStructure.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_createStructure.sh @@ -108,7 +108,7 @@ function texinfo_createStructure { done # Initialize chapter structure inside the manual. - ${FLAG_BACKEND}_createStructureChapters + ${MANUAL_BACKEND}_createStructureChapters # Redefine absolute path to changed directory. MANUAL_CHANGED_DIRS=${MANUAL_BASEDIR} diff --git a/Scripts/Functions/Help/Texinfo/texinfo_deleteCrossReferences.sh b/Scripts/Functions/Help/Texinfo/texinfo_deleteCrossReferences.sh index a38e2c0..f5a3d16 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_deleteCrossReferences.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_deleteCrossReferences.sh @@ -42,7 +42,7 @@ function texinfo_deleteCrossReferences { fi # Build the node string using entry location. - local NODE="$(${FLAG_BACKEND}_getEntryNode "$MANUAL_ENTRY")" + local NODE="$(${MANUAL_BACKEND}_getEntryNode "$MANUAL_ENTRY")" # Define regular expression patterns for texinfo cross reference # commands. diff --git a/Scripts/Functions/Help/Texinfo/texinfo_deleteEntry.sh b/Scripts/Functions/Help/Texinfo/texinfo_deleteEntry.sh index 40f09c2..e0219da 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_deleteEntry.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_deleteEntry.sh @@ -38,7 +38,7 @@ function texinfo_deleteEntry { # Once the documentation entry is deleted, the section menu # and nodes definition files are updated to keep manual in a # consistent state. - ${FLAG_BACKEND}_deleteEntrySection + ${MANUAL_BACKEND}_deleteEntrySection elif [[ ${MANUAL_CHAN[$MANUAL_DOCENTRY_ID]} != '' ]];then @@ -52,7 +52,7 @@ function texinfo_deleteEntry { # Actualization of section definition files must be done one # at a time because menu entries related to section # definitions are updated one at a time. - ${FLAG_BACKEND}_deleteEntryChapter + ${MANUAL_BACKEND}_deleteEntryChapter elif [[ ${MANUAL_DIRN[$MANUAL_DOCENTRY_ID]} != '' ]];then @@ -60,7 +60,7 @@ function texinfo_deleteEntry { # to either a section or chapter but a manual name only. In # this configuration the entire manual directory is marked for # deletion, and that way processed. - ${FLAG_BACKEND}_deleteEntryManual + ${MANUAL_BACKEND}_deleteEntryManual else cli_printMessage "`gettext "The parameters you provided are not supported."`" --as-error-line diff --git a/Scripts/Functions/Help/Texinfo/texinfo_deleteEntryChapter.sh b/Scripts/Functions/Help/Texinfo/texinfo_deleteEntryChapter.sh index 0ec1b8d..8fc4b90 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_deleteEntryChapter.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_deleteEntryChapter.sh @@ -48,8 +48,8 @@ function texinfo_deleteEntryChapter { svn del ${MANUAL_CHAPTER_DIR} --quiet # Update chapter menu and nodes inside manual structure. - ${FLAG_BACKEND}_updateChapterMenu --delete-entry - ${FLAG_BACKEND}_updateChapterNodes + ${MANUAL_BACKEND}_updateChapterMenu --delete-entry + ${MANUAL_BACKEND}_updateChapterNodes # Loop through section entries retrived from chapter, before # deleting it, in order to remove cross references pointing to @@ -59,7 +59,7 @@ function texinfo_deleteEntryChapter { # pointing to non-existent section entries will be transformed in # order for documentors to advertise the section entry state. for MANUAL_ENTRY in $MANUAL_ENTRIES;do - ${FLAG_BACKEND}_deleteCrossReferences ${MANUAL_ENTRY} + ${MANUAL_BACKEND}_deleteCrossReferences ${MANUAL_ENTRY} done } diff --git a/Scripts/Functions/Help/Texinfo/texinfo_deleteEntrySection.sh b/Scripts/Functions/Help/Texinfo/texinfo_deleteEntrySection.sh index af8a7b6..c162287 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_deleteEntrySection.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_deleteEntrySection.sh @@ -41,6 +41,6 @@ function texinfo_deleteEntrySection { svn del $MANUAL_ENTRY --quiet # Update section menu, nodes and cross references. - ${FLAG_BACKEND}_updateStructureSection "${MANUAL_ENTRY}" --delete + ${MANUAL_BACKEND}_updateStructureSection "${MANUAL_ENTRY}" --delete } diff --git a/Scripts/Functions/Help/Texinfo/texinfo_editEntry.sh b/Scripts/Functions/Help/Texinfo/texinfo_editEntry.sh index b6f2386..e9f4d8d 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_editEntry.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_editEntry.sh @@ -36,7 +36,7 @@ function texinfo_editEntry { # its chapter directory. There is no more levels deep so it is # possible to perform a direct chapter verification here. if [[ ! -a $(dirname $MANUAL_ENTRY)/chapter.${MANUAL_EXTENSION} ]];then - ${FLAG_BACKEND}_createChapter + ${MANUAL_BACKEND}_createChapter fi # Print confirmation question. @@ -46,7 +46,7 @@ function texinfo_editEntry { # Update section menu, nodes and cross references based on # changes in order for manual structure to remain cosistent. - ${FLAG_BACKEND}_updateStructureSection "$MANUAL_ENTRY" + ${MANUAL_BACKEND}_updateStructureSection "$MANUAL_ENTRY" # Use default text editor to write changes on documentation entry. $EDITOR $MANUAL_ENTRY @@ -60,7 +60,7 @@ function texinfo_editEntry { # documentation entry. This way, if there is any change in the # section menu definition, it will be visible to you on # edition. - ${FLAG_BACKEND}_makeSeeAlso "$MANUAL_ENTRY" + ${MANUAL_BACKEND}_makeSeeAlso "$MANUAL_ENTRY" # Use default text editor to write changes on documentation entry. $EDITOR $MANUAL_ENTRY @@ -70,7 +70,7 @@ function texinfo_editEntry { # expansion to realize in the section menu definition, it be # applied right now. Don't see a reason for waiting until the # next edition for expansions to happen. - ${FLAG_BACKEND}_makeSeeAlso "$MANUAL_ENTRY" + ${MANUAL_BACKEND}_makeSeeAlso "$MANUAL_ENTRY" fi diff --git a/Scripts/Functions/Help/Texinfo/texinfo_makeSeeAlso.sh b/Scripts/Functions/Help/Texinfo/texinfo_makeSeeAlso.sh index 924161d..d159a87 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_makeSeeAlso.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_makeSeeAlso.sh @@ -117,11 +117,11 @@ function texinfo_makeSeeAlso { # Redefine list's entry based on translation marker definition. if [[ $LIST_TYPE =~ '^menu$' ]];then for CHILD_ENTRY in $CHILD_ENTRIES;do - LIST_ENTRIES="* $(${FLAG_BACKEND}_getEntryNode "$CHILD_ENTRY")::\n${LIST_ENTRIES}" + LIST_ENTRIES="* $(${MANUAL_BACKEND}_getEntryNode "$CHILD_ENTRY")::\n${LIST_ENTRIES}" done elif [[ $LIST_TYPE =~ '^(itemize|enumerate)$' ]];then for CHILD_ENTRY in $CHILD_ENTRIES;do - LIST_ENTRIES="@item @ref{$(${FLAG_BACKEND}_getEntryNode "$CHILD_ENTRY")}\n${LIST_ENTRIES}" + LIST_ENTRIES="@item @ref{$(${MANUAL_BACKEND}_getEntryNode "$CHILD_ENTRY")}\n${LIST_ENTRIES}" done else # When an translation marker isn't recognize, go on with diff --git a/Scripts/Functions/Help/Texinfo/texinfo_renameCrossReferences.sh b/Scripts/Functions/Help/Texinfo/texinfo_renameCrossReferences.sh index c63d340..87ed739 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_renameCrossReferences.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_renameCrossReferences.sh @@ -30,8 +30,8 @@ function texinfo_renameCrossReferences { local -a REPLACE # Build source and target node definitions. - local NODE_SRC="$(${FLAG_BACKEND}_getEntryNode "$MANUAL_ENTRY_SRC")" - local NODE_DST="$(${FLAG_BACKEND}_getEntryNode "$MANUAL_ENTRY_DST")" + local NODE_SRC="$(${MANUAL_BACKEND}_getEntryNode "$MANUAL_ENTRY_SRC")" + local NODE_DST="$(${MANUAL_BACKEND}_getEntryNode "$MANUAL_ENTRY_DST")" # Define regular expression pattern and its replacement for node # definitions that have been previously removed. diff --git a/Scripts/Functions/Help/Texinfo/texinfo_renameEntry.sh b/Scripts/Functions/Help/Texinfo/texinfo_renameEntry.sh index ab0230c..d692d61 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_renameEntry.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_renameEntry.sh @@ -42,7 +42,7 @@ function texinfo_renameEntry { # location has been renamed, the section menu, nodes and cross # references are updated to keep consistency inside the # manual. - ${FLAG_BACKEND}_renameEntrySection + ${MANUAL_BACKEND}_renameEntrySection elif [[ ${MANUAL_CHAN[$MANUAL_DOCENTRY_ID]} != '' ]] \ && [[ ${MANUAL_CHAN[(($MANUAL_DOCENTRY_ID + 1))]} != '' ]];then @@ -53,7 +53,7 @@ function texinfo_renameEntry { # location has been renamed, the chapter and section menu, # nodes and cross references are updated to keep consistency # inside the manual. - ${FLAG_BACKEND}_renameEntryChapter + ${MANUAL_BACKEND}_renameEntryChapter elif [[ ${MANUAL_DIRN[$MANUAL_DOCENTRY_ID]} != '' ]] \ && [[ ${MANUAL_DIRN[(($MANUAL_DOCENTRY_ID + 1))]} != '' ]] ;then @@ -64,7 +64,7 @@ function texinfo_renameEntry { # location. Once the source manual has been renamed, chapter # and section menu, nodes and cross references are updated to # keep consistency inside the manual. - ${FLAG_BACKEND}_renameEntryManual + ${MANUAL_BACKEND}_renameEntryManual else cli_printMessage "`gettext "The parameters you provided are not supported."`" --as-error-line diff --git a/Scripts/Functions/Help/Texinfo/texinfo_renameEntryChapter.sh b/Scripts/Functions/Help/Texinfo/texinfo_renameEntryChapter.sh index 6a03cd3..9820e07 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_renameEntryChapter.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_renameEntryChapter.sh @@ -27,12 +27,12 @@ function texinfo_renameEntryChapter { # Copy section source entry to target location. - ${FLAG_BACKEND}_copyEntryChapter + ${MANUAL_BACKEND}_copyEntryChapter # Delete section source entry. - ${FLAG_BACKEND}_deleteEntryChapter + ${MANUAL_BACKEND}_deleteEntryChapter # Rename menu, nodes and cross references related entries. - ${FLAG_BACKEND}_renameCrossReferences + ${MANUAL_BACKEND}_renameCrossReferences } diff --git a/Scripts/Functions/Help/Texinfo/texinfo_renameEntryManual.sh b/Scripts/Functions/Help/Texinfo/texinfo_renameEntryManual.sh index a7ec0b8..e1015d8 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_renameEntryManual.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_renameEntryManual.sh @@ -27,10 +27,10 @@ function texinfo_renameEntryManual { # Copy section source entry to target location. - ${FLAG_BACKEND}_copyEntryManual + ${MANUAL_BACKEND}_copyEntryManual # Delete section source entry. - ${FLAG_BACKEND}_deleteEntryManual + ${MANUAL_BACKEND}_deleteEntryManual # Redefine absolute paths to changed directories. This is # required in order for `cli_commitRepoChanges' to be aware of diff --git a/Scripts/Functions/Help/Texinfo/texinfo_renameEntrySection.sh b/Scripts/Functions/Help/Texinfo/texinfo_renameEntrySection.sh index 504ee56..ca6b2e7 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_renameEntrySection.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_renameEntrySection.sh @@ -27,12 +27,12 @@ function texinfo_renameEntrySection { # Copy section source entry to target location. - ${FLAG_BACKEND}_copyEntrySection + ${MANUAL_BACKEND}_copyEntrySection # Delete section source entry. - ${FLAG_BACKEND}_deleteEntrySection + ${MANUAL_BACKEND}_deleteEntrySection # Rename menu, nodes and cross references related entries. - ${FLAG_BACKEND}_renameCrossReferences + ${MANUAL_BACKEND}_renameCrossReferences } diff --git a/Scripts/Functions/Help/Texinfo/texinfo_restoreCrossReferences.sh b/Scripts/Functions/Help/Texinfo/texinfo_restoreCrossReferences.sh index a2b752a..d6a9055 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_restoreCrossReferences.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_restoreCrossReferences.sh @@ -46,7 +46,7 @@ function texinfo_restoreCrossReferences { fi # Build the node string using entry location. - local NODE="$(${FLAG_BACKEND}_getEntryNode "$MANUAL_ENTRY")" + local NODE="$(${MANUAL_BACKEND}_getEntryNode "$MANUAL_ENTRY")" # Define regular expression patterns to match removed message # format produced by message_removeCrossReferences function. diff --git a/Scripts/Functions/Help/Texinfo/texinfo_searchIndex.sh b/Scripts/Functions/Help/Texinfo/texinfo_searchIndex.sh index 49a4ea4..db767d4 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_searchIndex.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_searchIndex.sh @@ -26,7 +26,7 @@ function texinfo_searchIndex { # Rebuild output files to propagate recent changes. - ${FLAG_BACKEND}_updateOutputFiles + ${MANUAL_BACKEND}_updateOutputFiles # Print separator line. cli_printMessage '-' --as-separator-line diff --git a/Scripts/Functions/Help/Texinfo/texinfo_searchNode.sh b/Scripts/Functions/Help/Texinfo/texinfo_searchNode.sh index 40a4a5c..9e5509b 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_searchNode.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_searchNode.sh @@ -28,12 +28,12 @@ function texinfo_searchNode { # Verify documentation entry. If it doesn't exist, ask to create # it. if [[ ! -f "$MANUAL_ENTRY" ]];then - ${FLAG_BACKEND}_editEntry + ${MANUAL_BACKEND}_editEntry fi # Verify manual output files. If they don't exist, create them. if [[ ! -f ${MANUAL_BASEFILE}.info.bz2 ]];then - ${FLAG_BACKEND}_updateOutputFiles + ${MANUAL_BACKEND}_updateOutputFiles fi # Print separator line. @@ -43,6 +43,6 @@ function texinfo_searchNode { cli_printMessage "${MANUAL_BASEFILE}.info.bz2" --as-reading-line # Use info reader to present manual's info output. - info --node="$(${FLAG_BACKEND}_getEntryNode "$MANUAL_ENTRY")" --file=${MANUAL_BASEFILE}.info.bz2 + info --node="$(${MANUAL_BACKEND}_getEntryNode "$MANUAL_ENTRY")" --file=${MANUAL_BASEFILE}.info.bz2 } diff --git a/Scripts/Functions/Help/Texinfo/texinfo_updateOutputFiles.sh b/Scripts/Functions/Help/Texinfo/texinfo_updateOutputFiles.sh index 88ae436..cf329f2 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_updateOutputFiles.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_updateOutputFiles.sh @@ -40,12 +40,12 @@ function texinfo_updateOutputFiles { # paths incorrectly. pushd ${CLI_WRKCOPY} > /dev/null - ${FLAG_BACKEND}_updateOutputFileInfo - ${FLAG_BACKEND}_updateOutputFileXhtml - ${FLAG_BACKEND}_updateOutputFileXml - ${FLAG_BACKEND}_updateOutputFileDocbook - ${FLAG_BACKEND}_updateOutputFilePdf - ${FLAG_BACKEND}_updateOutputFilePlaintext + ${MANUAL_BACKEND}_updateOutputFileInfo + ${MANUAL_BACKEND}_updateOutputFileXhtml + ${MANUAL_BACKEND}_updateOutputFileXml + ${MANUAL_BACKEND}_updateOutputFileDocbook + ${MANUAL_BACKEND}_updateOutputFilePdf + ${MANUAL_BACKEND}_updateOutputFilePlaintext # Remove the working copy root directory from directory stack. popd > /dev/null diff --git a/Scripts/Functions/Help/Texinfo/texinfo_updateSectionMenu.sh b/Scripts/Functions/Help/Texinfo/texinfo_updateSectionMenu.sh index 0fe6baa..54c1c34 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_updateSectionMenu.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_updateSectionMenu.sh @@ -49,7 +49,7 @@ function texinfo_updateSectionMenu { fi # Build node information used inside chapter menu. - local MENUNODE=$(${FLAG_BACKEND}_getEntryNode "$MANUAL_ENTRY") + local MENUNODE=$(${MANUAL_BACKEND}_getEntryNode "$MANUAL_ENTRY") # Define menu entry using texinfo style and node information as # reference. diff --git a/Scripts/Functions/Help/Texinfo/texinfo_updateSectionNodes.sh b/Scripts/Functions/Help/Texinfo/texinfo_updateSectionNodes.sh index e90bd95..ec136d7 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_updateSectionNodes.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_updateSectionNodes.sh @@ -37,8 +37,8 @@ function texinfo_updateSectionNodes { local NODE=$(echo "${NODE}" | sed -r 's!:! !g') local INCL=$(echo "${NODE}" | sed -r 's! !/!' | sed -r 's! !-!g' | sed -r 's!/(.+)!/\L\1!').${MANUAL_EXTENSION} - local SECT=$(${FLAG_BACKEND}_getEntryTitle "$NODE") - local CIND=$(${FLAG_BACKEND}_getEntryIndex "$NODE") + local SECT=$(${MANUAL_BACKEND}_getEntryTitle "$NODE") + local CIND=$(${MANUAL_BACKEND}_getEntryIndex "$NODE") # Create texinfo section file using templates, only if the # section file doesn't exist and hasn't been marked for diff --git a/Scripts/Functions/Help/Texinfo/texinfo_updateStructureSection.sh b/Scripts/Functions/Help/Texinfo/texinfo_updateStructureSection.sh index 103dc56..f12d059 100755 --- a/Scripts/Functions/Help/Texinfo/texinfo_updateStructureSection.sh +++ b/Scripts/Functions/Help/Texinfo/texinfo_updateStructureSection.sh @@ -131,10 +131,10 @@ function texinfo_updateStructureSection { # nodes and related cross-references). for MANUAL_ENTRY in ${MANUAL_ENTRIES};do cli_printMessage "${MANUAL_ENTRY}" --as-response-line - ${FLAG_BACKEND}_${ACTIONNAM_SECMENU} - ${FLAG_BACKEND}_updateSectionNodes - ${FLAG_BACKEND}_makeSeeAlso "${MANUAL_ENTRY}" - ${FLAG_BACKEND}_${ACTIONNAM_CROSREF} "${MANUAL_ENTRY}" + ${MANUAL_BACKEND}_${ACTIONNAM_SECMENU} + ${MANUAL_BACKEND}_updateSectionNodes + ${MANUAL_BACKEND}_makeSeeAlso "${MANUAL_ENTRY}" + ${MANUAL_BACKEND}_${ACTIONNAM_CROSREF} "${MANUAL_ENTRY}" done } diff --git a/Scripts/Functions/Help/help.sh b/Scripts/Functions/Help/help.sh index 484cbff..ba98c40 100755 --- a/Scripts/Functions/Help/help.sh +++ b/Scripts/Functions/Help/help.sh @@ -35,7 +35,7 @@ function help { # Initialize the backend flag (`--backend'). This option sets the # documentation backed used to perform documentation actions. - local FLAG_BACKEND='texinfo' + local MANUAL_BACKEND='texinfo' # Initialize manual's language. local MANUAL_L10N=$(cli_getCurrentLocale) @@ -86,7 +86,7 @@ function help { # execution environment and make them available, this way, to # perform backend-specific documentation tasks. cli_exportFunctions "${CLI_FUNCDIR}/${CLI_FUNCDIRNAM}/$(cli_getRepoName \ - ${FLAG_BACKEND} -d)" "${FLAG_BACKEND}" + ${MANUAL_BACKEND} -d)" "${MANUAL_BACKEND}" # Execute backend-specific documentation tasks for each # documentation entry specified in the command-line, individually. @@ -147,7 +147,7 @@ function help { MANUAL_SECTION_NAME=${MANUAL_SECN[${MANUAL_DOCENTRY_ID}]} # Execute backend-specific documentation tasks. - ${FLAG_BACKEND} + ${MANUAL_BACKEND} # Increment documentation entry counter id. MANUAL_DOCENTRY_ID=$(($MANUAL_DOCENTRY_ID + 1)) @@ -155,7 +155,7 @@ function help { done # Rebuild output files to propagate recent changes. - ${FLAG_BACKEND}_updateOutputFiles + ${MANUAL_BACKEND}_updateOutputFiles # Syncronize changes between repository and working copy. At this # point, changes in the repository are merged in the working copy diff --git a/Scripts/Functions/Help/help_getOptions.sh b/Scripts/Functions/Help/help_getOptions.sh index 5802190..3d7282a 100755 --- a/Scripts/Functions/Help/help_getOptions.sh +++ b/Scripts/Functions/Help/help_getOptions.sh @@ -64,7 +64,7 @@ function help_getOptions { # through cli_getRepoName using just the basename of # the value provided. Otherwise, functionalities might # be executed from unexpected places. - FLAG_BACKEND="$(cli_getRepoName "$2" -f)" + MANUAL_BACKEND="$(cli_getRepoName "$2" -f)" shift 2 ;;