man/make.pdf.bookmark.Rd

   1 % Generated by roxygen2 (4.1.1): do not edit by hand
   2 % Please edit documentation in R/bookmarks.R
   3 \name{make.pdf.bookmark}
   4 \alias{make.pdf.bookmark}
   5 \title{make.bookmark}
   6 \usage{
   7 make.pdf.bookmark(text, level = 1, page = NULL)
   8 }
   9 \arguments{
  10 \item{text}{Text of bookmark to create}
  11
  12 \item{level}{Optional bookmark level which defaults to 1. This
  13 enables you to have headings and sub-headings and so forth, simply
  14 by increasing the number passed.}
  15
  16 \item{page}{Optional page number to write the bookmark to. If you
  17 are using a Cairo device, this is automatically set for you to be
  18 the page which you are currently writing to.}
  19 }
  20 \value{
  21 list of bookmarks to be passed to write.bookmarks or
  22 further calls to save.bookmark
  23 }
  24 \description{
  25 Make a bookmark for a PDF for later saving to the pdf with
  26 \code{write.pdf.bookmarks}
  27 }
  28 \examples{
  29 Cairo::CairoPDF(file="example.pdf",onefile=TRUE)
  30 plot(y~x,data.frame(x=1:5,y=1:5))
  31 bookmarks <- make.pdf.bookmark("First plot")
  32 plot(y~x,data.frame(x=1:5,y=1:5))
  33 bookmarks <- bookmarks + make.pdf.bookmark("Second plot")
  34 dev.off()
  35 write.pdf.bookmarks(file="example.pdf",bookmarks)
  36 }
  37 \author{
  38 Don Armstrong <don@donarmstrong.com>
  39 }
  40