Blame Manual/repository-latex/centos-art.sh-latex/Concepts/Frameworks/templates.tex

0668a4
% Part   : Concepts
0668a4
% Chapter: Frameworks
0668a4
% ------------------------------------------------------------
0668a4
% $Id: templates.tex 6207 2010-08-05 13:11:13Z al $
0668a4
% ------------------------------------------------------------
0668a4
0668a4
\section{Design Templates}
0668a4
\hypertarget{sec:Concepts:Frameworks:Templates}{}
0668a4
\label{sec:Concepts:Frameworks:Templates}
0668a4
0668a4
Design templates are plain text files. Design templates may or may not
0668a4
contain translation markers inside.  Design templates are used to
0668a4
define the CentOS visual style (the look and feel) of CentOS corporate
0668a4
identity in all its manifestations.  Design templates are the
0668a4
documents you need to create or edit in order to implement or maintain
0668a4
the monolithic CentOS corporate visual structure.  Design templates
0668a4
are normative documents that need to be conceived carefully.
0668a4
0668a4
Design templates may be based on specific markups (i.e. XHTML, SVG,
0668a4
CSS, etc.). If that is the case, translation markers may be combined
0668a4
inside the specific markup design template to create a translatable
0668a4
markup-specific design template. In contrast, if design templates do
0668a4
not have specific markup inside, they are considered the simpliest
0668a4
design templates because they only have translation markers inside.
0668a4
0668a4
Design templates can be read, edited, and studied using your favorite
0668a4
text editor. 
0668a4
0668a4
Design templates are specific to frameworks using design patterns to
0668a4
define the visual style of content produced inside them.  This is the
0668a4
case of frameworks inside ``trunk/Identity/'', where design templates
0668a4
are used to define images' visual style; and ``trunk/Translations/'',
0668a4
where design tempates are used to define translations' common files.
0668a4
0668a4
Inside frameworks, design templates are stored in a directory named
0668a4
`tpl'. This name is a convenction that scripts use to find framework's
0668a4
design tempate files. If you want to change the design template
0668a4
directory's name to something different from `tpl', you need to set
0668a4
the same name in all design templates' directories along the CentOS
0668a4
Artwork Repository, and update scripts to recognize the new name you
0668a4
set.  This is something you problably don't need to do, but if you
0668a4
still want to, please share your reasons in
0668a4
\href{mailto:centos-devel@centos.org}{centos-devel@centos.org} before
0668a4
commit your changes. Changing the design template directory's name is
0668a4
a big chanage that needs to be discussed in the community.
0668a4
0668a4
\subsection{Simpliest Design Templates}
0668a4
0668a4
The simpliest design templates are inside identity frameworks. The
0668a4
simpliest design tempaltes are plain text files with translation
0668a4
markers only.  These kind of design templates are used to define
0668a4
information like ``eula files'' (i.e trunk/Identity/Release/Tpl/eula)
0668a4
used by Anaconda and similar files.  The simpliest design template
0668a4
files do not use extension.
0668a4
0668a4
\subsection{Translation Design Templates} 
0668a4
0668a4
The translation design templates are inside translation frameworks.
0668a4
The translation design templats are plain text documents whithout any
0668a4
kind of markup.  Instead, they contain sed's replacements commands.
0668a4
As convenction, translation file names end with the extension `.sed'.
0668a4
Translation files are created and edited using your favorite text
0668a4
editor.
0668a4
0668a4
\subsection{SVG Design Templates}
0668a4
0668a4
The scalar vector graphics (SVG) design templates are inside identity
0668a4
frameworks.  The SVG design templates are plain text files with
0668a4
markup, based on SVG standard. The SVG standard is described at
0668a4
\href{http://www.w3.org/2000/svg}{http://www.w3.org/2000/svg}. 
0668a4
0668a4
Even SVG design templates can be read and edited with your favorite
0668a4
text editor, it is better to use a SVG editor like
0668a4
\href{http://www.inkscape.org/}{Inkscape} (see
0668a4
http://www.inkscape.org/) to create and edit them. The SVG design
0668a4
template files are used to define the visual style of images
0668a4
controlling the visual style of CentOS distribution, CentOS web sites,
0668a4
CentOS promotion, etc.
0668a4
0668a4
Inside SVG design templates, each object has an ``Id'' property.  By
0668a4
default the object's Id is a combination of letters and numbers
0668a4
granting its uniqueness inside the entire document.  
0668a4
0668a4
Inside CentOS Artwork Repository, SVG design templates are rendered
0668a4
automatically using the \texttt{render.sh} identity script.  The
0668a4
\texttt{render.sh} identity script looks for the object's Id property
0668a4
containing the CENTOSARTWORK uppercase word and exports its area as
0668a4
bitmap, automatically.
0668a4
0668a4
If you are designing SVG templates for CentOS Artwork Repository, and
0668a4
you are using the \texttt{render.sh} identity script to render them,
0668a4
you need to set the CENTOSARTWORK uppercase word as object's Id on the
0668a4
design object you want to export as bitmap during the rendering
0668a4
process. The CENTOSARTWORK uppercase word is a convenction used by
0668a4
scripts to find the export area on your SVG design templates.
0668a4
0668a4
In CentOS Artwork Repository, SVG design templates are released under
0668a4
the \href{http://creativecommons.org/licenses/by-sa/3.0/}{Creative
0668a4
Common Share-Alike License 3.0}.\footnote{See
0668a4
http://creativecommons.org/licenses/by-sa/3.0/} In Inkscape, you say
0668a4
so in the ``Document Metadata'' panel, available in the ``File'' menu.
0668a4
0668a4
\subsection{XHTML Design Templates} 
0668a4
0668a4
The XHTML design templates are inside identity frameworks. They are
0668a4
plain text with markup, based on the
0668a4
\href{http://www.w3.org/TR/xhtml1}{XHTML standard} described at
0668a4
\href{http://www.w3.org/TR/xhtml1}{http://www.w3.org/TR/xhtml1}. These
0668a4
files are created and edited using your favorite text editor.  XHTML
0668a4
design templates are used to define the visual style of files like the
0668a4
``Release Notes'' (trunk/Identity/Release/Tpl/release-notes.html) used
0668a4
by Anaconda.
0668a4