summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/circuit-macros/examples/README-examples
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/circuit-macros/examples/README-examples')
-rw-r--r--Master/texmf-dist/doc/latex/circuit-macros/examples/README-examples122
1 files changed, 68 insertions, 54 deletions
diff --git a/Master/texmf-dist/doc/latex/circuit-macros/examples/README-examples b/Master/texmf-dist/doc/latex/circuit-macros/examples/README-examples
index 1f37cf5f36b..bcd3bf37284 100644
--- a/Master/texmf-dist/doc/latex/circuit-macros/examples/README-examples
+++ b/Master/texmf-dist/doc/latex/circuit-macros/examples/README-examples
@@ -1,59 +1,73 @@
-This directory contains examples.tex, source files for the diagrams
-that are imported when examples.tex is LaTeXed, and some other standalone
-diagrams. To generate examples.pdf in a unix-like environment (versions
-of unix, linux, cygwin, djgpp, ...):
+THIS DIRECTORY contains examples.tex, source files for the diagrams
+ that are imported when examples.tex is LaTeXed, some other example
+ diagrams, and a subdirectory for producing SVG files without invoking
+ LaTeX. To generate examples.pdf in a unix-like environment (versions
+ of unix, linux, cygwin, djgpp, ...):
1. Install the libraries as described in the top-level README file.
-2. In this directory, type "make". If your installed dpic is the
- Mingw version included in the dpic distribution, (a) edit the
- file windows.m4 to point to your installation folder, and (b) uncomment
- the CUSTOM=windows.m4 line in the Makefile, or type
- "make CUSTOM=windows.m4".
-
-To test one of the diagrams, say ex01.m4, type one of the following
-(and have a look at the comments at the top of the Makefile):
-"make ex01.ps"
-"make ex01.eps"
-"make ex01.pdf" (uses pdflatex)
-"make ex01.png" (requires Imagemagick convert)
-"make ex01.tif" (requires Imagemagick convert)
-"make ex01.svg" (requires Imagemagick convert, but see the svg folder)
+
+2. Verify that dpic is installed. Some of the examples also work
+ with gpic.
+
+3. In this directory, type "make", but note the following:
+
+ If your installed dpic is the precompiled Mingw version for Windows,
+ (a) edit the file windows.m4 to point to your installation folder,
+ and (b) uncomment the CUSTOM=windows.m4 line in the Makefile, or type
+ "make CUSTOM=windows.m4".
+
+ If you get an error in examples.log, your LaTeX installation might
+ need updating.
IN CASE OF DIFFICULTY: Look at files debug1.tex and debug2.m4, and
-follow the instructions.
-
-To test and debug a single diagram, write it into test.m4. Type
-"make tst" to process the file, creating test.tex, which is imported into
-tst.tex. The diagram source and tst.tex are processed twice in case
-the boxdim macro is being used. If you only need to process once, type
-"make tst1". In both cases the resulting file is tst.ps.
-To use tikz and pdflatex to produce test.pdf, type "make test.pdf" as above.
-
-To test and debug a single diagram in a different directory, copy Makefile
-to where you want to work, adjust the definition of LIBDIR
-in Makefile if environment variable M4PATH has not been defined, and type
-one of the above commands.
-
-By default, the dpic processor is invoked, producing TiKz commands.
-To use PSTricks instead, type "make clean; make examples.ps".
-To process the diagrams using TikZ PGF for processing either by LaTeX or
-PDFlatex, type "make" or "make examplespgf.ps" in the pgf subdirectory.
-
-There are often several methods for producing similar graphical results,
-particularly of text labels. Some of the diagrams in this directory are
-slightly more complicated than required for Tikz or PSTricks in order
-that they will work with other postprocessors. Dpic output that does
-not handle LaTeX labels has to be treated separately as, for example,
-in the svg directory.
-
-To process the diagrams using .eps intermediate files with embedded psfrag
-strings, go into the psfrag directory and read the README file.
-
-To process the diagrams using MetaPost, look in the mpost subdirectory.
-
-The xfig subdirectory contains the file xfig/xfiglib.fig, which contains
-elements in xfig 3.2 format produced by dpic for importing into xfig.
-
-SVG: Look in the svg directory for an experimental configuration file and
-examples. Type "make" in the svg directory to see the examples.
+ follow the instructions.
+
+SINGLE DIAGRAMS: To test one of the diagrams, say ex01.m4, type one of
+ the following (and have a look at the comments at the top of the Makefile):
+ "make ex01.ps"
+ "make ex01.eps"
+ "make ex01.pdf" (uses pdflatex)
+ "make ex01.png" (requires Imagemagick convert)
+ "make ex01.tif" (requires Imagemagick convert)
+ "make ex01.svg" (requires Imagemagick convert, but see the svg folder)
+
+DEBUGGING: To test and debug a single diagram, write it into test.m4. Type
+ "make tst" to process the file, creating test.tex, which is imported into
+ tst.tex. The diagram source and tst.tex are processed twice in case
+ the boxdim macro is being used. If you only need to process once, type
+ "make tst1". In both cases the resulting file is tst.ps.
+ To use tikz and pdflatex to produce test.pdf, type "make test.pdf" as above.
+
+ To test and debug a single diagram in a different directory, copy Makefile
+ to where you want to work, adjust the definition of LIBDIR
+ in Makefile if environment variable M4PATH has not been defined, and type
+ one of the above commands.
+
+TiKz and PSTricks: By default, the dpic processor is invoked, producing
+ TiKz commands. To use PSTricks instead, type "make clean; make
+ examples.ps". To process the diagrams using TikZ PGF for formatting
+ either by LaTeX or PDFlatex, type "make" or "make examplespgf.ps"
+ in the pgf subdirectory.
+
+SVG: Look in the svg directory for examples, and type "make".
+
+ALTERNATIVES: There are often several methods for producing similar
+ graphical results, particularly of text labels. Some of the diagrams
+ in this directory are slightly more complicated than required for Tikz
+ or PSTricks in order for them to work with other postprocessors. Dpic
+ output that does not produce LaTeX labels has to be treated separately
+ as, for example, in the svg directory.
+
+METAPOST: To process the diagrams using MetaPost, look in the mpost
+ subdirectory. To accommodate MetaPost, some of these sources use
+ latexcommand(...) when iflatex(command "...") or, simply, command "..."
+ would do.
+
+PSFRAG: To process the diagrams using .eps intermediate files with embedded
+ psfrag strings, go into the psfrag directory and read the README file.
+ As for METAPOST, some of these sources disable "command" or
+ "latexcommand".
+
+XFIG: The xfig subdirectory contains the file xfig/xfiglib.fig, which contains
+ elements in xfig 3.2 format produced by dpic for importing into xfig.