From 32e48c4430a89077b7563b05d76dba045b90dac9 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Sep 14 2012 15:11:46 +0000 Subject: Update `Tcar-ug' documentation structure: - Add Preface directory back into the structure. Each book has its own preface. Preface sections like feedback and docconvs must be common to all books produced inside the repository so we need to find a way to keep this information without duplications. --- diff --git a/Documentation/Manuals/Docbook/Tcar-ug/Preface.docbook b/Documentation/Manuals/Docbook/Tcar-ug/Preface.docbook new file mode 100644 index 0000000..42c8578 --- /dev/null +++ b/Documentation/Manuals/Docbook/Tcar-ug/Preface.docbook @@ -0,0 +1,9 @@ + + + Preface + + &preface-overview; + &preface-docconvs; + &preface-feedback; + + diff --git a/Documentation/Manuals/Docbook/Tcar-ug/Preface.ent b/Documentation/Manuals/Docbook/Tcar-ug/Preface.ent new file mode 100644 index 0000000..ce36070 --- /dev/null +++ b/Documentation/Manuals/Docbook/Tcar-ug/Preface.ent @@ -0,0 +1,4 @@ + + + + diff --git a/Documentation/Manuals/Docbook/Tcar-ug/Preface/docconvs.docbook b/Documentation/Manuals/Docbook/Tcar-ug/Preface/docconvs.docbook new file mode 100644 index 0000000..8eda7bc --- /dev/null +++ b/Documentation/Manuals/Docbook/Tcar-ug/Preface/docconvs.docbook @@ -0,0 +1,225 @@ +
+ + Document Convenctions + + + In this manual, certain words are represented in different + fonts, typefaces, sizes, and weights. This highlighting is + systematic; different words are represented in the same style + to indicate their inclusion in a specific category. The types + of words that are represented this way include the + following: + + + + + command + + + Linux commands (and other operating system commands, when + used) are represented this way. This style should + indicate to you that you can type the word or phrase on + the command line and press Enter to + invoke a command. Sometimes a command contains words that + would be displayed in a different style on their own (such + as file names). In these cases, they are considered to be + part of the command, so the entire phrase is displayed as + a command. For example: + + + + Use the centos-art render + trunk/Identity/Images/Themes/TreeFlower/4/Distro/5/Anaconda + --filter="01-welcome" command to produce the first + slide image used by Anaconda in the branch 5 of &TCD; + using the version 4 of TreeFlower artistic motif. + + + + + + file name + + + File names, directory names, paths, and RPM package names + are represented this way. This style indicates that a + particular file or directory exists with that name on your + system. Examples: + + + + The init.sh file in trunk/Scripts/Bash/Cli/ + directory is the initialization script, written in Bash, + used to automate most of tasks in the repository. + + + + The centos-art command uses the + ImageMagick RPM package to convert + images from PNG format to other formats. + + + + + + key + + + A key on the keyboard is shown in this style. For + example: + + + + To use Tab completion to list particular + files in a directory, type ls, then a + character, and finally the Tab key. Your + terminal displays the list of files in the working + directory that begin with that character. + + + + + + keycombination + + + A combination of keystrokes is represented in this way. + For example: + + + + The CtrlAltBackspace + key combination exits your graphical session and returns + you to the graphical login screen or the console. + + + + + + computer output + + + Text in this style indicates text displayed to a shell + prompt such as error messages and responses to commands. + For example, the ls command displays + the contents of a directory using this style: + + + +render_doTranslation.sh render_getDirTemplate.sh render_doBaseActions.sh +render_getConfigOption.sh render_getOptions.sh render_doThemeActions.sh +render_getDirOutput.sh render.sh + + + + The output returned in response to the command (in this + case, the contents of the directory) is shown in this + style. + + + + + + prompt + + + A prompt, which is a computer's way of signifying that it + is ready for you to input something, is shown in this + style. Examples: + + + + + + $ + + + + + # + + + + + [centos@projects centos]$ + + + + + projects login: + + + + + + + + user input + + + Text that the user types, either on the command line or + into a text box on a GUI screen, is displayed in this + style. In the following example, + text is displayed in this style: To + boot your system into the text based installation program, + you must type in the text command + at the boot: prompt. + + + + + + replaceable + + + Text used in examples that is meant to be replaced with + data provided by the user is displayed in this style. In + the following example, + version-number is displayed in + this style: The directory for the kernel source is + /usr/src/kernels/version-number/, + where version-number is the + version and type of kernel installed on this system. + + + + + + Additionally, we use several different strategies to draw + your attention to certain pieces of information. In order of + urgency, these items are marked as a note, tip, important, + caution, or warning. For example: + + + Remember that Linux is case sensitive. In other words, a + rose is not a ROSE is not a rOsE. + + + + The directory /usr/share/doc/ contains + additional documentation for packages installed on your + system. + + + + If you modify the DHCP configuration file, the changes + do not take effect until you restart the DHCP daemon. + + + + Do not perform routine tasks as root — use a + regular user account unless you need to use the root account + for system administration tasks. + + + + Be careful to remove only the necessary partitions. + Removing other partitions could result in data loss or a + corrupted system environment. + + +
diff --git a/Documentation/Manuals/Docbook/Tcar-ug/Preface/feedback.docbook b/Documentation/Manuals/Docbook/Tcar-ug/Preface/feedback.docbook new file mode 100644 index 0000000..b6f8334 --- /dev/null +++ b/Documentation/Manuals/Docbook/Tcar-ug/Preface/feedback.docbook @@ -0,0 +1,14 @@ +
+ + Send In Your Feedback + + + If you find a bug in &TCAR; or this manual, we would like to + hear about it. To report bugs related to this manual, send an + e-mail to the centos-devel@centos.org mailing + list. When you write the bug report, take care of being + specific about the problem you are reporting on (e.g., where + it is, the section number, etc.) so we can found it easily. + + +
diff --git a/Documentation/Manuals/Docbook/Tcar-ug/Preface/overview.docbook b/Documentation/Manuals/Docbook/Tcar-ug/Preface/overview.docbook new file mode 100644 index 0000000..b12e354 --- /dev/null +++ b/Documentation/Manuals/Docbook/Tcar-ug/Preface/overview.docbook @@ -0,0 +1,84 @@ +
+ + Overview + + + Welcome to &TCARUG;, the official documentation of &TCAR;. + + + + This book describes the corporate visual identity of &TCP; and + the way it is produced. If you are interested in making &TCP; + a more beautiful project, this book is definitly for you. + + + + To make the information in this book managable, it has been + organized in the following parts: + + + + + + describes the convenctions you should + follow to keep everything organized and consistent inside the + repository directory structure, how to to install and + configure a working copy inside your workstation. At the end + of this part you will find a history of most relevant changes + committed to the repository along the years. + + + + + + describes the corporate visual + identity of the organization known as &TCP; and the production + tasks related to image rendition inside &TCAR;. If you are a + graphic designer, this part of the book might result + interesting to you. + + + + + + describes production tasks related to + content internationalization and localization inside &TCAR;. + If you are a translator, this part of the book might result + interesting to you. + + + + + + describes production tasks related + to content documentation inside &TCAR;. If you are a + documentor, this part of the book might result interesting to + you. + + + + + + describes automation of production + tasks inside &TCAR;. If you are a programmer, this part of the + book might result interesting to you. + + + + + + organizes the licenses mentioned + in this book. + + + + + + + This book assumes you have a basic understanding of &TCD;. If + you need help with it, go to the Help page inside + &TCWIKI; for or a list of different places you can find help. + + +