Blame Scripts/Bash/Functions/Help/Texinfo/texinfo_getEntryTitle.sh

878a2b
#!/bin/bash
878a2b
#
878a2b
# texinfo_getEntryTitle.sh -- This function standardizes the way entry
878a2b
# titles for chapters and sections are printed out.
878a2b
#
03486a
# Copyright (C) 2009, 2010, 2011, 2012 The CentOS Project
878a2b
#
878a2b
# This program is free software; you can redistribute it and/or modify
878a2b
# it under the terms of the GNU General Public License as published by
878a2b
# the Free Software Foundation; either version 2 of the License, or (at
878a2b
# your option) any later version.
878a2b
#
878a2b
# This program is distributed in the hope that it will be useful, but
878a2b
# WITHOUT ANY WARRANTY; without even the implied warranty of
878a2b
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
878a2b
# General Public License for more details.
878a2b
#
878a2b
# You should have received a copy of the GNU General Public License
878a2b
# along with this program; if not, write to the Free Software
878a2b
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
878a2b
#
878a2b
# ----------------------------------------------------------------------
878a2b
# $Id$
878a2b
# ----------------------------------------------------------------------
878a2b
878a2b
function texinfo_getEntryTitle {
878a2b
878a2b
    # Initialize phrase we want to transform based on style provided.
878a2b
    local PHRASE="$1"
878a2b
878a2b
    # Define section style. Through this property you can customize
878a2b
    # the section title in predefined ways.  By default, section
878a2b
    # titles are printed with each word capitalized (`cap-each-word').
878a2b
    # Other values to this option are `cap-first-only' (to capitalize
878a2b
    # just the first word in the title) or `directory' to transform
878a2b
    # each word to a directory path.
878a2b
    local MANUAL_SECTION_STYLE=$(cli_getConfigValue "${MANUAL_CONFIG_FILE}" "main" "manual_section_style")
878a2b
    if [[ ! $MANUAL_SECTION_STYLE =~ '^(cap-each-word|cap-first-only|directory)$' ]];then
878a2b
        MANUAL_SECTION_STYLE='cap-each-word'
878a2b
    fi
878a2b
878a2b
    # Verify section style provided and transform the phrase value in
878a2b
    # accordance with it.
878a2b
    case $MANUAL_SECTION_STYLE in
878a2b
878a2b
        'cap-first-only' )
878a2b
878a2b
            # In the entire phrase provided, capitalize the first word
878a2b
            # only.
878a2b
            PHRASE=$(echo "${PHRASE}" | tr '[:upper:]' '[:lower:]' \
878a2b
                | sed -r 's!^([[:alpha:]])!\u\1!')
878a2b
            ;;
878a2b
878a2b
        'directory' )
878a2b
878a2b
            # In the entire phrase provided, concatenate all words
878a2b
            # with slash (/) character and remark the fact it is a
878a2b
            # directory.
878a2b
            PHRASE=$(echo "${PHRASE}" | sed -r \
878a2b
                -e 's/(Trunk|Branches|Tags)/\l\1/' \
878a2b
                -e 's/ /\//g' \
878a2b
                -e 's/\/([[:alpha:]])/\/\u\1/g')
878a2b
878a2b
            PHRASE="@file{$PHRASE}"
878a2b
            ;;
878a2b
878a2b
        'cap-each-word' | * )
878a2b
878a2b
            # In the entire phrase provided, capitalize all words.
878a2b
            PHRASE=$(echo "${PHRASE}" | tr '[:upper:]' '[:lower:]' \
878a2b
                | sed -r 's!\<([[:alpha:]]+)\>!\u\1!g')
878a2b
            ;;
878a2b
878a2b
    esac
878a2b
878a2b
    # Output transformed phrase.
878a2b
    echo "$PHRASE"
878a2b
878a2b
}