Workbook User Guide

Setting Up

Install required software first, then install Workbook.

Hardware

Requirement

No special hardware needed. Any ordinary PC is fine.

Software

Requirement

Workbook requires the following softtware to run (Debian package names we used for testing are in parentheses):

• Unix-like operating environment (Debian GNU/Linux 4.0 (etch))
• xsltproc (xsltproc 1.1.19)
• XHTML plus Math 1.1 DTD (w3c-dtd-xhtml 1.1, w3-dtd-mathml 2.0.0.0)
• Ruby (ruby1.8 1.8.5)
• Rake (rake 0.7.1)
• pLaTeX (ptex-bin 3.1.10~beta3+0.04b, ptex-jisfonts 2-19)
• Adobe CMaps (cmap-adobe-japan1 0+20040605, cmap-adobe-japan2 0+20020208)
• mendex (mendexk 2.6d)
• dvipdfmx (dvipdfmx 20050831)
• jsbook/jsclasses LaTeX class (okumura-clsfiles 2006.11.06)
• Computer Modern font (cm-super 0.3.3)
• Ghostscript (gs-esp 8.15.3, gs-cjk-resource 1.20021122)
• ImageMagick (imagemagick 6.2.4.5)
• pdfinfo (xpdf-utils 3.01)
• epstool (epstool 3.08)
• nkf (nkf 2.07)
• GNU wget (wget 1.10.2)
• HTML Tidy (tidy 20051018)
• unzip (unzip 5.52)

See Depends: field in debian/control in the distribution tarball for detail.

We use the following for development:

• Debian GNU/Linux unstable (sid)
• GNU make (make 3.81)
• Subversion (subversion 1.4)

We recommend you use OS's with packaging system to avoid dependency problem. Excuse us for inconvenience.

Note for Windows users: While Workbook does not directly support Windows yet, it runs on Unix-like OS in VMware, coLinux or similar virtualization software.

Recommended

These are not requirement, but recommended over other options.

• Debian GNU/Linux
• Mozilla Firefox (1.5 and above supports MathML)
• MIT MathML fonts

Suggested

These are not required to run the software, but may be useful when used in conjunction with.

• psgml-mode / Emacs (for editing XHTML/XML)
• Web Developer extension for Firefox (for validating XHTML with w3 validator service)
• OpenOffice.org Draw (for drawing diagrams)
• Adobe Acrobat (Professional)
• Decent font

Workbook Distribution

Everything is available at the following site, including binary packages and source code:

http://sourceforge.net/projects/workbook

Installation

Debian Package

Debian package is easy to install and also easy to uninstall. Download the .deb package and install it using dpkg.

$ sudo dpkg --install workbook-x.y.z-*.deb
$ sudo apt-get install -f
$ sudo dpkg --install workbook-x.y.z-*.deb

Do not forget to include contrib and non-free in your apt lines.

Tarball

If you dare to install using tar ball, use make. Use DESTDIR to change installation directory.

$ tar zxvf workbook-x.y.z.tar.gz
$ cd workbook-x.y.z
$ make
$ make install DESTDIR=/home/jdoe