vb6hobbyst7 / specif-viewer

A viewer and editor for SpecIF files.

SpecIF Viewer and Editor

An app for your web-browser to view, edit* and transform system specifications. (Features of the SpecIF Editor are marked with an asterisk*).

SpecIF is the 'Specification Integration Facility'. It's purpose is to combine partial specifications from different tools in a single model to allow

• to search, navigate and audit partial results in a common context
• to exchange model information between organizations and tools.

Please have a look at the SpecIF Homepage for further information.

Features

• Import 'specif' and 'specif.zip' file with schema and consistency check
• Import 'reqif' an 'reqifz' file (experimental)
• Import MS-Excel 'XLSX', 'XLS' and 'CSV' file
• Import 'BPMN-XML' file
• Import Archimate Open-Exchange (experimental)
• Import from an URL or the local file system
• Browse the content ('resources') along the supplied hierarchy
• Display model-element details when hovering over a representation on a diagram (in case of SVG images with annotated model-element identifier)
• Create, clone and update resources with an input form derived from the respective resource class*
• Move single nodes and subtrees in the hierarchy by drag'n'drop*
• Inspect the semantic net ('statements')
• Create statements according to the options defined in the statement classes*
• Delete selected resources and statements*
• Filter using text fragments ('full text search'), resource classes or enumerated property values
• Report some model-based statistics, such as used resource classes or used property enumerated values
• Export 'html' file with embedded SpecIF data
• Export 'specif.zip' file
• Export 'reqifz' file (Requirements Interchange Format)
• Export 'Turtle' file (experimental)
• Export 'ePub' file
• Export MS-Word OOXML file

Compatibility

• Mozilla Firefox
• Google Chromium and Chrome
• Microsoft Edge
• Apple Safari (beware of performance issues in case of bigger models)
• Opera
• Microsoft Internet Explorer is not any more supported

Maturity

The software code is a reference implementation and has not been designed for high data volume and other production requirements. Any contribution to this collaborative effort is highly welcome!

Demonstration

The app has been installed for demonstration

• View the dimmer example in SpecIF format,
• View a BPMN example in BPMN 2.0 XML format,
• View a XLSX example in XSLX format,
• View the SpecIF Vocabulary in SpecIF format,
• Start the viewer to load and view your own files.
• Start the editor to load and edit your own files.

The installation provided for your convenience is neither intended to be highly available nor scalable. You may use the latest release of the software for your own installation, see below.

Compatibility

• Mozilla Firefox
• Google Chromium and Chrome
• Microsoft Edge
• Opera
• Apple Safari (beware of performance issues in case of bigger models)
• Microsoft Internet Explorer is not any more supported

Installation

For any purpose other than demonstration please install the latest release on a web server of your choice. Just unpack the files and load 'yourPath/view' or 'yourPath/edit' with a web-browser.

Running the App Locally

First, make sure you have NodeJS and NPM installed.

Then, install all dependencies:

  npm install

After installing all dependencies, run the build script:

  npm run start

On Windows

After creating the build directory with the executables, you may start the local web-server:

  http-server

• Then, navigate to localhost -> build -> view.html to open the SpecIF Viewer
• Temporarily deactivate Cross-Origin Restrictions and Local File Restrictions in your browser, if you encounter a blank screen. Make sure to re-activate these settings, later.

Acknowledgements

This work has been sponsored by enso-managers gmbh and adesso SE, both Berlin.