summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorwisberg <wisberg>2003-08-06 02:06:20 +0000
committerwisberg <wisberg>2003-08-06 02:06:20 +0000
commitb0d37c4b51a344bee94bb7f7cc1ecef1a233e3ab (patch)
tree2d09a44cad775e155152ae004fe11cb8d571cc13 /docs
parentc7584070e1ca1e4f1899f4b62e2c193d4d43c206 (diff)
downloadaspectj-b0d37c4b51a344bee94bb7f7cc1ecef1a233e3ab.tar.gz
aspectj-b0d37c4b51a344bee94bb7f7cc1ecef1a233e3ab.zip
document new contents of docs module
Diffstat (limited to 'docs')
-rw-r--r--docs/readme-docs-module.html44
1 files changed, 34 insertions, 10 deletions
diff --git a/docs/readme-docs-module.html b/docs/readme-docs-module.html
index fdb7866a1..28f9647d3 100644
--- a/docs/readme-docs-module.html
+++ b/docs/readme-docs-module.html
@@ -3,16 +3,40 @@
<body>
<h1>AspectJ docs</h1>
-The AspectJ docs include native sources (html and word files)
-and XML DocBook files used to produce the FAQ and guides.
-The <a href="dist">dist</a> directory contains the native files
-as they are delivered with the distribution, and the
-docbook directories
- <a href="faq">faq</a>,
- <a href="progGuideDB">progGuideDB</a>, and
- <a href="devGuideDB">devGuideDB</a>
-contain sources for the FAQ and the Programming and Development Guides,
-generated using the Ant <a href="build.xml">build.xml</a> script.
+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