diff options
author | Karl Berry <karl@freefriends.org> | 2019-05-02 22:39:39 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2019-05-02 22:39:39 +0000 |
commit | 76e559e4657cc54e211e35d7ae6fdb91f89ee034 (patch) | |
tree | 938b4c1c850c06a1fc686dacbb79646c6d9d60ff /Master/texmf-dist/doc/latex/filecontentsdef | |
parent | c7ea87b7b16e55ce9460b7789a8dcbc8d84ec51f (diff) |
filecontentsdef (24apr19)
git-svn-id: svn://tug.org/texlive/trunk@50942 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/filecontentsdef')
9 files changed, 121 insertions, 39 deletions
diff --git a/Master/texmf-dist/doc/latex/filecontentsdef/INSTALL b/Master/texmf-dist/doc/latex/filecontentsdef/INSTALL new file mode 100644 index 00000000000..26576323824 --- /dev/null +++ b/Master/texmf-dist/doc/latex/filecontentsdef/INSTALL @@ -0,0 +1,37 @@ + Source: filecontentsdef.dtx (v1.4 2019/04/20) + Author: Jean-Francois Burnol + Info: filecontents + macro + verbatim + License: LPPL 1.3c + Copyright (C) 2016-2019 Jean-Francois Burnol. + <jfbu at free dot fr> + + + +INSTALLATION + + +Use your installation manager. + +Else, for manual installation: + +- To extract the package and at the same time produce the + documentation, execute latex twice on filecontentsdef.dtx then + dvipdfmx on the dvi file. + + To customize the PDF documentation (paper size, etc...): execute + etex once on filecontentsdef.dtx then follow instructions given + inside the extracted file filecontentsdef.tex. + +- To extract the package but not necessarily build the documentation: + run etex on filecontentsdef.dtx. + +Files should then be moved to appropriate locations: + + filecontentsdef.sty -> TDS:tex/latex/filecontentsdef/ + filecontentsdef.dtx -> TDS:source/latex/filecontentsdef/ + filecontentsdef.pdf -> TDS:doc/latex/filecontentsdef/ + README.md -> TDS:doc/latex/filecontentsdef/ + INSTALL.md -> TDS:doc/latex/filecontentsdef/ + +You can also place filecontentsdef.sty directly within the directory of +the project using it. diff --git a/Master/texmf-dist/doc/latex/filecontentsdef/INSTALL.md b/Master/texmf-dist/doc/latex/filecontentsdef/INSTALL.md new file mode 100644 index 00000000000..7e828696307 --- /dev/null +++ b/Master/texmf-dist/doc/latex/filecontentsdef/INSTALL.md @@ -0,0 +1,37 @@ +<!-- --> + + Source: filecontentsdef.dtx (v1.4 2019/04/20) + Author: Jean-Francois Burnol + Info: filecontents + macro + verbatim + License: LPPL 1.3c + Copyright (C) 2016-2019 Jean-Francois Burnol. + <jfbu at free dot fr> + +INSTALLATION +============ + +Use your installation manager. + +Else, for manual installation: + +- To extract the package and at the same time produce the documentation, + execute latex twice on `filecontentsdef.dtx` then `dvipdfmx` on the + `dvi` file. + + To customize the PDF documentation (paper size, etc...): execute `etex` + once on `filecontentsdef.dtx` then follow instructions given inside the + extracted file `filecontentsdef.tex`. + +- To extract the package but not necessarily build the documentation: + run `etex` on `filecontentsdef.dtx`. + +Files should then be moved to appropriate locations: + + filecontentsdef.sty -> TDS:tex/latex/filecontentsdef/ + filecontentsdef.dtx -> TDS:source/latex/filecontentsdef/ + filecontentsdef.pdf -> TDS:doc/latex/filecontentsdef/ + README.md -> TDS:doc/latex/filecontentsdef/ + INSTALL.md -> TDS:doc/latex/filecontentsdef/ + +You can also place `filecontentsdef.sty` directly within the directory +of the project using it. 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. diff --git a/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef-ex1.tex b/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef-ex1.tex new file mode 100644 index 00000000000..a7f97df53b2 --- /dev/null +++ b/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef-ex1.tex @@ -0,0 +1,2 @@ + Prove that \[x^n+y^n=z^n\] is not solvable in positive integers if $n$ is at + most $-3$.\par diff --git a/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef-ex2.tex b/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef-ex2.tex new file mode 100644 index 00000000000..d4b672e425c --- /dev/null +++ b/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef-ex2.tex @@ -0,0 +1 @@ + Refute the existence of black holes in less than 140 characters.\par diff --git a/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef-ex3.tex b/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef-ex3.tex new file mode 100644 index 00000000000..5884d1449e8 --- /dev/null +++ b/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef-ex3.tex @@ -0,0 +1,4 @@ + \def\NSA{NSA}% + Prove that factorization is easily done via probabilistic algorithms and + advance evidence from knowledge of the names of its employees in the + seventies that the \NSA\ has known that for 40 years.\par diff --git a/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef.pdf b/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef.pdf Binary files differindex e5f701f4fc3..ddf56cc7ac0 100644 --- a/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef.pdf +++ b/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef.pdf diff --git a/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef.test b/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef.test new file mode 100644 index 00000000000..15169b9eb83 --- /dev/null +++ b/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef.test @@ -0,0 +1,10 @@ +%% LaTeX2e file `filecontentsdef.test' +%% generated by the `filecontentshere' environment +%% from source `filecontentsdef' on 2019/05/03. +%% + \begin{framed} + \noindent + We have coded this in \LaTeX: both + $E=mc^2$ (input as \verb|$E=mc^2$|) + and $E=h\nu$ owe much to \textsc{Albert Einstein}. + \end{framed} diff --git a/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef.tex b/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef.tex index 22290d7d8b9..9aa1933073b 100644 --- a/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef.tex +++ b/Master/texmf-dist/doc/latex/filecontentsdef/filecontentsdef.tex @@ -1,8 +1,8 @@ %% %% Package: filecontentsdef -%% Version: 1.2 (2016/09/19) +%% Version: 1.4 (2019/04/20) %% License: LPPL 1.3c -%% Copyright (C) 2016 Jean-Francois Burnol <jfbu at free dot fr> +%% Copyright (C) 2016-2019 Jean-Francois Burnol <jfbu at free dot fr> %% \chardef\Withdvipdfmx 1 % replace 1 by 0 for using pdflatex \chardef\NoSourceCode 0 % replace 0 by 1 for the doc *without* the source code |