\HeaderA{getPkgVigList}{A function to retrieve a listing of package vignettes}{getPkgVigList}
\aliasA{baseVigDesc}{getPkgVigList}{baseVigDesc}
\aliasA{getVigInfo}{getPkgVigList}{getVigInfo}
\aliasA{getVigInfoNames}{getPkgVigList}{getVigInfoNames}
\aliasA{print.pkgFileList}{getPkgVigList}{print.pkgFileList}
\aliasA{transformVigInfoLine}{getPkgVigList}{transformVigInfoLine}
\keyword{utilities}{getPkgVigList}
\begin{Description}\relax
Functionality to retrive vignette metadata, on a per-vignette or a
per-package level.
\end{Description}
\begin{Usage}
\begin{verbatim}
getPkgVigList(pkg, vigDescFun=baseVigDesc, vigPath = "/doc/", 
vigExt="\\.(Rnw|Snw|rnw|snw|Rtex)$", pkgVers = TRUE)

getVigInfo(vig,pkg=NULL, vigDescFun=baseVigDesc, pkgVers=TRUE)
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{pkg}] Path to a package directory
\item[\code{vig}] Filename of a vignette
\item[\code{vigDescFun}] Function to provide output string for display
\item[\code{vigPath}] Path to directory that contains vignettes in the
package
\item[\code{vigExt}] Regular expression pattern to match vignette file extensions
\item[\code{pkgVers}] Record the package version with the other vignette metadata
\end{ldescription}
\end{Arguments}
\begin{Details}\relax
getPkgVigList: This function will look at all vignette files in the directory
\code{<pkg>/<vigPath>}.  It will then extract any header information (using
\code{getVigInfo}), and return a list of this information.

getVigInfo:  This function will retrieve the metadata from a
particular vignette file.  Any line starting with '\%\bsl{}Vignette' is
taken to be metadata.  Common values include VignetteIndexEntry (required),
VignetteKeywords, VignetteDepends, etc.  A named list of lists is
returned to the user, where the names correspond to the particular
metadata variable.

Both functions take a parameter \code{baseVigDesc}, which is a
function to provide the output string to correspond with a vignette
summary.  This function is directly called by \code{getVigInfo}.  It
takes one parameter, which is a vigInfo list from \code{getVigInfo}.
\end{Details}
\begin{Author}\relax
Jeff Gentry
\end{Author}
\begin{SeeAlso}\relax
\code{\LinkA{vignette}{vignette}}
\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}
## Not run: 
   ## We need a vignette for this to work
   dynPath <- .path.package("DynDoc")
   vigList <- getPkgVigList(dynPath)
   vigList
## End(Not run)
\end{ExampleCode}
\end{Examples}