Document work product

 

Overview

In order to parameterize the documentation generator, it is useful to retrieve the values defined for the document work product that runs the generation.

 

This document work product can be retrieved using the "getStartUpObject()" J method.

Object : getStartUpObject() return Object

 

 

Attributes

 

The ... attribute

type ...

corresponds in the document work product to...

Author

String

the author

Date

String

the date

Formator

enumerated: Ascii, Groff, HTML, Winword

the targeted format

messageFile

String

the message file

Name

String

the name of the work product

Path

String

the generation directory

Title

String

the title

Reference

String

the reference

SubTitle

String

the subtitle

suffix

String

the generation suffix  ("txt" for Ascii, "ps" for Postscript, "html" for HTML, "rtf" for Winword)

Version

String

the version

 

 

Example

file = getStartUpObject().messageFile;