Si2oaD/User Guide
From oacwiki
Si2oaD simplifies debugging of OpenAccess applications or data by automating display and traversal of
The Si2oaD project distribution page has more information, like
While the "raw" XML console output stream includes traversal of the entire model (depending on limits set by Options, including regular expression filtering), the active-HTML GUI mode enables dynamic relationship traversal, incremental data loading, Collection sorting, and on-demand binding across by-name associations. |
|
The Si2oaD project distribution page has more information, like
- a webinar of individually playable, Flash, mini-presentations covering Si2oaD features
- downloads of Si2oaD code releases (source, documentation, etc.)
- samples of Si2oaD "raw output" XML and with its XSL transformed HTML
While the "raw" XML console output stream includes traversal of the entire model (depending on limits set by Options, including regular expression filtering), the active-HTML GUI mode enables dynamic relationship traversal, incremental data loading, Collection sorting, and on-demand binding across by-name associations.
Contents |
1 Preface
| Published by: | Silicon Integration Initiative, Inc. (Si2™)
(512) 342-2244 |
Copyright © 2006–2011 by Si2, Inc.
All rights reserved. No part of the material contained herein may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of Si2, Inc.
ISBN: 1-882750-16-0
The authors, editors and publisher make no warranties of any kind, express or implied, and specifically disclaim, without limitation, any implied warranties of merchantability and fitness for a particular purpose, with regard to any material contained herein. In no event shall the authors, editors or publisher be responsible or liable for any loss of profit or any other commercial damages, including but not limited to special, incidental, consequential or any other damages in connection with or arising out of any use of this material.
Where manufacturer or vendor designations claimed as trademarks are used herein, and Si2 was aware of the trademark claim, such designations have been printed in initial caps or all caps.
1.1 Conventions
The following conventions are used throughout this document to help organize the presentation and communicate special semantics associated with portions of the text:
1.1.1 Typography
| Format | Meaning |
|---|---|
| Courier font | Actual program, function, or variable names, or other text designed to be entered literally, as-is, to a program input stream; or which is directed as-is to the output stream |
| Italic font | Text that is a placeholder for a specific substution that must be made to a program input stream |
| Courier, in a box | Console output, input examples, syntax prototypes (typically referenced by the preceding "normal style" paragraph) |
| [OPTIONAL-CONTENT] | Optional items in a syntax prototype are enclosed in square brackets |
1.1.2 Abbreviations
| Abbreviation | Meaning |
|---|---|
| OA | OpenAccess |
| Class name sans oa prefix | an instantiation of the corresponding OA class. Examples: Design, Object, ScalarNet, Term, BitTerm, DMAttr. |
| OAD, oaD | Si2oaD |
| oad() | the main entry point in the Si2oaD application interface |
| oaDebug | the name of the Working Group responsible for OAD (sometimes also used as the name of the Si2oaD tool itself) |
| RTM | Run-Time Model – A structured representation of the complete set of OA Objects, attributes, and relationships, associated with an application process at a given point during its execution. |
| Si2 | Silicon Integration Initiative |
| Si2oaDebug | Si2oaD (The early name for the tool was “oaDebug”, named after the Working Group) |
| WG | Working Group |
1.1.3 Wiki Markup
1.1.3.1 Subpages
The subpage feature of MediaWiki is not being used. Instead, all subpages of Si2oaD information are prefixed with "Si2oaD/". These can then be referenced as links using:
[ [Si2oaD/Options|options] ]
The part before the | is the name of the linked page, which could be postfixed with a # followed by an anchor reference to some point within that page. For example:
[ [Si2oaD/Options#Figure 1|options] ]
1.1.3.2 Figures, Tables
Use a bold line wrapped by a < center> tag, followed by the figure < img> tag or table markup:
<center id="Figure 4">' ' 'Figure 4: This is the Figure's Title' ' '</center>
[[img:filename.png]]
<center id="Table 4">' ' 'Table 4: This is the Figure's Title' ' '</center>
...table goes here...
These can then be referenced like the Figures:
[[#Figure 4|..whatever you want to show in the text here (maybe just, "Figure 4")...]]
[[#Table 4|..whatever you want to show in the text here (maybe just, "Table 4")...]]
1.1.3.3 URL Hyperlinks
Hyperlinks to any, arbitrary URL are marked up in the normal Wiki way:
- enclosed in brackets
- with the URL first
- and the text that is to be shown for the link following whitespace after the URL.
For example, the markup
[https://www.si2.org/?page=667 Debug Working Group]
displays (with a little lock icon on the end because it is https) as follows:
Debug Working Group
1.2 Acknowledgements
The members of the [OpenAccess Debug Working Group] (the "Debug WG" or just "WG") have provided guidance, feedback, ideas, and adoption support for the development of this code at Si2 during the course of their mission to investigate techniques to simplify the debugging of problems encountered using
- the OpenAccess Reference Implementation,
- applications linked with it, or
- OA data


