summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/filecontentsdef/README.md
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2016-09-20 21:18:47 +0000
committerKarl Berry <karl@freefriends.org>2016-09-20 21:18:47 +0000
commit61a904cd1a5937bb93de96ec42b8fcfddeadf8fa (patch)
treee41cd7c486ed1458bff006cb0f1cc7c9e99b2aa2 /Master/texmf-dist/doc/latex/filecontentsdef/README.md
parentd37cc0c40375e871a7a084f033c6075a99957853 (diff)
filecontentsdef (20sep16)
git-svn-id: svn://tug.org/texlive/trunk@42107 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/filecontentsdef/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/filecontentsdef/README.md80
1 files changed, 80 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/filecontentsdef/README.md b/Master/texmf-dist/doc/latex/filecontentsdef/README.md
new file mode 100644
index 00000000000..c72c1a542df
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/filecontentsdef/README.md
@@ -0,0 +1,80 @@
+<!-- -->
+
+ Source: filecontentsdef.dtx (v1.2 2016/09/19)
+ Author: Jean-Francois Burnol
+ Info: filecontents + macro + verbatim
+ License: LPPL 1.3c
+ Copyright (C) 2016 Jean-Francois Burnol.
+ <jfbu at free dot fr>
+
+ABSTRACT
+========
+
+This lightweight LaTeX2e package provides two environments called
+`filecontentsdef` and `filecontentshere`. They are derived from the
+LaTeX `filecontents` environment as extended by Scott Pakin's
+[filecontents] [1] package. In addition to the file creation they
+either store the (verbatim) contents in a macro (`filecontentsdef`)
+or typeset them (verbatim) on the spot (`filecontentshere`).
+
+I developed this to display TeX code verbatim in documentation and
+simultaneously produce during the LaTeX run the corresponding files
+in order to embed them in the PDF as _file attachment annotations_
+(via the services of Scott Pakin's further package [attachfile] [2].)
+
+[1]: http://www.ctan.org/pkg/filecontents "filecontents package"
+[2]: http://www.ctan.org/pkg/attachfile "attachfile package"
+
+INSTALLATION
+============
+
+To extract the package (.sty) run etex on the dtx file. To produce
+the PDF documentation, either:
+
+1. latex (twice) filecontentsdef.dtx, then dvips, then ps2pdf
+2. or pdflatex (twice),
+3. or latex (twice) then dvipdfmx
+
+This will also extract automatically the style file.
+
+Installation:
+
+ filecontentsdef.sty -> TDS:tex/latex/filecontentsdef/filecontentsdef.sty
+ filecontentsdef.dtx -> TDS:source/latex/filecontentsdef/filecontentsdef.dtx
+ filecontentsdef.pdf -> TDS:doc/latex/filecontentsdef/filecontentsdef.pdf
+
+ README.md -> TDS:doc/latex/filecontentsdef/README.md
+
+The other files may be discarded.
+
+LICENSE
+=======
+
+This Work may be distributed and/or modified under the
+conditions of the LaTeX Project Public License 1.3c.
+This version of this license is in
+
+> <http://www.latex-project.org/lppl/lppl-1-3c.txt>
+
+and 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.
+
+The Author of this Work is:
+
+- Jean-Francois Burnol `<jfbu at free dot fr>`
+
+This Work consists of the main source file filecontentsdef.dtx and
+the derived files filecontentsdef.sty, filecontentsdef.ins,
+filecontentsdef.pdf, filecontentsdef.dvi, README.md.
+
+CHANGE LOG
+==========
+
+v1.2 \[2016/09/19\]
+-------------------
+
+Initial version.