1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
Bazaar Documentation
====================
This directory contains high level documentation describing the interactions of
the various non-web Launchpad subsystems that implement The Bazaar.
Compiling
=========
You can export the documentation to HTML and Postscript using, respectively,
``make html`` (that's the default target) and ``make ps``.
``make html`` requires ``xsltproc`` and ``dia``::
sudo apt-get install xsltproc dia-gnome
``make ps`` requires ``texmacs`` and ``dia``::
sudo apt-get install texmacs dia-gnome
Modifying
=========
Please read this section before modifying the documentation.
The documentation is written using GNU TeXmacs (``apt-get install texmacs``)
and is saved as ``bazaar.tmml``. You can make small changes directly on the
``bazaar.tmml`` file (that's an XML document), but using TeXmacs is strongly
recommended for any non-trivial editing.
TeXmacs has a crashing bug which is exercised by ``unclutter`` (a little
utility that hides the mouse cursor), so you must kill ``unclutter`` to use
TeXmacs. The first minutes of use tend to be a bit painful when TeXmacs
compiles a bunch fonts, please be patient, and start ``texmacs`` from a
terminal so you get some idea of what is going on.
If you have an trouble using TeXmacs, please ask David Allouche (ddaa).
All figures were created using ``dia`` (``apt-get install dia-gnome``) and are
stored in the ``dia`` and ``large-dia`` directories. The ``large-dia``
directory contains images which would be exported by default to a width greater
than 600 pixels.
If you modify a diagram from the ``large-dia`` directory, you should export it
manually from ``dia`` and set the width to be at most 600 pixels. Then run
``make large-dia/sizes`` to record the new size of the exported PNG file. This
is necessary because the ``dia`` command line does not support image export
with aspect-ratio preserving scaling.
|