Directory macros/latex/contrib/shipunov/doc
README
shipunov 2019/10/03 version 1.2 Alexey Shipunov <dactylorhiza(at)gmail.com>, 2019 ************************************************************ Contents of README 1. Description 2. Installation 3. Usage notes 4. History 5. Acknowledgements 6. License 7. Files 1. Description ---------------------- This is the version 1.2 of "shipunov" bundle, collection of LaTeX packages and classes, along with one bibliography style, some independent examples and a set of Perl scripts for converting TeX files. Many of them intend to help field biologists and Russian writers, others have broader application. Most of packages have example files, with "tex" extension and "-ex" postfix. Some of them are in Russian (codepage Windows-1251 or UTF-8, "-ru" postfix). Documentation files have "-doc" postfix. Besides, some examples did not related with any packages, they just demonstrate how to produce reliable forms for biological (morphometry and floristic/faunistic) fieldwork and also slides and exam sheets for teaching biology. Any suggestions concerning this package are highly appreciated. The Russian mini-review can be found in the "review.tex" file, written by Eugene Baldin, with minor corrections of bundle author. 2. Installation --------------- Extract the zip archive to the $LOCALTEXMF directory of your system. Refresh your filename database. Please see the documentation of your LaTeX distribution for further details. If someone would like to use this package under MikTex, this is the/a way to install: a. The "shipunov" directory, with the style files directly under it, should be copied to "[MiKTeX DIR]\tex\latex\" directory. b. Then in the "Settings" GUI program of MikTex the "Refresh FNDB" button should be pressed (located under the "General" tab of the GUI window). 3. Usage notes -------------- For Russian examples, LH fonts, "cm-super" and "cyrillic" packages should be installed. Russian hyphenation patterns should be loaded via "babel". For using "rusnat" bibliography style, some preparations are needed in the source bib file (example is in the documentation). To run bibtex on aux-file, I recommend the command like "bibtex8 -B -c cp1251.csf rusnat-ex1-ru.aux". However, there is an evidence that simple "bibtex rusnat-ex1-ru.aux" works as well. Note that "rusnat" bibliography style is now deprecated in favor of "gost" styles. 4. History ---------- 2008/02/01 Version 1. Initial CTAN release. However, the bundle was mantained locally since 1997. 2010/10/24 Version 1.1 (See NEWS for changelog). 2019/10/03 Version 1.2 (See NEWS for changelog). 5. Acknowledgements ------------------- For suggestions and contributions I would like to thank Eugeny Baldin and Anna Shipunova. 6. Licence ---------- This work may be distributed and/or modified under the conditions of the LaTeX Project Public License, either version 1.3 of this license or (at your option) any later version. The latest version of this license is in http://www.latex-project.org/lppl.txt and version 1.3 or later is part of all distributions of LaTeX version 2005/12/01 or later. 7. Files -------- This work consists of the following files: * NEWS List of changes * README (here, in doc/latex/shipunov directory) This file, including license * review.tex Russian mini-review, written by Eu. Baldin * README (in the root directory of the bundle) Short descriptions of packages * Class files and their examples: cassete.cls Audiocassete labels cassete-ex-ru.tex etiketka.cls Herbarium labels etiketka-ex1-en.tex etiketka-ex2-en.tex etiketka-ex-ru.tex * LaTeX style files, their examples and/or documentation: add2-ex.tex add2.sty Save trees altverse-ex1-ru.tex altverse-ex2-ru.tex altverse-ex3-ru.tex altverse-ex-en.tex altverse.sty Typesetting verses, depends on "xtab" package autolist-ex-en.tex autolist-ex-ru.tex autolist.sty Various lists, depends on "calc" package biokey2html-doc-en.tex biokey-doc-en.tex biokey.sty Pretty formatting of biological identification keys biokey-ex-en.tex biolist-ex-en.tex biolist.sty Pretty formatting of floristic/faunistic species lists boldline-ex-en.tex boldline.sty Thick lines in tables, depends on "array" package classif2-ex-en.tex classif2.sty Pretty formatting of biological classifications dline-ex.tex dline.sty Double lines drcaps-ex-en.tex drcaps.sty Various drop caps flower-ex-en.tex flower.sty Flower formulas, depends on "wasy" font package isyntax-ex-en.tex isyntax.sty Interactive syntax check, depends on "ifthen" and "syntaxonly" packages numerus-ex-ru.tex numerus.sty Spell numbers in Russian (with gender!) punct-ex-en.tex punct.sty Straight punctuation marks inside italics qqru-ex-en.tex qqru-ex-ru.tex qqru.sty Universal quotes sltables-doc-en.tex sltables.sty LaTeX modification of R. Nilson S-Tables Plain TeX macro starfn-ex-ru.tex starfn.sty Footnote marks as stars, depends on "footnpag" package textfrac-ex.tex textfrac.sty Slanted fractions * BibTeX bibliography style, documentation and examples: rusnat.bst Russian bibliography style, now DEPRECATED, depends on "natbib" package rusnat_bst.readme Deprecation note rusnat-doc-ru.tex rusnat-ex-ru.bib rusnat-ex1-ru.tex rusnat-ex2-ru.tex * Some other examples (e.g., field forms): exam-ex.tex Exam sheet example field-form-ex1-ru.tex Field form for morphometry field-form-ex2-ru.tex Field form for floristics lecture-slides-ex.tex Lecture slides example * Perl scripts and shell command files: abs2rel.pl Convert from absolute to relative (automatic) keys biokey2html1.pl biokey2html2.pl biokey2html3.pl biokey2html.bat Windows command file biokey2html.sh Bash command file txt2qq.pl Convert from simple text to LaTeX with universal quotes There may be also additional PDF and HTML files, results of examples processing.
