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

108c62
@subsection 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
108c62
@subsection 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
b0bf66
brushes}.  In both cases, brushes are created under a @file{Xcf}
b0bf66
directory as @file{.xcf} files first and later exported to @file{.gbr}
b0bf66
or @file{.gih} format in the same level of @file{Xcf} directory.
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
b0bf66
loaded by GIMP, they need to be stored under
b0bf66
@file{~/.gimp-2.2/brushes} directory. Since files related to brushes
b0bf66
already exist in the repository, there is no need to duplicate them in
b0bf66
@file{~/.gimp-2.2/brushes} directory, too.  Instead, we make use of
b0bf66
symbolic links and file name convenctions to ``connect'' brushes
b0bf66
created in the repository with the standard location they need to be
b0bf66
stored in for GIMP to recognize them. In this configuration, when
b0bf66
links to brushes are created, if someone commits a change for a brush
b0bf66
you are using, that change will be immediatly available for you the
b0bf66
next time you update your working copy and refresh the Brushes panel
b0bf66
of GIMP.
b0bf66
b0bf66
When new brushes are added to or removed from the repository, it is
b0bf66
required to update the connection between the brushes inside the
b0bf66
repository working copy and the links created in the predifined
b0bf66
location that GIMP uses to retrive them.  Otherwise you may end up
b0bf66
with broken links or brushes in the repository which are not linked.
b0bf66
b0bf66
Inside the repository, common brushes and theme-specific brushes are
b0bf66
created individually in different locations. However, they all are
b0bf66
linked from one unique directory (i.e., @file{~/.gimp-2.2/brushes}).
b0bf66
This configuration may provoke overlapping of brushes if a name
b0bf66
convenction is not implemented correctly.  In that sake, file names
b0bf66
used for brushes inside the repository must be unique, no matter where
b0bf66
they be.
b0bf66
b0bf66
As convenction inside the repository, brush files are named using a
b0bf66
numerical value that start at 1 and increment one unit when a new
b0bf66
brush is added to the same directory. Later, when links are built, we
b0bf66
use one suffix for those brushes retrived from
b0bf66
@file{trunk/Identity/Brushes} and another suffix for those brushes
b0bf66
retrivided from theme-specific directories. Using both the numerical
b0bf66
value and the suffix information,  it is possible to build unique
b0bf66
names for links under @file{~/.gimp-2.2/brushes} 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
b0bf66
|-- 1.gbr (file) <-- ~/.gimp-2.2/brushes/centos-THEMENAME-THEMEVERSION.1.gbr (link)
b0bf66
|-- 2.gbr (file) <-- ~/.gimp-2.2/brushes/centos-THEMENAME-THEMEVERSION.2.gbr (link)
b0bf66
`-- 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
b0bf66
Each brush produced with GIMP has a description field associated which
b0bf66
is shown in the Brushes panel of GIMP.  This description is set when
b0bf66
the 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
b0bf66
too useful to have two or more brushes using the same description. So,
b0bf66
in order to have unique descriptions in brushes it is required to
b0bf66
provide them that way. In that sake, we use the same name schema used
b0bf66
to name brush files as description but without including the file
b0bf66
extension.  This way, if we have the @file{centos-flame-3.gbr} brush,
b0bf66
its description would be @code{centos-flame-3}.
108c62
108c62
@subsection Usage
108c62
b0bf66
How to use brushes is up to your creativeness. You can use brushes as
b0bf66
you consider them more appropriate for your graphical compositions.
b0bf66
However, adding and removing them from the repository is something we
b0bf66
need to standardize. It would be terribly sad being using one brush
b0bf66
and suddenly find out that it no longer exists, the next time you
b0bf66
update your working copy.
b0bf66
b0bf66
@subsection 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
b0bf66
@subsection 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
b0bf66
directory structure. Each artistic motif inside the repository has the
b0bf66
@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
b0bf66
using the @code{brush} functionality of @command{centos-art.sh} script
b0bf66
().
108c62
108c62
@subsection See also
108c62
b0bf66
@itemize
b0bf66
@item
b0bf66
@url{file:///usr/share/gimp/2.0/help/en/gimp-concepts-brushes.html,Brushes}
b0bf66
(from GIMP's manual) 
b0bf66
@end itemize