diff options
author | Karl Berry <karl@freefriends.org> | 2011-05-15 22:18:59 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2011-05-15 22:18:59 +0000 |
commit | 84add25b1941f4a2447c8d13da3b056007dd98b4 (patch) | |
tree | 9c8d4cea2c1cc0b5493f2b1b6c0ba664aefb2a57 /Master/texmf-dist/doc/latex/thumbs/README | |
parent | 97d9b8c347a2c6a0056e2372681aafa786726fbe (diff) |
new latex package thumbs 1.0a (14may11)
git-svn-id: svn://tug.org/texlive/trunk@22486 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/thumbs/README')
-rw-r--r-- | Master/texmf-dist/doc/latex/thumbs/README | 145 |
1 files changed, 145 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/thumbs/README b/Master/texmf-dist/doc/latex/thumbs/README new file mode 100644 index 00000000000..0602f9a74b5 --- /dev/null +++ b/Master/texmf-dist/doc/latex/thumbs/README @@ -0,0 +1,145 @@ +README for thumbs package, 2011/05/14, v1.0a + + +TABLE OF CONTENTS +================= + +1 Introduction +2 Download +3 Installation +4 Additional Packages +5 New Features +6 Package Compatibility +7 Authors/Maintainers +8 Bug Reports +9 Known Problems + + +1 INTRODUCTION +============== + +This package puts running, customizable thumb marks in the +outer margin, moving downward as the chapter number (or +whatever shall be marked by the thumb marks) increases. +Additionally an overview page/table of thumb marks can be +added automatically, which gives the respective names of the +thumbed objects, the page where the object/thumb mark first +appears, and the thumb mark itself at the respective +position. The thumb marks are probably useful for documents, +where a quick and easy way to find e.g. a chapter is needed, +for example in reference guides, anthologies, or quite +large documents. + + +2 DOWNLOAD +========== + +`thumbs' is available on CTAN: + CTAN:macros/latex/contrib/thumbs/ + +Also a ZIP file is provided that contains the files, already +sorted in a TDS tree: + CTAN:install/macros/latex/contrib/thumbs.tds.zip + +`CTAN:' means one of the `Comprehensive TeX Archive Network' +nodes or one of its mirrors. This is explained in + http://www.tex.ac.uk/cgi-bin/texfaq2html?label=archives + +The CTAN stuff will be mirrored automatically from the +ftp server, so + ftp://ftp.tug.org/pub/tex/thumbs/ +corresponds to + CTAN:macros/latex/contrib/thumbs/ + + +3 INSTALLATION +============== + +Installation with ZIP file in TDS format +---------------------------------------- +The ZIP file `thumbs.tds.zip' contains the files sorted +in a TDS tree. Thus you can directly unpack the ZIP file +inside a TDS tree. +(See CTAN:tds.zip for an explanation of TDS.) +Example: + cd /...somewhere.../texmf + unzip /...downloadpath.../thumbs.tds.zip +Do not forget to refresh the file name database of this +TDS tree. +Example: + texhash /...somewhere.../texmf + +Manual installation +------------------- +a) Download the thumbs files from CTAN or the TUG server. + If necessary, unpack them. +b) Generate the package and driver files: + tex thumbs.ins +c) Install the file `*.sty' in your TDS tree: + cp *.sty TDS:tex/latex/thumbs/ + Replace `TDS:' by the prefix of your TDS tree + (texmf directory). +d) Copy the documentation files to + "TDS:doc/latex/thumbs/": + README, thumbs.pdf, thumbs-example.tex, + thumbs-example.pdf. +e) Update the databases if necessary, e.g. for teTeX: + mktexlsr .../texmf + + +4 ADDITIONAL PACKAGES +===================== + +Depending on the driver and option settings, thumbs loads +other packages: kvoptions, atbegshi, xcolor, picture, +alphalph, pagesLTS, rerunfilecheck, ifthen, and warning, +which again load other packages +(see the result of the \listfiles command in the log-file + of the example). + + +5 PACKAGE COMPATIBILITY +======================= + +thumbs should be loaded AFTER the required packages, +but loding it before those packages schould be possible, +too. + + +6 AUTHOR/MAINTAINER +===================== + +* Hans-Martin Münch + + +7 BUG REPORTS +============== + +A bug report should contain: +* Comprehensive problem description. This includes error or + warning messages. + * \errorcontextlines=\maxdimen can be added in the + TeX code to get more informations in TeX error messages. +* Minimal test file that shows the problem, but does not + contain any unnecessary packages and code. +* Used drivers/programs. +* Version information about used packages and programs. + * If you are using LaTeX, then add "\listfiles". Then + a list of version informations is printed at the end + of the LaTeX run. +* Please no other files than the minimal test file. + The other files .log, .dvi, .ps, .pdf are seldom + necessary, so send them only on request. +* Please .zip or .tar.gz your file(s) before sending them! + +Bug address +----------- +Bug reports can be send to the maintainer: + Hans-Martin Münch + <Martin [dot] Muench [at] Uni-Bonn [dot] de> + + +8 KNOWN PROBLEMS +================= + +* as yet: none...
\ No newline at end of file |