Debian Codegraph @

texmf-dist/doc/latex/prerex/README

raw
1 prerex, version 2019-11-15. Macros for prerequisite charts, with
2 associated editor and viewer applications.
3
4 This package consists of
5
6 prerex.sty
7 a LaTeX package for producing charts of course nodes
8 linked by arrows representing pre- and co-requisites,
9
10 prerex
11 an interactive program for creating and editing chart
12 descriptions, and
13
14 vprerex ("visual prerex") a GUI and previewer for prerex.
15
16 The implementation of prerex.sty is built on pgf, so that it
17 may be used equally happily with latex or pdflatex; prerex
18 is written in C and vprerex is written in C++ using the Qt-4
19 or Qt-5 and poppler-qt libraries.
20
21 See chart.{pdf,svg} for a small example of a prerequisite
22 chart.
23
24 Prerequisite charts are useful to students selecting courses and
25 planning their programs, and to faculty and staff advising students
26 and managing curriculum development. Conventional sources of course,
27 program and timetable information are rarely in a user-friendly
28 format. Faculty and staff advisors, being already fairly familiar
29 with their courses and programs, often do not appreciate how
30 inconvenient it is for students to access all the information they
31 need to make course choices.
32
33 The crucial tool in the prerex suite is "prerex.sty", a macro
34 package that defines a "chart" environment and commands to specify
35 construction of course boxes and directed arrows between them.
36
37 prerex.sty depends on
38
39 pgf (and add-on tikz), version 3.0 or higher
40 multido
41 relsize
42 calc
43 hyperref
44
45 The use of pgf means that Postscript processing is not required.
46 Either pdflatex or latex -> dvips [ -> ps2pdf ] or latex -> dvipdfmx
47 or latex -> dvisvgm (with suitable driver options) will generate
48 charts.
49
50 Installation of prerex.sty:
51
52 + copy prerex.sty to your-texmf-tree/tex/latex/misc
53 + copy doc/prerex.{tex,pdf} to your-texmf-tree/doc/latex/misc
54 + if necessary, refresh the TeX database (e.g., texhash)
55 + copy doc/prerex.sty.7 to sub-directory man7 of a man directory on your
56 MANPATH
57 + test by doing
58
59 man 7 prerex.sty
60 pdflatex chart.tex
61
62 See doc/prerex.pdf for detailed documentation.
63
64 The prerex editor allows interactive editing of the chart
65 environments of LaTeX source files. It supports add, remove,
66 cut-and-paste, and edit operations on course boxes and arrows, and
67 vertical or horizontal shifts of the whole diagram or selected sets
68 of course boxes. When a course box is moved, the arrows into and out
69 of it automatically follow. To install on most Unix-like platforms,
70 including OS-X and Cygwin on Windows:
71
72 tar zxvf prerex-6.8.0.tar.gz
73 cd prerex-6.8.0
74 ./configure [--prefix=$HOME]
75 make
76 make install (as root if necessary)
77
78 The prerex editor will also build on the MinGW platform on Windows
79 if the readline package in the gnuwin32.sourceforge.net repository
80 has been installed.
81
82 The effects of editing operations may be observed in any PDF viewer
83 that re-loads dynamically. The vprerex (visual prerex) application
84 included in the prerex suite is a GUI and viewer for the prerex
85 editor. It may be used just as a minimalist viewer of arbitrary PDF
86 files but supports editing of charts generated using prerex.sty
87 by allowing coordinates of course boxes, arrows, and background
88 points to be conveyed back to the prerex editor command-line using
89 the clipboard. See the INSTALL in the tarball for installation
90 instructions. There are two versions, for Qt-4 (vprerex-6.4.4)
91 and Qt-5 (vprerex-6.5.1), respectively.
92
93 See the file doc/intro.pdf for an overview of the prerex system.
94
95 prerex.sty, README, prerex.1, prerex.5, prerex.sty.7, prerex.tex and
96 chart.tex may be modified and distributed according to the terms of
97 the LaTeX Project Public License.
98
99 The source files for prerex and vprerex may be modified and
100 distributed according to the terms of the GNU General Public Licence
101 (version 2).