diff options
author | Karl Berry <karl@freefriends.org> | 2006-12-19 01:02:58 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2006-12-19 01:02:58 +0000 |
commit | 1103128be3749c33d08fd931e52a0b4f07080207 (patch) | |
tree | 26b95aa8c34c75d6cf6f21af6f1626cda97b0b6f /Master/texmf-dist/doc/latex/gmiflink/README | |
parent | 4f682edd48d4737aeaa4926675aa72a93b9c0ec8 (diff) |
new package gmiflink (18dec06)
git-svn-id: svn://tug.org/texlive/trunk@2802 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/gmiflink/README')
-rw-r--r-- | Master/texmf-dist/doc/latex/gmiflink/README | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/gmiflink/README b/Master/texmf-dist/doc/latex/gmiflink/README new file mode 100644 index 00000000000..695b67bc086 --- /dev/null +++ b/Master/texmf-dist/doc/latex/gmiflink/README @@ -0,0 +1,69 @@ +The gmiflink.sty LaTeX package +is a work of Grzegorz `Natror' Murzynowski, +<natror at o2 dot pl> + + +1. Copyright 2005, 2006 by Grzegorz `Natror' Murzynowski + +This program is subject to the LaTeX Project Public License. +See http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html +for the details of that license. + + +2. Introduction + +The gmiflink.sty package protects you against an error when a link is +dangling and typesets some plain text instead of a hyperlink then. It +is intended for use with the hyperref.sty package. + +I used it for typesetting the names of the objects in a documentation +of a computer program. If the object had been defined a \hyperlink to its +definition was made, otherwise a plain object's name was typeset. +I also use this package in automatic making of hyperlinking indexes. + +It provides the macros \gmiflink, \gmifref and +\gmhypertarget for conditional making of hyperlinks in your document. + +\gmhypertarget makes a \hypertarget and a \label of the given name. + +\gmiflink makes a \hyperlink to the given \hypertarget if the +correspondent label exists, otherwise typesets an ordinary text. + +\gmifref makes a (hyper-)\ref to the given label if the label exists, +otherwise it typesets an ordinary text. + + +3. Installation + +Just put the gmiflink.sty somewhere in the texmf/tex/latex +branch. Creating a /texmf/tex/latex/gm directory may be advisable if +you consider using other packages written by me. + +Then you should refresh your TeX distribution's files' +database most probably. + + +4. Contents + +The distribution of this package consists of the following four files. + +gmiflink.sty +README +gmiflinkDoc.tex +gmiflinkDoc.pdf + + +5. Documentation + +The last of the above files (the .pdf) is a documentation compiled +from the .sty file by running LaTeX (twice) on the gmiflinkDoc.tex +file. Compiling of the documentation requires the packages: gmdoc +(gmdoc.sty and gmdocc.cls), gmverb.sty, gmutils.sty and also some +standard packages: hyperref.sty, color.sty, geometry.sty, +multicol.sty, lmodern.sty, fontenc.sty that should be installed +on your computer by default. + +If you have not installed the mwart.cls class (available on CTAN in +mwcls package), the result of your compilation may differ a bit from +the .pdf provided in this .zip archive in formattings: If you have not +installed mwart.cls, the standard article.cls will be used. |