/[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.2 by wl, Mon Apr 25 07:16:20 2005 UTC revision 1.3 by wl, Tue May 17 20:18:57 2005 UTC
# Line 5  Publishing with GNU Troff Line 5  Publishing with GNU Troff
5  .AU Keith Marshall  .AU Keith Marshall
6  .AI <keith.d.marshall@ntlworld.com>  .AI <keith.d.marshall@ntlworld.com>
7  .CE  .CE
8    .\"
9    .\" Specify the Internet address for the groff web site.
10    .\" Currently, there are two available addresses; a copy is maintained at ...
11    .\"
12    .ds GROFF-WEBSITE http://www.gnu.org/software/groff
13    .\"
14    .\" ... but the official home site is at ...
15    .\"
16    .ds GROFF-WEBSITE http://groff.ffii.org
17    .\"
18  .\" Set the PDF default document view attribute, to ensure that the document  .\" Set the PDF default document view attribute, to ensure that the document
19  .\" outline is visible, each time the document is opened in Acrobat Reader.  .\" outline is visible, each time the document is opened in Acrobat Reader.
20  .\"  .\"
# Line 204  GNU/Linux, and on Microsoft\*(rg Windows Line 214  GNU/Linux, and on Microsoft\*(rg Windows
214  .pdfhref M footnote1  .pdfhref M footnote1
215  Later versions should, and some earlier versions may, be equally suitable.  Later versions should, and some earlier versions may, be equally suitable.
216  See  See
217  .pdfhref W http://groff.ffii.org  .pdfhref W \*[GROFF-WEBSITE]
218  for information and availability of the latest version.  for information and availability of the latest version.
219  .FE  .FE
220  in association with  in association with
# Line 472  macro. Line 482  macro.
482  As an example of how it is used,  As an example of how it is used,
483  the identification meta\(hydata attached to this document  the identification meta\(hydata attached to this document
484  was specified using a macro sequence similar to:\(en  was specified using a macro sequence similar to:\(en
485  .RS  .DS I
486  .LD  .CW
 .fam C  
487  \&.pdfinfo /Title     PDF Document Publishing with GNU Troff  \&.pdfinfo /Title     PDF Document Publishing with GNU Troff
488  \&.pdfinfo /Author    Keith Marshall  \&.pdfinfo /Author    Keith Marshall
489  \&.pdfinfo /Subject   How to Exploit PDF Features with GNU Troff  \&.pdfinfo /Subject   How to Exploit PDF Features with GNU Troff
490  \&.pdfinfo /Keywords  groff troff PDF pdfmark  \&.pdfinfo /Keywords  groff troff PDF pdfmark
491  .DE  .DE
 .RE  
492  Notice that the  Notice that the
493  .CW pdfinfo  .CW pdfinfo
494  macro is repeated, once for each  macro is repeated, once for each
# Line 1078  This operation has been described earlie Line 1086  This operation has been described earlie
1086  Place a \(lqnamed destination\(rq reference mark at the current output position,  Place a \(lqnamed destination\(rq reference mark at the current output position,
1087  in the current PDF document,  in the current PDF document,
1088  .XR mark-dest ). (  .XR mark-dest ). (
1089    .IP \*[= D]
1090    Specify the content of a PDF document reference dictionary entry;
1091    typically, such entries are generated automatically,
1092    by transformation of the intermediate output resulting from the use of
1093    .CW pdfhref
1094    .CWB M \& \& \(rq, \(lq
1095    with the
1096    .CWB -X \& \& \(rq \(lq
1097    modifier,
1098    .XR create-map ); (
1099    however, it is also possible to specify such entries manually,
1100    .XR user-format ). (
1101  .IP \*[= L]  .IP \*[= L]
1102  Insert an active link to a named destination,  Insert an active link to a named destination,
1103  .XR link-named ), (  .XR link-named ), (
# Line 1102  Specify a user defined macro, to be call Line 1122  Specify a user defined macro, to be call
1122  .CW pdfhref ,  .CW pdfhref ,
1123  when formatting the text in the active region of a link,  when formatting the text in the active region of a link,
1124  .XR set-format ). (  .XR set-format ). (
1125    .IP \*[= Z]
1126    Define the absolute position on the physical PDF output page,
1127    where the \(lqhot\(hyspot\(rq associated with an active link is to be placed.
1128    Invoked in pairs, marking the starting and ending PDF page co\(hyordinates
1129    for each link \(lqhot\(hyspot\(rq, this operator is rarely, if ever,
1130    specified directly by the user;
1131    rather, appropriate
1132    .CW pdfhref
1133    .CWB Z \& \& \(rq \(lq
1134    specifications are inserted automatically into the document reference map
1135    during the PDF document formatting process,
1136    .XR create-map ). (
1137  .IP \*[= I]  .IP \*[= I]
1138  Initialise support for  Initialise support for
1139  .CW pdfhref  .CW pdfhref
# Line 2052  operator; nevertheless, the invocation s Line 2084  operator; nevertheless, the invocation s
2084  .B -- ] [  .B -- ] [
2085  .I "descriptive text ...\&"  .I "descriptive text ...\&"
2086  .LP  .LP
2087  where  where the optional
2088    .CWB -D
2089    .CWBI URI > <
2090    modifier specifies the address for the target Internet resource,
2091    in any appropriate
2092    .EM "Uniform Resource Identifier"
2093    format, while the
2094    .CWI descriptive
2095    .CWI text
2096    argument specifies the text which is to appear in the \(lqhot\(hyspot\(rq
2097    region, and the
2098    .CWB -P
2099    .CWBI prefix\(hytext > <
2100    and
2101    .CWB -A
2102    .CWBI affixed\(hytext > <
2103    options have the same effect as in the case of local document links,
2104    .XR link-intern ). (
2105    .LP
2106    Notice that it is not mandatory to include the
2107    .CWB -D
2108    .CWBI URI > <
2109    in the link specification; if it
2110    .EM is
2111    specified, then it is not necessary for the URI to appear,
2112    in the running text of the document \(em the
2113    .CWI descriptive
2114    .CWI text
2115    argument exactly defines the text
2116    which will appear within the \(lqhot\(hyspot\(rq region,
2117    and this need not include the URI.
2118    However, if the
2119    .CWB -D \& \& \~\c
2120    .CWBI URI > <
2121    specification is omitted, then the
2122    .CWI descriptive
2123    .CWI text
2124    argument
2125    .EM must
2126    be an
2127    .EM exact
2128    representation of the URI, which
2129    .EM will ,
2130    therefore, appear as the entire content of the \(lqhot\(hyspot\(rq.
2131    For example, we could introduce a reference to
2132    .pdfhref W -D \*[GROFF-WEBSITE] -A , the groff web site
2133    in which the actual URI is concealed, by using mark up such as:\(en
2134    .DS I
2135    .CW
2136    For example, we could introduce a reference to
2137    \&.pdfhref W -D \*[GROFF-WEBSITE] -A , the groff web site
2138    in which the actual URI is concealed,
2139    .DE
2140    Alternatively,
2141    to refer the reader to the groff web site,
2142    making it obvious that the appropriate URI is
2143    .pdfhref W -A , \*[GROFF-WEBSITE]
2144    the requisite mark up might be:\(en
2145    .DS I
2146    .CW
2147    to refer the reader to the groff web site,
2148    making it obvious that the appropriate URI is
2149    \&.pdfhref W -A , \*[GROFF-WEBSITE]
2150    the requisite mark up might be:\e(en
2151    .DE
2152  .NH 3  .NH 3
2153  .XN -N set-format -- Establishing a Format for References  .XN -N set-format -- Establishing a Format for References
2154  .LP  .LP

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

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