Wat is Axaptadoc ?
Axaptadoc is een tool waarmee je documentatie kan maken in HTML-formaat.
Wie met Java vertrouwd is, kent Javadoc.
Microsoft heeft naar aloude traditie hier een kopie van gemaakt voor de .NET-omgeving onder de naam Ndoc.
En dankzij Lars Schunk is er ook een tool die hetzelfde doet voor Dynamics Ax of Axapta.
Meer informatie over Axdoc vind je op de webstek van Lars Schunk.
Je kan er de tool afladen hetzij voor Dynamics Ax 4.0 hetzij voor Axapta 3.0.
Wat is de output van Axaptadoc
We hebben het al gezegd : wie vertrouwd is met Javadoc of Ndoc, kent de output van deze documentatiegeneratoren. Het gaat om HTML-pagina's waarmee je in de bibliotheken en klassen kan bladeren.
Lars Schunk heeft de output van Axaptadoc op zijn webstek geplaatst. Wie de Axapta 3.0 referentie wil raadplegen, kan terecht op de webpagina Axapta 3.0 Reference
Hieronder zie je een voorbeeld van documentatie over een tabel.
En hieronder zie je een voorbeeld van documentatie over een klasse.
Hoe moet ik Axaptadoc downloaden ?
We zijn natuurlijk vooral geïnteresseerd in de tool zelf zodat we die kunnen toepassen op onze eigen Axaptaomgeving. De tool kan je afladen op de webstek van Lars Schunk http://schunk.dk/docgen.shtml.
Daar vind je een verwijzing naar een zipbestand dat wordt afgeladen zodra je klikt op de woorden “Axapta Doc generator 0.5.2”.
We bewaren het zipbestand in een folder naar keuze.
Hoe installeer ik Axaptadoc ?
In de zipfolder is er een tekstbestand INSTALL.txt. We hernemen de instructies hieronder.
Installation Instructions for Axapta Doc Generator
Follow these instructions in order to install Axapta Doc Generator.
Note: If you want to generate class diagrams, you will need
to install ‘dot’ from the graph visualization suite Graphviz.
Get it from http://www.graphviz.org.
STEP 1: Prepare the base directory
Create a directory in which to put the generated
documentation files, e.g., C:\DocGenerator. Put the
files ‘style.css’ and ‘functions.js’ into this directory.
Optionally, you can put the file ‘kernel functions.html’
in here, too.
STEP 2: Import the xpo files
There are two xpo files:
DocGenerator.xpo
The generation program.
DocGeneratorAddIn.xpo
This integrates Axapta Doc Generator with
the Axapta help system, and adds an item
to the Add-Ins context menu in the AOT.
This is optional, though highly recommended.
However, you can always view the generated
documentation using Internet Explorer.
Read the following warning before carrying out this step:
To install the xpo files, open the Projects window and import
the files (do not import with labels or IDs). Open each of
the two projects and compile them.
WARNING: When importing DocGeneratorAddIn.xpo, you should know
that this project includes modifications to the following
standard Axapta objects:
class SysContextMenu
Code has been added to the method verifyItem. This
is cleary marked with ‘Axapta Doc Generator’ comments.
form SysHelp
Window:Window3 and ButtonGroup:DocGenerator have been
added to Group:NavigationBar in Group:TopGrp.
You should do a compare on these objects and maybe merge in the
modifications manually.
STEP 3: Add Axapta Doc Generator to the Add-Ins context menu.
If you imported DocGeneratorAddIn.xpo, you should locate the
menu SysContextMenu in the AOT, add a menu item, and have it
point at the action menu item DocGeneratorAddIn.
STEP 4: Tell Axapta Doc Generator about locations
Now you need to open the DocGenerator macro from the DocGenerator
project. The ‘dotExec’ constant must point to the ‘dot.exe’ file that
was installed by Graphviz. This is used for generating diagrams.
The ‘baseDir’ constant must point to the base directory you created
in step 1. This is used by the DocGeneratorAddIn to locate the
generated documentation files. You need to recompile both projects
after changing the constants.
STEP 5: Restart Axapta
We do this to make sure the SysHelp form is updated with the new
button group.
That's it! Axapta Doc Generator should be ready to go. For your
convenience, you could add the two menu items DocGenerator and
DiagramGenerator from the DocGenerator project to some menu so
that you can access them from the main menu.
For help on using Axapta Doc Generator, see the file README.txt.
