aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Always use ":leveloffset: +1" with ":doctype: book"Alexander Kriegisch2024-02-01108-948/+965
| | | | | | | | | Headlines per ADOC file should start at level 1, not 2. Adjusting the level offset for books helps to avoid warnings when including book chapters, but still allows to also use the chapters as stand-alone documents. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Remove some old files relating to AspectJ Debugger ajdbAlexander Kriegisch2024-02-011-323/+0
| | | | | | | | If ajdb ever existed and was part of the product, it must have been 20+ years ago. There are still some references to it in old release notes and unused Ant and text files, but that is OK for now. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Update AJDT update site URLs after project terminationAlexander Kriegisch2024-01-211-6/+6
| | | | | | | | AJDT is now part of the AspectJ project. Hence, both repository and download area have moved to other URLs. See also: https://gitlab.eclipse.org/eclipsefdn/emo-team/emo/-/issues/475#note_1612124 Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Fix typo in BUILD.mdAlexander Kriegisch2024-01-071-1/+1
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Delete obsolete filesAlexander Kriegisch2024-01-075-108/+0
| | | | | | | | | | | | | - Redundant copies of HTML files used in AspectJ installer, which already exist as resource files in module 'build' - Null-sized AspectJ library JARs which probably were used to trigger certain build steps in the former Ant build - BridgeVersion.java.txt, which has been replaced by a regular org.aspectj.bridge.Version class which can dynamically determine versions from a properties file instead of relying on them being hard-coded into the template. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Update assemblies to include AspectJ licenceAlexander Kriegisch2024-01-061-2/+2
| | | | | | | | | | | | | | | | | | | | | | The former HTML file was moved up one directory level and converted to asciidoc format. Therefore, include the ADOC file from the correct location now. Alternatively, we could have included the generated HTML from the aj-build/dist/docs/doc directory, but that would have meant adding a dependency to the 'docs' module to several other modules for this one file. Actually, asciidoc has become a widely used and accepted format for documentation and is human-readable by design. Therefore, it is OK to include the ADOC file. The important thing is that the licence information - is contained in each published artifact, - can be found easily, - its content is human-readable. All these requirements are still met with this change. Arguably, ADOC is easier to read than HTML and does not even need a web browser. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Fix docs links to example source codeAlexander Kriegisch2024-01-061-5/+3
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Remove obsolete DocBook build config in favour of AsciidoctorAlexander Kriegisch2024-01-064-716/+0
| | | | | | | | | | | | Along with the Ant and Maven build configs, downloads of - DocBook DTD, - DocBook XSL, - FOP, - Batik, - Saxon also become obsolete. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Add runtime and weaver API javadocs to installer againAlexander Kriegisch2024-01-061-3/+9
| | | | | | Closes #271. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Minor changes in IDE.mdAlexander Kriegisch2024-01-061-14/+16
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Rename doc generation profiles, making Asciidoctor the defaultAlexander Kriegisch2024-01-061-4/+4
| | | | | | | The Docbook etc. Ant task profile is now called 'create-docs-LEGACY' and will go away with the cut-over to the new doc generator logic. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Asciidoc: Create PDFs from multi-page guidesAlexander Kriegisch2024-01-062-15/+149
| | | | | | | | | | | | | | | | | | Using Asciidoctor Maven, we now produce PDFs (which are also linked to from the main documentation index page) for - Programming Guide, - AspectJ 5 Developer's Notebook, - Development Environment Guide, - Problem Diagnosis Guide, - AspectJ Design Overview. Attention! PDF generation alone takes 3+ minutes, almost 4 minutes including asciidoc to HTML conversion. Just deactivate the 'create-docs' profile if you do not need docs during the build. Closes #272. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Replace docs GIFs by PNGsAlexander Kriegisch2024-01-0616-20/+19
| | | | | | | | | | | | Follow-up on previous rename-only commit. This time, the binaries are real PNGs. The asciidoc and other references to them have also been replaced. File figures_classes.png in the teaching materials also was rotated by 90° to display it correctly. Background: The Asciidoctor PDF back-end cannot handle GIFs directly without an additional Ruby Gem. It is easier to only use PNGs and JPEGs. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Rename docs GIF to PNGAlexander Kriegisch2024-01-0610-0/+0
| | | | | | | | | | The files are still GIFs for now. In the next steps after the rename, they will be replaced by real PNGs. Background: The Asciidoctor PDF back-end cannot handle GIFs directly without an additional Ruby Gem. It is easier to only use PNGs and JPEGs. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Fix some broken/invalid ADOC linksAlexander Kriegisch2024-01-064-6/+6
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Move image used in IDE.md to images subfolderAlexander Kriegisch2024-01-062-1/+1
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Delete some unused images from docsAlexander Kriegisch2024-01-065-0/+0
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Move progguide images to subfolderAlexander Kriegisch2024-01-067-3/+3
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Rename Visio files for images used in compiler-weaver.adocAlexander Kriegisch2024-01-062-0/+0
| | | | | | | to match the GIF file names, so it is easy to recognise which Visio file was used to create which GIF, even if no Visio viewer is available. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Adjust image links in compiler-weaver.adocAlexander Kriegisch2024-01-061-5/+5
| | | | | | After move in previous commit, now the paths have been fixed, too. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Move compiler-weaver.adoc up one directory levelAlexander Kriegisch2024-01-0610-25/+1
| | | | | | | | Also rename ADOC on the way and move images to subdirectory. This makes the Maven Resource execution superfluous. TODO: Adjust image links in compiler-weaver.adoc in next commit. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Move main license and readme files to docs root directoryAlexander Kriegisch2024-01-062-0/+0
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Reformat asciidoc source for main docs pageAlexander Kriegisch2024-01-061-125/+104
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Link to Java version compatibility matrix from main docs pageAlexander Kriegisch2024-01-061-4/+8
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Change syntax in JavaVersionCompatibility.adoc to asciidocAlexander Kriegisch2024-01-061-21/+23
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Rename JavaVersionCompatibility.md to .adocAlexander Kriegisch2024-01-061-0/+0
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Move JavaVersionCompatibility.md to release directoryAlexander Kriegisch2024-01-061-0/+0
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Fix referenced images in README-1.6.7Alexander Kriegisch2024-01-063-1/+3
| | | | | | | | | | | Before, only one image was referenced, consisting of a screenshot of two diagrams. The other image file, containing just one of the diagrams, was not used. Now, both images have been cropped correctly and are both referenced separately from the release notes. Better late than never... Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Move release notes README-*.adoc to separate directoryAlexander Kriegisch2024-01-0665-35/+35
| | | | | | | Also move two more release-related documents. All referenced images are now in a common subdirectory. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Move quick reference DOC/PDF files to separate directoryAlexander Kriegisch2024-01-068-7/+7
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Move docs examples directory two levels upAlexander Kriegisch2024-01-0692-89/+89
| | | | | | Now, the location more closely resembles where it is on the website. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Bulk-rename release read-me files to version numbers with dotsAlexander Kriegisch2024-01-0656-46/+46
| | | | | | | | | Also rename references. E.g. - RELEASE-11 -> RELEASE-1.1 - RELEASE-1810 -> RELEASE-1.8.10 - RELEASE-1921 -> RELEASE-1.9.21 Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Delete 50+ XML DocBook resource filesAlexander Kriegisch2024-01-0654-74896/+0
| | | | | | in favour of the already existing asciidoc ones. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Fix/add more links for multi-page docsAlexander Kriegisch2024-01-061-5/+9
| | | | | | In each case, link both to multi- and single-page docs separately. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Adjust design overview docs to other multi-page docsAlexander Kriegisch2024-01-062-3/+35
| | | | | | | - Link to other pages in index.adoc - Include other pages in design-overview.adoc Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Remove references and docs about obsolete toolsAlexander Kriegisch2024-01-0624-2265/+21
| | | | | | | | | | | | | - AspectJ Browser (ajbrowser) - Forte IDE integration - JBuilder IDE integration - Emacs integration All this information was old and outdated. Ajbrowser was removed from AspectJ a while ago. If the other tools even still exist, any possibly existing AspectJ support is not part of AspectJ itself. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Remove 'imagesdir' from Asciidoctor Maven configAlexander Kriegisch2024-01-061-0/+24
| | | | | | | | | | | | User relative paths for images instead. In one case, we need to copy images from a subdirectory one level up, because otherwise the images are only found in the included document, but not in the single-page one including it from the subdirectory. In all other cases, included ADOCs are located in the same directory as the including document. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Fix most xref/link URLs in main documentation indexAlexander Kriegisch2024-01-062-78/+79
| | | | | | | | | | To do: - API docs (javadoc) - all-in-one guides - Eclipse website links - add links to markdown files (maybe convert md to adoc) Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Move main documentation index for website to root directoryAlexander Kriegisch2024-01-061-0/+0
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Add asciidoc release notes up to 1.9.21Alexander Kriegisch2024-01-0610-478/+288
| | | | | | and fix some minor punctuation issues in older release notes. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Add README-198.adoc, README-199.adocAlexander Kriegisch2024-01-065-310/+182
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Rename '*GuideDB' directories to their actual HTML site target namesAlexander Kriegisch2024-01-06122-268/+392
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Experimentally add asciidoctor-maven-plugin to 'docs' moduleAlexander Kriegisch2024-01-061-0/+33
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Remove all references to AOSD, but mention SpringAlexander Kriegisch2024-01-064-54/+27
| | | | | | | | | | | | | | | | | | | - The website is just a front page. - I failed to contact anyone via: * fb9553b7471df638478bbf918044bf52.gdrp@customers.whoisprivacycorp.com * info@aosd.net * admin@aosd.net - The discuss@aosd.net mailing list had its last post 6 years ago and the last one concerning AspectJ 11 years ago according to the archive at https://discuss.aosd.narkive.com/. Mention Spring support for native AspectJ an Spring AOP as a real world example in the FAQ. Also remove an FAQ link to a no longer existing PARC website about AspectJ and fix a small typo. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* AsciiDoc: updates in main index and FAQ (WIP)Alexander Kriegisch2024-01-064-101/+30
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Globally replace HTTP links to eclipse.org by HTTPSAlexander Kriegisch2024-01-0633-218/+215
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Remove outdated JDeveloper links from AsciiDocsAlexander Kriegisch2024-01-062-8/+1
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* More AsciiDoc formatting improvements (WIP)Alexander Kriegisch2024-01-0619-1318/+1291
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Improve release notes formattingAlexander Kriegisch2024-01-0648-566/+474
| | | | | | Also unify the way copyright and release date is displayed Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
* Finish AsciiDoc improvements in ADK Developer's Notebook (WIP)Alexander Kriegisch2024-01-0614-367/+299
| | | | Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-23 15:02:09 +0000