From 572d080f2b5e9901e9d6fafecc78a2f4cc7fdea7 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Dec 27 2013 20:48:09 +0000 Subject: Update documentation inside tcar-scripts-prepare-docs. - Previously, documentation was focused on how to prepare the repository for using it. Once the repository was made installable through RPM, the purpose of the prepare module changed from preparing the installed repository to prepare the workplace. The installed repository is in a read-only location while the workplace is read-write location. This update changes the prepare module documentation to reflect such changes. --- diff --git a/tcar-scripts-prepare-docs/Manpages/Locales/en_US/prepare.po b/tcar-scripts-prepare-docs/Manpages/Locales/en_US/prepare.po deleted file mode 100644 index 8472ab2..0000000 --- a/tcar-scripts-prepare-docs/Manpages/Locales/en_US/prepare.po +++ /dev/null @@ -1,331 +0,0 @@ -msgid "" -msgstr "" -"Project-Id-Version: prepare.asciidoc 0.6\n" -"POT-Creation-Date: 2013-11-07 14:49-0500\n" -"PO-Revision-Date: 2013-11-07 14:49-0500\n" -"Last-Translator: Localization SIG \n" -"Language-Team: English\n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=UTF-8\n" -"Content-Transfer-Encoding: 8bit\n" -"Plural-Forms: nplurals=2; plural=(n != 1);\n" - -msgid "prepare" -msgstr "prepare" - -msgid "1" -msgstr "1" - -msgid "Prepare your workstation for using the repository." -msgstr "Prepare your workstation for using the repository." - -msgid "centos-art.sh prepare [OPTIONS]" -msgstr "centos-art.sh prepare [OPTIONS]" - -msgid "Description" -msgstr "Description" - -msgid "" -"The first time you download the CentOS artwork repository into your " -"workstation, you only find source files inside the repository. In " -"order to produce each component of CentOS corporate visual " -"identity, it is necessary that you first transform the source files " -"(e.g., .svgz, .asciidoc, " -".po) into final files (e.g., .png, .html, .mo). This " -"process is known as preparing your workstation to use the " -"repository and is standardized through the prepare module. This way, the prepare module is the first command you " -"execute after downloading a fresh copy of CentOS artwork repository." -msgstr "" -"The first time you download the CentOS artwork repository into your " -"workstation, you only find source files inside the repository. In " -"order to produce each component of CentOS corporate visual " -"identity, it is necessary that you first transform the source files " -"(e.g., .svgz, .asciidoc, " -".po) into final files (e.g., .png, .html, .mo). This " -"process is known as preparing your workstation to use the " -"repository and is standardized through the prepare module. This way, the prepare module is the first command you " -"execute after downloading a fresh copy of CentOS artwork repository." - -msgid "" -"When you execute the prepare " -"module without any option, it first checks existence of required " -"packages (see --packages), then updates the locale information " -"required by centos-art.sh " -"script to show messages in your current locale, later renders " -"documentation (see --documents) and images (see --images) using " -"source files available inside the repository. Finally, it updates " -"the link relation that connects content inside the repository and " -"the applications outside it (see --links)." -msgstr "" -"When you execute the prepare " -"module without any option, it first checks existence of required " -"packages (see --packages), then updates the locale information " -"required by centos-art.sh " -"script to show messages in your current locale, later renders " -"documentation (see --documents) and images (see --images) using " -"source files available inside the repository. Finally, it updates " -"the link relation that connects content inside the repository and " -"the applications outside it (see --links)." - -msgid "" -"When you execute the prepare " -"module with options, the order in which preparation actions take " -"place is set by the order in which you passed the options. See " -", for more information about available " -"options and what they do." -msgstr "" -"When you execute the prepare " -"module with options, the order in which preparation actions take " -"place is set by the order in which you passed the options. See " -", for more information about available " -"options and what they do." - -msgid "" -"Once the prepare module " -"completes its execution, both your workstation and your copy of " -"CentOS artwork repository will be ready for production." -msgstr "" -"Once the prepare module " -"completes its execution, both your workstation and your copy of " -"CentOS artwork repository will be ready for production." - -msgid "Options" -msgstr "Options" - -msgid "" -"The prepare module accepts the " -"following options:" -msgstr "" -"The prepare module accepts the " -"following options:" - -msgid "--help" -msgstr "--help" - -msgid "Print module's documentation." -msgstr "Print module's documentation." - -msgid "--version" -msgstr "--version" - -msgid "Print module's version." -msgstr "Print module's version." - -msgid "--packages" -msgstr "--packages" - -msgid "" -"This option verifies whether you have installed the required " -"packages in your workstation or not. If they are not installed an " -"error will be printed telling you what the missing package is, so " -"you can install it. It is important that all the required packages " -"be installed for centos-art.sh " -"script modules to work as expected." -msgstr "" -"This option verifies whether you have installed the required " -"packages in your workstation or not. If they are not installed an " -"error will be printed telling you what the missing package is, so " -"you can install it. It is important that all the required packages " -"be installed for centos-art.sh " -"script modules to work as expected." - -msgid "" -"When you are verifying packages, be aware that it is required that " -"you have installed EPEL repository. The EPEL configuration package " -"(epel-release) isn't part of " -"CentOS distribution and you need to download it and install it " -"manually. The epel-release " -"package can be found in either of the locations (based on your " -"system version):" -msgstr "" -"When you are verifying packages, be aware that it is required that " -"you have installed EPEL repository. The EPEL configuration package " -"(epel-release) isn't part of " -"CentOS distribution and you need to download it and install it " -"manually. The epel-release " -"package can be found in either of the locations (based on your " -"system version):" - -msgid "" -"For CentOS-5: http://download.fedoraproject.org/pub/epel/5/i386/" -msgstr "" -"For CentOS-5: http://download.fedoraproject.org/pub/epel/5/i386/" - -msgid "" -"For CentOS-6: http://download.fedoraproject.org/pub/epel/6/i386/" -msgstr "" -"For CentOS-6: http://download.fedoraproject.org/pub/epel/6/i386/" - -msgid "--locales" -msgstr "--locales" - -msgid "" -"This option looks for all translatable strings inside the centos-art.sh script, updates the " -"related POT and PO files and produces the related MO file using the " -"specific locale environment information the script was run in. If " -"the PO file already have translations, they are preserved and used " -"to build the MO file." -msgstr "" -"This option looks for all translatable strings inside the centos-art.sh script, updates the " -"related POT and PO files and produces the related MO file using the " -"specific locale environment information the script was run in. If " -"the PO file already have translations, they are preserved and used " -"to build the MO file." - -msgid "--links" -msgstr "--links" - -msgid "" -"This updates the link information that connects the information " -"inside the repository with the information outside the repository. " -"For example, inside the repository we have the font information " -"required to build messages in specific typography, such information " -"isn't by default in the default system locations so we install them " -"in the home directory of the user running the prepare module, using symbolic links." -msgstr "" -"This updates the link information that connects the information " -"inside the repository with the information outside the repository. " -"For example, inside the repository we have the font information " -"required to build messages in specific typography, such information " -"isn't by default in the default system locations so we install them " -"in the home directory of the user running the prepare module, using symbolic links." - -msgid "" -"Whenever you need to update this information, use this option. Take " -"care that all links previously created in the target location will " -"be removed and recreated again. So, you can change the name " -"relation in the configuration files and install the changes without " -"leaving broken links in the target location." -msgstr "" -"Whenever you need to update this information, use this option. Take " -"care that all links previously created in the target location will " -"be removed and recreated again. So, you can change the name " -"relation in the configuration files and install the changes without " -"leaving broken links in the target location." - -msgid "" -"The file that controls the link configuration is inside the " -"repository at Automation/Modules/Prepare/Modules/Links/" -"Configs/render.conf." -msgstr "" -"The file that controls the link configuration is inside the " -"repository at Automation/Modules/Prepare/Modules/Links/" -"Configs/render.conf." - -msgid "--images" -msgstr "--images" - -msgid "" -"This option produces images from source files available inside the " -"repository, using the correct order. When you use this option, " -"centos-art.sh script calls the render module internally which " -"produces content for all configuration (render.conf) files found inside the repository." -msgstr "" -"This option produces images from source files available inside the " -"repository, using the correct order. When you use this option, " -"centos-art.sh script calls the render module internally which " -"produces content for all configuration (render.conf) files found inside the repository." - -msgid "--documents" -msgstr "--documents" - -msgid "" -"This options produces documentation from source files available " -"inside the repository. When you pass this option, the current " -"locale information is considered to produce the documentation. If " -"the current locale doesn't have translation files set for the " -"current locale information, English language is used as default " -"language." -msgstr "" -"This options produces documentation from source files available " -"inside the repository. When you pass this option, the current " -"locale information is considered to produce the documentation. If " -"the current locale doesn't have translation files set for the " -"current locale information, English language is used as default " -"language." - -msgid "Author" -msgstr "Author" - -msgid "" -"The prepare module has " -"received contributions from the following people:" -msgstr "" -"The prepare module has " -"received contributions from the following people:" - -msgid "" -"Alain Reguera Delgado <al@centos.org.cu>, 2009-2013" -msgstr "" -"Alain Reguera Delgado <al@centos.org.cu>, 2009-2013" - -msgid "Copyright" -msgstr "Copyright" - -msgid "Copyright © 2009-2013 The CentOS Project" -msgstr "Copyright © 2009-2013 The CentOS Project" - -msgid "" -"This program is free software; you can redistribute it and/or " -"modify it under the terms of the GNU General Public License as " -"published by the Free Software Foundation; either version 2 of the " -"License, or (at your option) any later version." -msgstr "" -"This program is free software; you can redistribute it and/or " -"modify it under the terms of the GNU General Public License as " -"published by the Free Software Foundation; either version 2 of the " -"License, or (at your option) any later version." - -msgid "" -"This program is distributed in the hope that it will be useful, but " -"WITHOUT ANY WARRANTY; without even the implied warranty of " -"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU " -"General Public License for more details." -msgstr "" -"This program is distributed in the hope that it will be useful, but " -"WITHOUT ANY WARRANTY; without even the implied warranty of " -"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU " -"General Public License for more details." - -msgid "" -"You should have received a copy of the GNU General Public License " -"along with this program; if not, write to the Free Software " -"Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA." -msgstr "" -"You should have received a copy of the GNU General Public License " -"along with this program; if not, write to the Free Software " -"Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA." - -msgid "See Also" -msgstr "See Also" - -msgid "" -"centos-art.sh(1), centos-art.sh-render(1), centos-art.sh-locale(1)" -msgstr "" -"centos-art.sh(1), centos-art.sh-render(1), centos-art.sh-locale(1)" - -#. Put one translator per line, in the form of NAME , YEAR1, YEAR2. -msgid "translator-credits" -msgstr "translator-credits" diff --git a/tcar-scripts-prepare-docs/Manpages/Locales/en_US/tcar-prepare.po b/tcar-scripts-prepare-docs/Manpages/Locales/en_US/tcar-prepare.po new file mode 100644 index 0000000..8472ab2 --- /dev/null +++ b/tcar-scripts-prepare-docs/Manpages/Locales/en_US/tcar-prepare.po @@ -0,0 +1,331 @@ +msgid "" +msgstr "" +"Project-Id-Version: prepare.asciidoc 0.6\n" +"POT-Creation-Date: 2013-11-07 14:49-0500\n" +"PO-Revision-Date: 2013-11-07 14:49-0500\n" +"Last-Translator: Localization SIG \n" +"Language-Team: English\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" + +msgid "prepare" +msgstr "prepare" + +msgid "1" +msgstr "1" + +msgid "Prepare your workstation for using the repository." +msgstr "Prepare your workstation for using the repository." + +msgid "centos-art.sh prepare [OPTIONS]" +msgstr "centos-art.sh prepare [OPTIONS]" + +msgid "Description" +msgstr "Description" + +msgid "" +"The first time you download the CentOS artwork repository into your " +"workstation, you only find source files inside the repository. In " +"order to produce each component of CentOS corporate visual " +"identity, it is necessary that you first transform the source files " +"(e.g., .svgz, .asciidoc, " +".po) into final files (e.g., .png, .html, .mo). This " +"process is known as preparing your workstation to use the " +"repository and is standardized through the prepare module. This way, the prepare module is the first command you " +"execute after downloading a fresh copy of CentOS artwork repository." +msgstr "" +"The first time you download the CentOS artwork repository into your " +"workstation, you only find source files inside the repository. In " +"order to produce each component of CentOS corporate visual " +"identity, it is necessary that you first transform the source files " +"(e.g., .svgz, .asciidoc, " +".po) into final files (e.g., .png, .html, .mo). This " +"process is known as preparing your workstation to use the " +"repository and is standardized through the prepare module. This way, the prepare module is the first command you " +"execute after downloading a fresh copy of CentOS artwork repository." + +msgid "" +"When you execute the prepare " +"module without any option, it first checks existence of required " +"packages (see --packages), then updates the locale information " +"required by centos-art.sh " +"script to show messages in your current locale, later renders " +"documentation (see --documents) and images (see --images) using " +"source files available inside the repository. Finally, it updates " +"the link relation that connects content inside the repository and " +"the applications outside it (see --links)." +msgstr "" +"When you execute the prepare " +"module without any option, it first checks existence of required " +"packages (see --packages), then updates the locale information " +"required by centos-art.sh " +"script to show messages in your current locale, later renders " +"documentation (see --documents) and images (see --images) using " +"source files available inside the repository. Finally, it updates " +"the link relation that connects content inside the repository and " +"the applications outside it (see --links)." + +msgid "" +"When you execute the prepare " +"module with options, the order in which preparation actions take " +"place is set by the order in which you passed the options. See " +", for more information about available " +"options and what they do." +msgstr "" +"When you execute the prepare " +"module with options, the order in which preparation actions take " +"place is set by the order in which you passed the options. See " +", for more information about available " +"options and what they do." + +msgid "" +"Once the prepare module " +"completes its execution, both your workstation and your copy of " +"CentOS artwork repository will be ready for production." +msgstr "" +"Once the prepare module " +"completes its execution, both your workstation and your copy of " +"CentOS artwork repository will be ready for production." + +msgid "Options" +msgstr "Options" + +msgid "" +"The prepare module accepts the " +"following options:" +msgstr "" +"The prepare module accepts the " +"following options:" + +msgid "--help" +msgstr "--help" + +msgid "Print module's documentation." +msgstr "Print module's documentation." + +msgid "--version" +msgstr "--version" + +msgid "Print module's version." +msgstr "Print module's version." + +msgid "--packages" +msgstr "--packages" + +msgid "" +"This option verifies whether you have installed the required " +"packages in your workstation or not. If they are not installed an " +"error will be printed telling you what the missing package is, so " +"you can install it. It is important that all the required packages " +"be installed for centos-art.sh " +"script modules to work as expected." +msgstr "" +"This option verifies whether you have installed the required " +"packages in your workstation or not. If they are not installed an " +"error will be printed telling you what the missing package is, so " +"you can install it. It is important that all the required packages " +"be installed for centos-art.sh " +"script modules to work as expected." + +msgid "" +"When you are verifying packages, be aware that it is required that " +"you have installed EPEL repository. The EPEL configuration package " +"(epel-release) isn't part of " +"CentOS distribution and you need to download it and install it " +"manually. The epel-release " +"package can be found in either of the locations (based on your " +"system version):" +msgstr "" +"When you are verifying packages, be aware that it is required that " +"you have installed EPEL repository. The EPEL configuration package " +"(epel-release) isn't part of " +"CentOS distribution and you need to download it and install it " +"manually. The epel-release " +"package can be found in either of the locations (based on your " +"system version):" + +msgid "" +"For CentOS-5: http://download.fedoraproject.org/pub/epel/5/i386/" +msgstr "" +"For CentOS-5: http://download.fedoraproject.org/pub/epel/5/i386/" + +msgid "" +"For CentOS-6: http://download.fedoraproject.org/pub/epel/6/i386/" +msgstr "" +"For CentOS-6: http://download.fedoraproject.org/pub/epel/6/i386/" + +msgid "--locales" +msgstr "--locales" + +msgid "" +"This option looks for all translatable strings inside the centos-art.sh script, updates the " +"related POT and PO files and produces the related MO file using the " +"specific locale environment information the script was run in. If " +"the PO file already have translations, they are preserved and used " +"to build the MO file." +msgstr "" +"This option looks for all translatable strings inside the centos-art.sh script, updates the " +"related POT and PO files and produces the related MO file using the " +"specific locale environment information the script was run in. If " +"the PO file already have translations, they are preserved and used " +"to build the MO file." + +msgid "--links" +msgstr "--links" + +msgid "" +"This updates the link information that connects the information " +"inside the repository with the information outside the repository. " +"For example, inside the repository we have the font information " +"required to build messages in specific typography, such information " +"isn't by default in the default system locations so we install them " +"in the home directory of the user running the prepare module, using symbolic links." +msgstr "" +"This updates the link information that connects the information " +"inside the repository with the information outside the repository. " +"For example, inside the repository we have the font information " +"required to build messages in specific typography, such information " +"isn't by default in the default system locations so we install them " +"in the home directory of the user running the prepare module, using symbolic links." + +msgid "" +"Whenever you need to update this information, use this option. Take " +"care that all links previously created in the target location will " +"be removed and recreated again. So, you can change the name " +"relation in the configuration files and install the changes without " +"leaving broken links in the target location." +msgstr "" +"Whenever you need to update this information, use this option. Take " +"care that all links previously created in the target location will " +"be removed and recreated again. So, you can change the name " +"relation in the configuration files and install the changes without " +"leaving broken links in the target location." + +msgid "" +"The file that controls the link configuration is inside the " +"repository at Automation/Modules/Prepare/Modules/Links/" +"Configs/render.conf." +msgstr "" +"The file that controls the link configuration is inside the " +"repository at Automation/Modules/Prepare/Modules/Links/" +"Configs/render.conf." + +msgid "--images" +msgstr "--images" + +msgid "" +"This option produces images from source files available inside the " +"repository, using the correct order. When you use this option, " +"centos-art.sh script calls the render module internally which " +"produces content for all configuration (render.conf) files found inside the repository." +msgstr "" +"This option produces images from source files available inside the " +"repository, using the correct order. When you use this option, " +"centos-art.sh script calls the render module internally which " +"produces content for all configuration (render.conf) files found inside the repository." + +msgid "--documents" +msgstr "--documents" + +msgid "" +"This options produces documentation from source files available " +"inside the repository. When you pass this option, the current " +"locale information is considered to produce the documentation. If " +"the current locale doesn't have translation files set for the " +"current locale information, English language is used as default " +"language." +msgstr "" +"This options produces documentation from source files available " +"inside the repository. When you pass this option, the current " +"locale information is considered to produce the documentation. If " +"the current locale doesn't have translation files set for the " +"current locale information, English language is used as default " +"language." + +msgid "Author" +msgstr "Author" + +msgid "" +"The prepare module has " +"received contributions from the following people:" +msgstr "" +"The prepare module has " +"received contributions from the following people:" + +msgid "" +"Alain Reguera Delgado <al@centos.org.cu>, 2009-2013" +msgstr "" +"Alain Reguera Delgado <al@centos.org.cu>, 2009-2013" + +msgid "Copyright" +msgstr "Copyright" + +msgid "Copyright © 2009-2013 The CentOS Project" +msgstr "Copyright © 2009-2013 The CentOS Project" + +msgid "" +"This program is free software; you can redistribute it and/or " +"modify it under the terms of the GNU General Public License as " +"published by the Free Software Foundation; either version 2 of the " +"License, or (at your option) any later version." +msgstr "" +"This program is free software; you can redistribute it and/or " +"modify it under the terms of the GNU General Public License as " +"published by the Free Software Foundation; either version 2 of the " +"License, or (at your option) any later version." + +msgid "" +"This program is distributed in the hope that it will be useful, but " +"WITHOUT ANY WARRANTY; without even the implied warranty of " +"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU " +"General Public License for more details." +msgstr "" +"This program is distributed in the hope that it will be useful, but " +"WITHOUT ANY WARRANTY; without even the implied warranty of " +"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU " +"General Public License for more details." + +msgid "" +"You should have received a copy of the GNU General Public License " +"along with this program; if not, write to the Free Software " +"Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA." +msgstr "" +"You should have received a copy of the GNU General Public License " +"along with this program; if not, write to the Free Software " +"Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA." + +msgid "See Also" +msgstr "See Also" + +msgid "" +"centos-art.sh(1), centos-art.sh-render(1), centos-art.sh-locale(1)" +msgstr "" +"centos-art.sh(1), centos-art.sh-render(1), centos-art.sh-locale(1)" + +#. Put one translator per line, in the form of NAME , YEAR1, YEAR2. +msgid "translator-credits" +msgstr "translator-credits" diff --git a/tcar-scripts-prepare-docs/Manpages/prepare.asciidoc b/tcar-scripts-prepare-docs/Manpages/prepare.asciidoc deleted file mode 100644 index c0d014e..0000000 --- a/tcar-scripts-prepare-docs/Manpages/prepare.asciidoc +++ /dev/null @@ -1,149 +0,0 @@ -prepare(1) -========== - -Name ----- - -prepare - Prepare your workstation for using the repository. - -Synopsis --------- - -*centos-art.sh prepare [OPTIONS]* - -Description ------------ - -The first time you download the CentOS artwork repository into your -workstation, you only find source files inside the repository. In -order to produce each component of CentOS corporate visual identity, -it is necessary that you first transform the source files (e.g., -+.svgz+, +.asciidoc+, +.po+) into final files (e.g., +.png+, +.html+, -+.mo+). This process is known as _preparing your workstation to use -the repository_ and is standardized through the *prepare* module. This -way, the *prepare* module is the first command you execute after -downloading a fresh copy of CentOS artwork repository. - -When you execute the *prepare* module without any option, it first -checks existence of required packages (see --packages), then updates -the locale information required by *centos-art.sh* script to show -messages in your current locale, later renders documentation (see ---documents) and images (see --images) using source files available -inside the repository. Finally, it updates the link relation that -connects content inside the repository and the applications outside it -(see --links). - -When you execute the *prepare* module with options, the order in which -preparation actions take place is set by the order in which you passed -the options. See <>, for more information about available -options and what they do. - -Once the *prepare* module completes its execution, both your -workstation and your copy of CentOS artwork repository will be ready -for production. - -[[options]] -Options -------- - -The *prepare* module accepts the following options: - -*--help*:: - Print module's documentation. - -*--version*:: - Print module's version. - -*--packages*:: - This option verifies whether you have installed the required - packages in your workstation or not. If they are not installed an - error will be printed telling you what the missing package is, so - you can install it. It is important that all the required packages - be installed for *centos-art.sh* script modules to work as - expected. -+ -[NOTE] -====================================================================== -When you are verifying packages, be aware that it is required that you -have installed EPEL repository. The EPEL configuration package -(*epel-release*) isn't part of CentOS distribution and you need to -download it and install it manually. The *epel-release* package can be -found in either of the locations (based on your system version): - - * For CentOS-5: http://download.fedoraproject.org/pub/epel/5/i386/[http://download.fedoraproject.org/pub/epel/5/i386/] - * For CentOS-6: http://download.fedoraproject.org/pub/epel/6/i386/[http://download.fedoraproject.org/pub/epel/6/i386/] -====================================================================== - -*--locales*:: - This option looks for all translatable strings inside the - *centos-art.sh* script, updates the related POT and PO files and - produces the related MO file using the specific locale environment - information the script was run in. If the PO file already have - translations, they are preserved and used to build the MO file. - -*--links*:: - This updates the link information that connects the information - inside the repository with the information outside the repository. - For example, inside the repository we have the font information - required to build messages in specific typography, such - information isn't by default in the default system locations so we - install them in the home directory of the user running the - *prepare* module, using symbolic links. -+ -Whenever you need to update this information, use this option. Take -care that all links previously created in the target location will be -removed and recreated again. So, you can change the name relation in -the configuration files and install the changes without leaving broken -links in the target location. -+ -The file that controls the link configuration is inside the repository -at +Automation/Modules/Prepare/Modules/Links/Configs/render.conf+. - -*--images*:: - This option produces images from source files available inside the - repository, using the correct order. When you use this option, - centos-art.sh script calls the render module internally which - produces content for all configuration (+render.conf+) files found - inside the repository. - -*--documents*:: - This options produces documentation from source files available - inside the repository. When you pass this option, the current - locale information is considered to produce the documentation. If - the current locale doesn't have translation files set for the - current locale information, English language is used as default - language. - -Author ------- - -The *prepare* module has received contributions from the following -people: - - * Alain Reguera Delgado , 2009-2013 - -Copyright ---------- - -Copyright (C) 2009-2013 The CentOS Project - -This program is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2 of the License, or (at -your option) any later version. - -This program is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - -See Also --------- - -centos-art.sh(1), centos-art.sh-render(1), centos-art.sh-locale(1) - -// vim: set syntax=asciidoc: diff --git a/tcar-scripts-prepare-docs/Manpages/render.conf b/tcar-scripts-prepare-docs/Manpages/render.conf index 1b130ce..9b6eccf 100644 --- a/tcar-scripts-prepare-docs/Manpages/render.conf +++ b/tcar-scripts-prepare-docs/Manpages/render.conf @@ -1,7 +1,7 @@ -[prepare] +[tcar-prepare] render-type = "asciidoc" render-flow = "manpage" -render-from = "prepare.asciidoc" -locale-from = "Locales/${TCAR_SCRIPT_LANG_LC}/prepare.po" +render-from = "tcar-prepare.asciidoc" +locale-from = "Locales/${TCAR_SCRIPT_LANG_LC}/tcar-prepare.po" formats = "xhtml manpage" mansect = "1" diff --git a/tcar-scripts-prepare-docs/Manpages/tcar-prepare.asciidoc b/tcar-scripts-prepare-docs/Manpages/tcar-prepare.asciidoc new file mode 100644 index 0000000..5edb5c9 --- /dev/null +++ b/tcar-scripts-prepare-docs/Manpages/tcar-prepare.asciidoc @@ -0,0 +1,92 @@ +tcar-prepare(1) +=============== + +Name +---- + +tcar-prepare - Prepare the repository workplace. + +Synopsis +-------- + +*centos-art.sh prepare /path/to/your/workplace* + +Description +----------- + +When you install The CentOS Artwork Repository in your workstation, it +only provides the source files and documentation you need to produce +final content but no way to produce final content inside the location +it was installed. To produce final content using the source files +provided by The CentOS Artwork Repository you need to create a +directory in your workstation where you can store the files you +produce and the configuration files provided by the installed +repository. This directory is known as the ``repository workplace'' +and you should create it using the *prepare* module of *tcar* script. + +The *prepare* module creates the workplace in the location you +specified as argument in the command-line. Inside the workplace, there +is one directory for each visual manifestation The CentOS Project is +made of. Each directory inside the workplace might exist to organize +other directories or storing final content. The directories storing +final content hold one configuration file describing how the final +content is produced inside of it. The configuration files inside the +workplace are symbolic links to configuration files inside The CentOS +Artwork Repository installed in your workstation. + +The first time you create the workplace using the *prepare* module, it +doesn't include images required to brand other images (e.g., The +CentOS Symbol and The CentOS Type). This is something you need to do +in order for images requiring brand information to be rendered as they +are expected. Rendering images related to brands might consume some +time but it is something that needs to be done just once, unless +variations to brand information be introduced to The CentOS Artwork +Repository, in which case it would be required to render them again to +propagate the changes introduced to brand information the next time +images requiring them be rendered. + +[[options]] +Options +------- + +The *prepare* module accepts the following options: + +*--help*:: + Print module's documentation. + +*--version*:: + Print module's version. + +Authors +------- + +The *prepare* module has received contributions from the following +people: + + * Alain Reguera Delgado , 2009-2013 + +Copyright +--------- + +Copyright (C) 2009-2013 The CentOS Artwork SIG + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or (at +your option) any later version. + +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +See Also +-------- + +tcar(1), tcar-render(1), tcar-locale(1) + +// vim: set syntax=asciidoc: