Blame Manual/repository-latex/Distribution/Anaconda/Firstboot/framework.tex

4c79b5
\section{Identity}
4c79b5
\hypertarget{sec:Distribution:Anaconda:Firstboot:Identity}{}
4c79b5
\label{sec:Distribution:Anaconda:Firstboot:Identity}
4c79b5
4c79b5
\begin{description}
4c79b5
\item[framework:]
4c79b5
trunk/Identity/Themes/\$THEME/Distro/Anaconda/Firstboot/
4c79b5
\end{description}
4c79b5
4c79b5
\noindent Here is where CentOS firstboot design templates and image
4c79b5
rendering take place. Firstboot identity file structure is illustrated
4c79b5
in \autoref{fig:Distribution:Anaconda:Firstboot:Identity} and
4c79b5
described in the following sections.
4c79b5
4c79b5
\begin{figure}
4c79b5
\hrulefill
4c79b5
\begin{verbatim}
4c79b5
trunk/Identity/Themes/$THEME/Distro/Anaconda/Firstboot/
4c79b5
|-- img
4c79b5
|   |-- 3
4c79b5
|   |   `-- splash-small.png
4c79b5
|   |-- 4
4c79b5
|   |   `-- splash-small.png
4c79b5
|   |-- 5
4c79b5
|   |   `-- splash-small.png
4c79b5
|   |-- ... (more releases here)
4c79b5
|   `-- firstboot-left.png
4c79b5
|-- render.sh
4c79b5
`-- tpl
4c79b5
    |-- firstboot-left.svg
4c79b5
        `-- splash-small.svg
4c79b5
\end{verbatim}
4c79b5
\hrulefill
4c79b5
\caption{Firstboot identity framework.%
4c79b5
   \label{fig:Distribution:Anaconda:Firstboot:Identity}}
4c79b5
\end{figure}
4c79b5
4c79b5
\subsection{Design Templates}
4c79b5
4c79b5
\begin{description}
4c79b5
\item[framework:]
4c79b5
trunk/Identity/Themes/\$THEME/Distro/Anaconda/Firstboot/Tpl/
4c79b5
\end{description}
4c79b5
4c79b5
\noindent Here is where Firstboot design templates are stored.
4c79b5
Firstboot design templates control Firstboot's visual style. 
4c79b5
4c79b5
\begin{description}
4c79b5
4c79b5
\item[firstboot-left.svg:] This design is common for all major
4c79b5
releases of CentOS Distribution. It is visible in all firstboot
4c79b5
screens. In
4c79b5
\autoref{fig:Distribution:Anaconda:Firstboot:Identity:Models}, this
4c79b5
design is illustraded by the number 8.
4c79b5
4c79b5
\item[splash-small.svg:] This design is specific for each major
4c79b5
release of CentOS Distribution.  There is one splash-small.png image
4c79b5
for each major release of CentOS Distribution. This image is visible
4c79b5
only in the first (Welcome) screen of Firstboot. In
4c79b5
\autoref{fig:Distribution:Anaconda:Firstboot:Identity:Models}, this
4c79b5
design is illustraded by number 5.
4c79b5
4c79b5
\end{description}
4c79b5
4c79b5
\subsection{Design Models}
4c79b5
4c79b5
\begin{description}
4c79b5
\item[framework:]
4c79b5
trunk/Identity/Models/Distro/Anaconda/Firstboot/
4c79b5
\end{description}
4c79b5
4c79b5
\noindent Here is where firstboot design models are stored. Firstboot
4c79b5
design model is shown in
4c79b5
\autoref{fig:Distribution:Anaconda:Firstboot:Identity:Models} and described
4c79b5
below: 
4c79b5
4c79b5
\begin{figure}
4c79b5
\begin{center}
4c79b5
\fbox{\includegraphics[width=0.8\textwidth]{%
4c79b5
../Identity/Models/Img/en/Distro/Anaconda/Firstboot/splash-small.pdf}}
4c79b5
\end{center}
4c79b5
\caption{Firstboot design model.%
4c79b5
   \label{fig:Distribution:Anaconda:Firstboot:Identity:Models}}
