###########################################################################/**

# @RdocFunction parseVignette

#

# @title "Parses an Rnw file"

#

# \description{

#  @get "title".

# }

#

# @synopsis

#

# \arguments{

#   \item{pathname}{The Rnw file to be parsed.}

#   \item{commentPrefix}{A regular expression specifying the prefix

#     pattern of vignette comments.}

#   \item{final}{If @TRUE, the output PDF or HTML file is also located.}

#   \item{source}{If @TRUE, the output R source code file is also located.}

#   \item{maxLines}{The maximum number of lines to scan.}

#   \item{...}{Not used.}

# }

#

# \value{

#   Returns a named @list or NULL if a non-vignette.

# }

#

# @author

#

# @keyword file

# @keyword IO

# @keyword internal

#*/###########################################################################

parseVignette <- function(pathname, commentPrefix="^[ \t]*%[ \t]*", final=FALSE, source=FALSE, maxLines=-1L, ...) {

  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  # Local functions

  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

     # All available output files

     # Order by decreasing filename lengths

  }

  }

  # Parse for "\Vignette" options

  # Nothing found?

  }

  # If the first entry is not among the first 20 rows, assume the ones

  # founds are part of the text document such entries rather than entries

  # used for the vignette itself.

  }

  # Drop duplicated entries, assuming the first ones are the intended

  # ones.  The extra ones may happen when a vignette documents how to

  # use %\\VignetteNnn{} markup.

  # No %\VignetteIndexEntry{}?

  }

  # Look for a generated PDF or HTML file?

     }

  }

  # Look for a generated R source code file?

     }

  }

  # Assert unique entries

  }

} # parseVignette()

###########################################################################/**

# @RdocFunction parseVignettes

#

# @title "Locates and parses all vignettes"

#

# \description{

#  @get "title".

# }

#

# @synopsis

#

# \arguments{

#   \item{path}{The directory where to search for vignettes.}

#   \item{pattern}{Filename pattern to locate vignettes.}

#   \item{...}{Additional arguments passed to @see "parseVignette".}

#   \item{drop}{A @vector of filename patterns of vignette sources

#    to be ignored.}

# }

#

# \value{

#   Returns a @list where each element corresponds to an

#   identified vignette source file.  A file is considered to be

#   a vignette source file if it has \code{\\Vignette.*\{\}} markups

#   in the top 50 lines.

#   Each such vignette element consists of a named @list with

#   the parse \code{\\Vignette.*\{\}} information.

# }

#

# @author

#

# @keyword file

# @keyword IO

# @keyword internal

#*/###########################################################################

parseVignettes <- function(path=".", pattern="[.][^.~]*$", ..., drop="^dummy.tex$") {

  # Ignore certain files, e.g. "^dummy.Rnw$"?

    }

  }

  }

} # parseVignettes()

###########################################################################/**

# @RdocFunction buildNonSweaveVignette

#

# @title "Builds a non-Sweave Rnw vignette"

#

# \description{

#  @get "title".

# }

#

# @synopsis

#

# \arguments{

#   \item{pathname}{The vignette file to be built.}

#   \item{...}{Not used.}

# }

#

# \value{

#   Returns (invisibly) a named @list.

# }

#

# @author

#

# @keyword file

# @keyword IO

# @keyword internal

#*/###########################################################################

buildNonSweaveVignette <- function(vign, envir=new.env(), ...) {

  # Local functions

  }

  # A filename?

  }

  # Load required packages

    }

  }

  # Build vignette according to \VignetteBuild{} command

    # Retrieve the "engine" according to \VignetteEngine{} expression

    # Parse \VignetteBuild{} expression

    })

    # Evaluate \VignetteBuild{} expression

  } else {

     # If not specified, assume Sweave

  }

  # Was a function specified?

  }

} # buildNonSweaveVignette()

###########################################################################/**

# @RdocFunction buildNonSweaveVignettes

#

# @title "Builds all non-Sweave Rnw vignette"

#

# \description{

#  @get "title".

# }

#

# @synopsis

#

# \arguments{

#   \item{path}{The directory where to search for non-Sweave vignettes.}

#   \item{pattern}{Filename pattern to locate non-Sweave vignettes.}

#   \item{...}{Additional arguments passed to @see "buildNonSweaveVignette".}

# }

#

# \value{

#   Returns (invisibly) a named @list with elements of what

#   the vignette builder returns.

# }

#

# @author

#

# \seealso{

#   To build vignette, see @see "buildNonSweaveVignette".

# }

#

# @keyword file

# @keyword IO

# @keyword internal

#*/###########################################################################

buildNonSweaveVignettes <- function(...) {

     }

  }

  }

} # buildNonSweaveVignettes()

###########################################################################/**

# @RdocFunction buildNonSweaveTexToPdf

#

# @title "Compiles all TeX files into PDFs"

#

# \description{

#  @get "title", unless already done.

# }

#

# @synopsis

#

# \arguments{

#   \item{path}{The directory where to search for TeX files.}

#   \item{pattern}{Filename pattern to locate TeX files.}

#   \item{...}{Additional arguments passed to @see "tools::texi2pdf".}

# }

#

# \value{

#   Returns (invisibly) a named @list of results.

# }

#

# @author

#

# @keyword file

# @keyword IO

# @keyword internal

#*/###########################################################################

buildNonSweaveTexToPdf <- function(path=".", pattern="[.](tex|ltx)$", ...) {

  # Ignore dummy.tex (which is created by R from dummy.Rnw just before make)

    }

  }

} # buildNonSweaveTexToPdf()

###########################################################################/**

# @RdocFunction buildPkgIndexHtml

#

# @title "Builds a package index HTML file"

#

# \description{

#  @get "title", iff missing.

# }

#

# @synopsis

#

# \arguments{

#   \item{...}{Not used.}

# }

#

# \value{

#   Returns (invisibly) the absolute pathname to the built index.html file.

#   If an index.html file already exists, nothing is done and @NULL

#   is returned.

# }

#

# @author

#

# @keyword file

# @keyword IO

# @keyword internal

#*/###########################################################################

buildPkgIndexHtml <- function(...) {

  # Nothing to do?

  }

    # If not custom index.html.rsp exists, use the one of the R.rsp package

    })

  }

  # Sanity check

  # Build index.html

} # buildPkgIndexHtml()