diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/filecontentsdef/README.md')
-rw-r--r-- | Master/texmf-dist/doc/latex/filecontentsdef/README.md | 65 |
1 files changed, 28 insertions, 37 deletions
diff --git a/Master/texmf-dist/doc/latex/filecontentsdef/README.md b/Master/texmf-dist/doc/latex/filecontentsdef/README.md index c72c1a542df..305ecfc66d9 100644 --- a/Master/texmf-dist/doc/latex/filecontentsdef/README.md +++ b/Master/texmf-dist/doc/latex/filecontentsdef/README.md @@ -1,51 +1,50 @@ <!-- --> - Source: filecontentsdef.dtx (v1.2 2016/09/19) + Source: filecontentsdef.dtx (v1.4 2019/04/20) Author: Jean-Francois Burnol Info: filecontents + macro + verbatim License: LPPL 1.3c - Copyright (C) 2016 Jean-Francois Burnol. + Copyright (C) 2016-2019 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`). +This lightweight LaTeX2e package provides an environment `filecontentsdef` +which is like the `filecontents` environment of Scott Pakin's +[filecontents] [1] package but in addition to the file creation stores the +(verbatim) contents into a macro given as an additional argument (either as a +control sequence or as a name). -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].) +Displaying verbatim these contents is possible via `\filecontentsprint`, +and executing them (if they represent LaTeX code) via `\filecontentsexec`. + +A variant environment `filecontentsdefmacro` stores the contents into a +macro, but skips the save-to-a-file part. [1]: http://www.ctan.org/pkg/filecontents "filecontents package" -[2]: http://www.ctan.org/pkg/attachfile "attachfile package" -INSTALLATION -============ +CHANGE LOG +========== -To extract the package (.sty) run etex on the dtx file. To produce -the PDF documentation, either: +v1.4 \[2019/04/20\] +------------------- -1. latex (twice) filecontentsdef.dtx, then dvips, then ps2pdf -2. or pdflatex (twice), -3. or latex (twice) then dvipdfmx +- backport 2018/04/01 LaTeX release change to filecontents environment + (`^^L` and `^^I` definitions). -This will also extract automatically the style file. +- add `filecontentsdefmacro` environment. -Installation: +- extend `filecontentsdef` and `filecontentsdefmacro` environments as + well as `\filecontentsprint` and `\filecontentsexec` macros to accept + indifferently either a control sequence or a name as argument. - filecontentsdef.sty -> TDS:tex/latex/filecontentsdef/filecontentsdef.sty - filecontentsdef.dtx -> TDS:source/latex/filecontentsdef/filecontentsdef.dtx - filecontentsdef.pdf -> TDS:doc/latex/filecontentsdef/filecontentsdef.pdf +- refactor documentation, explain how to define wrapper environments. - README.md -> TDS:doc/latex/filecontentsdef/README.md +v1.2 \[2016/09/19\] +------------------- -The other files may be discarded. +Initial version. LICENSE ======= @@ -68,13 +67,5 @@ 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. +its derived files filecontentsdef.sty, filecontentsdef.pdf, +filecontentsdef.dvi, README.md, INSTALL.md, README, INSTALL. |