Generating Documentation

Taylor leverages many great features of Maven to produce documentation for your application. Maven Site Gen Tutorial is a good place to get started.

Here are some examples

• Html Format
• PDF Format

Here is where taylor generates documentation in your doc project:

   src
      site
         apt
            ...
         changes 
            (boiler plate to get you started)
            ...
         fml
            (boiler plates to get you started)
            ...
         resources
            (place images here)
            ...

Contents 1 Almost Plain Text (APT) 2 Rendering Diagrams 3 Generating Documentation 4 Other

Almost Plain Text (APT)

Taylor support using APT (Almost Plain Text) for formating documentation of UML elements and rendering it into your maven site when you run 'mvn site'.

All of the documentation you enter into the Document Tabs of your model is generated into the apt directory using the Maven Almost Plain Text (APT) notation. If you are familiar with wiki notation then this will be a breeze.

• APT Reference

• Use Case Documentation Template - use this to get started with a use case

Rendering Diagrams

In the various apt files you will find instruction like this:

~~right-click on your diagram and select File/Save As Image File...
~~save the file to your src/site/resources directory
~~use the name specified below or change this file 
[tutorial-net.taylor.tutorial.entity.jpg] Entity Diagram

Generating Documentation

To generate the documentation run the following maven command

   mvn site

Other

• Documentation from your entities is also used to create Help pages in your CRUD portlets that are accessed via the portlet Help Mode.
• Documentation is also rendered in to the JavaDoc
• Documentation on packages is used to generate project.html javadoc files.