stardoc Manual
This document should contain all you need to know on how to use stardoc.
Introduction
stardoc's main target is turning Use-Cases documented in the STAR-format into other formats. STAR stands for Simple Text Annotation Restructured and is a very simple format developed by Clear View Training. If you are not familiar with this format you should visit this page.
Convertion process
The convertion process is illustrated below.
Figure 1: Convertion illustration
Usage
Let's say that we write our use-case files in model/usecases/*.uc and actors in model/actors/*.act in your directory for documentation of your project (i.e. doc). We want to generate HTML documentation (--format html) to a specific directory (i.e. html with --target html). Then you would use stardoc like this:
stardoc --title "UseCaseSpecification"
--directory "model/usecases,model/actors"
--stylesheet /usr/local/lib/php/data/stardoc/xsl/UseCaseToXHTML.xsl
--format html
--target html
--verbose
This should produce a set of HTML-files inside a directory named html. Open html/index.html in your favorite browser and you'll see the output.
Options
A set of options need to be set through the command line. Each and everyone is documented here:
-h --help - Brings up the help menu-i --title - Project title-f --filename - List of files to be included (seperated by ',')-d --directory - List of directories to be included (seperated by ',')-x --xmldir - Directory to put temporary XML-files for future processing (optional, default: /tmp)-s --stylesheet - XSL stylesheet to transform XML-files to HTML-o --format - Output format (only html supported)-t --target - Target output directory-v --verbose - See what's going on
References
Some references to documentation used in development of stardoc.
|
