Requirements Tutorial - Revision history

imported>Jastram: /* Parsers */

2009-02-25T15:44:28Z

Parsers

← Older revision		Revision as of 15:44, 25 February 2009
Line 96:		Line 96:
	The Requirements Plug-In provides an open architecture that makes it easy to implement parsers for various data types. The following parsers are currently available:		The Requirements Plug-In provides an open architecture that makes it easy to implement parsers for various data types. The following parsers are currently available:

	; Plain Text Parser~~: A very simple implementation that is useful for demonstrations.~~		== Plain Text Parser ==

	~~; LaTeX Parser:~~ A ~~parser~~ that ~~can~~ be configured ~~to detect various Latex-Constructs.~~		A very simple implementation that is useful for demonstrations. This Parser cannot be configured in any way, and it expect the following format:

	; OpenOffice Parser: A parser that processes OpenOffice documents.		* Each requirement starts with the label "Requirement:"
			* The label is followed by the Requirement-identifier, consisting of a text part, followed by a hyphen, followed by a number (e.g. FUN-1)
			* The requirements text starts on the next line and may span multiple lines
			* Repeat for every requirement.

			Example:

			Requirement: FUN-17

			Text describing the requirement

			== LaTeX Parser ==

			A parser that can be configured to detect various Latex-Constructs, using regular expressions.

			* This parser must be configured (right-click on the entry of the requirements map and select "Edit parser settings")
			* The individual settings are documented in the interface

			There are a few pitfalls: First, the regular expressions are greedy and don't stop at line breaks. Second, the regular expressions use the Java-Syntax which differs from the grep syntax. It is documented [http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html here].



			== OpenOffice Parser ==
			A parser that processes OpenOffice documents.

	[[Category:User documentation]]		[[Category:User documentation]]
	[[Category:Requirement Plugin]]		[[Category:Requirement Plugin]]
	[[Category:Tutorial\|Requirement Plugin]]		[[Category:Tutorial\|Requirement Plugin]]

imported>Jastram at 11:58, 23 January 2009

2009-01-23T11:58:35Z

← Older revision		Revision as of 11:58, 23 January 2009
Line 31:		Line 31:

	* That's it! Now you can now start using the Plug-In		* That's it! Now you can now start using the Plug-In

	~~= Architecture =~~

	~~[[Image:rodin-requirements.png\|right]]~~

	In order to manage Requirements in Rodin, a Requirements Map must be created. This Map is part of a Project. It keeps track of Requirements Documents that are managed outside of Rodin. Currently, Plain Text, Latex and OpenOffice are supported.

	Each Requirements Document is broken into Requirements. Within Rodin, only textual Requirements are visible and Formatting is lost. Individual Requirements can then be marked as relevant and fulfilled, and can be linked with individual Event-B-Elements.

	~~All additional information (links, fulfillment information, etc.) is stored in the Map, nothing is stored in the Requirements Documents or Event-B.~~

	~~More than one Map can be created. This could be useful for different relationships, e.g. "fulfills", "tests", etc.~~

	= Enabling the Navigator View =		= Enabling the Navigator View =
Line 62:		Line 50:
	= Adding a Requirements Document =		= Adding a Requirements Document =

	You need a specification before you can add one to the Requirements Map. Three formats are currently supported~~, but as of 22-July-2008, only the connectors for Plain Text and LaTex are working~~. ~~The formats are described further down, here~~ is a [[Sample Plain Text Requirements Specification]] that we are going to use to demonstrate the Plug-In's features.		You need a specification before you can add one to the Requirements Map. Three formats are currently supported (see below). Here is a [[Sample Plain Text Requirements Specification]] that we are going to use to demonstrate the Plug-In's features.

	The Requirements Editor has an "Add document" button on the "Requirements documents" tab. Add a document by clicking this button and selecting the Requirements Document from the file system. The Requirements Editor should now look as follows:		The Requirements Editor has an "Add document" button on the "Requirements documents" tab. Add a document by clicking this button and selecting the Requirements Document from the file system. The Requirements Editor should now look as follows:

