From ed9d95b103a72465e2c81e66a43647e481e3dab7 Mon Sep 17 00:00:00 2001 From: "Paul W. Frields" Date: Fri, 9 Mar 2007 01:16:05 +0000 Subject: Yay, segmentedlists for everyone! --- en_US/module-struct.xml | 291 ++++++++++++++++++++++++++---------------------- 1 file changed, 158 insertions(+), 133 deletions(-) diff --git a/en_US/module-struct.xml b/en_US/module-struct.xml index 8e67b91..400df6b 100644 --- a/en_US/module-struct.xml +++ b/en_US/module-struct.xml @@ -41,48 +41,62 @@ | `-- Makefile]]> - - Primary language directory (required) - This is the only directory absolutely required. It is named for the - original language of the document, such as en_US (US English). The primary language - does not have to be US English; all languages are supported. This - directory contains all the XML source for the actual document, as well - as XML source for document-specific - entities - Think of an XML entity as a predefined snippet of information. - It can represent a chunk of XML source, or simply a word or - character. If the information changes, it need be replaced only - once, in the definition, to fix all usage. - . - - - - Graphics directory (optional) - The figs/ directory is an - optional directory where graphics for the document should be stored. If - graphics are screenshots that are particular to a language, the - figs/ directory can and should be - stored in a language directory. - - - Translation (PO) directory (optional) - The po/ directory contains - specially formatted files created and used by translators. The &FDP; - build tools use these files to create translated versions of documents. - The translated documents are not stored in CVS; they are created as - needed from these PO files. - - - Makefile (required) - The Makefile controls the build process. Its - content is discussed in . - - - <filename>rpm-info.xml</filename> (required) - The rpm-info.xml file contains document - specific metadata - + + CVS Module Contents + Component + Type + Usage Notes + + Primary language directory + required + This is the only directory absolutely required. It is named + for the original language of the document, such as en_US (US English). The + primary language does not have to be US English; all languages + are supported. This directory contains all the XML source for + the actual document, as well as XML source for + document-specific entities + Think of an XML entity as a predefined snippet of + information. It can represent a chunk of XML source, or + simply a word or character. If the information changes, it + need be replaced only once, in the definition, to fix all + usage. + . + + + Graphics directory + optional + The figs/ directory + is an optional directory where graphics for the document + should be stored. If graphics are screenshots that are + particular to a language, the figs/ directory can and should + be stored in a language directory. + + + Translation (PO) directory + optional + The po/ directory + contains specially formatted files created and used by + translators. The &FDP; build tools use these files to create + translated versions of documents. The translated documents are + not stored in CVS; they are created as needed from these PO + files. + + + Makefile + required + The Makefile controls the build + process. Its content is discussed in . + + + rpm-info.xml + required + The rpm-info.xml file contains + document specific metadata + +
The Document Build System @@ -109,7 +123,7 @@ Sample Document Makefile such as the XMLFILES_template stanza. An explanation for this template appears a few paragraphs below. - - <systemitem class="macro">DOCBASE</systemitem> - This variable contains the name for the main (parent) XML - document. Follow convention by naming your document after the - module name. - - - <systemitem class="macro">PRI_LANG</systemitem> - This variable contains the ISO code for the original - version of the document, such as - en_US. - - - <systemitem class="macro">OTHERS</systemitem> - This variable contains a listing of ISO codes for any - other versions into which the document has been translated. - The module must contain a po/ directory and a PO file for - any indicated additional languages. - - - <systemitem class="macro">DOC_ENTITIES</systemitem> - This variable contains a listing of any files containing - entity definitions. The &FDP; uses a special XML format to - record document-specific entities, so they can be translated and - built on the fly like any other XML document. An example is - shown later in this guide. - - - <systemitem - class="macro">XMLFILES_template</systemitem> - This template allows the build tools to work with the - document in multiple languages once it is translated. The - ${1} marking is a - variable used to substitute the appropriate language. This - template is not terribly complicated. For a new module, - duplicate this section exactly except for the actual - filenames. Prepend the text ${1}/, in place of the language - code directory name, to each filename in your document. - - + + Makefile Variables + Variable + Explanation + + DOCBASE + This variable contains the name for the main (parent) XML + document. Follow convention by naming your document after + the module name. + + + PRI_LANG + This variable contains the ISO code for the original + version of the document, such as + en_US. + + + OTHERS + This variable contains a listing of ISO codes for any + other versions into which the document has been translated. + The module must contain a po/ directory and a PO file + for any indicated additional languages. + + + DOC_ENTITIES + This variable contains a listing of any files containing + entity definitions. The &FDP; uses a special XML format to + record document-specific entities, so they can be translated + and built on the fly like any other XML document. An + example is shown later in this guide. + + + XMLFILES_template + This template allows the build tools to work with the + document in multiple languages once it is translated. The + ${1} marking is a + variable used to substitute the appropriate language. This + template is not terribly complicated. For a new module, + duplicate this section exactly except for the actual + filenames. Prepend the text ${1}/, in place of the language + code directory name, to each filename in your document. + + + Files Exempt From Listing Do not include the document-specific entities XML file or @@ -233,54 +253,59 @@ include ../docs-common/Makefile.common]]> To render the XML document into another format, use one of the following make targets: - - <systemitem class="macro">html</systemitem> - This target builds the "chunked" HTML - document for each defined translation. Output is placed in a - separate directory named ${DOCBASE}-${LANG}/. Each - document section is a separate file within that - directory. - - - <systemitem - class="macro">html-nochunks</systemitem> - This target builds the "non-chunked" HTML - document for each defined translation. Output is placed in a - single file: ${DOCBASE}-${LANG}.html; no other - files are created. - - - <systemitem class="macro">pdf</systemitem> - This target builds only the PDF document - for all document languages. PDF production is - currently erratic and may not work for your document. - - - <systemitem class="macro">tarball</systemitem> - This target builds only the tar(1) - archive for all document languages. - - - <systemitem class="macro">all</systemitem> - This target builds all targets listed above. - - - <systemitem class="macro">clean</systemitem> - This target deletes any temporary, or generated files, but - does not erase any HTML, - PDF, or archive files. - - - <systemitem class="macro">distclean</systemitem> - This target erases all HTML, - PDF, and archive files. This target - automatically invokes the clean target as - well. - + + Build Targets + Target + Explanation + + html + This target builds the "chunked" HTML + document for each defined translation. Output is placed in a + separate directory named ${DOCBASE}-${LANG}/. Each + document section is a separate file within that + directory. + + + html-nochunks + This target builds the "non-chunked" HTML + document for each defined translation. Output is placed in a + single file: ${DOCBASE}-${LANG}.html; no + other files are created. + + + pdf + This target builds only the PDF document + for all document languages. PDF production is + currently erratic and may not work for your document. + + + tarball + This target builds only the tar(1) + archive for all document languages. + + + all + This target builds all targets listed above. + + + clean + This target deletes any temporary, or generated files, but + does not erase any HTML, + PDF, or archive files. + + + distclean + This target erases all HTML, + PDF, and archive files. This target + automatically invokes the clean target as + well. + +
Adding or Changing Targets -- cgit