% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/bookmarks.R
\name{make.pdf.bookmark}
\alias{make.pdf.bookmark}
\title{make.bookmark}
\usage{
make.pdf.bookmark(text, level = 1, page = NULL)
}
\arguments{
\item{text}{Text of bookmark to create}

\item{level}{Optional bookmark level which defaults to 1. This
enables you to have headings and sub-headings and so forth, simply
by increasing the number passed.}

\item{page}{Optional page number to write the bookmark to. If you
are using a Cairo device, this is automatically set for you to be
the page which you are currently writing to.}
}
\value{
list of bookmarks to be passed to write.bookmarks or
further calls to save.bookmark
}
\description{
Make a bookmark for a PDF for later saving to the pdf with
\code{write.pdf.bookmarks}
}
\examples{
CairoPDF(file="example.pdf",onefile=TRUE)
plot(y~x,data.frame(x=1:5,y=1:5))
bookmarks <- make.pdf.bookmark("First plot")
plot(y~x,data.frame(x=1:5,y=1:5))
bookmarks <- bookmarks + make.pdf.bookmark("Second plot")
dev.off()
write.pdf.bookmarks(file="example.pdf",bookmarks)
}
\author{
Don Armstrong <don@donarmstrong.com>
}