imported>Jastram at 11:47, 23 January 2009

2009-01-23T11:47:18Z

← Older revision		Revision as of 11:47, 23 January 2009
Line 8:		Line 8:
	* Individual Requirements to be linked to individual Event-B-Entities		* Individual Requirements to be linked to individual Event-B-Entities
	* A basic completion test to be performed		* A basic completion test to be performed

	~~This Plug-In is not yet officially part of Rodin and therefore not supported yet. Version 1 of the Plug-In is planned for September 2008.~~

	= Glossary =		= Glossary =
Line 105:		Line 103:

	Every parser has different parameters. The values for the parameters can be set in the "Value" column.		Every parser has different parameters. The values for the parameters can be set in the "Value" column.

	~~= Check Model Completeness =~~

	~~{{TODO\|}}~~

	= Parsers =		= Parsers =

	~~== Plain Text Parser ==~~		The Requirements Plug-In provides an open architecture that makes it easy to implement parsers for various data types. The following parsers are currently available:

	~~== LaTeX~~ Parser ==		; Plain Text Parser: A very simple implementation that is useful for demonstrations.

	~~== OpenOffice~~ Parser ==		; LaTeX Parser: A parser that can be configured to detect various Latex-Constructs.

	~~tbd~~		; OpenOffice Parser: A parser that processes OpenOffice documents.

	[[Category:User documentation]]		[[Category:User documentation]]
	[[Category:Requirement Plugin]]		[[Category:Requirement Plugin]]
	[[Category:Tutorial\|Requirement Plugin]]		[[Category:Tutorial\|Requirement Plugin]]

imported>Jastram: /* Creating a Requirements Map */

2008-11-20T13:14:59Z

Creating a Requirements Map

← Older revision		Revision as of 13:14, 20 November 2008
Line 54:		Line 54:
	= Creating a Requirements Map =		= Creating a Requirements Map =

	~~Currently,~~ the ~~Requirements Map must be created manually:~~		A requirements map is the link between the requirements documents (managed outside Rodin) and the Event-B-Specification.

	* Create a ~~file with the extension~~ .~~req within~~ a ~~Rodin Project~~		NOTE: While multiple requirements maps can be created for a project, it is recommended to create just one. One map can manage multiple requirements documents.
	* Seed the ~~file with~~ the ~~following content:~~
	~~<?xml version=~~"1.~~0" encoding=~~"~~UTF~~-~~8" standalone="no"?>~~		To create a map, simply right-click on the project and select "New Requirements Map". Alternatively, it can be created through the "New..." dialog (located at Event-B/Requirements Map).
	~~<root>~~
	~~</root>~~		Upon creation, the Requirements Map Editor is opened.
	* You can now open the file from the Navigator view. To do so, ~~either doubleclick~~ the ~~file or select Open With >~~ Requirements Editor ~~from the context menu~~.

	= Adding a Requirements Document =		= Adding a Requirements Document =

imported>Jastram: /* Installation */

2008-11-20T12:48:04Z

Installation

← Older revision		Revision as of 12:48, 20 November 2008
Line 20:		Line 20:
	= Installation =		= Installation =

	As the Plug-In ~~is currently under development, it has to~~ be installed ~~manually~~. ~~Alternatively~~, ~~it can be built and deployed together with~~ the ~~Rodin sources. This exercise is left for advanced users.~~		As of Rodin 0.9.0, the Requirements Plug-In can be installed via the Eclipse update mechanism. To do so, follow the following steps:

	~~To deploy the Requirements Plug-In:~~		* Start Rodin

	* ~~Install the Plug-In~~ from the ~~Düsseldorf Update site at http~~:~~//www~~.~~stups~~.~~uni-duesseldorf~~.~~de/update~~		* Select from the menu: Help > Software Updates > Find and Install...
	* Unzip the file and copy the contents into your Rodin Plug-In directory

	~~That's it! After restarting Rodin~~, ~~you can check whether the Plug-In got installed successfully by opening Help > About Rodin Platform~~ and ~~clicking on Plug-In Details. The Plug-In should be listed as shown in the following screenshot:~~		* On the dialog, select "Search for new features to install" and press Next

	~~[[Image:About~~-~~Dialog.png]]~~		* On the next page, select "ProB update site" and click Finish

			* On the next dialog, you see the ProB update site. Unfold the tree, and you should see "Requirements Management". Check it, and follow the standard install procedure (accepting license, confirming the install, restart)

			* That's it! Now you can now start using the Plug-In

	= Architecture =		= Architecture =

