From 6f2bd0f240437725d38a4a2a770dfd68257698e0 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Aug 13 2011 03:12:45 +0000 Subject: Update `Manuals/Texinfo/templates.docbook'. --- diff --git a/Manuals/Tcar-ug/Manuals/Texinfo/templates.docbook b/Manuals/Tcar-ug/Manuals/Texinfo/templates.docbook index c5b9d9a..cdd5a4d 100644 --- a/Manuals/Tcar-ug/Manuals/Texinfo/templates.docbook +++ b/Manuals/Tcar-ug/Manuals/Texinfo/templates.docbook @@ -1,6 +1,104 @@ + Texinfo Document Templates - ... - + + Texinfo document templates provide the texinfo document design + model that centos-art.sh script needs to + create and maintain texinfo document structures like that one + described in . + + + + Texinfo document templates are language-specific. This means + that there is one texinfo document template for each language + you want to write documentation manuals in texinfo format. + This is required because, when we write documentation manuals + in texinfo format, it is not possible to retrive translatable + strings from source files so translators can localize + documentation source files to other languages, independently + from documentors. To create documentation manuals in + different languages, it is required to write a complete + texinfo document structure for each language you plan to + write one documentation manual for; or what might be the same, + to duplicate the source documenation manual you want to + translate and do the translation inside the source files + themselves. This way, in order for the help + functionality of centos-art.sh script to + support creation and maintainance of documentation manual in + different languages, it is necessary that one texinfo document + template be available for each language you pretend to + support. + + + + In order to create texinfo document templates in different + languages, duplicate the texinfo document template used to + build documentation manuals in English language (trunk/Scripts/Functions/Help/Texinfo/Templates/en_US) + to a new directory at the same directory level and using the + language and country codification described in the standards + iso-639 and iso-3166, respectively. Once the directory has + been duplicated, get into it and localize all the files + inside it. At this point, after localizing files, the recently + created language-specific texinfo document template is ready + for production. + + + + When you write documentation manuals for a language that + doesn't have a language-specific texinfo document template, + then the texinfo document template written in English language + is used for that document. + + + + + The directory structure used to organize texinfo document + templates take place under trunk/Scripts/Functions/Help/Texinfo/Templates + directory, as displayed in . In this structure, + files like manual-ini.pl, + manual.sed and + manual.conf aren't related to manual's + source files, but manual's output files. Some of these files + are inside and outside language-specific directories in order + to control common and specific output settings through them. + + + + Texinfo document template + + Texinfo document template + + + trunk/Scripts/Functions/Help/Texinfo/Templates +|-- $LANG +| |-- Chapters +| | |-- chapter-menu.texinfo +| | |-- chapter-nodes.texinfo +| | |-- chapter.texinfo +| | `-- section.texinfo +| |-- Licenses +| | |-- GFDL.texinfo +| | |-- GPL.texinfo +| | |-- chapter-menu.texinfo +| | |-- chapter-nodes.texinfo +| | `-- chapter.texinfo +| |-- manual-index.texinfo +| |-- manual-init.pl +| |-- manual-menu.texinfo +| |-- manual-nodes.texinfo +| |-- manual.conf +| |-- manual.sed +| `-- manual.texinfo +|-- manual-init.pl +`-- manual.sed + + + + + +