From 0134f0317b0e93d5d950cdb7e8a9a2f5f91103bc Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Jun 12 2011 21:14:44 +0000 Subject: Update en_US/Directories/trunk/Manuals.texinfo. --- diff --git a/Manuals/Repository/en_US/Directories/trunk/Manuals.texinfo b/Manuals/Repository/en_US/Directories/trunk/Manuals.texinfo index 4ec2167..320ad8a 100644 --- a/Manuals/Repository/en_US/Directories/trunk/Manuals.texinfo +++ b/Manuals/Repository/en_US/Directories/trunk/Manuals.texinfo @@ -8,78 +8,30 @@ how automation scripts make use of them. @subheading Description -The repository documentation manual is made of the following files: - -@table @file - -@item repository.css - -This file controls the visual style for XHTML output files of -repository documentation manual. - -@item repository-index.texinfo - -This file controls the index definition for source files of repository -documentation manual. - -@item repository.info.bz2 - -This file provides the Info output of repository documentation manual. - -@item repository-init.pl - -This file provides the initialization script of @command{texi2html}, -the program used by @command{centos-art.sh} script to produce the -XHTML output of repository documentation manual. - -@item repository-menu.texinfo - -This file controls the menu definition of chapters for source files of -repository documentation manual. - -@item repository-node.texinfo - -This file controls the node definition of chapters for source files of -repository documentation manual. - -@item repository.pdf - -This file provides the PDF output of repository documentation manual. - -@item repository.sed - -This file provides post-transformations for XHTML output files. In -this file is where XHTML definitions for admonitions are set in. - -@item repository.texinfo - -This is the source file of repository documentation manual where -the manual structure initialization is set. -manual. - -@item repository.txt.bz2 - -This file provides the TXT output of repository documentation manual. - -@item repository.xhtml.bz2 - -This file provides the XHTML output of repository documentation -manual. - -@item repository.xml - -This file provides the XML output of repository documentation manual. - -@end table - -The repository documentation manual is made of the following -directories: - -@itemize -@item @xref{Directories trunk Manuals Directories}. -@item @xref{Directories trunk Manuals Introduction}. -@item @xref{Directories trunk Manuals Licenses}. -@end itemize +The documentation work line exists to describe what each directory +inside the CentOS Artwork Repository is for, the conceptual ideas +behind them and, if possible, how automation scripts make use of them. + +The CentOS Artwork Repository documentation is supported by Texinfo, a +documentation system that uses a single source file to produce both +online information and printed output. + +The repository documentation is organized under @file{trunk/Manual} +directory and uses the repository directory structre as reference. +Each directory in the repository has a documentation entry associated +in the documentation manual. Documentation entries are stored under +@file{trunk/Manual/Directories} directory and the action itself is +controlled by the @code{help} functionality of @command{centos-art.sh} +script. + +The @code{help} functionality let you create, edit and delete +documentation entries in a way that you don't need to take care of +updating menus, nodes and cross reference information inside the +manual structure; the functionality takes care of it for you. +However, if you need to write repository documentation that have +nothing to do with repository directories (e.g., Preface, Introduction +and similar) you need to do it manually, there is no functionality to +automate such process yet. @subheading Usage