healpix_doc

This IDL facility displays HTML or PDF HEALPix documentation

Location in HEALPix directory tree: src/idl/misc/healpix_doc.pro 

FORMAT

IDL> healpix_doc, [HTML=| PDF=| EPUB=] [, HELP=, WHOLE=]

KEYWORDS

HELP=

if set, an extensive help on healpix_doc is displayed.

EPUB=

if set, the (whole) HEALPix EPUB documentation is shown with an ebook reader.

HTML=

if set, the HEALPix (IDL) HTML documentation is shown with a web browser. If the browser is already in use, a new tab is open.

PDF=

if set, the HEALPix (IDL) PDF documentation is shown with a pdf viewer.
Either EPUB, HTML or PDF must be set.

WHOLE=

if set, the whole HEALPix documentation is accessible, not just the IDL related part.

DESCRIPTION

healpix_doc calls the script $HEALPIX/healpix_doc to open either the EPUB, HTML or PDF HEALPix documentation. The content of the !healpix system variable is used to determine the documentation path.

RELATED ROUTINES

This section lists the routines related to healpix_doc

idl

version 6.4 or more is necessary to run healpix_doc.

!HEALPIX

IDL system variable used by healpix_doc to locate the documentation.

EXAMPLE # 1:

healpix_doc, /html, /whole

will open the whole HEALPix HTML documentation in a web browser.

EXAMPLE # 2:

healpix_doc, /pdf

will open the IDL related HEALPix PDF documentation.

EXAMPLE # 3:

healpix_doc, /epub

will open the whole HEALPix EPUB documentation.