diff --git a/Manuals/Userguide/Identity.docbook b/Manuals/Userguide/Identity.docbook index a592006..b357b4f 100644 --- a/Manuals/Userguide/Identity.docbook +++ b/Manuals/Userguide/Identity.docbook @@ -1,14 +1,36 @@ - Identity + Visual Identity ... + The CentOS Distribution + ... + + ... ... + + + + + + The CentOS Web-Environment + ... + + + ... + ... + + + + + + The CentOS Showroom + ... ... diff --git a/Manuals/Userguide/Manuals.docbook b/Manuals/Userguide/Manuals.docbook index e8d1b16..3f0f888 100644 --- a/Manuals/Userguide/Manuals.docbook +++ b/Manuals/Userguide/Manuals.docbook @@ -1,21 +1,20 @@ - + Documentation - ... - - - - ... - ... + + This part describes the repository's documentation work + line. Here you'll find how documentation backends inside + The CentOS Distribution are used to produce documentation + manuals inside The CentOS + Artwork Repository. + - - ... - ... - + - + &manuals-texinfo; + &manuals-docbook; diff --git a/Manuals/Userguide/Manuals.ent b/Manuals/Userguide/Manuals.ent index c1569ac..5919e6d 100644 --- a/Manuals/Userguide/Manuals.ent +++ b/Manuals/Userguide/Manuals.ent @@ -1 +1,8 @@ - + + + + + + + + diff --git a/Manuals/Userguide/Manuals/Docbook.docbook b/Manuals/Userguide/Manuals/Docbook.docbook new file mode 100644 index 0000000..f7cff53 --- /dev/null +++ b/Manuals/Userguide/Manuals/Docbook.docbook @@ -0,0 +1,20 @@ + + + The DocBook backend + + + Overview + ... + + + + How to create new manuals + ... + + + + How to maintain manuals + ... + + + diff --git a/Manuals/Userguide/Manuals/Texinfo.docbook b/Manuals/Userguide/Manuals/Texinfo.docbook new file mode 100644 index 0000000..3424f68 --- /dev/null +++ b/Manuals/Userguide/Manuals/Texinfo.docbook @@ -0,0 +1,11 @@ + + + The Texinfo backend + + &manuals-texinfo-intro; + &manuals-texinfo-structure; + &manuals-texinfo-templates; + &manuals-texinfo-localizing; + &manuals-texinfo-encoding; + + diff --git a/Manuals/Userguide/Manuals/Texinfo/encoding.docbook b/Manuals/Userguide/Manuals/Texinfo/encoding.docbook new file mode 100644 index 0000000..e77e506 --- /dev/null +++ b/Manuals/Userguide/Manuals/Texinfo/encoding.docbook @@ -0,0 +1,5 @@ + + Document encoding + ... + + diff --git a/Manuals/Userguide/Manuals/Texinfo/intro.docbook b/Manuals/Userguide/Manuals/Texinfo/intro.docbook new file mode 100644 index 0000000..7410942 --- /dev/null +++ b/Manuals/Userguide/Manuals/Texinfo/intro.docbook @@ -0,0 +1,30 @@ + + + Introduction + + + Documentation manuals that use + Texinfo as documentation backend + are conceived 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. They provides a documentation entry for each directory + inside the repository and, this way, a place to document it. + + + + Most actions related to Texinfo documentation backend (e.g., + editing, reading, copying, renaming, etc.) are controlled by + the help functionality as described in + . Through this + functionality you can manipulate documentation entries in a + way that you don't need to take care of updating menus, nodes + and cross reference information inside the manual source files + because 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 by your own, there + is no functionality to help you doing such things, yet. + + + diff --git a/Manuals/Userguide/Manuals/Texinfo/localizing.docbook b/Manuals/Userguide/Manuals/Texinfo/localizing.docbook new file mode 100644 index 0000000..d2f1d05 --- /dev/null +++ b/Manuals/Userguide/Manuals/Texinfo/localizing.docbook @@ -0,0 +1,4 @@ + + Document localization + ... + diff --git a/Manuals/Userguide/Manuals/Texinfo/structure.docbook b/Manuals/Userguide/Manuals/Texinfo/structure.docbook new file mode 100644 index 0000000..c6c36b5 --- /dev/null +++ b/Manuals/Userguide/Manuals/Texinfo/structure.docbook @@ -0,0 +1,116 @@ + + + Document structure + + + Based on the fact that there is only one repository directory + structure to document, there is only one documentation manual + structure based on Texinfo documentation backend to maintain, + for each language we want to provide support. + + + + Each language-specific documentation structure based on + Texinfo documentation backend is stored in the trunk/Manuals/Repository + directory. Inside this location, we use the file + repository-init.pl, + repository.css and + repository.sed to control common + characteristics of all language-specific document structures + (e.g., common initialization of texi2html + as well as common visual styles and transformations applied to + final XHTML output). + + + + Texinfo document structure. + + Texinfo document structure. + + + trunk/Manuals/Repository +|-- $LANG +| |-- Directories +| | |-- chapter-menu.texinfo +| | |-- chapter-nodes.texinfo +| | |-- chapter.texinfo +| | |-- trunk/Identity.texinfo +| | `-- trunk.texinfo +| |-- Introduction +| | |-- chapter-menu.texinfo +| | |-- chapter-nodes.texinfo +| | |-- chapter.texinfo +| | `-- history.texinfo +| |-- Licenses +| | |-- chapter-menu.texinfo +| | |-- chapter-nodes.texinfo +| | `-- chapter.texinfo +| |-- repository-index.texinfo +| |-- repository-menu.texinfo +| |-- repository-nodes.texinfo +| `-- repository.texinfo +|-- repository-init.pl +|-- repository.css +`-- repository.sed + + + + + + + Inside each language-specific directory, we have the Introduction, Directories and Licenses directories to cover + manual's introduction, documentation of repository directories + and license information. In addition to these directories, we + also have the repository.texinfo, + repository-index.texinfo, + repository-menu.texinfo and + repository-nodes.texinfo files to make up + the manual's main structure (e.g., title, copyright notice, + chapters, appendixes, indexes and all the similar stuff a + documentation manual should have). + + + + Inside chapter directories, we have at least the files + chapter.texinfo, + chapter-menu.texinfo and + chapter-nodes.texinfo to control section + definitions inside the chapter. In addition to these files, we + have documentation entries to store the information itself. + + + + Inside Introduction + directory, documentation entries are managed without any + functionality's help, you need to take care of them by your + own. + + + + Inside Directories + directory, documentation entries are all managed by the + help functionality and you don't need to + take care of them. To manage documentation entries here you + need to use the help functionality as + described in . + + + + Inside Licenses + directory, there aren't documentation entries. Instead, they + are imported from trunk/Scripts/Functions/Help/Templates/$LANG/Licenses/ + directory. We did it this way to reuse license files when + different language-specific document structures, based on + Texinfo documentation backend, are created for first time. + There is no need to duplicate the license files inside each + language-specific document structure if they can be placed in + a single location and then be imported to reduce the amount of + files in need of maintainance. + + + diff --git a/Manuals/Userguide/Manuals/Texinfo/templates.docbook b/Manuals/Userguide/Manuals/Texinfo/templates.docbook new file mode 100644 index 0000000..9d29e9b --- /dev/null +++ b/Manuals/Userguide/Manuals/Texinfo/templates.docbook @@ -0,0 +1,6 @@ + + Document templates + ... + + + diff --git a/Manuals/Userguide/Scripts.docbook b/Manuals/Userguide/Scripts.docbook index f80f2c6..3645deb 100644 --- a/Manuals/Userguide/Scripts.docbook +++ b/Manuals/Userguide/Scripts.docbook @@ -1,4 +1,4 @@ - + Automation @@ -6,16 +6,7 @@ ... - - ... - ... - - - ... - ... - - - + &scripts-bash; diff --git a/Manuals/Userguide/Scripts.ent b/Manuals/Userguide/Scripts.ent index fb2149b..a0e60e5 100644 --- a/Manuals/Userguide/Scripts.ent +++ b/Manuals/Userguide/Scripts.ent @@ -1 +1,9 @@ - + + + + + + + + + diff --git a/Manuals/Userguide/Scripts/Bash.docbook b/Manuals/Userguide/Scripts/Bash.docbook new file mode 100644 index 0000000..903a882 --- /dev/null +++ b/Manuals/Userguide/Scripts/Bash.docbook @@ -0,0 +1,13 @@ + + + The <command>centos-art.sh</command> script + + &scripts-bash-intro; + &scripts-bash-design; + &scripts-bash-render; + &scripts-bash-locale; + &scripts-bash-help; + &scripts-bash-prepare; + &scripts-bash-tuneup; + + diff --git a/Manuals/Userguide/Scripts/Bash/design.docbook b/Manuals/Userguide/Scripts/Bash/design.docbook new file mode 100644 index 0000000..1521d7d --- /dev/null +++ b/Manuals/Userguide/Scripts/Bash/design.docbook @@ -0,0 +1,4 @@ + + The script design + ... + diff --git a/Manuals/Userguide/Scripts/Bash/help.docbook b/Manuals/Userguide/Scripts/Bash/help.docbook new file mode 100644 index 0000000..cbef852 --- /dev/null +++ b/Manuals/Userguide/Scripts/Bash/help.docbook @@ -0,0 +1,269 @@ + + + The <function>help</function> functionality + + + The help functionality is the interface + the centos-art.sh script provides to + control frequent documentation tasks (e.g., reading, editing, + update output files, etc.) requied by specific documentation + backends. Documentation backends supported by + help functionality are described in . + + + + + Synopsis + + + centos-art help [OPTIONS] path/to/dir … + + + + The path/to/dir parameter specifies + the directory structure inside the working copy of The + CentOS Artwork Repository you want to process the related + documentation entry for. More than one directory structure + can be passed as path/to/dir + parameter. + + + + The help functionality accepts the + following options: + + + + + + + + Supress all output messages except error messages. + When this option is passed, all confirmation requests + are supressed as well and a possitive answer is + assumed for them, just as if the + option had been + provided. + + + + + + + + + Assume yes to all confirmation requests. + + + + + + + + + Supress all commit and update actions realized over + files, before and after the action itself had took + place over files in the working copy. + + + + + + + + + Specify STRING as + default documentation backend to use. Possible + arguments to this options are: + texinfo + or docbook. If this option is not + provided, texinfo is used as + default documentation backend. + + + + + + + + + Go to node pointed by index entry STRING. + + + + + + + + + Edit documentation entry related to path specified by + path/to/dir parameter. + + + The path/to/dir parameter must + point to any directory inside the repository. When + more than one path/to/dir are + passed as non-option arguments to the + centos-art.sh script command-line, + they are queued for further edition. The edition + itself takes place through your default text editor + (e.g., the one you specified in the + EDITOR environment variable) and the + text editor opens one file at time (i.e., the queue of + files to edit is not loaded in the text editor.). + + + + + + + + + Read documentation entry specified by + path/to/dir path. This option + is used internally by centos-art.sh + script to print out the reference you can follow to + know more about an error message. + + + + + + + + + Update output files rexporting them from the specified + backend source files. + + + + + + + + + Duplicate documentation entries inside the working + copy of the repository. + + + When documentation entries are copied, it is required + to pass two non-option parameters in the command-line. + The first non-option parameter is considered the + source location and the second one the target + location. Both source location and target location + must point to a directory under the working copy. + + + + + + + + + Delete documentation entries specified by + path/to/dir inside the working + copy. It is possible to delete more than one + documentation entry by specifying more + path/to/dir parameters in the + command-line. + + + + + + + + + Rename documentation entries inside the working copy. + + + When documentation entries are renamed, it is required + to pass only two non-option parameters to the + command-line. The first non-option parameter is + considered the source location and the second one the + target location. Both source location and target + location must point to a directory under the working + copy. + + + + + + + + + When documentation entries are removed (e.g., through + or + options), the help functionality + takes care of updating nodes, menus and cross references + related to documentation entries in order to keep the + manual structure in a correct state. + + + + + + + Examples + + + + + centos-art help --edit trunk/Identity + + + This command edits the documentation entry related to + trunk/Identity + directory inside the repository working copy. + + + + + + centos-art help --read trunk/Identity + + + This command reads the documentation entry related to + trunk/Identity + directory inside the repository working copy. + + + + + + + + + + + Author + + + Written by Alain Reguera Delgado. + + + + + + Reporting bugs + + Report bugs to centos-artwork@centos.org + mailing list. + + + + + Copyright + + Copyright © 2009, 2010, 2011 The CentOS Artwork SIG. + + + This is free software. You may redistribute copies of it + under the terms of the . + There is NO WARRANTY, to the extent permitted by law. + + + + diff --git a/Manuals/Userguide/Scripts/Bash/intro.docbook b/Manuals/Userguide/Scripts/Bash/intro.docbook new file mode 100644 index 0000000..00ee91e --- /dev/null +++ b/Manuals/Userguide/Scripts/Bash/intro.docbook @@ -0,0 +1,4 @@ + + Introduction + ... + diff --git a/Manuals/Userguide/Scripts/Bash/locale.docbook b/Manuals/Userguide/Scripts/Bash/locale.docbook new file mode 100644 index 0000000..83bf643 --- /dev/null +++ b/Manuals/Userguide/Scripts/Bash/locale.docbook @@ -0,0 +1,4 @@ + + The <function>locale</function> functionality + ... + diff --git a/Manuals/Userguide/Scripts/Bash/prepare.docbook b/Manuals/Userguide/Scripts/Bash/prepare.docbook new file mode 100644 index 0000000..f518855 --- /dev/null +++ b/Manuals/Userguide/Scripts/Bash/prepare.docbook @@ -0,0 +1,4 @@ + + The <function>prepare</function> functionality + ... + diff --git a/Manuals/Userguide/Scripts/Bash/render.docbook b/Manuals/Userguide/Scripts/Bash/render.docbook new file mode 100644 index 0000000..c1d272b --- /dev/null +++ b/Manuals/Userguide/Scripts/Bash/render.docbook @@ -0,0 +1,4 @@ + + The <function>render</function> functionality + ... + diff --git a/Manuals/Userguide/Scripts/Bash/tuneup.docbook b/Manuals/Userguide/Scripts/Bash/tuneup.docbook new file mode 100644 index 0000000..a96a583 --- /dev/null +++ b/Manuals/Userguide/Scripts/Bash/tuneup.docbook @@ -0,0 +1,4 @@ + + The <function>tuneup</function> functionality + ... +