From 062af2c3b58e6b38589b13b5e7f0d8338b0cdfc0 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Aug 10 2011 16:52:39 +0000 Subject: Update `Manuals/Texinfo/structure.docbook'. --- diff --git a/Manuals/Tcar-ug/Manuals/Texinfo/structure.docbook b/Manuals/Tcar-ug/Manuals/Texinfo/structure.docbook index 5a01699..75f7982 100644 --- a/Manuals/Tcar-ug/Manuals/Texinfo/structure.docbook +++ b/Manuals/Tcar-ug/Manuals/Texinfo/structure.docbook @@ -5,21 +5,21 @@ The document structure provided by texinfo backend creates the organization needed to make documentation manuals scalable and - maintainable through time. Structuring considerations follows + maintainable through time. Structuring considerations follow the idea of an upside-down tree to organize chapters, sections, subsections, and the like. The document initiates - with a Top node where we place document title, copyright note, - abstract, and the list of chapters. Inside each chapter the - information is logically organized in sections, subsections - and subsubsections. + with a Top node which contains manual's main definitions + (e.g., title, copyright note, abstract, and the list of + chapters). Inside each chapter the information is logically + organized in sections, subsections and subsubsections. - The first time you create a documentation manual through + The first time the documentation structure is created through texinfo backend, the centos-art.sh script considers the working directory you are placed in order to - determine where to store the documentation manual. When the - current working directory is branches/Manuals/Texinfo, the documentation manual directory is created therein. On all other situations, the documentation manual directory is @@ -28,22 +28,31 @@ the documentation manual directory has been created, the centos-art.sh script creates its definition files in conjuction with an appendix named - Licenses. The content of licenses stored in - the Licenses appendix isn't inside the documentation manual - directory but refered from texinfo document templates, as - described at , so - the help functionality cannot control it. + Licenses. The content stored in the Licenses + appendix isn't inside the documentation manual directory + itself, but refered from texinfo document templates as + described at . - Inside the documentation manual directory, the + Inside the documentation manual directory, source files are + all stored inside language-specific directories. + Language-specific directories are necessary to implement + localization of source files written in texinfo format, as + described in . + + + + Inside the language-specific directory, the ${MANUAL_NAME}.texinfo, ${MANUAL_NAME}-index.texinfo, ${MANUAL_NAME}-menu.texinfo and ${MANUAL_NAME}-nodes.texinfo files exist to - set manual's main definitions; including title, copyright - notice, chapters, appendixes, indexes and all the similar - stuff a documentation manual should have. Inside each chapter + set manual's main definitions (e.g., title, subtitle, author, + copyright notice, chapters, appendixes, indexes and all the + similar stuff a documentation manual should have). In + addition to these files, there is one directory for each + chapter created inside the manual. Inside each chapter directory, the chapter.texinfo, chapter-menu.texinfo and chapter-nodes.texinfo files exist to @@ -51,14 +60,14 @@ stored in. The documentation manual content itself is stored in section files (a.k.a. documentation entries) suffixed with texinfo - extension and arbitrarily named, as describes. + extension and arbitrary names, as it is displayed in . - - Texinfo document structure. + + Texinfo document structure - Texinfo document structure. + Texinfo document structure trunk/Manuals/${MANUAL_NAME}