TIP Doc Generator

JOSIF Main Page | JOSIF Framework | TIP Doc Generator

Introduction

TIP Doc Generator reads a TIP model project to generate a document which describes the details of the model.

Subversion Location

sourcecode: https://openoss.svn.sourceforge.net/svnroot/openoss/tip/framework/TIP_Doc_Generator/trunk/TIP_Doc_Generator/

package: https://openoss.svn.sourceforge.net/svnroot/openoss/tip/framework/TIP_Doc_Generator/trunk/TIP_Doc_Generator_Package/

Variables

The generator needs some values of variables to be provided by model projects. Here we give description and default value of these variables.

serviceName

description: the name of service provided by a TIP spec. e.g. 'Service Problem Management' in TIP SPM Model. The name will appear in cover page of generated PDF file.

default value: A TIP Service

fileName

description: The short name of generated PDF file, e,g, 'TMF_SPM_IA'.

default value: Doc_For_A_TIP_Service

Following picture shows a sample configuration.

Concepts

Please refer to TIP Doc Generator DocStructure for the structure of generated TIP model documents.

Display Rules

Please refer to Display Rules for display rules supported.

User Guide

Please refer to  TIP Doc Generator UserGuidefor usage of the generator.