5285d6 Update `manual' functionality:

Authored and Committed by areguera 13 years ago
20 files changed. 231 lines added. 308 lines removed.
Scripts/Bash/Functions/Manual/manual.sh
file modified
+5 -34
Scripts/Bash/Functions/Manual/manual_checkChapter.sh
file modified
+2 -2
Scripts/Bash/Functions/Manual/manual_deleteCrossReferences.sh
file modified
+9 -6
Scripts/Bash/Functions/Manual/manual_deleteEntry.sh
file modified
+35 -22
Scripts/Bash/Functions/Manual/manual_getActions.sh
file modified
+29 -59
Scripts/Bash/Functions/Manual/manual_getEntry.sh
file modified
+28 -37
Scripts/Bash/Functions/Manual/manual_restoreCrossReferences.sh
file modified
+8 -5
Scripts/Bash/Functions/Manual/manual_searchIndex.sh
file modified
+1 -46
Scripts/Bash/Functions/Manual/manual_searchNode.sh
file modified
+1 -1
Scripts/Bash/Functions/Manual/manual_updateChaptersFiles.sh
file modified
+13 -18
Scripts/Bash/Functions/Manual/manual_updateChaptersMenu.sh
file modified
+13 -13
Scripts/Bash/Functions/Manual/manual_updateChaptersNodes.sh
file modified
+4 -4
Scripts/Bash/Functions/Manual/manual_updateMenu.sh
file modified
+4 -4
Scripts/Bash/Functions/Manual/manual_updateNodes.sh
file modified
+7 -17
Scripts/Bash/Functions/Manual/manual_updateOutputFileHtml.sh
file modified
+8 -8
Scripts/Bash/Functions/Manual/manual_updateOutputFileInfo.sh
file modified
+7 -14
Scripts/Bash/Functions/Manual/manual_updateOutputFilePdf.sh
file modified
+6 -7
Scripts/Bash/Functions/Manual/manual_updateOutputFilePlaintext.sh
file modified
+5 -8
Scripts/Bash/Functions/Manual/manual_updateOutputFileXml.sh
file added
+36
Scripts/Bash/Functions/Manual/manual_updateOutputFiles.sh
file modified
+10 -3
    Update `manual' functionality:
    
        - Update locations of documentation manuals. Manuals are directly
          stored under trunk/Manuals/ directory structure as described
          below:
    
            Initializing
            ------------
            trunk/Manual/${NAME}/${NAME}-index.texi
            trunk/Manual/${NAME}/${NAME}-menu.texi
            trunk/Manual/${NAME}/${NAME}-nodes.texi
            trunk/Manual/${NAME}/${NAME}.texi
    
            Structuring
            -----------
            trunk/Manual/${NAME}/Chapter-${NUM}/chapter-intro.texi
            trunk/Manual/${NAME}/Chapter-${NUM}/chapter-menu.texi
            trunk/Manual/${NAME}/Chapter-${NUM}/chapter-nodes.texi
            trunk/Manual/${NAME}/Chapter-${NUM}/chapter.texi
            trunk/Manual/${NAME}/Chapter-${NUM}/section-${NUM}.texi
    
            Exporting
            ---------
            trunk/Manual/${NAME}/${NAME}.info.bz2
            trunk/Manual/${NAME}/${NAME}.pdf
            trunk/Manual/${NAME}/${NAME}.xml
            trunk/Manual/${NAME}/${NAME}-es_ES.xml
            trunk/Manual/${NAME}/${NAME}-html/
            ...
    
            When $NAME is used as directory it follows the convenction
            used to create directories inside the repository (the first
            letter is uppercase and the rest letters are in lowercase).
            Likewise, when $NAME is used as file it follows the
            convenction used to create files inside the repository (all
            letters in lowercase).
    
            The value of $NUM starts in number one arabic format (i.e.,
            `1') and increments one for each new chapter or section added.
    
            At this moment, automation of documentation manual is
            available for Repository documentation manual only. The
            Repository documentation manual organization is a bit
            different compared to that organization we consider to
            implement on generic documentation manuals under trunk/Manuals
            directory structure. 
            
            So, since the organizational point of view, we have two
            different kinds of documentation manuals. However, these two
            different organizational structures are handled by the same
            manual functionality.
    
            The main difference between Repository documentation manual
            organization and generic documentation manual organization is
            that Repository documentation manual takes its organization
            from the CentOS Artwork Repository directory structure itself,
            while generic documentation manuals take their organization
            from what the writer considers better for the purpose of the
            very specific documentation manual she/he is planning to write
            on.
    
            The Repository documentation manual documents directory
            structures of CentOS Artwork Repository only, while generic
            documentation manuals can cover very different topics that
            could be or not related to CentOS Artwork Repository (e.g.,
            release notes, planification manuals, etc.).
    
        - Remove localization from new sections created from template
          files. All information is produced in English language.
          Translations are made through XML output, xml2po and gettext.
    
        - Add manual_updateOutputFileXml.sh. The --docbook option of
          makeinfo seems to produced not very well formed DocBook
          documents at this moment. However, the --xml option of makeinfo
          produces beautiful xml documents we could use to produce
          translated xml files through xml2po and gettext.
    
        - Update variable names. Array variables are no longer used to
          store path information. Most of needs are covered by
          MANUAL_BASEDIR, MANUAL_DIR, MANUAL_BASEFILE, MANUAL_CHA_NAME and
          MANUAL_DIR_CHAPTER variables.