Blame Manual/Directories/trunk/Identity/Brushes.texi

41622d
@subheading Goals
108c62
b0bf66
This section describes how brushes are organized in the repository and
b0bf66
how to make them available for you to use in @acronym{GIMP,GNU Image
b0bf66
Manipulation Program}.
108c62
41622d
@subheading Description
108c62
b0bf66
A brush is a pixmap or set of pixmaps used for painting through an
b0bf66
image manipulation program like GIMP.  Inside the repository, we've
b0bf66
organized brushes in @emph{common brushes} and @emph{theme-specific
96908c
brushes}.  In both cases, brushes are initially created in @file{.xcf}
96908c
format and later exported to any of the brush formats recognized by
96908c
GIMP (e.g., @file{.gbr} or @file{.gih}) using the same name of its
96908c
source file.
b0bf66
b0bf66
@float Figure, Brush file format and directory structure
b0bf66
@verbatim
b0bf66
1. Common brushes       2. Theme-specific brushes
b0bf66
----------------------  -----------------------------------------------------------
b0bf66
trunk/Identity/Brushes  trunk/Identity/Themes/Motifs/THEMENAME/THEMEVERSION/Brushes
b0bf66
|-- Xcf                 |-- Xcf
b0bf66
|   |-- 1.xcf           |   |-- 1.xcf
b0bf66
|   |-- 2.xcf           |   |-- 2.xcf
b0bf66
|   `-- 3.xcf           |   `-- 3.xcf
b0bf66
|-- 1.gbr               |-- 1.gbr
b0bf66
|-- 2.gih               |-- 2.gih
b0bf66
`-- 3.gbr               `-- 3.gbr
b0bf66
@end verbatim
b0bf66
@caption{Brush file format and directory structure.}
b0bf66
@end float
b0bf66
b0bf66
In order for both common brushes and theme-specific brushes to be
96908c
loaded by GIMP, related @file{.gbr} and @file{.gih} brush files need
96908c
to be stored under @file{~/.gimp-2.2/brushes} directory. This location
96908c
is out of CentOS Artwork Repository and provides no version control by
96908c
itself. This way, brushes aren't exported to this location but into
96908c
the repository directory structure which is versioned. Later, we
96908c
create symbolic links in @file{~/.gimp-2.2/brushes} to connect file
96908c
brushes inside the repository and, this way, provide the configuration
96908c
needed by GIMP to use the brush files produced inside the repository.
96908c
96908c
@quotation
96908c
@strong{Warning}
96908c
When brushes are added to or removed from the repository, you need to
96908c
update your working copy and all information related to brushes inside
96908c
your workstation (e.g., brush links in @file{~/.gimp-2.2/brushes} and
96908c
the Brushes panel in GIMP).  Otherwise, you may end up with broken
96908c
links or brushes in the repository that wouldn't be available for you
96908c
to use in GIMP.
96908c
@end quotation
b0bf66
b0bf66
Inside the repository, common brushes and theme-specific brushes are
96908c
created individually in different locations, but they all are linked
96908c
from one unique location (i.e., @file{~/.gimp-2.2/brushes}).  This
96908c
configuration may provoke brush overlapping if a name convenction is
96908c
not implemented correctly.  In that sake, file names used for brushes
96908c
inside the repository must be unique, no matter where they be.
96908c
96908c
As file name convenction inside the repository, brushes are named
96908c
using lowercase letters, numbers, minus characters and dot characters,
96908c
only.  Additionally, when links are built, we use one suffix for those
96908c
brushes retrived from @file{trunk/Identity/Brushes} and another suffix
96908c
for those brushes retrivided from theme-specific directories.  Using
96908c
both the brush file name and the suffix information,  it is possible
96908c
to build unique names for links under @file{~/.gimp-2.2/brushes}
96908c
directory, scalably.
b0bf66
b0bf66
@float Figure, Common brushes path relation
b0bf66
@verbatim
b0bf66
trunk/Identity/Brushes
b0bf66
|-- 1.gbr (file) <-- ~/.gimp-2.2/brushes/centos-1.gbr (link)
b0bf66
|-- 2.gbr (file) <-- ~/.gimp-2.2/brushes/centos-2.gbr (link)
b0bf66
`-- 3.gbr (file) <-- ~/.gimp-2.2/brushes/centos-3.gbr (link)
b0bf66
@end verbatim
b0bf66
@caption{Common brushes path relation.}
b0bf66
@end float
b0bf66
b0bf66
@float Figure, Theme-specific brushes path relation
b0bf66
@verbatim
b0bf66
trunk/Identity/Themes/Motifs/THEMENAME/THEMEVERSION/Brushes
96908c
|-- 1.gbr (file) <-- ~/.gimp-2.2/brushes/centos-THEMENAME-THEMEVERSION-1.gbr (link)
96908c
|-- 2.gbr (file) <-- ~/.gimp-2.2/brushes/centos-THEMENAME-THEMEVERSION-2.gbr (link)
96908c
`-- 3.gbr (file) <-- ~/.gimp-2.2/brushes/centos-THEMENAME-THEMEVERSION-3.gbr (link)
b0bf66
@end verbatim
b0bf66
@caption{Theme-specific brushes path relation.}
b0bf66
@end float
b0bf66
96908c
Brushes produced with GIMP has a description field associated that is
96908c
shown in the Brushes panel of GIMP.  This description is set when the
96908c
brush is created as @file{.xcf} file and can be updated when it is
b0bf66
exported either to @file{.gbr} or @file{.gih} format. It wouldn't be
96908c
too useful to have two or more brushes using the same description so,
96908c
we also make description of brush files unique, too. In that sake, we
96908c
use the same name schema used to name brush links as description but
96908c
without including the file extension (e.g., if we have the
96908c
@file{centos-flame-3.gbr} brush, its description would be
96908c
@code{centos-flame-3}).
108c62
41622d
@subheading Usage
108c62
96908c
The way you use brushes is up to your creativeness. However, the way
96908c
brushes are made available needs to be standardized. That's the reason
96908c
of organizing brushes in common brushes and theme-specific brushes.
b0bf66
41622d
@subheading Common brushes
b0bf66
b0bf66
Common brushes exist to organize brushes that can be used anywhere
b0bf66
inside the repository. Inside the repository, common brushes under
b0bf66
@file{trunk/Identity/Brushes} are mainly used to hold brand
b0bf66
information related to The CentOS Project (e.g., symbols, logos,
b0bf66
trademarks, etc.).
b0bf66
b0bf66
Common brushes are always made available under
b0bf66
@file{~/.gimp-2.2/brushes} directory after preparing the repository
b0bf66
(@pxref{Directories trunk Scripts Functions Prepare}).
b0bf66
41622d
@subheading Theme-specific brushes
b0bf66
b0bf66
Theme-specific brushes exist to organize brushes that can be used
b0bf66
inside specific artistic motifs only. Inside the repository,
b0bf66
theme-specific brushes are stored in a directory named @file{Brushes}
b0bf66
which is stored in the first directory level under the artistic motif
96908c
directory structure. Each artistic motif inside the repository has its
96908c
own @file{Brushes} directory and uses it to store brushes that can be
b0bf66
considered auxiliars to that artistic motif construction.
b0bf66
b0bf66
Theme-specific brushes aren't made available under
b0bf66
@file{~/.gimp-2.2/brushes} directory after preparing the repository.
b0bf66
In order to make theme-specific brushes available under
b0bf66
@file{~/.gimp-2.2./brushes} it is required to activate/deactivate them
96908c
using the @code{theme} functionality of @command{centos-art.sh}
96908c
script. @c (@pxref{Directories trunk Scripts Functions Theme}).
108c62
41622d
@subheading See also
108c62
b0bf66
@itemize
96908c
@item @url{file:///usr/share/gimp/2.0/help/en/index.html,The Gimp
96908c
Manual}, specifically the section related to
96908c
@url{file:///usr/share/gimp/2.0/help/en/gimp-concepts-brushes.html,
96908c
Brushes}.
b0bf66
@end itemize