summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/filecontentsdef/README.md
blob: c72c1a542df7ae8914b45b6a6421923f65afeb54 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
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.