A User's and Contributor's Guide to YaTiSeWoBe 0.1.2

Javier Iglesias

INFORGE
Information Systems Department


                        College Propedeutique 1
                        CH-1015 Lausanne
                        Switzerland
                        
                        Professional: ++41 21 692 35 87
                        Professional: ++41 21 692 35 85
                    

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

Warning and Disclaimer. Every effort has been made to make this documentation as complete and accurate as possible, but INFORGE-NHRG make no warranties, either express or implied, regarding the content or its fitness for any particular purpose. The information is provided on an as-is basis. The author and INFORGE-NHRG shall have neither liability nor responsibility to any person or entity with respect to any loss or damages arising from the information contained in this documentation.

This documentation contains links to third-party Web sites that are not under the control of INFORGE-NHRG , and INFORGE-NHRG and the author are not responsible for the content of any linked site. If you access a third-party website mentioned in this documentation, then you do so at your own risk. INFORGE-NHRG provides these links only as a convenience, and the inclusion of the link does not imply that INFORGE-NHRG or the author endorses or accepts any responsibility for the content of those third-party sites.

Trademarks. All terms mentioned in this documentation that are known to be trademarks or service marks have been appropriately capitalized. Use of a term in this book should not be regarded as affecting the validity of any trademark or service mark.

Revision History
Revision 1.82004-05-28ji
DobBook-aware license formating.
Revision 1.62004-05-06ji
Added "development tracking" section. Changed title. Checked dependencies list and versions. Checked glossary. Reordered entries in bibliography. Use sans-serif font family for PDF.
Revision 1.12004-04-11ji
Automated generation for HTML, JavaHelp, and PDF formats. Automated olink target collections. Automated syntax checking. Checked conformance to DTD. Cleaned up bibliography. Completed section on installing on Linux. Completed section on QuickStart. First draft internationalization section. First ispell/aspell. Fixed citations.
Revision 1.02004-03-10ji
First release of the software and documentation at version 0.1-beta.

Table of Contents

1. Introduction
1.1. History
1.1.1. About the past
1.1.2. About the present
1.1.3. About the future
1.2. Contact
1.3. About this document
2. A Quick-Start session
3. Concepts
3.1. Time series
3.2. Data handling
3.2.1. Resolving URIs/URLs with XML catalogs
3.2.2. Data filter
3.2.3. Data set
3.2.4. Data bundle
3.2.5. Data collection
3.3. Plug-ins
3.3.1. Types
3.3.2. Levels
3.3.3. Security
4. Normal operations
4.1. Requirements
4.2. Installation
4.2.1. Using Java WebStart
4.2.2. Mac-OS X users
4.2.3. GNU/Linux users
4.2.4. Microsoft Windows users
4.2.5. Advanced Java users
4.2.6. Setup
5. Advanced topics
5.1. Documents
5.1.1. Native documents
5.1.2. Template documents
5.2. Managing distributed installations
5.2.1. Plug-in manager
5.2.2. Adding plug-ins
5.3. Jython console
5.3.1. Console shortcuts
5.3.2. Console environment
5.3.3. Executing scripts
5.3.4. Recording scripts
6. Contributors
6.1. Compiling YaTiSeWoBe from sources
6.1.1. Compiling executable from sources
6.1.2. Compiling documentation from sources
6.1.3. Miscellaneous tricks
6.2. Internationalization (I18N)
6.2.1. Standard translation files
6.2.2. Main translation file
6.3. Shared properties
6.4. Plug-in life cycle
6.4.1. "Create" state
6.4.2. "Init" state
6.4.3. "Start" state
6.4.4. "Stop" state
6.4.5. "Destroy" state
6.5. Meta-information
6.6. Contextual menus
6.7. Alternative implementations
6.7.1. Data store
6.7.2. Graph manager
6.7.3. Graph
6.8. Development tracking
6.8.1. Release history
6.8.2. Foreseeable releases
6.8.3. Directions
6.8.4. Wish-list
A. FAQ
B. Dependencies
B.1. Runtime libraries
B.2. Development tools
C. Man Pages
D. Data format
D.1. Data Structure of Spike Data Files in a Standard Format
D.1.1. Data Structure
D.1.2. Separators
D.1.3. Comments
D.1.4. Keywords
D.1.5. Codes
D.1.6. Checksum
D.1.7. Version and Titles
D.1.8. Analog Data
D.1.9. Synopsis
E. Licenses
E.1. GNU General Public License
E.1.1. Preamble
E.1.2. GNU General Public License terms and conditions for copying, distribution and modification
E.1.3. Addendum: How to Apply These Terms to Your New Programs
E.2. GNU Free Documentation License
E.2.1. Preamble
E.2.2. Applicability and definitions
E.2.3. Verbatim copying
E.2.4. Copying in quantity
E.2.5. Modifications
E.2.6. Combining documents
E.2.7. Collections of documents
E.2.8. Aggregation with independent works
E.2.9. Translation
E.2.10. Termination
E.2.11. Future revisions of this license
E.2.12. Addendum: How to use this License for your documents
References
Glossary
Index

List of Figures

3.1. Data handling overview
3.2. Data collections usage overview
3.3. Plug-in overview
6.1. Plug-in life cycle
6.2. Window plug-in life cycle (partial)

List of Examples

3.1. Data filter
3.2. Data set
3.3. Consecutive data bundle
3.4. Simultaneous data bundle
3.5. Complex data bundle
3.6. Simple data collections
3.7. Organized data collections
3.8. Dynamic data collections
5.1. Structure of a native file
5.2. Document content section example
5.3. Native document: settings section
5.4. Native document: catalog section
5.5. Native document: style-sheet section