summaryrefslogtreecommitdiffstats
path: root/docs/readme-docs-module.html
blob: 28f9647d3c7ade674fe520f54504c9f9eabf677c (plain)
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<html>
<title>AspectJ docs</title>
<body>
<h1>AspectJ docs</h1>

This module contains the sources for the documentation
delivered with the AspectJ distribution and 
for various internal, teaching, and online works:
<ul>
    <li><a href="devGuideDB">devGuideDB</a>: DocBook sources
        for the AspectJ Development Environment Guide</li>

    <li><a href="progGuideDB">progGuideDB</a>: DocBook sources
        for the AspectJ Programming Language Guide</li>

    <li><a href="faq">faq</a>: DocBook sources
        for the AspectJ Frequently Asked Questions</li>

    <li><a href="sandbox">sandbox</a>: a collection of sample
        AspectJ programs, tools built on the AspectJ API's,
        script snippets, and instructional trails, all intended
        to serve as sources for documentation.
        See <a href="sandbox/readme-sandbox.html">
                     sandbox/readme-sandbox.html</a></li>

    <li><a href="teaching">teaching</a>: Teaching materials, esp.
        for the AspectJ tutorials.</li>

    <li><a href="quick.doc">quick.doc</a>: The Microsoft Word
        source file for the .pdf Quick Reference guides
		<a href="dist/doc/quick.pdf">dist/doc/quick.pdf</a> and
		<a href="dist/doc/quickA4.pdf">dist/doc/quickA4.pdf</a>.</li>

    <li><a href="build.xml">build.xml</a>: Ant build script for 
        the doc distribution</li>

    <li><a href="developer">developer</a>: Docs for AspectJ developers.
       See the <a href="developer/overview.html">overview.html</a></li>
</ul>

<p>
<u>Build</u>: <a href="build.xml">build.xml</a> assembles a local
distribution which is gathered into the product distribution by
the master build script, 
<a href="../build/build.xml">../build/build.xml</a>.
Dependencies outside this directory:
<ul>
<li>.xml files refer to their docbook dtds using relative
    path, for the moment ../../lib/docbook/...
    </li>
<li>When building docbook, uses ../lib/saxon libraries.
    </li>
<li>When building installer, using ../lib/build/build.jar
    and the ../build/installer-resources.
    </li>
<li><a href="dist/doc/quick.pdf">dist/doc/quick.pdf</a>
     is generated manually from <a href="quick.doc">quick.doc</a>.
    </li>
</ul>
</body>
</html>