edaa9d Update `texinfo' documentation backend inside `help' functionality:

Authored and Committed by areguera 13 years ago
28 files changed. 845 lines added. 452 lines removed.
Scripts/Functions/Help/Texinfo/Templates/manual.conf
file modified
+4 -4
Scripts/Functions/Help/Texinfo/texinfo.sh
file modified
+97 -75
Scripts/Functions/Help/Texinfo/texinfo_copyEntry.sh
file modified
+68 -70
Scripts/Functions/Help/Texinfo/texinfo_copyEntryChapter.sh
file added
+82
Scripts/Functions/Help/Texinfo/texinfo_copyEntryManual.sh
file added
+75
Scripts/Functions/Help/Texinfo/texinfo_copyEntrySection.sh
file added
+74
Scripts/Functions/Help/Texinfo/texinfo_createChapters.sh
file modified
+66 -29
Scripts/Functions/Help/Texinfo/texinfo_createStructure.sh
file modified
+23 -26
Scripts/Functions/Help/Texinfo/texinfo_createStructureChapters.sh
file modified
+9 -7
Scripts/Functions/Help/Texinfo/texinfo_deleteCrossReferences.sh
file modified
+1 -1
Scripts/Functions/Help/Texinfo/texinfo_deleteEntry.sh
file modified
+4 -4
Scripts/Functions/Help/Texinfo/texinfo_editEntry.sh
file modified
+9 -24
Scripts/Functions/Help/Texinfo/texinfo_getEntry.sh
file modified
+8 -39
Scripts/Functions/Help/Texinfo/texinfo_getNode.sh
file modified
+3 -2
Scripts/Functions/Help/Texinfo/texinfo_renameCrossReferences.sh
file modified
+5 -5
Scripts/Functions/Help/Texinfo/texinfo_renameEntry.sh
file modified
+3 -3
Scripts/Functions/Help/Texinfo/texinfo_restoreCrossReferences.sh
file modified
+1 -1
Scripts/Functions/Help/Texinfo/texinfo_searchIndex.sh
file modified
+1 -1
Scripts/Functions/Help/Texinfo/texinfo_searchNode.sh
file modified
+12 -21
Scripts/Functions/Help/Texinfo/texinfo_updateChaptersMenu.sh
file modified
+13 -6
Scripts/Functions/Help/Texinfo/texinfo_updateChaptersNodes.sh
file modified
+7 -6
Scripts/Functions/Help/Texinfo/texinfo_updateMenu.sh
file modified
+29 -28
Scripts/Functions/Help/Texinfo/texinfo_updateNodes.sh
file modified
+37 -28
Scripts/Functions/Help/Texinfo/texinfo_updateOutputFiles.sh
file modified
+6 -6
Scripts/Functions/Help/Texinfo/texinfo_updateStructureSection.sh
file added
+88
Scripts/Functions/Help/help.sh
file modified
+72 -24
Scripts/Functions/Help/help_getEntries.sh
file modified
+39 -26
Scripts/Functions/Help/help_getOptions.sh
file modified
+9 -16
    Update `texinfo' documentation backend inside `help' functionality:
    
        - The ACTIONVAL variable is no longer used. Instead, the
          MANUAL_SLFN, MANUAL_DIRN, MANUAL_CHAN and MANUAL_SECN array
          variables are used. These array variables simulate a
          bidimensional array that increments parallelly on each
          non-option argument passed to `centos-art.sh' script.  Each
          array entry consists on the following information:
    
            1. The manual name information. This value is stored in the
            MANUAL_SLFN array. The manual name is always lower case and is
            used to build the manual's main definition file.
    
            2. The manual directory name. This value is stored in the
            MANUAL_DIRN array. The manual directory name is always
            capitalized and is used to store the manual's main definition
            files as well as auxiliar files (e.g., chapters and sections
            definitions).
    
            3. The chapter name. This value is stored in the MANUAL_CHAN
            array. The chapter name is always capitalized and is used to
            define the chapter directory where all documentation actions
            will take place on.
    
            4. The section name. This value is stored in the MANUAL_SECN
            array. The section name is always in lower case and is used to
            define the section's definition file where documentation
            actions will take place on.
    
        - The `--manual' option is no longer used. Instead, non-option
          arguments passed to `centos-art.sh' script are used to provide
          all information required to work with manuals, chapters inside
          manuals and sections inside chapters. As convenction, when using
          texinfo documentation backend, non-option arguments must be
          specified with the `MANUAL:CHAPTER:SECTION' format. To separate
          words, you can use the minus sign (e.g.,
          `TCAR-UG:Directories:trunk-identity').
    
        - Add `texinfo_copyEntryManual', `texinfo_copyEntryChapter',
          `texinfo_copyEntrySection' to improve the way manuals, chapters
          and sections, respectively, are duplicated inside the working
          copy.  Now, you can:
    
            - Duplicate sections inside the same chapter.  For example, 
              
                centos-art help --copy MANSRC:CHASRC:SECSRC MANSRC:CHASRC:SECDST
    
            - Duplicate sections from one chapter to another different.
              For example,
    
                centos-art help --copy MANSRC:CHASRC:SECSRC MANSRC:CHADST:SECSRC
                centos-art help --copy MANSRC:CHASRC:SECSRC MANSRC:CHADST:SECDST
                centos-art help --copy MANSRC:CHASRC:SECSRC MANSRC:CHADST
    
            - Duplicate chapters inside a manual. For example, 
    
                centos-art help --copy MANSRC:CHASRC MANSRC:CHADST
    
            - Duplicate manuals inside the working copy. For example,
    
                centos-art help --copy MANSRC MANDST
    
        - When new documentaion manuals written in texinfo format are
          created for very first time, they are created using all chapters
          definitions available inside the documentation template
          directory with the exception of `Chapters' directory, which is
          used to store chapter's and section's main definition files.
    
          In this commit, only a `Licenses' chapter is inside
          documentation template directory. This chapter contains the
          license information refered inside the manual and shouldn't be
          removed.  This chapter is defined as appendix to differentiate
          it from regular chapters inside the manual.
    
          In addition to `Licenses' directory, the `Index' chapter is
          added too. This chapter is unnumbered.
    
        - Add `texinfo_updateStructureSection.sh' file. This function
          looks for all documentation entry (section) files inside the
          manual's base directory and updates menu, nodes and cross
          references for them.
    
        - Rename MANUAL_BACKEND variable name to FLAG_BACKEND.
    
    
        
file modified
+72 -24