TDS structure
Assuming your LaTeX package is called foobar
. Then according to TDS (A Directory Structure for TeX files) the files would go below the following Directories:
TDS:tex/latex/foobar/
(for TeX files: .tex, .sty, images)
TDS:doc/latex/foobar/
(for documentation files)
TDS:source/latex/foobar/
(for source files .dtx, .ins)
Further subdirectories are up to you. I would avoid them, if there are few files only. If there are many files, then further directory levels might help to organize the files.
Example:
TDS:doc/latex/foobar/foobar.pdf
TDS:source/latex/foobar/foobar.dtx
TDS:source/latex/foobar/foobar.ins
- Other source files that are not provided in the
.dtx
file can be given in:
TDS:source/latex/foobar/
or
TDS:source/latex/foobar/resources/
TDS:tex/latex/foobar/foobar.cls
TDS:tex/latex/foobar/foobar-common.sty
(The TeX file for the letter class and beamer templates)
TDS:tex/latex/foobar/<foobar beamer file 1>
,
TDS:tex/latex/foobar/<foobar beamer file 2>
,
...,
TDS:tex/latex/foobar/<foobar beamer file 5>
TDS:tex/latex/foobar/resources/<.eps/.pdf image files>
If you additionally provide a README
file, then I would use this name exactly (AFAIK CTAN convention) and put it in the doc
or source
subtree, depending on the contents of the file.
Distribution form
For the distribution I would put these files including the directory structure in a .zip
file foobar.tds.zip
(without the TDS:
/temxf
root).
Then the installation is quite easy for the user, who can easily install by unzipping. Installation example for default home tree in Linux/TeX Live:
$ unzip foobar.tds.zip -d ~/texmf/
In case the package is installed in a system wide local texmf
tree, the file name database needs to be updated (under root):
$ texhash
or
$ mktexlsr
CTAN
A suggestion for the CTAN form, if you want to provide it there:
CTAN:macros/latex/foobar/foobar.dtx
CTAN:macros/latex/foobar/foobar.ins
CTAN:macros/latex/foobar/foobar.pdf
(documentation)
- (
CTAN:macros/latex/foobar/README
)
CTAN:macros/latex/foobar/resources.zip
(or unzipped in directory resources/
)
CTAN:install/macros/latex/foobar.tds.zip
.eps
files are ASCII, you can include them in a.dtx
(I do inchemstyle
, for example).beamer
core, you'll see it's subdivided withintex/latex/beamer
, but that is because there are lots of files. You don't necessarily need to do that for a smaller bundle.