Debian Codegraph @

texmf-dist/doc/latex/combinedgraphics/README

raw
1 SHORT DESCRIPTION
2 =================
3
4 (This is a copy of the LaTeX code of the documentation's abstract.)
5
6 This package provides a macro (|\includecombinedgraphics|) for the
7 inclusion of combined EPS/\LaTeX{} and PDF/\LaTeX{} graphics (an export
8 format of Gnuplot, Xfig, and maybe other programs). Instead of including
9 the graphics with a simple |\input|, the |\includecombinedgraphics| macro
10 has some benefits:
11
12 \begin{itemize}
13 \item changing the font and color of the text of the \LaTeX{} parts
14 \item rescaling the graphics without affecting the font of the \LaTeX{}
15 parts
16 \item automatic inclusion of the vector graphics parts, as far as \LaTeX{}
17 parts do not do it (e.\,g., for files exported from Gnuplot before
18 version 4.2 or Xfig)
19 \item changing the inclusion order of \LaTeX{} and vector graphics
20 parts (e.\,g., Gnuplot 4.4 exports files in a way that the vector
21 graphics part overlays the \LaTeX{} part, which means that text may be
22 hidden under shaded areas)
23 \item rescaling and rotating of complete graphics (similar to
24 |\includegraphics| from \textsf{graphicx} package)
25 \item scaling the vector graphics part (without affecting the font) to
26 a defined width or height of the graphics, which might, e.g., be of
27 importance for graphics that are intended for publication in a journal
28 requesting a certain size of graphics
29 \end{itemize}
30
31 A test PDF file with extensively commented examples is shipped with this
32 package and a BASH script (\texttt{texpic2epspdf.sh}) to convert combined
33 EPS/\LaTeX{} and PDF/\LaTeX{} graphics to EPS or PDF files with text part
34 included.
35
36 See `combinedgraphics.pdf' for detailed information on usage.
37
38 BUILDING
39 ========
40
41 If you do not want to use any pre-build `combinedgraphics.sty' and
42 `combinedgraphics.pdf' files, you will have to choose one of the following
43 two ways for building them. Otherwise you can skip this section.
44
45 1) Building with make
46 ---------------------
47
48 Running `make' will create the LaTeX package, the documentation and the test
49 file:
50 $ make
51
52 2) Building manually
53 --------------------
54
55 a) Generation of package (.sty file):
56
57 Run `combinedgraphics.ins' through LaTeX:
58 $ pdflatex -interaction=nonstopmode combinedgraphics.ins
59
60 b) Generation of documentation:
61
62 Run `combinedgraphics.dtx' through LaTeX:
63 $ pdflatex -interaction=nonstopmode combinedgraphics.dtx
64
65 Then create the index and change history:
66 $ makeindex -s gind.ist -o combinedgraphics.ind combinedgraphics.idx
67 $ makeindex -s gglo.ist -o combinedgraphics.gls combinedgraphics.glo
68
69 Finally, run `combinedgraphics.dtx' three time through LaTeX:
70 $ pdflatex -interaction=nonstopmode combinedgraphics.dtx
71 $ pdflatex -interaction=nonstopmode combinedgraphics.dtx
72 $ pdflatex -interaction=nonstopmode combinedgraphics.dtx
73
74 Optionally you can compile the test file:
75 $ pdflatex -interaction=nonstopmode combinedgraphics_test.tex
76 $ pdflatex -interaction=nonstopmode combinedgraphics_text.tex
77 $ pdflatex -interaction=nonstopmode combinedgraphics_text.tex
78
79 INSTALLATION
80 ============
81
82 1) Installing with make
83 -----------------------
84
85 To install the package into a TDS (= TeX directory structure; typically its base
86 directory is named `texmf' or something similar), run the following command:
87 $ make DESTDIR=<your TDS> install
88
89 Note: `$(DESTDIR)' defaults to `$(HOME)/.texmf'.
90
91 2) Installing manually
92 ----------------------
93
94 In principle, you will only habe to copy the file `ionumbers.sty' into a
95 directory, where LaTeX can find it. If you copy it into a TDS (TeX directory
96 structure), you will most probably have to run the following command afterwards:
97 $ mktexlsr <your TDS>
98
99 LICENSE
100 =======
101
102 Copyright 2009,2011 Christian Schneider <software(at)chschneider(dot)eu>
103
104 ion@addto@macro: identical to l@addto@macro from koma-script
105 bundle v2.9t
106 Copyright 1994-2004 Markus Kohm and Frank Neukam
107
108 Thanks to Markus Kohm for permitting to use his code in this package.
109 Please do not bother Markus with questions or bugs concering this package!
110
111 This file is part of combinedgraphics.
112
113 combinedgraphics is free software: you can redistribute it and/or modify
114 it under the terms of the GNU General Public License version 3 as
115 published by the Free Software Foundation, not any later version.
116
117 combinedgraphics is distributed in the hope that it will be useful,
118 but WITHOUT ANY WARRANTY; without even the implied warranty of
119 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
120 GNU General Public License for more details.
121
122 You should have received a copy of the GNU General Public License
123 along with combinedgraphics. If not, see <http://www.gnu.org/licenses/>.
124
125 WARNING: THIS IS ALPHA SOFTWARE AND MAY CONTAIN SERIOUS BUGS!