From 1f6dd813dd2a1ec9853ec0a7fe78af83d4f1444b Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Mar 22 2011 18:25:23 +0000 Subject: Update `help' functionality: - Define default node displayed when no argument is provided to help functionality. By default, the Top node of repository manual is called. --- diff --git a/Scripts/Bash/Cli/Functions/Help/help.sh b/Scripts/Bash/Cli/Functions/Help/help.sh index da12189..6f17e68 100755 --- a/Scripts/Bash/Cli/Functions/Help/help.sh +++ b/Scripts/Bash/Cli/Functions/Help/help.sh @@ -35,6 +35,15 @@ function help { # organized in. MANUAL_BASEDIR="${HOME}/artwork/trunk/Manual" + # Define file name for documentation manual. This is the file used + # to initiate the structure of documentation manual. + MANUAL_NAME=repository + + # Define base name for documentation manual files (without + # extension). This is the main file name used to build texinfo + # related files (.info, .pdf, .xml, etc.). + MANUAL_BASEFILE="${MANUAL_BASEDIR}/${MANUAL_NAME}" + # Interpret arguments and options passed through command-line. help_getArguments @@ -49,6 +58,13 @@ function help { # In that sake, we defined action name inside help_getArguments, # at the moment of interpreting options. + # Define default manual node shown when no argument is provided to + # help functionality. By default, the Top node of repository + # manual is called. + if [[ $ACTIONNAM == '' ]] && [[ $ACTIONVAL == '' ]];then + /usr/bin/info --node="Top" --file=${MANUAL_BASEFILE}.info.bz2 + fi + # Define action value. As convenction, we use non-option arguments # to define the action value (ACTIONVAL) variable. for ACTIONVAL in "$@";do @@ -71,10 +87,6 @@ function help { # Define documentation entry file (without extension). ENTRY_FILE=$(basename ${ENTRY} | sed -r 's!\.texi$!!') - # Define file name for documentation manual. This is the file - # used to initiate the structure of documentation manual. - MANUAL_NAME=repository - # Define directory to store documentation entries. At this # point, we need to take a desition about documentation # design, in order to answer the question: How do we assign @@ -93,11 +105,6 @@ function help { # working with. MANUAL_CHAPTER_NAME=$(basename "$MANUAL_CHAPTER_DIR") - # Define base name for documentation manual files (without - # extension). This is the main file name used to build texinfo - # related files (.info, .pdf, .xml, etc.). - MANUAL_BASEFILE="${MANUAL_BASEDIR}/${MANUAL_NAME}" - # Set action preable. cli_printActionPreamble "${MANUAL_BASEFILE}.texi" '' ''