From 96908c95b00e6aef9779fdd449d204d649b51511 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Apr 17 2011 18:47:21 +0000 Subject: Update repository documentation manual. --- diff --git a/Manual/Directories/trunk/Identity/Brushes.texi b/Manual/Directories/trunk/Identity/Brushes.texi index c415a67..0683f53 100755 --- a/Manual/Directories/trunk/Identity/Brushes.texi +++ b/Manual/Directories/trunk/Identity/Brushes.texi @@ -9,9 +9,10 @@ Manipulation Program}. A brush is a pixmap or set of pixmaps used for painting through an image manipulation program like GIMP. Inside the repository, we've organized brushes in @emph{common brushes} and @emph{theme-specific -brushes}. In both cases, brushes are created under a @file{Xcf} -directory as @file{.xcf} files first and later exported to @file{.gbr} -or @file{.gih} format in the same level of @file{Xcf} directory. +brushes}. In both cases, brushes are initially created in @file{.xcf} +format and later exported to any of the brush formats recognized by +GIMP (e.g., @file{.gbr} or @file{.gih}) using the same name of its +source file. @float Figure, Brush file format and directory structure @verbatim @@ -30,40 +31,40 @@ trunk/Identity/Brushes trunk/Identity/Themes/Motifs/THEMENAME/THEMEVERSION/Brus @end float In order for both common brushes and theme-specific brushes to be -loaded by GIMP, they need to be stored under -@file{~/.gimp-2.2/brushes} directory. Since files related to brushes -already exist in the repository, there is no need to duplicate them in -@file{~/.gimp-2.2/brushes} directory, too. Instead, we make use of -symbolic links and file name convenctions to ``connect'' brushes -created in the repository with the standard location they need to be -stored in for GIMP to recognize them. In this configuration, when -links to brushes are created, if someone commits a change for a brush -you are using, that change will be immediatly available for you the -next time you update your working copy and refresh the Brushes panel -of GIMP. - -When new brushes are added to or removed from the repository, it is -required to update the connection between the brushes inside the -repository working copy and the links created in the predifined -location that GIMP uses to retrive them. Otherwise you may end up -with broken links or brushes in the repository which are not linked. +loaded by GIMP, related @file{.gbr} and @file{.gih} brush files need +to be stored under @file{~/.gimp-2.2/brushes} directory. This location +is out of CentOS Artwork Repository and provides no version control by +itself. This way, brushes aren't exported to this location but into +the repository directory structure which is versioned. Later, we +create symbolic links in @file{~/.gimp-2.2/brushes} to connect file +brushes inside the repository and, this way, provide the configuration +needed by GIMP to use the brush files produced inside the repository. + +@quotation +@strong{Warning} +When brushes are added to or removed from the repository, you need to +update your working copy and all information related to brushes inside +your workstation (e.g., brush links in @file{~/.gimp-2.2/brushes} and +the Brushes panel in GIMP). Otherwise, you may end up with broken +links or brushes in the repository that wouldn't be available for you +to use in GIMP. +@end quotation Inside the repository, common brushes and theme-specific brushes are -created individually in different locations. However, they all are -linked from one unique directory (i.e., @file{~/.gimp-2.2/brushes}). -This configuration may provoke overlapping of brushes if a name -convenction is not implemented correctly. In that sake, file names -used for brushes inside the repository must be unique, no matter where -they be. - -As convenction inside the repository, brush files are named using a -numerical value that start at 1 and increment one unit when a new -brush is added to the same directory. Later, when links are built, we -use one suffix for those brushes retrived from -@file{trunk/Identity/Brushes} and another suffix for those brushes -retrivided from theme-specific directories. Using both the numerical -value and the suffix information, it is possible to build unique -names for links under @file{~/.gimp-2.2/brushes} directory, scalably. +created individually in different locations, but they all are linked +from one unique location (i.e., @file{~/.gimp-2.2/brushes}). This +configuration may provoke brush overlapping if a name convenction is +not implemented correctly. In that sake, file names used for brushes +inside the repository must be unique, no matter where they be. + +As file name convenction inside the repository, brushes are named +using lowercase letters, numbers, minus characters and dot characters, +only. Additionally, when links are built, we use one suffix for those +brushes retrived from @file{trunk/Identity/Brushes} and another suffix +for those brushes retrivided from theme-specific directories. Using +both the brush file name and the suffix information, it is possible +to build unique names for links under @file{~/.gimp-2.2/brushes} +directory, scalably. @float Figure, Common brushes path relation @verbatim @@ -78,32 +79,29 @@ trunk/Identity/Brushes @float Figure, Theme-specific brushes path relation @verbatim trunk/Identity/Themes/Motifs/THEMENAME/THEMEVERSION/Brushes -|-- 1.gbr (file) <-- ~/.gimp-2.2/brushes/centos-THEMENAME-THEMEVERSION.1.gbr (link) -|-- 2.gbr (file) <-- ~/.gimp-2.2/brushes/centos-THEMENAME-THEMEVERSION.2.gbr (link) -`-- 3.gbr (file) <-- ~/.gimp-2.2/brushes/centos-THEMENAME-THEMEVERSION.3.gbr (link) +|-- 1.gbr (file) <-- ~/.gimp-2.2/brushes/centos-THEMENAME-THEMEVERSION-1.gbr (link) +|-- 2.gbr (file) <-- ~/.gimp-2.2/brushes/centos-THEMENAME-THEMEVERSION-2.gbr (link) +`-- 3.gbr (file) <-- ~/.gimp-2.2/brushes/centos-THEMENAME-THEMEVERSION-3.gbr (link) @end verbatim @caption{Theme-specific brushes path relation.} @end float -Each brush produced with GIMP has a description field associated which -is shown in the Brushes panel of GIMP. This description is set when -the brush is created as @file{.xcf} file and can be updated when it is +Brushes produced with GIMP has a description field associated that is +shown in the Brushes panel of GIMP. This description is set when the +brush is created as @file{.xcf} file and can be updated when it is exported either to @file{.gbr} or @file{.gih} format. It wouldn't be -too useful to have two or more brushes using the same description. So, -in order to have unique descriptions in brushes it is required to -provide them that way. In that sake, we use the same name schema used -to name brush files as description but without including the file -extension. This way, if we have the @file{centos-flame-3.gbr} brush, -its description would be @code{centos-flame-3}. +too useful to have two or more brushes using the same description so, +we also make description of brush files unique, too. In that sake, we +use the same name schema used to name brush links as description but +without including the file extension (e.g., if we have the +@file{centos-flame-3.gbr} brush, its description would be +@code{centos-flame-3}). @subsection Usage -How to use brushes is up to your creativeness. You can use brushes as -you consider them more appropriate for your graphical compositions. -However, adding and removing them from the repository is something we -need to standardize. It would be terribly sad being using one brush -and suddenly find out that it no longer exists, the next time you -update your working copy. +The way you use brushes is up to your creativeness. However, the way +brushes are made available needs to be standardized. That's the reason +of organizing brushes in common brushes and theme-specific brushes. @subsection Common brushes @@ -123,21 +121,22 @@ Theme-specific brushes exist to organize brushes that can be used inside specific artistic motifs only. Inside the repository, theme-specific brushes are stored in a directory named @file{Brushes} which is stored in the first directory level under the artistic motif -directory structure. Each artistic motif inside the repository has the -@file{Brushes} directory and uses it to store brushes that can be +directory structure. Each artistic motif inside the repository has its +own @file{Brushes} directory and uses it to store brushes that can be considered auxiliars to that artistic motif construction. Theme-specific brushes aren't made available under @file{~/.gimp-2.2/brushes} directory after preparing the repository. In order to make theme-specific brushes available under @file{~/.gimp-2.2./brushes} it is required to activate/deactivate them -using the @code{brush} functionality of @command{centos-art.sh} script -(). +using the @code{theme} functionality of @command{centos-art.sh} +script. @c (@pxref{Directories trunk Scripts Functions Theme}). @subsection See also @itemize -@item -@url{file:///usr/share/gimp/2.0/help/en/gimp-concepts-brushes.html,Brushes} -(from GIMP's manual) +@item @url{file:///usr/share/gimp/2.0/help/en/index.html,The Gimp +Manual}, specifically the section related to +@url{file:///usr/share/gimp/2.0/help/en/gimp-concepts-brushes.html, +Brushes}. @end itemize diff --git a/Manual/Introduction/authors.texi b/Manual/Introduction/authors.texi index 87f6878..8747241 100755 --- a/Manual/Introduction/authors.texi +++ b/Manual/Introduction/authors.texi @@ -29,7 +29,6 @@ Repository: @itemize @item @email{karan@@centos.org,Karanbirn Singh} @item @email{ralph@@centos.org,Ralph Angenendt} -@item @email{alain.reguera@@gmail.com,Alain Reguera Delgado} @end itemize @subsection Packaging diff --git a/Manual/repository.info.bz2 b/Manual/repository.info.bz2 index dfdce9e..80a3641 100644 Binary files a/Manual/repository.info.bz2 and b/Manual/repository.info.bz2 differ diff --git a/Manual/repository.pdf b/Manual/repository.pdf index 8ee8915..930f629 100644 Binary files a/Manual/repository.pdf and b/Manual/repository.pdf differ diff --git a/Manual/repository.txt.bz2 b/Manual/repository.txt.bz2 index 7dd7ef6..a00af41 100644 Binary files a/Manual/repository.txt.bz2 and b/Manual/repository.txt.bz2 differ diff --git a/Manual/repository.xhtml.tar.bz2 b/Manual/repository.xhtml.tar.bz2 index 300f945..bf45848 100644 Binary files a/Manual/repository.xhtml.tar.bz2 and b/Manual/repository.xhtml.tar.bz2 differ diff --git a/Manual/repository.xml b/Manual/repository.xml index bd7d081..ca21924 100644 --- a/Manual/repository.xml +++ b/Manual/repository.xml @@ -216,9 +216,6 @@ ralph@centos.orgRalph Angenendt - - alain.reguera@gmail.comAlain Reguera Delgado - @@ -1105,7 +1102,7 @@ centos-art help --read turnk/Identity/Themes/Motifs/TreeFlower/3 Description - A brush is a pixmap or set of pixmaps used for painting through an image manipulation program like GIMP. Inside the repository, we've organized brushes in common brushes and theme-specific brushes. In both cases, brushes are created under a Xcf directory as .xcf files first and later exported to .gbr or .gih format in the same level of Xcf directory. + A brush is a pixmap or set of pixmaps used for painting through an image manipulation program like GIMP. Inside the repository, we've organized brushes in common brushes and theme-specific brushes. In both cases, brushes are initially created in .xcf format and later exported to any of the brush formats recognized by GIMP (e.g., .gbr or .gih) using the same name of its source file. Figure @@ -1123,10 +1120,12 @@ trunk/Identity/Brushes trunk/Identity/Themes/Motifs/THEMENAME/THEMEVERSION/Brus ]]> Brush file format and directory structure. - In order for both common brushes and theme-specific brushes to be loaded by GIMP, they need to be stored under ~/.gimp-2.2/brushes directory. Since files related to brushes already exist in the repository, there is no need to duplicate them in ~/.gimp-2.2/brushes directory, too. Instead, we make use of symbolic links and file name convenctions to “connect” brushes created in the repository with the standard location they need to be stored in for GIMP to recognize them. In this configuration, when links to brushes are created, if someone commits a change for a brush you are using, that change will be immediatly available for you the next time you update your working copy and refresh the Brushes panel of GIMP. - When new brushes are added to or removed from the repository, it is required to update the connection between the brushes inside the repository working copy and the links created in the predifined location that GIMP uses to retrive them. Otherwise you may end up with broken links or brushes in the repository which are not linked. - Inside the repository, common brushes and theme-specific brushes are created individually in different locations. However, they all are linked from one unique directory (i.e., ~/.gimp-2.2/brushes). This configuration may provoke overlapping of brushes if a name convenction is not implemented correctly. In that sake, file names used for brushes inside the repository must be unique, no matter where they be. - As convenction inside the repository, brush files are named using a numerical value that start at 1 and increment one unit when a new brush is added to the same directory. Later, when links are built, we use one suffix for those brushes retrived from trunk/Identity/Brushes and another suffix for those brushes retrivided from theme-specific directories. Using both the numerical value and the suffix information, it is possible to build unique names for links under ~/.gimp-2.2/brushes directory, scalably. + In order for both common brushes and theme-specific brushes to be loaded by GIMP, related .gbr and .gih brush files need to be stored under ~/.gimp-2.2/brushes directory. This location is out of CentOS Artwork Repository and provides no version control by itself. This way, brushes aren't exported to this location but into the repository directory structure which is versioned. Later, we create symbolic links in ~/.gimp-2.2/brushes to connect file brushes inside the repository and, this way, provide the configuration needed by GIMP to use the brush files produced inside the repository. + + Warning When brushes are added to or removed from the repository, you need to update your working copy and all information related to brushes inside your workstation (e.g., brush links in ~/.gimp-2.2/brushes and the Brushes panel in GIMP). Otherwise, you may end up with broken links or brushes in the repository that wouldn't be available for you to use in GIMP. + + Inside the repository, common brushes and theme-specific brushes are created individually in different locations, but they all are linked from one unique location (i.e., ~/.gimp-2.2/brushes). This configuration may provoke brush overlapping if a name convenction is not implemented correctly. In that sake, file names used for brushes inside the repository must be unique, no matter where they be. + As file name convenction inside the repository, brushes are named using lowercase letters, numbers, minus characters and dot characters, only. Additionally, when links are built, we use one suffix for those brushes retrived from trunk/Identity/Brushes and another suffix for those brushes retrivided from theme-specific directories. Using both the brush file name and the suffix information, it is possible to build unique names for links under ~/.gimp-2.2/brushes directory, scalably. Figure @@ -1143,18 +1142,18 @@ trunk/Identity/Brushes Theme-specific brushes path relation. - Each brush produced with GIMP has a description field associated which is shown in the Brushes panel of GIMP. This description is set when the brush is created as .xcf file and can be updated when it is exported either to .gbr or .gih format. It wouldn't be too useful to have two or more brushes using the same description. So, in order to have unique descriptions in brushes it is required to provide them that way. In that sake, we use the same name schema used to name brush files as description but without including the file extension. This way, if we have the centos-flame-3.gbr brush, its description would be centos-flame-3. + Brushes produced with GIMP has a description field associated that is shown in the Brushes panel of GIMP. This description is set when the brush is created as .xcf file and can be updated when it is exported either to .gbr or .gih format. It wouldn't be too useful to have two or more brushes using the same description so, we also make description of brush files unique, too. In that sake, we use the same name schema used to name brush links as description but without including the file extension (e.g., if we have the centos-flame-3.gbr brush, its description would be centos-flame-3). Usage - How to use brushes is up to your creativeness. You can use brushes as you consider them more appropriate for your graphical compositions. However, adding and removing them from the repository is something we need to standardize. It would be terribly sad being using one brush and suddenly find out that it no longer exists, the next time you update your working copy. + The way you use brushes is up to your creativeness. However, the way brushes are made available needs to be standardized. That's the reason of organizing brushes in common brushes and theme-specific brushes. @@ -1165,8 +1164,9 @@ trunk/Identity/Themes/Motifs/THEMENAME/THEMEVERSION/Brushes Theme-specific brushes - Theme-specific brushes exist to organize brushes that can be used inside specific artistic motifs only. Inside the repository, theme-specific brushes are stored in a directory named Brushes which is stored in the first directory level under the artistic motif directory structure. Each artistic motif inside the repository has the Brushes directory and uses it to store brushes that can be considered auxiliars to that artistic motif construction. - Theme-specific brushes aren't made available under ~/.gimp-2.2/brushes directory after preparing the repository. In order to make theme-specific brushes available under ~/.gimp-2.2./brushes it is required to activate/deactivate them using the brush functionality of centos-art.sh script (). + Theme-specific brushes exist to organize brushes that can be used inside specific artistic motifs only. Inside the repository, theme-specific brushes are stored in a directory named Brushes which is stored in the first directory level under the artistic motif directory structure. Each artistic motif inside the repository has its own Brushes directory and uses it to store brushes that can be considered auxiliars to that artistic motif construction. + Theme-specific brushes aren't made available under ~/.gimp-2.2/brushes directory after preparing the repository. In order to make theme-specific brushes available under ~/.gimp-2.2./brushes it is required to activate/deactivate them using the theme functionality of centos-art.sh script. + @@ -1174,7 +1174,7 @@ trunk/Identity/Themes/Motifs/THEMENAME/THEMEVERSION/Brushes • - file:///usr/share/gimp/2.0/help/en/gimp-concepts-brushes.htmlBrushes (from GIMP's manual) + file:///usr/share/gimp/2.0/help/en/index.htmlThe Gimp Manual, specifically the section related to file:///usr/share/gimp/2.0/help/en/gimp-concepts-brushes.htmlBrushes.