summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2020-05-21 21:46:33 +0000
committerKarl Berry <karl@freefriends.org>2020-05-21 21:46:33 +0000
commit285dd4f2910323b6d8ed9a3321aae1bbac50fe10 (patch)
tree52f2132ad498bb2c158204b7c3518ca22b45d85e /Master/texmf-dist/doc/latex
parent8331d123f77a7df43779bf6c2501ad9784aca5c6 (diff)
decorule (21may20)
git-svn-id: svn://tug.org/texlive/trunk@55230 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r--Master/texmf-dist/doc/latex/decorule/MANIFEST7
-rw-r--r--Master/texmf-dist/doc/latex/decorule/README87
-rw-r--r--Master/texmf-dist/doc/latex/decorule/README.md187
-rw-r--r--Master/texmf-dist/doc/latex/decorule/VERSION1
-rw-r--r--Master/texmf-dist/doc/latex/decorule/decorule.pdfbin423349 -> 396165 bytes
5 files changed, 191 insertions, 91 deletions
diff --git a/Master/texmf-dist/doc/latex/decorule/MANIFEST b/Master/texmf-dist/doc/latex/decorule/MANIFEST
index 5315031b5f1..c4e0a463684 100644
--- a/Master/texmf-dist/doc/latex/decorule/MANIFEST
+++ b/Master/texmf-dist/doc/latex/decorule/MANIFEST
@@ -1,7 +1,6 @@
-README
-MANIFEST
decorule.dtx
decorule.ins
decorule.pdf
-decorule.dvi
-decorule.ps.gz
+MANIFEST
+README.md
+VERSION
diff --git a/Master/texmf-dist/doc/latex/decorule/README b/Master/texmf-dist/doc/latex/decorule/README
deleted file mode 100644
index fa7fef1c5ae..00000000000
--- a/Master/texmf-dist/doc/latex/decorule/README
+++ /dev/null
@@ -1,87 +0,0 @@
-This is the README file for the decorule package.
-
-Summary
-
-This package implements a decorative swelled rule using
-only a symbol from a font installed with all distributions of
-\TeX{}, so it works independently, without the need to install
-any additional software or fonts.
-
-This is the packaged version of the macro which was
-originally published in the 'Typographers' Inn'
-column in TUGboat (Flynn 2010).
-
-This version fixes the bug caused by failing to supply the
-correct values for DVI drivers for rendering glyph rotation.
-The result now works in Postscript output but DVI viewers may
-still display incorrectly.
-
-INSTALLATION
-
-To install this package, run LaTeX on the decorule.ins file.
-This will create the package file decorule.sty, which you must
-move to a directory (folder) where LaTeX will find it.
-
-For personal installations, that is:
-
-(Mac) ~/Library/texmf/tex/latex/decorule
-(Unix / GNU/Linux) ~/texmf/tex/latex/decorule
-(MS-Windows 95/XP) C:\texmf\tex\latex\decorule
-(Windows 7/8) Computer\System\Users\your~name\texmf\tex\latex\decorule
- [replacing your-name with your account name]
-
-Create that directory (folder) if it does not exist.
-
-If you are a Windows user with MiKTeX and this is your
-first time installing packages by hand, you must also
-add the texmf folder to MiKTeX's list of supported
-folders (in the Roots tab of the MiKTeX Maintenance/Settings
-program), and then update the FNDB in the General tab.
-
-For shared installations (multi-user systems), identify
-the shared local directory with the command
-
- kpsewhich -expand-var '$TEXMFLOCAL'
-
-This will give you the texmf location within which you must
-create the tex/latex/decorule subdirectories. Do not forget
-to run the texhash or mktexlsr filename indexer program
-after installation, otherwise the files will not be findable.
-
-USAGE
-
-Add this line to the Preamble of your LateX document:
-
- \usepackage[options]{decorule}
-
-Read the documentation for the options available.
-
-
-BUGS
-
-None known of.
-
-
-COPYRIGHT
-
-%% decorule.*
-%% Copyright © 2010-2011 by Peter Flynn <peter@silmaril.ie>
-%
-% 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.
-%
-% This work has the LPPL maintenance status `maintained'.
-%
-% The current maintainer of this work is Peter Flynn <peter@silmaril.ie>
-%
-% This work consists of the files decorule.dtx and decorule.ins
-% and the derived file decorule.sty.
-
-Please send comments and bug reports to the maintainer.
diff --git a/Master/texmf-dist/doc/latex/decorule/README.md b/Master/texmf-dist/doc/latex/decorule/README.md
new file mode 100644
index 00000000000..fdbc0de71a2
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/decorule/README.md
@@ -0,0 +1,187 @@
+
+[//]: # (decorule LaTeX package)
+
+# decorule
+
+This is the README.md file for the decorule LaTeX package v0.7 (2020-04-01)
+generated by ClassPack v.1.19 (2020-05-19) on 21 May 2020 at 11:04:52
+
+## Summary
+
+This package implements a decorative swelled rule using only a symbol
+from a font installed with all distributions of TeX, so it works
+independently, without the need to install any additional software or
+fonts.
+
+This is the packaged version of the macro which was originally published
+in the “Typographers' Inn” column in TUGboat (Flynn, 2010).
+
+
+## Automated installation
+
+If this package is distributed from CTAN, it should be in a zip file
+which allows it to be installed automatically by the TeX Live Manager
+(tlmgr) and similar automated installers.
+
+If you are using automated LaTeX package installation, no further action
+is required: the package will be installed the first time you use it in
+a LaTeX document.
+
+If you are using the TeX Live Manager (_tlmgr_) program manually, you
+can install this package with the command:
+
+ $ tlmgr install decorule
+
+
+## TDS installation
+
+This package is also available as a TeX Directory System (TDS) zip file
+(`.tds.zip`). This is the standard directory layout for a modern TeX
+installation which enables the package to be unzipped directly into your
+Personal TeX Directory without the need to use _tlmgr_. If you haven’t
+yet created a Personal TeX Directory, see below for details of what one
+is, and how to create it.
+ * You can install this package on any TDS-compliant personal system
+(laptop, desktop, workstation, table, smartphone, PDA, etc) by unzipping
+it straight into your Personal TeX Directory. This will put all the
+files into the right places, so you can start using them immediately.
+ * On a shared (multiuser) system like a server, the administrator can
+unzip it into the `$TEXMFLOCAL` directory instead (see below), and run
+your TeX directory-indexing program (eg _texhash_, _mktexlsr_, etc) so
+that everyone can use it.
+ * If you are using an old non-TDS-compliant system, see below under Manual
+Installation.
+
+### Your Personal TeX Directory
+
+This is a directory (folder) where you should put all local manual
+modifications (updates, additions such as new or updated classes,
+packages, and fonts) that are _not_ handled automatically by _tlmgr_.
+The name and location are fixed (for all practical purposes):
+ * Apple Mac OS X
+
+ ~/Library/texmf
+ * Unix and GNU/Linux
+
+ ~/texmf
+ * MS-Windows 95/XP/NT
+
+ C:\texmf
+ * MS-Windows 2007 and above
+
+ Computer\System\YOURNAME\texmf
+
+Create that folder now if it does not already exist. Put (or unzip) all
+additions to your system that are _not_ handled by _tlmgr_ into this
+directory, following _exactly_ the subdirectory structure that is used
+in your main TeX distribution (unzipping a TDS file does this for you).
+This is what enables LaTeX to find stuff automatically.
+
+
+> #### If you are a Windows user running _MiKTeX_
+> When you create the folder for your Personal TeX Directory, you MUST add it to _MiKTeX_ ’s list of supported folders. Run the _MiKTeX Maintenance/Settings_ program, select the `Roots` tab, and add the folder. You only have to do this once.
+> > Each time you add or remove software in your Personal TeX Directory, you MUST then click on the `Update FNDB` button in the `General` tab of the _MiKTeX Maintenance/Settings_ program, otherwise _MiKTeX_ will not find them and nothing will work!
+>
+
+Unix (Mac and GNU/Linux) users do not need to (indeed, should not) run
+their filename database indexer program (_mktexlsr_ or _texhash_) for
+files put into a personal TeX directory.
+
+
+## Installation on shared systems
+
+On multi-user systems (Unix-based), identify the shared local directory
+tree with the command
+
+ kpsewhich -expand-var '$TEXMFLOCAL'
+
+This will give you the location of the shared `texmf` directory into
+which you must unzip these files.
+
+Do not forget to run your local TeX filename database indexer program
+(_texhash_ or _mktexlsr_) after installation, otherwise the files will
+not be found by LaTeX and nothing will work!
+
+
+## Manual installation (non-TDS systems)
+
+To install this software manually, download and unzip the _non-_TDS zip
+file into a temporary directory and move the class and/or package
+file[s] and other files to the proper locations where LaTeX will find
+them on your system. This is referred to in some documentation as “the
+`TEXINPUTS` directory”, although it may be called something else on your
+system.
+
+_It is your responsibility to know where this location is._ See the
+question in the TeX FAQ at https://texfaq.org/FAQ-inst-wlcf.html for
+more information. If you do not know, or cannot find it, or do not have
+access to it, your TeX system may be out of date and may need replacing.
+
+
+
+## Online systems and “last resort” systems
+
+Some online LaTeX systems use CTAN, so a package from there should be
+available on demand. For other online LaTeX systems where you do not
+have access to the file system, unzip the _non-_TDS zip file into a
+temporary directory and upload the files to the online system. Follow
+their instructions for where to put them.
+
+In an emergency, or as a last resort on unmanageable systems, it is
+possible simply to put the class and/or package file[s] into your
+current working directory (the same folder as your `.tex` file[s]).
+
+While this may work, it is not supported, and may lead to other
+resources (packages, fonts, images etc) not being found.
+
+
+## Usage
+
+Include the line shown below in the Preamble of your LaTeX document; a
+`\documentclass` line should be at the top; a `\usepackage` command
+normally goes anywhere in the Preamble:
+
+ \usepackage[options]{decorule}
+
+(similarly for other classes or packages if more than one is supplied
+with this package). Read the documentation for the options available, if
+any. The documentation is distributed as a PDF document in the zip file.
+You can also regenerate it by typesetting the `decorule.dtx` file with
+`pdflatex` (and `biber` and _makeindex_) in the normal way.
+
+
+## Bugs and TODO
+
+No outstanding reported bugs at the time of this version.
+
+For TODO items, see the PDF documentation.
+
+
+## Copyright
+
+The following statement is included in the source code:
+
+ Transformed from decorule.xml by ClassPack db2dtx.xsl
+ version 1.19 (2020-05-19) on Thursday 21 May 2020 at 11:04:52
+
+ decorule.sty is copyright © 2010-2020 by Peter Flynn <peter@silmaril.ie>
+
+ 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.
+
+ This work has the LPPL maintenance status ‘maintained’.
+
+ The current maintainer of this work is Peter Flynn <peter@silmaril.ie>
+
+ This work consists of the files decorule.dtx and decorule.ins,
+ the derived file ,
+ and any other ancillary files listed in the MANIFEST.
+
+
diff --git a/Master/texmf-dist/doc/latex/decorule/VERSION b/Master/texmf-dist/doc/latex/decorule/VERSION
new file mode 100644
index 00000000000..67e019434cc
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/decorule/VERSION
@@ -0,0 +1 @@
+Date of most recent change is 2020-04-01
diff --git a/Master/texmf-dist/doc/latex/decorule/decorule.pdf b/Master/texmf-dist/doc/latex/decorule/decorule.pdf
index 6cdb2bd06dd..027e981edef 100644
--- a/Master/texmf-dist/doc/latex/decorule/decorule.pdf
+++ b/Master/texmf-dist/doc/latex/decorule/decorule.pdf
Binary files differ