The Developer's Documentation for VICI
On this page: Development Documents, Design Documents, Design Diagrams, VICI API
This section provides links to the development documentation. In an ideal world this page and the linked files would be on the SourceForge site, but they do not provide a way to have browsable access to PDF and SVG files, so they are hosted here, but mostly so they can be referenced from the SourceForge wiki.
For a more detailed description of the development process please refer to the Wiki on SourceForge.
Development Documents
- Vision - The initial idea that started the project.
- Preliminary Analysis - The initial investigation into the ideas in the vision statement.
- Requirements - A list of all the things that we want from VICI.
- Requirements Analysis - Initial set of Use Case models.
- Documentation Plan - The documents we intend to provide.
- Increment Plan - The planned phases of development.
- Architecture - The high level design of VICI.
- Programmer's Guide - Coding standards, Eclipse configuration and a guide to the common infrastructure library
- Test Plan - The plan for testing VICI.
- Testing - A presentation on the way VICI is tested.
- Writing Tests - Instructions for programming the tests.
Design Documents
- Interfaces - The interfaces between the component modules of the system.
- Persistent Storage - The schema for the persistent storage used by VICI.
- Use Cases - A detailed description of how VICI will be used.
- EBNF Library - The design for the EBNF parser.
- Syntax Library - The design of the syntax chart display library.
- VICI Admin Program - The design of the program for administering VICI.
- Search Library - The design of the library for finding and organising programs.
- Command Library - The design of the library for entering commands and options.
- Symbol Library - The design of the library responsible for displaying the symbols.
- Canvas Library - The design of the library responsible for drawing the charts.
- Cron Library and Program - The design of the library responsible for scheduling the scripts.
- Interpreter Library - The design of script interpreter.
Design Diagrams
It is often difficult to see all the detail in diagrams that have been included into a PDF document. Some of the more interesting diagrams are reproduced here so that you can zoom into the detail. In addition some of the collaboration diagrams have been animated to so you can see the flow of events more easily.
| Module Diagrams | |||||
|---|---|---|---|---|---|
| logical-admin | logical-editor | logical-run | |||
| Class Diagrams | |||||
| vici-adm | libcanvas | libcommand | libebnf | libifstubs | |
| libsearch | libsymbol | libsyntax | testing | ||
| Interpreter Class Diagrams | |||||
| control | static | command | events | threads | |
| Collaboration Diagrams | |||||
| ebnf parse | ebnf validate | ||||
VICI API
The API is not intended for other applications, but rather it is the specification of the internal interfaces within VICI, between the various modules.
The API is available as a PDF or as a set of web pages. They are also available on the SourceForge site where the web pages are zipped into a single file.