imported>Jastram: /* Installation */

2008-10-24T14:11:25Z

Installation

← Older revision		Revision as of 14:11, 24 October 2008
Line 24:		Line 24:
	To deploy the Requirements Plug-In:		To deploy the Requirements Plug-In:

	* ~~[[Media~~:fr.~~systerel~~.~~reqsmgr~~-~~2008-07-22~~.~~zip\|Download]] the Plug-In~~		* Install the Plug-In from the Düsseldorf Update site at http://www.stups.uni-duesseldorf.de/update
	* Unzip the file and copy the contents into your Rodin Plug-In directory		* Unzip the file and copy the contents into your Rodin Plug-In directory

imported>Mathieu: {{TOCright}}

2008-09-23T13:31:02Z

← Older revision		Revision as of 13:31, 23 September 2008
Line 1:		Line 1:
			{{TOCright}}
	= Introduction =		= Introduction =

imported>Mathieu: Robot: Changing Category:User Documentation

2008-09-10T20:29:53Z

Robot: Changing Category:User Documentation

← Older revision		Revision as of 20:29, 10 September 2008
Line 117:		Line 117:
	tbd		tbd

			[[Category:User documentation]]
	[[Category:User ~~Documentation~~]]
	[[Category:Requirement Plugin]]		[[Category:Requirement Plugin]]
	[[Category:Tutorial\|Requirement Plugin]]		[[Category:Tutorial\|Requirement Plugin]]

imported>Mathieu: /* Check Model Completeness */

2008-09-09T20:37:08Z

Check Model Completeness

← Older revision		Revision as of 20:37, 9 September 2008
Line 105:		Line 105:
	= Check Model Completeness =		= Check Model Completeness =

	~~tbd~~		{{TODO\|}}

	= Parsers =		= Parsers =

imported>Jastram at 14:44, 31 July 2008

2008-07-31T14:44:07Z

← Older revision		Revision as of 14:44, 31 July 2008
Line 12:		Line 12:
	= Glossary =		= Glossary =

			; Parser: Each Requirements Document must be associated with a Parser that can extract requirements from the document. The Parser may require configuration.
	; Requirement: In this context, a Requirement is "a documented condition or property" of the system.		; Requirement: In this context, a Requirement is "a documented condition or property" of the system.
	; Requirements Document: A container for Requirements and optionally additional information (e.g. Headlines, explanatory texts, etc.)		; Requirements Document: A container for Requirements and optionally additional information (e.g. Headlines, explanatory texts, etc.)
Line 95:		Line 96:
	* n:m-relationships are possible		* n:m-relationships are possible
	* From the Project Explorer, you can navigate to a linked requirement through the context menu.		* From the Project Explorer, you can navigate to a linked requirement through the context menu.

			= Parser Settings =

			The plain text parser is a minimal parser that doesn't require configuration. However, all parsers can be configured further. The configuration dialog can be access from the "Requiremnts documents" tab by right-clicking on an entry and selecting "Edit Parser Settings" from the context menu.

			Every parser has different parameters. The values for the parameters can be set in the "Value" column.

	= Check Model Completeness =		= Check Model Completeness =
Line 100:		Line 107:
	tbd		tbd

	= LaTeX ~~connector~~ =		= Parsers =

			== Plain Text Parser ==

			== LaTeX Parser ==

			== OpenOffice Parser ==

	tbd		tbd