From 3c5068d01d0d202be5cb7ad2c26dd578d0e86dc3 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Jun 30 2011 01:33:16 +0000 Subject: Update repository documentation manual in docbook format. --- diff --git a/Manuals/TCAR-UG/Docbook/Repository.docbook b/Manuals/TCAR-UG/Docbook/Repository.docbook index bdef5f2..ea8dd86 100644 --- a/Manuals/TCAR-UG/Docbook/Repository.docbook +++ b/Manuals/TCAR-UG/Docbook/Repository.docbook @@ -2,10 +2,8 @@ Repository - &repo-layout; - &repo-whatis; + &repo-convs; &repo-ws; - &repo-worklines; &repo-history; diff --git a/Manuals/TCAR-UG/Docbook/Repository.ent b/Manuals/TCAR-UG/Docbook/Repository.ent index f819360..f934105 100644 --- a/Manuals/TCAR-UG/Docbook/Repository.ent +++ b/Manuals/TCAR-UG/Docbook/Repository.ent @@ -1,34 +1,23 @@ - - - - - - - - - - + + + + + + + + + + + - - - - - - - - - - - - - - - - + + + + diff --git a/Manuals/TCAR-UG/Docbook/Repository/Convenctions.docbook b/Manuals/TCAR-UG/Docbook/Repository/Convenctions.docbook index 96ac1db..71f68f8 100644 --- a/Manuals/TCAR-UG/Docbook/Repository/Convenctions.docbook +++ b/Manuals/TCAR-UG/Docbook/Repository/Convenctions.docbook @@ -2,9 +2,15 @@ Repository Convenctions - &repo-layout-filenames; - &repo-layout-relbdirs; - &repo-layout-syncpaths; - &repo-layout-extending; + &repo-convs-mission; + &repo-convs-layout; + &repo-convs-worklines; + &repo-convs-filenames; + &repo-convs-relbdirs; + &repo-convs-syncpaths; + &repo-convs-extending; + &repo-convs-publishing; + &repo-convs-authoring; + &repo-convs-copying; diff --git a/Manuals/TCAR-UG/Docbook/Repository/Convenctions/authoring.docbook b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/authoring.docbook new file mode 100755 index 0000000..fdbd8e8 --- /dev/null +++ b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/authoring.docbook @@ -0,0 +1,16 @@ + + + Repository Authoring + + + The content produced inside &TCAR; is copyright of &TCAS; and + this is something you, as author, need to be aware of because + you are giving part of your creation's rights to someone else; + &TCAS; for this matter. In this case, your work is + distributed using &TCAS; as copyright holder not your name. + Because &TCAS; is the copyright holder, is the license chosen + by &TCAS; the one applied to your work, so it is the one you + need to agree with before making a creation inside &TCAR;. + + + diff --git a/Manuals/TCAR-UG/Docbook/Repository/Convenctions/copying.docbook b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/copying.docbook new file mode 100755 index 0000000..04a3957 --- /dev/null +++ b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/copying.docbook @@ -0,0 +1,68 @@ + + + Repository Copying Conditions + + + &TCAS; uses &TCAR; to implement &TCPCVI;. The implementation + itself is controlled by the centos-art.sh + script. + + + + Both the centos-art.sh script and &TCAR;, + are not in the public domain; they are copyrighted and there + are restrictions on their distribution, but these restrictions + are designed to permit everything that a good cooperating + citizen would want to do. What is not allowed is to try to + prevent others from further sharing any version of this work + that they might get from you. + + + + Specifically, we want to make sure that you have the right to + give away copies of centos-art.sh script + and the organization of files it needs to work, that you + receive source code or else can get it if you want it, that + you can change this work or use pieces of it in new free + works, and that you know you can do these things. + + + + To make sure that everyone has such rights, we have to forbid + you to deprive anyone else of these rights. For example, if + you distribute copies of the centos-art.sh + script, you must give the recipients all the rights that you + have. You must make sure that they, too, receive or can get + the source code. And you must tell them their rights. + + + + Also, for our own protection, we must make certain that + everyone finds out that there is no warranty for the + centos-art.sh script. If this work is + modified by someone else and passed on, we want their + recipients to know that what they have is not what we + distributed, so that any problems introduced by others will + not reflect on our reputation. + + + + The centos-art.sh script is released as a + GPL work. Individual packages used by + centos-art.sh script include their own + licenses and the centos-art.sh script + license applies to all packages that it does not clash with. + If there is a clash between the + centos-art.sh script license and individual + package licenses, the individual package license applies + instead. + + + + The precise conditions of the license for the + centos-art.sh script are found in the . This manual specifically is covered + by the . + + + diff --git a/Manuals/TCAR-UG/Docbook/Repository/Convenctions/extending.docbook b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/extending.docbook index d99c721..6e0d153 100644 --- a/Manuals/TCAR-UG/Docbook/Repository/Convenctions/extending.docbook +++ b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/extending.docbook @@ -1,4 +1,4 @@ - + Extending Repository Layout diff --git a/Manuals/TCAR-UG/Docbook/Repository/Convenctions/filenames.docbook b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/filenames.docbook index 6941b4e..d47dbf4 100644 --- a/Manuals/TCAR-UG/Docbook/Repository/Convenctions/filenames.docbook +++ b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/filenames.docbook @@ -1,6 +1,6 @@ - + - File Names + Repository File Names Inside &TCAR;, file names are all written in lowercase (e.g., diff --git a/Manuals/TCAR-UG/Docbook/Repository/Convenctions/layout.docbook b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/layout.docbook index 33808e5..a62d4fd 100644 --- a/Manuals/TCAR-UG/Docbook/Repository/Convenctions/layout.docbook +++ b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/layout.docbook @@ -1,6 +1,28 @@ - Directories Layout + Repository Layout + + + &TCAR; is supported by Subversion, a + version control system which allows you to keep old versions + of files and directories (usually source code), keep a log of + who, when, and why changes occurred, etc., like CVS, RCS or + SCCS. + + + + &TCAR; is made of one source repository and + many working copies of that source repository. + The working copies are independent one another, can be + distributed all around the world and provide a local place for + designers, documentors, translators and programmers to perform + their work in a descentralized way. The source repository, on + the other hand, provides a central place for all independent + working copies to interchange data and provides the + information required to permit extracting previous versions of + files at any time. + The first level of directories in the repository provides @@ -23,8 +45,8 @@ The second level of directories in the repository provides - organization for each work line described in . + organization for repository work lines, as described in . @@ -32,3 +54,5 @@ from third level on, are created to organize specific concepts related to the work line they are in. + + diff --git a/Manuals/TCAR-UG/Docbook/Repository/Convenctions/mission.docbook b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/mission.docbook new file mode 100755 index 0000000..76a2e7c --- /dev/null +++ b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/mission.docbook @@ -0,0 +1,9 @@ + + + Repository Mission + + + &TCAR; exists to oraganize the files related to &TCPCVI;. + + + diff --git a/Manuals/TCAR-UG/Docbook/Repository/Convenctions/publishing.docbook b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/publishing.docbook new file mode 100755 index 0000000..dd8d7e4 --- /dev/null +++ b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/publishing.docbook @@ -0,0 +1,54 @@ + + + Repository Publishing + + + When you perform changes inside your working copy, those + changes are local to your working copy only. In order for you + to share your changes with others, you need to commit them up + to the central repository the working copy you are using was + initially downloaded from. To commit your changes up to the + central repository you use the commit + command of Subversion's client installed in your workstation. + + + + + Initially, when you get registered inside &TCAR;, you won't be + able to publish your changes to &TCAR; immediatly. It is + necessary that you prove your interest in contributing first, + preferably in conjunction with a description of the changes + you pretend to commit. This restriction is necessary in order + to protect the source repository from spammers. + + + + Once you've received access to publish your changes, they will + remain valid to you and there is no need for you to request + permission to publish new changes as long as you behave as a + good cooperating citizen. + + + + As a good cooperating citizen one understand of a person who + respects the work already done by others and share ideas with + authors before changing relevant parts of their work, + specially in situations when the access required to realize + the changes has been granted already. Of course, there is a + time when conversation has taken place, the paths has been + traced and changing the work is so obvious that there is no + need for you to talk about it; that's because you already did, + you already built the trust to keep going. As complement, the + mailing list mentioned above is available for sharing ideas in + a way that good relationship between community citizens could + be constantly balanced. + + + + The relationship between community citizens is monitored by + repository administrators. Repository administrators are + responsible of granting that everything goes the way it needs + to go in order for &TCAR; to accomplish its mission. + + + diff --git a/Manuals/TCAR-UG/Docbook/Repository/Convenctions/relbdirs.docbook b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/relbdirs.docbook index 967bb8e..1abadfd 100644 --- a/Manuals/TCAR-UG/Docbook/Repository/Convenctions/relbdirs.docbook +++ b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/relbdirs.docbook @@ -1,6 +1,6 @@ - + - Path Types + Repository Path Types In order for automation scripts to produce content inside a diff --git a/Manuals/TCAR-UG/Docbook/Repository/Convenctions/syncpaths.docbook b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/syncpaths.docbook index 7b4ec2d..23ad317 100644 --- a/Manuals/TCAR-UG/Docbook/Repository/Convenctions/syncpaths.docbook +++ b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/syncpaths.docbook @@ -1,6 +1,6 @@ - + - Path Syncronization + Syncronizing Repository Paths Once both master and auxiliar paths have been related in the diff --git a/Manuals/TCAR-UG/Docbook/Repository/Convenctions/worklines.docbook b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/worklines.docbook new file mode 100644 index 0000000..a49257e --- /dev/null +++ b/Manuals/TCAR-UG/Docbook/Repository/Convenctions/worklines.docbook @@ -0,0 +1,112 @@ + + + Repository Work Lines + + + To organize content production inside &TCAR;, production has + been divided into individual work lines that relate one + another based on the idea of doing one thing well. Later, the + results produced individually by each work line are combined + to achieve a higher purpose. Work lines, as conceived here, + provide the relayable output components the production cycle + inside &TCAR; needs to let everyone to work syncronized in a + descentralized environment. + + + + + Visual Identity + + + In the production cycle, the first step takes place through + graphic design. It is focused on preparing design models for + all the visual manifestation &TCP; is made of. Here, graphic + designers describe the visual characteristics of each visual + manifestation (e.g., image dimensions, position of text in the + visible area, translation markers, etc.). + Later, once design models have been defined, graphic designers + take care of artistic motifs to define the visual style of + those design models already created (e.g., how they look and + feel). + + + + Finally, graphic designers use the + render functionality of + centos-art.sh script to combine both design + models and artistic motifs in order to produce the final + images required by each visual manifestaions. + + + + + + + Localization + + + The second step in the production cycle is to localize + source files (e.g., SVG, DocBook, Shell scripts). This step + makes possible to produce localized images, localized + documentation and localized automation scripts. + + + + The localization tasks are carried on by translators using the + locale functionality of the + centos-art.sh script which take care of + retriving translatable strings from source files and provide a + consistent localization interface based on GNU + gettext multi-lingual message + production tool set and xml2po command. + + + + + + + Documentation + + + The third step in the production cycle is to document &TCAR;, + what it is and how to use it. This step provides the + conceptual ideas used as base to edificate &TCPCVI; and is + implemented through &TCARUG;. + + + + To write documentation, documentors use the + help functionality of + centos-art.sh script which provide an + consistent interface for building documentation through + different documentation backends (e.g., Texinfo and DocBook). + + + + + + + Automation + + + The fourth step in the production cycle is to automate + frequent tasks inside &TCAR;. This step closes the production + cycle and provides the production standards needed by all + different work lines to coexist together. Here is where + the centos-art.sh script and all + its functionalities (e.g., render for + rendition, help for documentation, + locale for localization, etc.) are + developed. + + + + At this point it should be obvious, but we consider worth to + remember that: there is no need to type several tasks, time + after time, if they can be programmed into just one executable + script. + + + + + diff --git a/Manuals/TCAR-UG/Docbook/Repository/Usage.docbook b/Manuals/TCAR-UG/Docbook/Repository/Usage.docbook deleted file mode 100644 index e9b8982..0000000 --- a/Manuals/TCAR-UG/Docbook/Repository/Usage.docbook +++ /dev/null @@ -1,66 +0,0 @@ - - - Usage Conditions - - - &TCAR; is a collaborative tool that anyone can have access to. - However, changing that tool in any form is something that - should be requested in &TCDML;. Generally, people download - working copies of &TCAR; to study its layout, make local - changes, test the changes really work the way expected and - finally, request access to publish them up. - - - - Once you've received access to publish your changes and as - long as you behave as a good cooperating - citizen, there is no need for you to request - permission to publish new changes. - - - - As a good cooperating citizen one understand of a person who - respects the work already done by others and share ideas with - authors before changing relevant parts of their work, - specially in situations when the access required to realize - the changes has been granted already. Of course, there is a - time when conversation has taken place, the paths has been - traced and changing the work is so obvious that there is no - need for you to talk about it; that's because you already did, - you already built the trust to keep going. As complement, the - mailing list mentioned above is available for sharing ideas in - a way that good relationship between community citizens could - be constantly balanced. - - - - The relationship between community citizens is monitored by - repository administrators. Repository administrators are - responsible of granting that everything goes the way it needs - to go in order for &TCAR; to accomplish its mission which is: - to provide a colaborative tool for &TCC; where &TCPCVI; could - be built and maintained by &TCC; itself. Repository - administrators have the reposability of creating new user's - account, setting permissions and revoking publishing rights to - ill-willed users, as well. - - - - The content produced inside &TCAR; is copyright of &TCAS; and - this is something you, as author, need to be aware of because - you are giving part of your creation's rights to someone else; - &TCAS; for this matter. In this case, your work is - distributed using &TCAS; as copyright holder not your name. - Because &TCAS; is the copyright holder, is the license chosen - by &TCAS; the one applied to your work, so it is the one you - need to agree with before making a creation inside &TCAR;. - - - - We belive that working together is far better than working - alone; eventhough somtimes, working alone is the only possible - way of reaching the state of glory which is to work - syncronized all together in freedom. - - - diff --git a/Manuals/TCAR-UG/Docbook/Repository/Worklines.docbook b/Manuals/TCAR-UG/Docbook/Repository/Worklines.docbook deleted file mode 100644 index cf805a6..0000000 --- a/Manuals/TCAR-UG/Docbook/Repository/Worklines.docbook +++ /dev/null @@ -1,21 +0,0 @@ - - - Identifying Repository's Work Lines - - - To organize content production inside &TCAR;, production has - been divided into individual work lines that relate one - another based on the idea of doing one thing well. Later, the - results produced individually by each work line are combined - to achieve a higher purpose. Work lines, as conceived here, - provide the relayable output components the production cycle - inside &TCAR; needs to let everyone to work syncronized in a - descentralized environment. - - - &repo-worklines-identity; - &repo-worklines-l10n; - &repo-worklines-manuals; - &repo-worklines-scripts; - - diff --git a/Manuals/TCAR-UG/Docbook/Repository/Worklines/identity.docbook b/Manuals/TCAR-UG/Docbook/Repository/Worklines/identity.docbook deleted file mode 100644 index 78205e7..0000000 --- a/Manuals/TCAR-UG/Docbook/Repository/Worklines/identity.docbook +++ /dev/null @@ -1,26 +0,0 @@ - - - Visual Identity - - - In the production cycle, the first step takes place through - graphic design. It is focused on preparing design models for - all the visual manifestation &TCP; is made of. Here, graphic - designers describe the visual characteristics of each visual - manifestation (e.g., image dimensions, position of text in the - visible area, translation markers, etc.). - Later, once design models have been defined, graphic designers - take care of artistic motifs to define the visual style of - those design models already created (e.g., how they look and - feel). - - - - Finally, graphic designers use the - render functionality of - centos-art.sh script to combine both design - models and artistic motifs in order to produce the final - images required by each visual manifestaions. - - - diff --git a/Manuals/TCAR-UG/Docbook/Repository/Worklines/l10n.docbook b/Manuals/TCAR-UG/Docbook/Repository/Worklines/l10n.docbook deleted file mode 100644 index 8134155..0000000 --- a/Manuals/TCAR-UG/Docbook/Repository/Worklines/l10n.docbook +++ /dev/null @@ -1,22 +0,0 @@ - - - Localization - - - The second step in the production cycle is to localize - source files (e.g., SVG, DocBook, Shell scripts). This step - makes possible to produce localized images, localized - documentation and localized automation scripts. - - - - The localization tasks are carried on by translators using the - locale functionality of the - centos-art.sh script which take care of - retriving translatable strings from source files and provide a - consistent localization interface based on GNU - gettext multi-lingual message - production tool set and xml2po command. - - - diff --git a/Manuals/TCAR-UG/Docbook/Repository/Worklines/manuals.docbook b/Manuals/TCAR-UG/Docbook/Repository/Worklines/manuals.docbook deleted file mode 100644 index ef40f87..0000000 --- a/Manuals/TCAR-UG/Docbook/Repository/Worklines/manuals.docbook +++ /dev/null @@ -1,20 +0,0 @@ - - - Documentation - - - The third step in the production cycle is to document &TCAR;, - what it is and how to use it. This step provides the - conceptual ideas used as base to edificate &TCPCVI; and is - implemented through &TCARUG;. - - - - To write documentation, documentors use the - help functionality of - centos-art.sh script which provide an - consistent interface for building documentation through - different documentation backends (e.g., Texinfo and DocBook). - - - diff --git a/Manuals/TCAR-UG/Docbook/Repository/Worklines/scripts.docbook b/Manuals/TCAR-UG/Docbook/Repository/Worklines/scripts.docbook deleted file mode 100644 index 53780f9..0000000 --- a/Manuals/TCAR-UG/Docbook/Repository/Worklines/scripts.docbook +++ /dev/null @@ -1,24 +0,0 @@ - - - Automation - - - The fourth step in the production cycle is to automate - frequent tasks inside &TCAR;. This step closes the production - cycle and provides the production standards needed by all - different work lines to coexist together. Here is where - the centos-art.sh script and all - its functionalities (e.g., render for - rendition, help for documentation, - locale for localization, etc.) are - developed. - - - - At this point it should be obvious, but we consider worth to - remember that: there is no need to type several tasks, time - after time, if they can be programmed into just one executable - script. - - -