4c79b5
\end{figure}
4c79b5
4c79b5
\begin{description}
4c79b5
4c79b5
\item[1:] List of labels and a pointer showing in which configuration
4c79b5
screen you are.
4c79b5
4c79b5
\item[2:] Screen icon. The screen icon is visible in all firstboot
4c79b5
screens. Each firsboot screen may have its own screen icon.
4c79b5
4c79b5
\item[3:] Screen label.
4c79b5
4c79b5
\item[4:] Screen description. 
4c79b5
4c79b5
\item[5:] Splash image (splash-small.png). The splash
4c79b5
image is visible in firstboot welcome screen only.
4c79b5
4c79b5
\item[6:] Configuration stuff.
4c79b5
4c79b5
\item[7:] Navigation area. Basically two buttons to navegate
4c79b5
configuration back and forward.
4c79b5
4c79b5
\item[8:] List of labels' background image (firtboot-left.png).  This
4c79b5
image is visible in all firstboot screens.
4c79b5
4c79b5
\end{description}
4c79b5
4c79b5
\subsection{Image Files}
4c79b5
\hypertarget{sec:Distribution:Anaconda:Firstboot:Identity:Images}{}
4c79b5
\label{sec:Distribution:Anaconda:Firstboot:Identity:Images}
4c79b5
4c79b5
\begin{description}
4c79b5
\item[framework:]
4c79b5
trunk/Identity/Themes/\$THEME/Distro/Anaconda/Firstboot/Img/
4c79b5
\end{description}
4c79b5
4c79b5
\noindent Here is where firstboot final images are stored. 
4c79b5
4c79b5
\subsection{Image Files Rendering}
4c79b5
\hypertarget{sec:Distribution:Anaconda:Firstboot:Identity:ImagesRendering}{}
4c79b5
\label{sec:Distribution:Anaconda:Firstboot:Identity:ImagesRendering}
4c79b5
4c79b5
\begin{description}
4c79b5
\item[framework:]
4c79b5
trunk/Identity/Themes/\$THEME/Distro/Anaconda/Firstboot/
4c79b5
\end{description}
4c79b5
4c79b5
\noindent Here is where you produce firstboot images. The following
4c79b5
rendering examples, based on
4c79b5
\autoref{fig:Distribution:Anaconda:Firstboot:Translations}, illustrate
4c79b5
the firstboot image files rendering process.\\
4c79b5
\\
4c79b5
\fbox{\texttt{./render.sh}}\\
4c79b5
\\
4c79b5
\fbox{\texttt{./render.sh '(5|6)/splash'}}\\
4c79b5
\\
4c79b5
\fbox{\texttt{./render.sh '(firstboot-left|5|4)/splash'}}
4c79b5
4c79b5
\section{Translations}
4c79b5
\hypertarget{sec:Distribution:Anaconda:Firstboot:Translations}{}
4c79b5
\label{sec:Distribution:Anaconda:Firstboot:Translations}
4c79b5
4c79b5
\begin{description}
4c79b5
\item[framework:]
4c79b5
trunk/Translations/Identity/Themes/Distro/Anaconda/Firstboot
4c79b5
\end{description}
4c79b5
4c79b5
\noindent Here is where translators locale firstboot images. Image
4c79b5
localization is defined inside .sed files, also known as translation
4c79b5
files.  Translation files can be common or specific. The given
4c79b5
organization of translation files defines the translation path.
4c79b5
4c79b5
\begin{figure}[!hbp]
4c79b5
\hrulefill
4c79b5
\begin{verbatim}
4c79b5
trunk/Translations/Identity/Themes/Distro/Anaconda/Firstboot
4c79b5
|-- 3
4c79b5
|   `-- splash-small.sed
4c79b5
|-- 4
4c79b5
|   `-- splash-small.sed
4c79b5
|-- 5
4c79b5
|   `-- splash-small.sed
4c79b5
|-- ... (more release directories)
4c79b5
`-- firstboot-left.sed
4c79b5
\end{verbatim}
4c79b5
\hrulefill
4c79b5
\caption{Firstboot translation path.%
4c79b5
   \label{fig:Distribution:Anaconda:Firstboot:Translations}}
4c79b5
\end{figure}
4c79b5
4c79b5
\subsection{Translation Markers}
4c79b5
4c79b5
In firstboot, markers are used in the file splash-small.svg only,
4c79b5
specifically to set the major release number of CentOS Distribution in
4c79b5
CentOS Release Brand. Since firstboot-left.svg design is common for
4c79b5
all CentOS Distribution there is no need to set any marker on it.
4c79b5
4c79b5
Markers used in firstboot design templates and translation files are
4c79b5
described in \autoref{tab:Distribution:Anaconda:Firstboot:Markers}.
4c79b5
4c79b5
\begin{table}
4c79b5
\centering
4c79b5
\begin{tabular}{rl}
4c79b5
\hline
4c79b5
\textbf{Marker} & \textbf{Description}\\
4c79b5
\hline
4c79b5
=MAJOR\_RELEASE= & Major release number of CentOS Distribution.\\
4c79b5
\hline
4c79b5
\end{tabular}
4c79b5
\caption{Firstboot translation markers.%
4c79b5
   \label{tab:Distribution:Anaconda:Firstboot:Markers}}
4c79b5
\end{table}
4c79b5
4c79b5
\section{Manuals}
4c79b5
\hypertarget{sec:Distribution:Anaconda:Firstboot:Manuals}{}
4c79b5
\label{sec:Distribution:Anaconda:Firstboot:Manuals}
4c79b5
4c79b5
\begin{description}
4c79b5
\item[framework:]
4c79b5
trunk/Manuals/Distribution/Anaconda/Firstboot/
4c79b5
\end{description}
4c79b5
4c79b5
\noindent Here is where firstboot documentation is stored.  If you
4c79b5
want to help improving Firstboot documentation this is the place you
4c79b5
need to go.
4c79b5
4c79b5
\section{Scripts}
4c79b5
\hypertarget{sec:Distribution:Anaconda:Firstboot:Scripts}{}
4c79b5
4c79b5
\begin{description}
4c79b5
\item[framework:] trunk/Scripts/Config/Identity/Themes/Distro/Anaconda/Firstboot/
4c79b5
\end{description}
4c79b5
4c79b5
\noindent Here is stored the Firstboot \texttt{render.conf.sh}
4c79b5
configuration script.  To render Firstboot images correctly, the
4c79b5
\texttt{ARTCOMP} configuration variable inside Anaconda progress
4c79b5
configuration script should be defined as illustrated in
4c79b5
\autoref{fig:Distribution:Anaconda:Firstboot:Scripts:Config}. 
4c79b5
4c79b5
\begin{figure}
4c79b5
\hrulefill
4c79b5
\begin{verbatim}
4c79b5
# Define artwork component.
4c79b5
ARTCOMP='Identity/Themes/Distro/Anaconda/Firstboot'
4c79b5
\end{verbatim}
4c79b5
\hrulefill
4c79b5
\caption{Firstboot configuration layout.%
4c79b5
   \label{fig:Distribution:Anaconda:Firstboot:Scripts:Config}}
4c79b5
\end{figure}
4c79b5