% makeindex < aebpro_man.idx > aebpro_man.ind
\documentclass{article}
\usepackage[fleqn]{amsmath}
\usepackage[%
    web={centertitlepage,designv,tight,usetemplates,%usesf,
        forcolorpaper,latextoc,pro},
        eforms,aebxmp,graphicxsp={showembeds}
]{aeb_pro}
\usepackage{rmannot}
\usepackage{fldigigal}

%\usepackage{multicol}
\usepackage{aeb_mlink}
\usepackage{array}
\usepackage[altbullet]{lucidbry}
%\usepackage{myriadpro}

\usepackage{makeidx}
\makeindex
\usepackage{acroman}

\usepackage[inactive]{srcltx}

\def\expath{../examples}
\let\app\textsf

\urlstyle{tt}

\makeatletter
\renewcommand{\paragraph}
    {\@startsection{paragraph}{4}{0pt}{6pt}{-3pt}{\bfseries}}
\makeatother

\DeclareDocInfo
{
    university={\AcroTeX.Net},
    title={The \texorpdfstring{\textsf{fldigigal} Package\\[1em]}{: }
        Creating Flash Digital Galleries},
    author={D. P. Story},
    email={dpstory@acrotex.net},
    subject={Creating Flash Digital Galleries},
    talksite={\url{www.acrotex.net}},
    version={0.6, 2020/08/08},
    keywords={AcroTeX, PDF, Flash Photo Gallery, rmannot},
    copyrightStatus=True,
    copyrightNotice={Copyright (C) \the\year, D. P. Story},
    copyrightInfoURL={http://www.acrotex.net}
}

\def\dps{$\hbox{$\mathfrak D$\kern-.3em\hbox{$\mathfrak P$}%
   \kern-.6em \hbox{$\mathcal S$}}$}

\universityLayout{fontsize=Large}
\titleLayout{fontsize=LARGE}
\authorLayout{fontsize=Large}
\tocLayout{fontsize=Large,color=aeb}
\sectionLayout{indent=-40pt,fontsize=large,color=aeb,afterskip=1sp}
\subsectionLayout{indent=-20pt,color=aeb,afterskip=1sp}
\subsubsectionLayout{indent=0pt,color=aeb,afterskip=1sp}
\subsubDefaultDing{\texorpdfstring{$\bullet$}{\textrm\textbullet}}

\newenvironment{eqComments}[1][\strut]{\smallskip\leftskip-\labelwidth
\item[]\textbf{\textcolor{blue}{#1}}}{\par\smallskip}

%----------fldigigal--------------
\definePath{\pathToSource}{%
    C:/Users/Public/Documents/My TeX Files/tex/%
        latex/aeb/aebpro/fldigigal/doc}
\definePath{\digisOnline}{%
    http://www.math.uakron.edu/~dpstory/photos/pa_demo}
\definePath{\digisLocal}{\pathToSource/digis}

\fdgXmlList{myDigis}
{%
    \image{path=\digisOnline/Chrysanthemum.jpg,caption=Jürgen\'s Chrysanthemum,online} %\iso{252}
    \image{path=\digisOnline/Desert.jpg,caption=Desert,online}
    \image{path=\digisOnline/Hydrangeas.jpg,caption=Hydrangeas,online}
    \image{path=\digisOnline/Jellyfish.jpg,caption=Jellyfish,online}
    \image{path=\digisOnline/Koala.jpg,caption=Koala,online}
    \image{path=\digisOnline/Lighthouse.jpg,caption=Lighthouse,online}
    \image{path=\digisOnline/Penguins.jpg,caption=Penguins,online}
    \image{path=\digisOnline/Tulips.jpg,caption=Tulips,online}
}
%---------fldigigal---------------------

\optionalPageMatter{\begin{center}
\fbox{\begin{minipage}{.67\linewidth}
\textbf{\color{red}End of Life of Software:}
After \textbf{December 2020}, Adobe no longer supports Flash Player (SWF, FLV files).
This package uses custom SWF files
(\texttt{fdg\_ht1.swf}, \texttt{fdg\_nt1.swf}, and \texttt{fd\_vt1.swf}); as a result this package will no longer function
in \app{Adobe Acrobat Reader DC} (dated Dec.~2020 or later). The package will continue to produce
PDFs as designed, \emph{but only if built using \emph{\textsf{Acrobat XI} (or a
version \textsf{Acrobat DC} prior to December 2020)} and viewed in \emph{\textsf{Adobe
Acrobat Reader XI} (or a version of \textsf{Reader DC} prior to December
2020)}.}\hfill\dps
\end{minipage}}
\end{center}}

%\pagestyle{empty}
\parindent0pt\parskip\medskipamount

\definePath\bgPath{"C:/Users/Public/Documents/ManualBGs/Manual_BG_Print_AeB.pdf"}
\begin{docassembly}
\addWatermarkFromFile({
    bOnTop:false,
    cDIPath:\bgPath
});
\executeSave();
\end{docassembly}

\begin{document}

\maketitle

\selectColors{linkColor=black}
\tableofcontents
\selectColors{linkColor=webgreen}

\section{Introduction}\label{s:intro}

The \textsf{fldigigal} package is the third application of \textsf{rmannot};
the others are the {\AcroFLeX} and \textsf{yt4pdf} packages.\footnote{All packages mentioned here use
SWF files; they all become obsolete after Dec.\ 2020.}

The \emph{Flash Digital Gallery} distribution consists of a {\LaTeX}
package, \textsf{fldigigal}, several \textsf{SWF} files, a small collection
of digital photos, and sample files. The purpose of this distribution is
to provide a convenient way to create a Flash slide show. The distribution
offers several design layouts of the slide show, called \emph{galleries}.
Below is an example of a slide show created by \textsf{fldigigal} using
source code from this document.
\begin{center}%\previewtrue
\resizebox{.9\linewidth}{!}
{%
    \fgRmAnnot[galleryopts={gallery=vthumbs1,auto=false,captionalign=center},
        posternote={Flash Digital Gallery},enabled=pageopen
    ]{myDigis}
}
\end{center}
The photos themselves may be embedded in the PDF file (increasing the
file size), or may be referenced with an URL. The gallery can be manually
operated, or set to change photos at a regular interval.

There are steps for creating a flash digital gallery:
\begin{enumerate}
    \item In the preamble of your document, specify the digitals (PNG,
    JPG, GIF) you want displayed in you gallery. This is entered by
    using the \cs{fdgXmlList} command. See the section
    \Nameref{fdgXmlList} for details.
    \item In the body of the document, create a Rich Media Annotation (RMA)
    using the command \cs{fgRmAnnot}, defined in \textsf{fldigigal}. For
    details of this command, see the section
    \Nameref{fgRmAnnot}.
\end{enumerate}



\section{Requirements}

This package is part of \textsf{AeB Pro}, which means Acrobat Distiller is
used to create the PDF; the package requires \textsf{rmannot}, which
creates rich media annotations. Therefore, we require
\begin{equation*}
    \boxed{\text{\large\bfseries Adobe Acrobat, version 9.0 or later}}
\end{equation*}
To use this package, the document author must have AeB and AeB Pro
installed, as well as \textsf{rmannot}. The manual for \textsf{rmannot}
needs to be read closely to install it properly and for it to function correctly.

\section{Configuring your installation}

In addition to configuring the \textsf{rmannot} package correctly, the
\textsf{fldigigal} package needs configuring as well. The \textsf{fldigigal}
comes with a configuration file \texttt{fldigigal.cfg}.  Open this file in
your favorite editor to see
\begin{Verbatim}[fontsize=\small]
% fldigigal config file. Delete the \endinput below and replace the path
% provided with the path to the swf folder of your fldigigal installation.
% This path is used to locate the fldigigal SWF files.
\endinput
\renewcommand{\fdgFolder}{C:/Users/Public/Documents/My TeX Files/%
    tex/latex/aeb/aebpro/fldigigal/swf}
\end{Verbatim}
Edit this file so that \cs{fdgFolder} points to the \texttt{swf} folder on
your computer.

\section{In the Preamble: Populating the
\texorpdfstring{\protect\cs{fdgXmlList}}{\CMD{fdgXmlList}}
Command}\label{fdgXmlList}

The {\AcroTeX} Flash Gallery SWF files take several arguments that are
passed to it using \texttt{FlashVars}; one such variable is a reference to
an XML file that contains the paths and captions to the digital files.
When I began developing the package, the XML file was just hand-written in
an editor; when I started to write the package, I included the
\cs{fdgXmlList} command which writes the XML file as the source file is
compiled.

At the bare minimum, the preamble must include a definition for
\cs{pathToSource} and the \cs{fdgXmlList} command.

The definition of \cs{pathToSource} should be made using the
\cs{definePath} command, defined in the \textsf{eforms} package.
Here is one such definition to a sample file in this distribution.
\begin{Verbatim}[xleftmargin=20pt,fontsize=\small]
\definePath{\pathToSource}{%
    C:/Users/Public/Documents/My TeX Files/tex/%
        latex/aeb/aebpro/fldigigal/doc}
\end{Verbatim}
The \textsf{fldigigal} uses the Adobe Distiller to create the PDF file.
Distiller only works with absolute file references; so, Distiller needs to
know the location of XML file that is to be written by the \cs{fdgXmlList}
command. \emph{This definition is required}.

Another (optional, but recommended) definition is the path to the digital
files. The photos may reside on your local hard drive, or on the Internet.
In the example that follows, we illustrate the method of defining the
paths; one for a local hard drive, the other for photos found online.
\begin{Verbatim}[xleftmargin=20pt,fontsize=\small]
\definePath{\digisOnline}{%
    http://www.math.uakron.edu/~dpstory/photos/pa_demo}
\definePath{\digisLocal}{\pathToSource/digis}
\end{Verbatim}
These paths may then be conveniently included in the \texttt{path} key
of the \cs{image} command, see below.

\begin{dCmd*}{.67\linewidth}
\fdgXmlList[<kv-pairs>]{<name>}{%
    \image{...}
    \image{...}
    ...
    \image{...}
}
\end{dCmd*}
\CmdDescription When the source document compiles, this command writes an
XML file to the source file's folder. The XML is later embedded in the PDF
file when the file is distilled.
\PD The command has three arguments, the first is optional.
\begin{itemize}
    \item[\texttt{[\#1]}] The optional argument labeled above as
        \texttt{[<kv-pairs>]} may include only two (Boolean) key-value
        pairs: \texttt{showcounts} and \texttt{nowrite}.
    \begin{itemize}
        \item \texttt{showcounts} When this key appears as \texttt{showcount} or as
        \texttt{showcount=true}, a count and a total count of the number of
        photos appearing in the gallery is displayed in the title bar.
        The count appears as (1 of 8), for example, but this can be
        redefined by the command \cs{fdgcntOf}. The default definition
        is\medskip
\begin{Verbatim}[xleftmargin=20pt,fontsize=\small]
\newcommand{\fdgcntOf}[1]{\space(#1 of \fdg@numDigis)}
\end{Verbatim}
\par\medskip The default is that no count is written to the title bar of the gallery.
    \item \texttt{nowrite} You optionally include this key in the list
    if the XML has already been written to your source folder; however, if
    you change options, or change the key-value pairs of the \cs{image}
    commands, you will need to re-write the XML by removing the \texttt{nowrite}
    option.
    \end{itemize}
    \item[\texttt{\#2}] The second parameter, \texttt{<name>}, is a
        unique name for the gallery being created with the photos; for
        example \texttt{myVacation2010}. The name should follow the
        rules of a JavaScript variable.
    \item[\texttt{\#3}] The third argument consists of a series of
    \cs{image} commands, each command takes three key-value pairs.
    \begin{itemize}
        \item \texttt{path}: The path to the digital file, the path may be
        that to a digital file on your hard drive, or on the Internet.
        A digital file may be a \textsf{JPG}, \textsf{PNG}, or \textsf{GIF} file.
        \emph{This key is required}.
        \item \texttt{caption}: The (short) descriptive string to be
        displayed along with the associated photo. This key is optional,
        if not present, the filename of the digital file is displayed. See
        the optional key-values \texttt{nocaptions} and \texttt{nocaptionstext} of
        \cs{fgRmAnnot}.
        \item \texttt{online}: Use this key to indicate that the
        \texttt{path} key is an \textsf{URL}, and refers to a resource on the
        Internet. If this key is not present, it is assumed that path
        points to a file on the local hard drive, and Distiller will get
        that file and embed it in the PDF. If Distiller does not find the
        file, distillation is aborted and a message is written to the
        distiller long which suggests that it cannot find the file.
    \end{itemize}
\end{itemize}
Below is an example of the \cs{fdgXmlList} used for this document, I've
modified the first two entries by removing the \texttt{online} key, and
replacing \cs{digiOnline} with \cs{digisLocal} to demonstrate how you
reference each type. (The definitions of \cs{digiOnline} and
\cs{digisLocal} appeared earlier.)  For this definition below, two files
will be embedded (the first two), all others are online and the gallery
will get them from the Internet.
\begin{Verbatim}[numbers=left,xleftmargin=20pt,fontsize=\small]
\fdgXmlList{myDigis}
{%
    \image{path=\digisLocal/Chrysanthemum.jpg,
        caption=Jürgen\'s Chrysanthemum}
    \image{path=\digisLocal/Desert.jpg,caption=Desert}
    \image{path=\digisOnline/Hydrangeas.jpg,caption=Hydrangeas,online}
    \image{path=\digisOnline/Jellyfish.jpg,caption=Jellyfish,online}
    \image{path=\digisOnline/Koala.jpg,caption=Koala,online}
    \image{path=\digisOnline/Lighthouse.jpg,caption=Lighthouse,online}
    \image{path=\digisOnline/Penguins.jpg,caption=Penguins,online}
    \image{path=\digisOnline/Tulips.jpg,caption=Tulips,online}
}
\end{Verbatim}
One comment is needed, refer to line~(3). I've included my friend,
J\"{u}rgen, name value of the \texttt{caption} key to demonstrate how to
use special latin-1 characters. The u-umlaut (ü) may be entered by your
keyboard, as I have, or by special command \verb!\iso{252}!,
which expands to `\makeatletter\texttt{\fdg@iso{252}}\makeatother'. The
interested user is referred to these two online documents.
\begin{align*}
&\text{\footnotesize\url{http://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references}}\\
&\text{\footnotesize\url{http://www.html-entities.com/}}
\end{align*}
The \verb!\iso{<dec>}! command expands to \verb!&#<dec>;!, see above
\textsf{URLs} to determine the correct value of the \texttt{<dec>} to get
the desired glyph.

The second comment concerns the single apostrophe (\texttt{'}). The
captions are enclosed in single quotes, so if you want an apostrophe, you
must use the the character entity `\verb!&apos;!', or you can use
\verb!\'!, as I did above. This special command, redefined within a group,
expands to `\verb!&apos;!'. Thus, we can write \verb!Jürgen\'s!, or
\verb!Jürgen&apos;s!, or \verb!J\iso{252}rgen&apos;s!, etc. If you want to
use an ampersand, use `\verb!&amp;!'.

OK, that's it for the preamble; on to \cs{fgRmAnnot}!

\section{In the Body: Create a Gallery with
\texorpdfstring{\protect\cs{fgRmAnnot}}{\CMD{fgRmAnnot}}}\label{fgRmAnnot}

To create a flash gallery of photos, use the command \cs{fgRmAnnot}, its definition
uses the command \cs{rmAnnot}, which is defined in the \textsf{rmannot} package.
\begin{dCmd*}{.5\linewidth}
\fgRmAnnot[<kv-pairs>]{<name>}
\end{dCmd*}
\PD
\begin{enumerate}
    \item The first (optional) parameter is used to pass the key-value pairs of the
    \cs{rmAnnot} command. Additionally, the \texttt{galleryopts} key is
    recognized by the \cs{fgRmAnnot} command. The value of the \texttt{galleryopts} key
    consists of key-value pairs that customize the gallery.
    \begin{itemize}
        \item \texttt{gallery}: The value of this key determines the layout of the gallery.
        Permissible choices are  \texttt{vthumbs1} (vertical thumbnails on the left),
        \texttt{hthumbs1} (horizontal thumbnails below digital), and
        \texttt{nothumbs1} (no thumbnails, the caption bar is a multiline
        text field so longer captions may be displayed). More designs are
        possible, as my skill in \textsf{Flash Professional Pro CS5} increases. The default is
        \texttt{vthumbs1}.
        \item \texttt{trans}: This key determines the transition effects.
            Possible values are \texttt{Blinds}, \texttt{Fade},
            \texttt{Fly}, \texttt{Iris}, \texttt{Photo},
            \texttt{PixelDissolve}, \texttt{Rotate}, \texttt{Squeeze},
            \texttt{Wipe}, \texttt{Zoom}, \texttt{Random}. The default is
            \texttt{Random}.
        \item \texttt{transOn}: A Boolean switch, which if \texttt{true} (the
        default), transition effects are used to display the digital
        images. If \texttt{transOn=false}, no transitions are used.
        \item \texttt{auto}: If true, the gallery will automatically
            display the list of photos at a regular interval. The user can
            stop the automatic display by pressing the pause button. The
            default is \texttt{auto=true}.
        \item \texttt{delay}: The delay, in seconds, between the automatic display of
        photos. The default is 6 (seconds).
        \item \texttt{captionalign} The alignment of the text in the caption bar. Possible choces
        are \texttt{left} (the default), \texttt{right}, and
        \texttt{center}. This key-value pair is ignored for
        \texttt{gallery=nothumbs1}.
        \item \texttt{nocaptions}: A Boolean key, which if \texttt{true},
        the caption strings are not displayed in the caption bar.
        \item \texttt{nocaptionstext}: If the \texttt{nocaptions} key is
        passed, you can populate the caption bar with a static string.
        Thus, \texttt{nocaptionstext=Hi Mom!} displays the string `Hi Mom' in
        the caption bar for each and every photo.
    \end{itemize}

    \item[] See the manual for the \textsf{rmannot} package for more details on the
    key-value pairs that can be passed through the optional first
    parameter.

    \item The \texttt{<name>} argument matches the \texttt{<name>}
    argument of a \cs{fdgXmlList} declared in the preamble.
\end{enumerate}

\goodbreak

The example that appeared earlier in this manual has code

\begin{Verbatim}[numbers=left,xleftmargin=20pt,fontsize=\small]
\resizebox{.9\linewidth}{!}
{%
    \fgRmAnnot[%
        galleryopts={gallery=vthumbs1,auto=false,captionalign=center},
        posternote={Flash Digital Gallery},enabled=pageopen
    ]{myDigis}
}
\end{Verbatim}
Line~(1) shows how the gallery may be resized used using \cs{resizebox}
(or by using \cs{scalebox}). In line~(3) we have the \cs{fgRmAnnot}
command that creates the digital gallery. In line~(4), we specify some of the
\texttt{galleryopts} key-value pairs. The other key-value pairs (outside
the scope of \texttt{galleryopts} are \cs{rmAnnot} key-value pairs.
The second argument, the \texttt{<name>} argument is shown in line~(6).
This name matches the name declared earlier in the preamble in an
\cs{fdgXmlList} command.

\section{Sample files}

The following are the sample files shipped with \textsf{fldigigal}:
\begin{itemize}
    \item \texttt{fdg\_demo.tex} lays out the basic structure for creating
    a \emph{{\AcroTeX} Flash Digital Gallery}. You can experiment with
    this file by changing the options.
    \item \texttt{fdg\_demo\_fit.tex} demonstrates how to have a one-page
    gallery whose size matches the size of the page.
    \item \texttt{fdg\_min.tex} uses the minimum set of packages to
    generate an \textsl{{\AcroTeX} Flash Digital Gallery}.
\end{itemize}
Advanced examples may appear, in time, at the \href{http://www.math.uakron.edu/~dpstory/aebblog.html}{AeB Blog site}.


\bigskip

That's all for now, I simply must get back to my retirement. {\dps}

\end{document}
