diff --git a/Scripts/Bash/Functions/Help/Texinfo/texinfo.sh b/Scripts/Bash/Functions/Help/Texinfo/texinfo.sh index 52f8309..30a0666 100755 --- a/Scripts/Bash/Functions/Help/Texinfo/texinfo.sh +++ b/Scripts/Bash/Functions/Help/Texinfo/texinfo.sh @@ -1,7 +1,7 @@ #!/bin/bash # # texinfo.sh -- This function initilializes Texinfo documentation -# backend used by `centos-art.sh' script to produce and maintain +# format used by `centos-art.sh' script to produce and maintain # documentation manuals written in Texinfo format, inside the working # copy of The CentOS Artwork Repository. # @@ -36,13 +36,13 @@ function texinfo { fi # Define file extension used by source files inside manuals. - MANUAL_EXTENSION="${MANUAL_BACKEND}" + MANUAL_EXTENSION="${MANUAL_FORMAT}" # Define absolute path to template directory. This is the place # 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 \ - ${MANUAL_BACKEND} -d)/Templates + ${MANUAL_FORMAT} -d)/Templates # Define absolute path to language-specific template directory. # This is the place where we store locale-specific files used to diff --git a/Scripts/Bash/Functions/Help/Texinfo/texinfo_createStructure.sh b/Scripts/Bash/Functions/Help/Texinfo/texinfo_createStructure.sh index ca41807..4671130 100755 --- a/Scripts/Bash/Functions/Help/Texinfo/texinfo_createStructure.sh +++ b/Scripts/Bash/Functions/Help/Texinfo/texinfo_createStructure.sh @@ -79,7 +79,7 @@ function texinfo_createStructure { --pattern="manual((-menu|-nodes|-index)?\.${MANUAL_EXTENSION}|\.conf)") # Verify manual base file. The manual base file is where the - # documentation manual is defined in the backend format. Assuming + # documentation manual is defined in the format format. Assuming # no file exists (e.g., a new language-specific manual is being # created), use texinfo templates for it. for FILE in $FILES;do diff --git a/Scripts/Bash/Functions/Help/help.sh b/Scripts/Bash/Functions/Help/help.sh index 31d43b2..813991f 100755 --- a/Scripts/Bash/Functions/Help/help.sh +++ b/Scripts/Bash/Functions/Help/help.sh @@ -2,7 +2,7 @@ # # help.sh -- This function initializes the interface used by # centos-art.sh script to perform documentation tasks through -# different documentation backends. +# different documentation formats. # # Copyright (C) 2009, 2010, 2011 The CentOS Project # @@ -30,7 +30,7 @@ function help { local ACTIONNAM='' # Initialize search option (`--search'). This option is used to - # look for documentation inside documentation backends. + # look for documentation inside documentation formats. local FLAG_SEARCH="" # Initialize manual's language. @@ -78,7 +78,7 @@ function help { # information related documentation entries from there. help_getEntries - # Execute backend-specific documentation tasks for each + # Execute format-specific documentation tasks for each # documentation entry specified in the command-line, individually. # Notice that we've stored all documentation entries passed as # non-option arguments in array variables in order to process them @@ -140,34 +140,34 @@ function help { # as the style and order used for printing sections. MANUAL_CONFIG_FILE="${MANUAL_BASEFILE}.conf" - # Define documentation backend. This information defines the + # Define documentation format. This information defines the # kind of source files we work with inside the documentation # manual as well as the kind of actions required by them to # perform actions related to document management (e.g., # creation, edition, deletion, copying, renaming, etc.). if [[ -f ${MANUAL_CONFIG_FILE} ]];then - # Retrive documentation backend from configuration file. - MANUAL_BACKEND=$(cli_getConfigValue \ - "${MANUAL_CONFIG_FILE}" "main" "manual_backend") + # Retrive documentation format from configuration file. + MANUAL_FORMAT=$(cli_getConfigValue \ + "${MANUAL_CONFIG_FILE}" "main" "manual_format") - # Verify documentation backend. This is required in order + # Verify documentation format. This is required in order # to prevent malformed values from being used. Be sure - # only supported documentation backends can be provided as - # value to `manual_backend' option inside configuration + # only supported documentation formats can be provided as + # value to `manual_format' option inside configuration # files. - if [[ ! $MANUAL_BACKEND =~ '^(texinfo)$' ]];then - cli_printMessage "`gettext "The documentation backend provided isn't supported."`" --as-error-line + if [[ ! $MANUAL_FORMAT =~ '^(texinfo)$' ]];then + cli_printMessage "`gettext "The documentation format provided isn't supported."`" --as-error-line fi else # When the current documentation manual is being created # for first time, there's no way to get the documentation - # backend to use in the future manual, but asking the user + # format to use in the future manual, but asking the user # creating it which one to use. - cli_printMessage "`gettext "Select one of the following documentation backends:"`" - MANUAL_BACKEND=$(cli_printMessage "texinfo" --as-selection-line) + cli_printMessage "`gettext "Select one of the following documentation formats:"`" + MANUAL_FORMAT=$(cli_printMessage "texinfo" --as-selection-line) fi @@ -178,7 +178,7 @@ function help { # non-option arguments refer the same manual directory name). # That would be only necessary when documentation entries # refer to different manual directory names that could be - # written in different documentation backends. + # written in different documentation formats. if [[ ${MANUAL_DOCENTRY_ID} -eq 0 \ || ( ( ${MANUAL_DOCENTRY_ID} -gt 0 ) && ( \ ${MANUAL_DIRN[${MANUAL_DOCENTRY_ID}]} != ${MANUAL_DIRN[((${MANUAL_DOCENTRY_ID} - 1))]} ) ) ]];then @@ -191,28 +191,28 @@ function help { cli_syncroRepoChanges ${MANUAL_CHANGED_DIRS} fi - # Initialize documentation backend functionalities. At + # Initialize documentation format functionalities. At # this point we load all functionalities required into # `centos-art.sh''s execution environment and make them - # available, this way, to perform backend-specific + # available, this way, to perform format-specific # documentation tasks. cli_exportFunctions "${CLI_FUNCDIR}/${CLI_FUNCDIRNAM}/$(cli_getRepoName \ - ${MANUAL_BACKEND} -d)" "${MANUAL_BACKEND}" + ${MANUAL_FORMAT} -d)" "${MANUAL_FORMAT}" fi - # Execute backend-specific documentation tasks. - ${MANUAL_BACKEND} + # Execute format-specific documentation tasks. + ${MANUAL_FORMAT} # Unset the exported functions before go on with the next # documentation entry provided as non-option argument to # `centos-art.sh' script. Different documentation entries may - # be written in different documentation backends. Each - # documentation backend is loaded in order to perform their + # be written in different documentation formats. Each + # documentation format is loaded in order to perform their # related documentation tasks. Assuming more that one # documentation entry be passed as non-option argument to # `centos-art.sh' script and they are written in different - # formats, we might end up loading documentation backend + # formats, we might end up loading documentation format # functionalities that aren't used in the current # documentation entry being processed. In that sake, unset # documentation bakend functionalities when the next @@ -221,7 +221,7 @@ function help { if [[ ${MANUAL_DOCENTRY_ID} -gt 0 \ && ${MANUAL_DIRN[${MANUAL_DOCENTRY_ID}]} != ${MANUAL_DIRN[((${MANUAL_DOCENTRY_ID} + 1))]} ]];then cli_unsetFunctions "${CLI_FUNCDIR}/${CLI_FUNCDIRNAM}/$(cli_getRepoName \ - ${MANUAL_BACKEND} -d)" "${MANUAL_BACKEND}" + ${MANUAL_FORMAT} -d)" "${MANUAL_FORMAT}" fi # Increment documentation entry counter id. diff --git a/Scripts/Bash/Functions/Render/Docbook/docbook.sh b/Scripts/Bash/Functions/Render/Docbook/docbook.sh index e776abc..57d6cc1 100755 --- a/Scripts/Bash/Functions/Render/Docbook/docbook.sh +++ b/Scripts/Bash/Functions/Render/Docbook/docbook.sh @@ -27,7 +27,7 @@ function docbook { # Initialize absolute path to Xsl directory. This is the location # where customization of XSL tranformations are stored in. - DOCBOOK_STYLES_DIR="${RENDER_BACKEND_DIR}/Docbook/Styles" + DOCBOOK_STYLES_DIR="${RENDER_FORMAT_DIR}/Docbook/Styles" docbook_convertToXhtmlChunk docbook_convertToXhtml @@ -40,10 +40,10 @@ function docbook { # of CentOS greater than 5.5, uncomment this to see what happen. #docbook_convertToPdf - # Perform backend post-rendition. + # Perform format post-rendition. docbook_doPostActions - # Perform backend last-rendition. + # Perform format last-rendition. docbook_doLastActions } diff --git a/Scripts/Bash/Functions/Render/Docbook/docbook_doLastActions.sh b/Scripts/Bash/Functions/Render/Docbook/docbook_doLastActions.sh index 7009fec..eaea5c4 100755 --- a/Scripts/Bash/Functions/Render/Docbook/docbook_doLastActions.sh +++ b/Scripts/Bash/Functions/Render/Docbook/docbook_doLastActions.sh @@ -29,7 +29,7 @@ function docbook_doLastActions { # Presently, there is no last-rendition action for DocBook base # rendition but the function should exist for consistency with - # other backends. + # other formats. return } diff --git a/Scripts/Bash/Functions/Render/Svg/svg.sh b/Scripts/Bash/Functions/Render/Svg/svg.sh index 0419479..0c02ac8 100755 --- a/Scripts/Bash/Functions/Render/Svg/svg.sh +++ b/Scripts/Bash/Functions/Render/Svg/svg.sh @@ -53,10 +53,10 @@ function svg { cli_printMessage "$(echo "$INKSCAPE_OUTPUT" | egrep '^Bitmap saved as' \ | sed -r "s!^Bitmap saved as:!`gettext "Saved as"`:!")" - # Perform backend post-rendition. + # Perform format post-rendition. svg_doPostActions - # Perform backend last-rendition. + # Perform format last-rendition. svg_doLastActions } diff --git a/Scripts/Bash/Functions/Render/render.sh b/Scripts/Bash/Functions/Render/render.sh index 98b4180..a27db19 100755 --- a/Scripts/Bash/Functions/Render/render.sh +++ b/Scripts/Bash/Functions/Render/render.sh @@ -72,14 +72,14 @@ function render { # branded. local FLAG_WITH_BRANDS='false' - # Initialize name of rendition backend as an empty value. The name - # of rendition backend is determined automatically based on + # Initialize name of rendition format as an empty value. The name + # of rendition format is determined automatically based on # template file extension, later, at rendition time. - local RENDER_BACKEND='' + local RENDER_FORMAT='' - # Initialize absolute path to backend's base directory, the place - # where backend-specific directories are stored in. - local RENDER_BACKEND_DIR="${CLI_FUNCDIR}/${CLI_FUNCDIRNAM}" + # Initialize absolute path to format's base directory, the place + # where format-specific directories are stored in. + local RENDER_FORMAT_DIR="${CLI_FUNCDIR}/${CLI_FUNCDIRNAM}" # Initialize list of supported file extensions. These file # extensions are used by design model files, the files used as diff --git a/Scripts/Bash/Functions/Render/render_doBaseActions.sh b/Scripts/Bash/Functions/Render/render_doBaseActions.sh index fbcad50..056034e 100755 --- a/Scripts/Bash/Functions/Render/render_doBaseActions.sh +++ b/Scripts/Bash/Functions/Render/render_doBaseActions.sh @@ -51,10 +51,10 @@ function render_doBaseActions { # Loop through list of supported file extensions. for RENDER_EXTENSION in ${RENDER_EXTENSIONS};do - # Redefine name of rendition backend based on supported file + # Redefine name of rendition format based on supported file # extension. if [[ $RENDER_EXTENSION =~ '^(svg|docbook)$' ]];then - RENDER_BACKEND=${RENDER_EXTENSION} + RENDER_FORMAT=${RENDER_EXTENSION} else cli_printMessage "`eval_gettext "The \\\"\\\$RENDER_EXTENSION\\\" file extension is not supported yet."`" --as-error-line fi @@ -109,9 +109,9 @@ function render_doBaseActions { continue fi - # Initialize backend-specific functionalities. - cli_exportFunctions "${RENDER_BACKEND_DIR}/$(cli_getRepoName \ - ${RENDER_BACKEND} -d)" "${RENDER_BACKEND}" + # Initialize format-specific functionalities. + cli_exportFunctions "${RENDER_FORMAT_DIR}/$(cli_getRepoName \ + ${RENDER_FORMAT} -d)" "${RENDER_FORMAT}" # Start processing the base rendition list of FILES. Fun part # approching :-). @@ -223,8 +223,8 @@ function render_doBaseActions { # Expand translation markers inside design model instance. cli_expandTMarkers ${INSTANCE} - # Perform backend base-rendition. - ${RENDER_BACKEND} + # Perform format base-rendition. + ${RENDER_FORMAT} # Remove template instance. if [[ -f $INSTANCE ]];then @@ -236,9 +236,9 @@ function render_doBaseActions { done - # Unset backend-specific functionalities. - cli_unsetFunctions "${RENDER_BACKEND_DIR}/$(cli_getRepoName \ - ${RENDER_BACKEND} -d)" "${RENDER_BACKEND}" + # Unset format-specific functionalities. + cli_unsetFunctions "${RENDER_FORMAT_DIR}/$(cli_getRepoName \ + ${RENDER_FORMAT} -d)" "${RENDER_FORMAT}" done } diff --git a/Scripts/Bash/Functions/Tuneup/tuneup.sh b/Scripts/Bash/Functions/Tuneup/tuneup.sh index b4a9efb..07c2442 100755 --- a/Scripts/Bash/Functions/Tuneup/tuneup.sh +++ b/Scripts/Bash/Functions/Tuneup/tuneup.sh @@ -29,13 +29,13 @@ function tuneup { local ACTIONNAM='' local ACTIONVAL='' - # Initialize name of rendition backend as an empty value. The name - # of rendition backend is determined automatically based on + # Initialize name of rendition format as an empty value. The name + # of rendition format is determined automatically based on # template file extension, later, when files are processed. - local TUNEUP_BACKEND='' + local TUNEUP_FORMAT='' - # Initialize absolute path to backend's base directory, the place - # where backend-specific directories are stored in. + # Initialize absolute path to format's base directory, the place + # where format-specific directories are stored in. local TUNEUP_BASEDIR="${CLI_FUNCDIR}/${CLI_FUNCDIRNAM}" # Initialize list of supported file extensions. This is, the file diff --git a/Scripts/Bash/Functions/Tuneup/tuneup_doBaseActions.sh b/Scripts/Bash/Functions/Tuneup/tuneup_doBaseActions.sh index 232ee5c..593daf2 100755 --- a/Scripts/Bash/Functions/Tuneup/tuneup_doBaseActions.sh +++ b/Scripts/Bash/Functions/Tuneup/tuneup_doBaseActions.sh @@ -27,8 +27,8 @@ function tuneup_doBaseActions { local TUNEUP_CONFIG_DIR='' - local TUNEUP_BACKEND_DIR='' - local TUNEUP_BACKEND_INIT='' + local TUNEUP_FORMAT_DIR='' + local TUNEUP_FORMAT_INIT='' local TUNEUP_EXTENSION='' local FILE='' local FILES='' @@ -39,28 +39,28 @@ function tuneup_doBaseActions { # Loop through list of supported file extensions. for TUNEUP_EXTENSION in ${TUNEUP_EXTENSIONS};do - # Define backend name based on supported file extensions. - TUNEUP_BACKEND="${TUNEUP_EXTENSION}" + # Define format name based on supported file extensions. + TUNEUP_FORMAT="${TUNEUP_EXTENSION}" - # Define absolute path to directory where backend-specific + # Define absolute path to directory where format-specific # functionalities are stored in. - TUNEUP_BACKEND_DIR="${TUNEUP_BASEDIR}/$(cli_getRepoName \ - ${TUNEUP_BACKEND} -d)" + TUNEUP_FORMAT_DIR="${TUNEUP_BASEDIR}/$(cli_getRepoName \ + ${TUNEUP_FORMAT} -d)" - # Define absolute path to backend initialization script. - TUNEUP_BACKEND_INIT="${TUNEUP_BACKEND_DIR}/$(cli_getRepoName ${TUNEUP_BACKEND} -f)" + # Define absolute path to format initialization script. + TUNEUP_FORMAT_INIT="${TUNEUP_FORMAT_DIR}/$(cli_getRepoName ${TUNEUP_FORMAT} -f)" - # Verify absolute path to backend initialization script. When - # a file extension is provided, but no backend initialization + # Verify absolute path to format initialization script. When + # a file extension is provided, but no format initialization # script exists for it, continue with the next file extension # in the list. - if [[ ! -f ${TUNEUP_BACKEND_INIT} ]];then + if [[ ! -f ${TUNEUP_FORMAT_INIT} ]];then continue fi - # Define absolute path to directory where backend-specific + # Define absolute path to directory where format-specific # configurations are retrived from. - TUNEUP_CONFIG_DIR="${TUNEUP_BACKEND_DIR}/Config" + TUNEUP_CONFIG_DIR="${TUNEUP_FORMAT_DIR}/Config" # Build list of files to process using action value as # reference. @@ -72,24 +72,24 @@ function tuneup_doBaseActions { continue fi - # Export backend-specific functionalities up to the + # Export format-specific functionalities up to the # execution environment. cli_exportFunctions "${TUNEUP_BASEDIR}/$(cli_getRepoName \ - ${TUNEUP_BACKEND} -d)" "${TUNEUP_BACKEND}" + ${TUNEUP_FORMAT} -d)" "${TUNEUP_FORMAT}" - # Execute backend-specific maintainance tasks. + # Execute format-specific maintainance tasks. for FILE in $FILES;do cli_printMessage "$FILE" --as-tuningup-line - ${TUNEUP_BACKEND} + ${TUNEUP_FORMAT} done - # Unset backend-specific functionalities from execution + # Unset format-specific functionalities from execution # environment. This is required to prevent end up with more - # than one backend-specifc function initialization, in those + # than one format-specifc function initialization, in those # cases when different template files are rendered in just one # execution of `centos-art.sh' script. cli_unsetFunctions "${TUNEUP_BASEDIR}/$(cli_getRepoName \ - ${TUNEUP_BACKEND} -d)" "${TUNEUP_BACKEND}" + ${TUNEUP_FORMAT} -d)" "${TUNEUP_FORMAT}" done diff --git a/Scripts/Bash/Functions/cli_unsetFunctions.sh b/Scripts/Bash/Functions/cli_unsetFunctions.sh index 0977480..9bf4e4b 100755 --- a/Scripts/Bash/Functions/cli_unsetFunctions.sh +++ b/Scripts/Bash/Functions/cli_unsetFunctions.sh @@ -38,7 +38,7 @@ function cli_unsetFunctions { SUFFIX=$CLI_FUNCNAME fi - # Define list of backend-specific functionalities. This is the + # Define list of format-specific functionalities. This is the # list of function definitions previously exported by # `cli_exportFunctions'. Be sure to limit the list to function # names that start with the suffix specified only.