(eplain.info)Options supported by all drivers

---

Next: Hyperlink driver hypertex Up: Hyperlink drivers

---

Enter node , (file) or (file)node

5.4.1 Options supported by all drivers
--------------------------------------

This subsection describes the destination and link options which are
supported by all hyperlink drivers.

Destination options supported by all drivers
............................................

'raise'
     Specifies how much to raise destinations above the baseline. When
     set to zero or empty, destinations are placed at the baseline.

     It is usually convenient to set this option to some variable
     parameter, so that the height to which destinations are raised is
     automatically adjusted according to the current context. For
     example, setting it to '\normalbaselineskip' (or some fraction of
     it, like '1.7\normalbaselineskip') makes the setting appropriate
     for different point sizes, in case your document uses more than
     one.

     The default setting is '\normalbaselineskip'. Initially, the
     destgroups do not define this option, so they fall back on the
     default, except for the 'eq' destgroup, for which this option is
     set to '1.7\normalbaselineskip', to accommodate the usual cases of
     large operators in displayed math.

     Example: '\hldestopts[eq]{raise=2.5\normalbaselineskip}'

Link options supported by all drivers
.....................................

'colormodel'
'color'
     These two options define the color to be used for rendering the
     link text. The colors are used only when a '\color' command is
     defined, e.g., by loading the LaTeX 'color' package (Note: Packages
     known to work). The '\color' command is called as
     '\color[COLORMODEL]{COLOR}', where COLORMODEL and COLOR are the
     definitions of the 'colormodel' and 'color' options, respectively.
     However, if COLORMODEL is empty, the optional argument to '\color'
     is omitted; and if COLOR is empty, the '\color' command is omitted
     altogether. The default setting is 'COLORMODEL=cmyk' and
     'COLOR=0.28,1,1,0.35'.

     When specifying colors with several components delimited by commas
     (e.g., RGB and CMYK colors in the LaTeX 'color' package), it is not
     possible to specify the components directly in the option list of
     '\hlopts', because comma is the option list delimiter. With the
     'color' package, it is possible to specify such colors by defining
     a custom color with '\definecolor' and using the new color name
     with an empty COLORMODEL (see examples below).

     Examples:

          \hlopts{colormodel=,color=blue}% predefined color
          \definecolor{mycolor}{rgb}{.3,.8,.95}
          \hlopts{colormodel=,color=mycolor}% custom color
          \hlopts{colormodel=gray,color=.4}