Page History

...

In this document all reference principles for knowledge in a Quaestor knowledge base is described. This information is particularly interesting for knowledge bases to be used by End-Users and Domain Experts.

For further detailed information on the use of images and documents, also read Image Management.

The document is divided into two parts:

1. The ways to create documentation and reference for your knowledge (parameters, relations, constraints, functions);
2. Details of how the documentation and binary data is presented in Quaestor and the web-based version;

1.    Documentation and reference for your knowledge

Knowledge in Quaestor is stored in a frame. A frame can contain the following types of knowledge:

...

Information on frames (knowledge) is presented and can be modified in the Knowledge Browser, Frame Viewer and Slots & Properties. For specialised presentation aspects most of the time Attributes are used.

1.1    Documentation and reference for parameters

...

Optionally you can create a presentation name by using the @WBNAME attribute. This attribute should be placed in the data slot of the Frame viewer. For example, for parameter F you can give a presentation name @WBNAME:Force. The alternative presentation name is also presented as {..} behind the parameter name in the Knowledge Browser. Note that you are able to use special characters in the presentation name (such as spaces etc.) which you are not allowed to use in the parameter name itself.

...

A proper dimension is based on (a combination of) SI dimension(s). Available SI dimensions are presented in the Knowledge Browser (Quaestor>Dimensions).

Optionally you can create your own presentation dimensions by using the @WBDIM attribute in the data slot of the parameter. For example, for parameter F you can give the unusual dimension @WBDIM:Newton. Please note that you should have a normal dimension at first before defining the alternative one. The alternative dimension is presented right away.

...

Please note that the first line of this description is handled in a unique way. This line is used as full reference text when selected in the Workbase (and the web-based dialogue) (see for further detailed in section 2 below).

The reference can be written in the reference part of the Frame Viewer. This is simple ASCII text.

...

Optionally you can use HTML code in the additional text after the first reference line. In the Explanation window (see section 2) this is presented as nicely formatted html text.

Furthermore, advanced syntax functionality can be used to define different reference text for a parameter when it is part of different objects. You can recognise that the parameter has a different reference text in different object by the fact that the text in reference part of the Frame Viewer is italic. Please note that this functionality is a bit special. You can edit the text of the parameter for the different objects by selecting the parameter in the relevant object in the workbase (for instance in the data set or in a solution) and change the text it presents. What is also possible is to press F2 when you your cursor in the Frame Viewer to open the content in a separate text editor. When you have already used the syntax, you will discover this in the external editor (it will never be visible in the Quaestor GUI itself). The syntax works as follows:

To start the definition use:

>< 

This if followed by the generic description (in orther than defined objects):

=misc=$Description

With Discription the general discription. Hereafter a description can be defined for within every object:

=ObjectName=$SpecialDescription

With ObjectName the name of the object it is valid for and SpecialDescription the description in this object. For example, the parameter VOL can be used with different definitions in theSPEEDTRIAL object and POWERING_MODEL_TEST_DATA object, both in the solution and in the data set below the Ships object entry:  

 ><
=misc=$Displacement volume on trials
From the speed trial data.
=SPEEDTRIAL=$Actual displacement volume on trials
This is the actual displacement volume corresponding with the actual loading condition during the trials.
Although the ship should be ballasted as accurate as possible on the specified trial condition, small differences are to be expected. Provide the actual value so that small displacement corrections can be made relevative to the specified displacement on trials.
=POWERING_MODEL_TEST_DATA=$Actual displacement volume model test
 
Note that the displacement volume is used to determine whether the modeltest can be used in the analysis for the conversion of speed trial results to another draught or loading condition.
The actual displacement should be within a boundary of 5% of the model test volume. If this is not the case, the model test can and will not be used for the trial volume correction to other loading conditions.
=Ship.SPEEDTRIAL=$Actual displacement volume on trials
This is the actual displacement volume corresponding with the actual loading condition during the trials.
Although the ship should be ballasted as accurate as possible on the specified trial condition, small differences are to be expected. Provide the actual value so that small displacement corrections can be made relevative to the specified displacement on trials.
=Ship.POWERING_MODEL_TEST_DATA=$Actual displacement volume model test
 
Note that the displacement volume is used to determine whether the modeltest can be used in the analysis for the conversion of speed trial results to another draught or loading condition.
The actual displacement should be within a boundary of 5% of the model test volume. If this is not the case, the model test can and will not be used for the trial volume correction to other loading conditions.

1.1.4    Optional parameter illustration connected through Slots & Properties

...