aboutsummaryrefslogtreecommitdiffstats
path: root/docs/modules/ROOT/pages/index.adoc
diff options
context:
space:
mode:
authorAlexander Kriegisch <Alexander@Kriegisch.name>2024-01-31 13:40:34 +0700
committerAlexander Kriegisch <Alexander@Kriegisch.name>2024-02-01 08:58:27 +0700
commit06557e86b01bf0c2a58a58e6d322f8c576b0acba (patch)
treec574b06f59d55cf3ba7f13528916ef9382fc9ba6 /docs/modules/ROOT/pages/index.adoc
parentc6de70659e3b52e6f6df5e309902a2fa5c8981ce (diff)
downloadaspectj-06557e86b01bf0c2a58a58e6d322f8c576b0acba.tar.gz
aspectj-06557e86b01bf0c2a58a58e6d322f8c576b0acba.zip
Fix several structural asciidoc warnings
In changes.adoc, also make headlines and TOC more readable. To avoid some "image not found" warnings, move images directory in ROOT module to the canonical level. This also required a small change in IDE.md. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
Diffstat (limited to 'docs/modules/ROOT/pages/index.adoc')
-rw-r--r--docs/modules/ROOT/pages/index.adoc128
1 files changed, 64 insertions, 64 deletions
diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
index 32a8d2001..37ea5464c 100644
--- a/docs/modules/ROOT/pages/index.adoc
+++ b/docs/modules/ROOT/pages/index.adoc
@@ -10,10 +10,10 @@ materials, see https://eclipse.org/aspectj. Not all of these materials have been
|+++Section+++ |+++Contents+++
|xref:#documentation[Documentation]
-|xref:faq/faq.adoc#faq[FAQ], xref:quickref/quick5.pdf[Quick Reference (AspectJ 5)],
-xref:quickref/quick.pdf[Quick Reference (1.2.1)], xref:adk15notebook/index.adoc[AspectJ 5 Developer's Notebook],
-xref:progguide/index.adoc[programming], xref:devguide/index.adoc[development] and
-xref:pdguide/index.adoc[problem diagnosis] guides, link:runtime-api/index.html[runtime API],
+|xref:faq:faq.adoc#faq[FAQ], xref:quickref/quick5.pdf[Quick Reference (AspectJ 5)],
+xref:quickref/quick.pdf[Quick Reference (1.2.1)], xref:adk15notebook:index.adoc[AspectJ 5 Developer's Notebook],
+xref:progguide:index.adoc[programming], xref:devguide:index.adoc[development] and
+xref:pdguide:index.adoc[problem diagnosis] guides, link:runtime-api/index.html[runtime API],
link:weaver-api/index.html[weaver API] and link:examples[example code]
|xref:#distributions[Distributions]
@@ -42,39 +42,39 @@ mailto:aspectj-users@eclipse.org[users] and mailto:aspectj-dev@eclipse.org[devel
a|AspectJ 5 Developer's Notebook
-* xref:adk15notebook/index.adoc[HTML multi-page]
-* xref:adk15notebook/adk15notebook.adoc[HTML single page]
+* xref:adk15notebook:index.adoc[HTML multi-page]
+* xref:adk15notebook:adk15notebook.adoc[HTML single page]
* xref:adk15notebook/adk15notebook.pdf[PDF]
|Describes the changes to the AspectJ language and tools introduced in the AspectJ 5 Development Kit. These changes are
additive, and are not yet reflected in the programming guide or quick reference.
a|Programming Guide
-* xref:progguide/index.adoc[HTML multi-page]
-* xref:progguide/progguide.adoc[HTML single page]
+* xref:progguide:index.adoc[HTML multi-page]
+* xref:progguide:progguide.adoc[HTML single page]
* xref:progguide/progguide.pdf[PDF]
-|Introduces AOP and the AspectJ language. xref:progguide/gettingstarted.adoc[Getting Started] describes basic semantics
-and shows development- and production-time applications. xref:progguide/language.adoc[The AspectJ Language] describes
-join points, pointcuts, advice, and introduction, all features new to AOP. xref:progguide/examples.adoc[Examples] walks
+|Introduces AOP and the AspectJ language. xref:progguide:gettingstarted.adoc[Getting Started] describes basic semantics
+and shows development- and production-time applications. xref:progguide:language.adoc[The AspectJ Language] describes
+join points, pointcuts, advice, and introduction, all features new to AOP. xref:progguide:examples.adoc[Examples] walks
you through the examples included with the documentation, and there are two short chapters on useful
-xref:progguide/idioms.adoc[Idioms] and a few xref:progguide/pitfalls.html[Pitfalls]. +
-The appendices have reference information: the xref:progguide/quickreference.adoc[Quick Reference] summarizes AspectJ
-syntax, the xref:progguide/semantics.adoc[Language Semantics] best describes AspectJ usage, and
-xref:progguide/implementation.adoc[Implementation Notes] describes how the current version is limited to code the
+xref:progguide:idioms.adoc[Idioms] and a few xref:progguide:pitfalls.adoc[Pitfalls]. +
+The appendices have reference information: the xref:progguide:quickreference.adoc[Quick Reference] summarizes AspectJ
+syntax, the xref:progguide:semantics.adoc[Language Semantics] best describes AspectJ usage, and
+xref:progguide:implementation.adoc[Implementation Notes] describes how the current version is limited to code the
compiler controls.
a|Development Environment Guide
-* xref:devguide/index.adoc[HTML multi-page]
-* xref:devguide/devguide.adoc[HTML single page]
+* xref:devguide:index.adoc[HTML multi-page]
+* xref:devguide:devguide.adoc[HTML single page]
* xref:devguide/devguide.pdf[PDF]
-|Guide to the command-line compiler xref:devguide/ajc.adoc[ajc] and the xref:devguide/antsupport.adoc[Ant tasks] for
+|Guide to the command-line compiler xref:devguide:ajc.adoc[ajc] and the xref:devguide:antsupport.adoc[Ant tasks] for
building AspectJ programs
a|Problem Diagnosis Guide
-* xref:pdguide/index.adoc[HTML multi-page]
-* xref:pdguide/pdguide.adoc[HTML single page]
+* xref:pdguide:index.adoc[HTML multi-page]
+* xref:pdguide:pdguide.adoc[HTML single page]
* xref:pdguide/pdguide.pdf[PDF]
|Guide to various debugging features available, such as messages and trace to help you both solve problems with you own
programs and report bugs to the AspectJ team
@@ -88,46 +88,46 @@ programs and report bugs to the AspectJ team
used for byte code weaving, both during compilation from source code and binary weaving during post-compile and
load-time weaving.
-|xref:faq/faq.adoc#faq[FAQ]
+|xref:faq:faq.adoc#faq[FAQ]
|Frequently asked questions about the AspectJ language, tools, and project
-|xref:release/JavaVersionCompatibility.adoc[Java version compatibility]
+|xref:release:JavaVersionCompatibility.adoc[Java version compatibility]
|Compatibility matrix, explaining which AspectJ compiler version supports which Java language version and needs which
JDK to run
|Release notes |Release notes, describing new features, improvements, bugfixes per AspectJ version: +
+
-xref:release/README-1.9.21.adoc[1.9.21],
-xref:release/README-1.9.20.adoc[1.9.20 and 1.9.20.1], xref:release/README-1.9.19.adoc[1.9.19],
-xref:release/README-1.9.9.adoc[1.9.9 and 1.9.9.1], xref:release/README-1.9.8.adoc[1.9.8],
-xref:release/README-1.9.7.adoc[1.9.7], xref:release/README-1.9.6.adoc[1.9.6],
-xref:release/README-1.9.5.adoc[1.9.5], xref:release/README-1.9.4.adoc[1.9.4],
-xref:release/README-1.9.3.adoc[1.9.3], xref:release/README-1.9.2.adoc[1.9.2],
-xref:release/README-1.9.1.adoc[1.9.1], xref:release/README-1.9.0.adoc[1.9.0],
-xref:release/README-1.8.11.adoc[1.8.11], xref:release/README-1.8.10.adoc[1.8.10],
-xref:release/README-1.8.9.adoc[1.8.9], xref:release/README-1.8.8.adoc[1.8.8],
-xref:release/README-1.8.7.adoc[1.8.7], xref:release/README-1.8.6.adoc[1.8.6],
-xref:release/README-1.8.5.adoc[1.8.5], xref:release/README-1.8.4.adoc[1.8.4],
-xref:release/README-1.8.3.adoc[1.8.3], xref:release/README-1.8.2.adoc[1.8.2],
-xref:release/README-1.8.1.adoc[1.8.1], xref:release/README-1.8.0.adoc[1.8.0],
-xref:release/README-1.7.4.adoc[1.7.4], xref:release/README-1.7.3.adoc[1.7.3],
-xref:release/README-1.7.2.adoc[1.7.2], xref:release/README-1.7.1.adoc[1.7.1],
-xref:release/README-1.7.0.adoc[1.7.0], xref:release/README-1.6.12.adoc[1.6.12],
-xref:release/README-1.6.11.adoc[1.6.11], xref:release/README-1.6.10.adoc[1.6.10],
-xref:release/README-1.6.9.adoc[1.6.9], xref:release/README-1.6.8.adoc[1.6.8],
-xref:release/README-1.6.7.adoc[1.6.7], xref:release/README-1.6.6.adoc[1.6.6],
-xref:release/README-1.6.5.adoc[1.6.5], xref:release/README-1.6.4.adoc[1.6.4],
-xref:release/README-1.6.3.adoc[1.6.3], xref:release/README-1.6.2.adoc[1.6.2],
-xref:release/README-1.6.1.adoc[1.6.1], xref:release/README-1.6.0.adoc[1.6.0],
-xref:release/README-1.5.4.adoc[1.5.4], xref:release/README-1.5.3.adoc[1.5.3],
-xref:release/README-1.5.2.adoc[1.5.2], xref:release/README-1.5.1.adoc[1.5.1],
-xref:release/README-1.5.0.adoc[1.5.0], xref:release/README-1.2.1.adoc[1.2.1],
-xref:release/README-1.2.adoc[1.2], xref:release/README-1.1.adoc[1.1].
-
-|xref:release/changes.adoc[Changes] (historical)
+xref:release:README-1.9.21.adoc[1.9.21],
+xref:release:README-1.9.20.adoc[1.9.20 and 1.9.20.1], xref:release:README-1.9.19.adoc[1.9.19],
+xref:release:README-1.9.9.adoc[1.9.9 and 1.9.9.1], xref:release:README-1.9.8.adoc[1.9.8],
+xref:release:README-1.9.7.adoc[1.9.7], xref:release:README-1.9.6.adoc[1.9.6],
+xref:release:README-1.9.5.adoc[1.9.5], xref:release:README-1.9.4.adoc[1.9.4],
+xref:release:README-1.9.3.adoc[1.9.3], xref:release:README-1.9.2.adoc[1.9.2],
+xref:release:README-1.9.1.adoc[1.9.1], xref:release:README-1.9.0.adoc[1.9.0],
+xref:release:README-1.8.11.adoc[1.8.11], xref:release:README-1.8.10.adoc[1.8.10],
+xref:release:README-1.8.9.adoc[1.8.9], xref:release:README-1.8.8.adoc[1.8.8],
+xref:release:README-1.8.7.adoc[1.8.7], xref:release:README-1.8.6.adoc[1.8.6],
+xref:release:README-1.8.5.adoc[1.8.5], xref:release:README-1.8.4.adoc[1.8.4],
+xref:release:README-1.8.3.adoc[1.8.3], xref:release:README-1.8.2.adoc[1.8.2],
+xref:release:README-1.8.1.adoc[1.8.1], xref:release:README-1.8.0.adoc[1.8.0],
+xref:release:README-1.7.4.adoc[1.7.4], xref:release:README-1.7.3.adoc[1.7.3],
+xref:release:README-1.7.2.adoc[1.7.2], xref:release:README-1.7.1.adoc[1.7.1],
+xref:release:README-1.7.0.adoc[1.7.0], xref:release:README-1.6.12.adoc[1.6.12],
+xref:release:README-1.6.11.adoc[1.6.11], xref:release:README-1.6.10.adoc[1.6.10],
+xref:release:README-1.6.9.adoc[1.6.9], xref:release:README-1.6.8.adoc[1.6.8],
+xref:release:README-1.6.7.adoc[1.6.7], xref:release:README-1.6.6.adoc[1.6.6],
+xref:release:README-1.6.5.adoc[1.6.5], xref:release:README-1.6.4.adoc[1.6.4],
+xref:release:README-1.6.3.adoc[1.6.3], xref:release:README-1.6.2.adoc[1.6.2],
+xref:release:README-1.6.1.adoc[1.6.1], xref:release:README-1.6.0.adoc[1.6.0],
+xref:release:README-1.5.4.adoc[1.5.4], xref:release:README-1.5.3.adoc[1.5.3],
+xref:release:README-1.5.2.adoc[1.5.2], xref:release:README-1.5.1.adoc[1.5.1],
+xref:release:README-1.5.0.adoc[1.5.0], xref:release:README-1.2.1.adoc[1.2.1],
+xref:release:README-1.2.adoc[1.2], xref:release:README-1.1.adoc[1.1].
+
+|xref:release:changes.adoc[Changes] (historical)
|Changes between historical releases up to 1.6.0
-|xref:release/porting.adoc[Porting guide] (historical)
+|xref:release:porting.adoc[Porting guide] (historical)
|Porting guide for historical releases to 1.2
|link:examples[Examples]
@@ -158,7 +158,7 @@ documentation and examples.
|https://eclipse.org/aspectj[AspectJ source code]
|Source code for AspectJ is available under the open-source
https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.txt[Eclipse Public License v 2.0] license from the Git
-repositories for the AspectJ project. See the xref:faq/faq.adoc#buildingsource[FAQ entry].
+repositories for the AspectJ project. See the xref:faq:faq.adoc#buildingsource[FAQ entry].
|https://eclipse.org/ajdt[AspectJ for Eclipse]
|AspectJ Development Environment support for Eclipse is available under Eclipse Public License v 1.0 from the
@@ -189,28 +189,28 @@ https://bugs.eclipse.org/bugs/buglist.cgi?product=AspectJ&component=Ant[Ant] (fo
https://bugs.eclipse.org/bugs/buglist.cgi?product=AspectJ&component=Docs[Docs] (for the documentation).
Bugs all users should know about are
https://bugs.eclipse.org/bugs/buglist.cgi?product=AspectJ&keywords=info[flagged with the "info" keyword].
-See the xref:faq/faq.adoc#ajcbugs[FAQ entry] for instructions on submitting compiler bugs.
+See the xref:faq:faq.adoc#ajcbugs[FAQ entry] for instructions on submitting compiler bugs.
|===
[[paths]]
== Suggested learning paths for those new to AspectJ
-To learn the AspectJ language, read the xref:progguide/index.adoc[Programming Guide], keeping the
-xref:progguide/semantics.adoc[Semantics appendix] nearby as the best reference for AspectJ usage. Focus initially on the
+To learn the AspectJ language, read the xref:progguide:index.adoc[Programming Guide], keeping the
+xref:progguide:semantics.adoc[Semantics appendix] nearby as the best reference for AspectJ usage. Focus initially on the
join point model and pointcuts, concepts AOP adds to OOP. To read about how the link:examples[examples] work, see the
-xref:progguide/examples.adoc[Examples] section in the xref:progguide/index.adoc[Programming Guide]. View and navigate
+xref:progguide:examples.adoc[Examples] section in the xref:progguide:index.adoc[Programming Guide]. View and navigate
the crosscutting structure using https://eclipse.org/ajdt[AJDT].
To start using AspectJ with your own code, modify the example aspects to apply to your classes. As you learn, use the
compiler's `-Xlint` flags to catch some common mistakes. (Understand that the
-xref:progguide/implementation.adoc[current implementation] is limited to code the compiler controls.)
-
-To plan how to adopt AspectJ into a project, read the xref:progguide/index.adoc[Programming Guide] on development- and
-production-time aspects and the FAQ entries for xref:faq/faq.adoc#howToStartUsing[How should I start using AspectJ?],
-xref:faq/faq.adoc#adoption[Deciding to adopt AspectJ], the Development tools sections
-(xref:faq/faq.adoc#integrateWithDevTools[How does AspectJ integrate with existing Java development tools?],
-xref:faq/faq.adoc#devtools[Integrating AspectJ into your development environment],
-xref:faq/faq.adoc#ltw[Load-time weaving]), and xref:faq/faq.adoc#opensource[AspectJ as open-source]).
+xref:progguide:implementation.adoc[current implementation] is limited to code the compiler controls.)
+
+To plan how to adopt AspectJ into a project, read the xref:progguide:index.adoc[Programming Guide] on development- and
+production-time aspects and the FAQ entries for xref:faq:faq.adoc#howToStartUsing[How should I start using AspectJ?],
+xref:faq:faq.adoc#adoption[Deciding to adopt AspectJ], the Development tools sections
+(xref:faq:faq.adoc#integrateWithDevTools[How does AspectJ integrate with existing Java development tools?],
+xref:faq:faq.adoc#devtools[Integrating AspectJ into your development environment],
+xref:faq:faq.adoc#ltw[Load-time weaving]), and xref:faq:faq.adoc#opensource[AspectJ as open-source]).
Enjoy the language!