INSIDE & OUT - graphical DTD editor From: ftp://ftp.igd.fhg.de/pub/iout/readme.txt =========================================================================== Welcome to the graphical DTD editor +=========================+ -->| I N S I D E & O U T |--> +=========================+ Version 0.9, 28 July 1995 Copyright: 1995 Computer Graphics Center (ZGDV), Darmstadt, Germany Hans Holger Rath, Ulrich von Engelberg Email: iout@igd.fhg.de --------------------------------------------------------------------------- Contents: 0. Warranty 1. Installation 2. Comprehensive Users Guide 3. Known Bugs and Limitations 4. Our "to do" list 5. How to Report Bugs, Comments, etc. --------------------------------------------------------------------------- 0. WARRANTY Permission to use, copy and distribute this software, parts of this software, and its documentation is hereby granted without fee, provided that the above copyright notice appears in all copies and that both that copyright notice and this permission notice appear in supporting documentation. It is provided "as is" without expressed or implied warranty. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. The authors disclaim all warranties with regard to this software, in no event shall the authors be liable for any special, indirect or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortuous action, arising out of or in connection with the use or performance of this software. --------------------------------------------------------------------------- 1. INSTALLATION 1.1. Minimal System Requirements 386'PC with MS-Windows 3.1, 4 MB RAM 1.2 Installation - Get iout.exe and iout.hlp from ftp://ftp.igd.fhg.de/pub/iout in binary mode. - Place these two files in a directory of your PC (e.g.: c:\ioutv09\) - Add the program iout.exe to the application group of your program manager. That's it! --------------------------------------------------------------------------- 2. COMPREHENSIVE USERS GUIDE Inside&Out (I&O) is a graphical editor to build SGML DTDs interactively. The graphical presentation of the DTD is a syntax (or railroad) diagram. Every element and parameter entity definition is shown in a single diagram. All definitions are alphabetically sorted (first all entity, second all element definitions). The basic (or root) element is marked with an anchor icon. You can select a definition by clicking on the element/entity name which stands on the left border. You can select a token from the content model by clicking on the appropriate object. 2.1 The Menu Bar Commands File ---- - New Creates new DTD document. - Open ... Opens existing DTD document which must be in I&Os binary format (*.iod) from disk. - Close Closes DTD document. - Save Saves DTD document in I&O binary format under given filename on disk. - Save As ... Asks for a new filename and saves DTD document in I&O binary format under this name. - Generate DTD ... Validates the DTD, asks for a filename for the DTD in SGML syntax, and writes the DTD. - Print ... Not implemented yet. - Print Preview Not implemented yet. - Print Setup ... Not implemented yet. - Exit Exits I&O. Edit ---- - Undo Not implemented yet. - Redo Not implemented yet. - Cut Not implemented yet. - Copy Not implemented yet. - Paste Not implemented yet. - Delete Deletes selected object(s). DTD --- - Create Referenced Objects Creates definitions for undefined elements/entities with #PCDATA as default content model. - New Element Creates new element definition with ELEMENTn as name and #PCDATA as default content model. - New Entity Creates new entity definition with ENTn as name and #PCDATA as default content model. - Clear All Deletes ALL definitions from DTD document (BE CAREFUL!). - Attributes ... Opens the attribute editing dialog. - Publicly Declared Entities ... Not implemented yet. - Validate ... Validates the DTD. - Normalize ... Normalizes (simplifies) the DTD. - Generate Entities ... Scans through DTD, looks for (in SGML sense) matching terms, and lists these terms in a dialog window. Here you can select one term and give it a name for a parameter entity. I&O will generate an entity with the given name and the selected term as content and it will replace all occurrences of the term in the DTD to the entity. Object ------ - Reference Content ... Displays element-entity-terminal dialog when an element/entity/ #PCDATA/RCDATA/CDATA/EMPTY/ANY in a content model is selected. - Definition ... Displays the element-entity definition dialog when a definition of an element/entity is selected. - Exceptions ... Displays the exceptions dialog when an element is selected. You edit the exclusions and inclusions of an element definition in this dialog. - Occurrence Indicator Changes the occurrence indicator of the selected content token to ... -- Required -- Optional -- Required And Repeated -- Optional And Repeated - Create New Group Adds a new #PCDATA token to the selected content token as ... -- Sequence (,) -- Choice (|) -- Collection (&) - Change Group Type Changes the group type of the selected group to ... -- Sequence (,) -- Choice (|) -- Collection (&) - Insert New Object Before Adds a new #PCDATA token before the selected content token with the same group type as the selected token. - Insert New Object After Adds a new #PCDATA token after the selected content token with the same group type as the selected token. - Move Up/Left Moves the selected content token before the upper/previous token. - Move Down/Right Moves the selected content token behind the lower/next token. - Raise Group Replaces all tokens of the selected group as tokens of the surrounding group (e.g., (a, (B? | C), d) with selection (B? | C) becomes (a, B?, C, d).) - Expand Collection Expands the selected collection (group with & operator) to a combination of sequence (,) and choice (|) operators. NOTE: Only a collection with up to 3 tokens will be expanded. WARNING: An un-ambiguous content model with & operator could become ambiguous after the expansion. - Hide Group Not implemented yet. - Show Group Not implemented yet. View ---- - Toolbar Toggles display of toolbar. - Status Bar Toggles display of status bar. - Sort Order Not implemented yet. -- Alphabetic Ascending -- Preorder Breadth Search -- Preorder Depth Search - Font Not implemented yet. Window ------ - New Syntax Diagram Window Opens another view for the same DTD document. The views are synchronized. - New Tree Window Not implemented yet. - Cascade Rearranges document windows. - Tile Rearranges document windows. - Arrange Icons Arranges document icons on the I&O main window. Help ---- - Contents No help available. - About Inside&Out Displays information about I&O. 2.2 The Toolbar Commands The toolbar icons represents shortcuts for some menu entries. They are listed in the order from the left to the right. File: New File: Open ... File: Save / Save As ... Edit: Cut Edit: Copy Edit: Paste Edit: Undo Edit: Redo Object: Occurrence Indicator: Required Object: Occurrence Indicator: Optional Object: Occurrence Indicator: Required And Repeated Object: Occurrence Indicator: Optional And Repeated Object: Create New Group: Sequence (,) Object: Create New Group: Choice (|) Object: Create New Group: Collection (&) Object: Change Group Type: Sequence (,) Object: Change Group Type: Choice (|) Object: Change Group Type: Collection (&) Object: Insert New Object Before Object: Insert New Object After Object: Move Up/Left Object: Move Down/Right Object: Raise Group 2.3 Various Dialog Windows The documentation will be added later. Try a little bit around. --------------------------------------------------------------------------- 3. KNOWN BUGS AND LIMITATIONS - Printing is not possible yet. - Double-click of an element/entity in a content model should jump to the definition of the element/entity. But, this does not work. Sorry. - Attribute dialog does not show all attribute settings correctly, when it is opened second or third time. The internal data structure is okay, when you generate the DTD. - The validation algorithm is a little bit restrictive, i.e., it gives you more errors than it should (e.g., (a & b?)+ will generate an error). - System may crash if you try to write on a write-protected diskette. - A lot of menu entries are never active. --------------------------------------------------------------------------- 4. OUR "TO DO" LIST - Bug fixes - Read-only tree view in ATA-100 style - Activate shaded menu entries - SGML like keyboard shortcuts - Integrate an SGML parser to import DTDs (not in the PD version) --------------------------------------------------------------------------- 5. HOW TO REPORT BUGS, COMMENTS, ETC. Please, report bugs, comments, etc. by email to iout@igd.fhg.de Thank YOU! ===========================================================================