| Import Definitions | ||
|---|---|---|
| File | Description | Comment |
| common.xml | Common functionality. | Import our common functionality. |
| development-macros.xml | Development functionality. | Import our common functionality. |
| documentation-properties.xml | Documentation properties. | Import our common functionality. |
| documentation-scripts.xml | Documentation scripts. | Import our common functionality. |
| environment-macros.xml | Environment functionality. | Import our common functionality. |
| utility-macros.xml | Utility functionality. | Import our common functionality. |
| Macro Definitions | ||
|---|---|---|
| Name | Description | URI |
| ant2html | Converts Ant scripts to HTML | http://jplate.sourceforge.net/documentation |
| ant2htmlWithNavLinks | Converts Ant scripts to HTML | http://jplate.sourceforge.net/documentation |
| antDoc | Converts Ant scripts to HTML | http://jplate.sourceforge.net/documentation |
| svn2html | Converts Subversion output to HTML | http://jplate.sourceforge.net/documentation |
| svn2htmlWithNavLinks | Converts Subversion output to HTML | http://jplate.sourceforge.net/documentation |
| Target Definitions | |||
|---|---|---|---|
| Name | Depends | Unless | Description |
| print-document-environment | Not Defined | Not Defined | Dump documentation environment to console |
| Attribute Definitions | ||
|---|---|---|
| Name | Description | Default |
| basedir | The directory in which to start searching for Ant scripts. | Not Defined |
| destdir | The directory in which the transformation will occur. | Not Defined |
| includes | The file pattern to include when transforming. | Not Defined |
| version | The version number/value to include in the heading. | Not Defined |
| description | Information about this macro call. | Not Defined |
@{basedir} = the directory in which to start searching for Ant scripts.
@{destdir} = the directory in which the transformation will occur.
@{includes} = the file pattern to include when transforming.
@{version} = the version number/value to include in the heading.
@{description} = information about calling this macro.
| Attribute Definitions | ||
|---|---|---|
| Name | Description | Default |
| basedir | The directory in which to start searching for Ant scripts. | Not Defined |
| destdir | The directory in which the transformation will occur. | Not Defined |
| includes | The file pattern to include when transforming. | Not Defined |
| displayNavLinks | Flag if true states navigation links be enabled. | true |
| prevLink | Link to previous document. | Not Defined |
| upLink | Link to go up a level. | Not Defined |
| nextLink | Link to next document. | Not Defined |
| version | The version number/value to include in the heading. | Not Defined |
| description | Information about this macro call. | Not Defined |
@{basedir} = the directory in which to start searching for Ant scripts.
@{destdir} = the directory in which the transformation will occur.
@{includes} = the file pattern to include when transforming.
@{displayNavLinks} = A flag, if true will force navigation links at the bottom of
the resultant generated HTML file.
@{prevLink} = URL that points to the previous link.
@{upLink} = URL that points to a higher level link.
@{nextLink} = URL that points to the next link.
@{version} = the version number/value to include in the heading.
@{description} = information about calling this macro.
| Attribute Definitions | ||
|---|---|---|
| Name | Description | Default |
| dir | The directory to start recursively applying AntDoc. | Not Defined |
| description | Information about this macro call. | Not Defined |
@{dir} = the directory to start recursively applying AntDoc.
@{description} = information about calling this macro.
| Attribute Definitions | ||
|---|---|---|
| Name | Description | Default |
| srcdir | The base directory in which to gather Subversion log information. | Not Defined |
| destdir | The directory in which the transformation will occur. | Not Defined |
| log-file | The file that will contain the outputted XML. | svn-log.xml |
| html-file | The file that will contain HTML conversion from @{log-file} | svn-log.html |
| rev-start | The Subversion starting revision number. | 0 |
| rev-end | The Subversion ending revision number. | HEAD |
| version | The version number/value to include in the heading. | Not Defined |
| description | Information about this macro call. | Not Defined |
@{srcdir} = The base directory in which to gather Subversion log information.
@{destdir} = The directory in which the transformation will occur.
@{log-file} = The file that will contain the outputted XML.
@{html-file} = The file that will contain HTML conversion from @{log-file}.
@{rev-start} = The Subversion starting revision number.
@{rev-end} = The Subversion ending revision number.
@{rev-end} = The version number/value to include in the heading.
@{version} = the version number/value to include in the heading.
@{description} = information about calling this macro.
| Attribute Definitions | ||
|---|---|---|
| Name | Description | Default |
| srcdir | The base directory in which to gather Subversion log information. | Not Defined |
| destdir | The directory in which the transformation will occur. | Not Defined |
| displayNavLinks | Flag if true states navigation links be enabled. | true |
| prevLink | Previous link. | Not Defined |
| upLink | Link to go up a level. | Not Defined |
| nextLink | Link to go up a level. | Not Defined |
| log-file | The file that will contain the outputted XML. | svn-log.xml |
| html-file | The file that will contain HTML conversion from @{log-file} | svn-log.html |
| rev-start | The Subversion starting revision number. | 0 |
| rev-end | The Subversion ending revision number. | HEAD |
| version | The version number/value to include in the heading. | Not Defined |
| description | Information about this macro call. | Not Defined |
@{srcdir} = The base directory in which to gather Subversion log information.
@{destdir} = The directory in which the transformation will occur.
@{displayNavLinks} = A flag, if true will force navigation links at the bottom of
the resultant generated HTML file.
@{prevLink} = URL that points to the previous link.
@{upLink} = URL that points to a higher level link.
@{nextLink} = URL that points to the next link.
@{log-file} = The file that will contain the outputted XML.
@{html-file} = The file that will contain HTML conversion from @{log-file}.
@{rev-start} = The Subversion starting revision number.
@{rev-end} = The Subversion ending revision number.
@{rev-end} = The version number/value to include in the heading.
@{version} = the version number/value to include in the heading.
@{description} = information about calling this macro.
| Prev | Up | Next |