/[groff]/groff/contrib/pdfmark/pdfmark.ms
ViewVC logotype

Diff of /groff/contrib/pdfmark/pdfmark.ms

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.1 by wl, Wed Dec 8 08:31:17 2004 UTC revision 1.2 by wl, Mon Apr 25 07:16:20 2005 UTC
# Line 10  Publishing with GNU Troff Line 10  Publishing with GNU Troff
10  .\"  .\"
11  .pdfview /PageMode /UseOutlines  .pdfview /PageMode /UseOutlines
12  .\"  .\"
13    .\" Initialise the outline view to show only three heading levels,
14    .\" with additional subordinate level headings folded.
15    .\"
16    .nr PDFOUTLINE.FOLDLEVEL 3
17    .\"
18  .\" Add document identification meta-data  .\" Add document identification meta-data
19  .\"  .\"
20  .pdfinfo /Title     Portable Document Format Publishing with GNU Troff  .pdfinfo /Title     Portable Document Format Publishing with GNU Troff
# Line 844  invoking the Line 849  invoking the
849  .CW pdfhref  .CW pdfhref
850  macro.  macro.
851  .NH 3  .NH 3
852    .XN -N outline-folding -- Folding the Outline to Conceal Less Significant Headings
853    .LP
854    When a document incorporates many subheadings,
855    at deeply nested levels,
856    it may be desirable to \(lqfold\(rq the outline
857    such that only the major heading levels are initially visible,
858    yet making the inferior subheadings accessible,
859    by allowing the reader to expand the view of any heading branch on demand.
860    .LP
861    The
862    .CW pdfmark
863    macros support this capability,
864    through the setting of the
865    .CW PDFOUTLINE.FOLDLEVEL
866    register.
867    This register should be set to the number of heading levels
868    which it is desired to show in expanded form, in the
869    .EM initial
870    document outline display;
871    all subheadings at deeper levels will still be added to the outline,
872    but will not become visible until the outline branch containing them is expanded.
873    'ne 5
874    For example, the setting used in this document:
875    .QS
876    .LD
877    .fam C
878    \&.\e" Initialise the outline view to show only three heading levels,
879    \&.\e" with additional subordinate level headings folded.
880    \&.\e"
881    \&.nr PDFOUTLINE.FOLDLEVEL 3
882    .DE
883    .QE
884    .LP
885    results in only the first three levels of headings being displayed
886    in the document outline,
887    .EM until
888    the reader chooses to expand the view,
889    and so reveal the lower level headings in any outline branch.
890    .LP
891    The initial default setting of
892    .CW PDFOUTLINE.FOLDLEVEL ,
893    if the document author does not choose to change it,
894    is 10,000.
895    This is orders of magnitude greater than the maximum heading level
896    which is likely to be used in any document;
897    thus the default behaviour will be to show document outlines fully expanded,
898    to display all headings defined,
899    at all levels within each document.
900    .LP
901    The setting of
902    .CW PDFOUTLINE.FOLDLEVEL
903    may be changed at any time;
904    however, the effect of each such change may be difficult to predict,
905    since it is applied not only to outline entries which are defined
906    .EM after
907    the setting is changed,
908    but also to any entries which remain in the outline cache,
909    .EM at
910    this time.
911    Therefore, it is recommended that
912    .CW PDFOUTLINE.FOLDLEVEL
913    should be set
914    .EM once ,
915    at the start of each document;
916    if it
917    .EM is
918    deemed necessary to change it at any other time,
919    the outline cache should be flushed,
920    .XR pdfsync ), (
921    .EM immediately
922    before the change,
923    which should immediately preceed a level one heading.
924    .NH 3
925  .XN -N multipart-outline -- Outlines for Multipart Documents  .XN -N multipart-outline -- Outlines for Multipart Documents
926  .LP  .LP
927  When a document outline is created, using the  When a document outline is created, using the

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26