issue-#100 new fixes in documentation

User avatar
Josef Templ
Posts: 2047
Joined: Tue Sep 17, 2013 6:50 am

Re: issue-#100 new fixes in documentation

Post by Josef Templ »

Looks very good now.
Also thanks for adding the note in CommTCP.

One question regarding the figure in Tut-1:
In BB 1.6 as well as in the current version there is one line that does not have a double arrow but a single arrow.
It points from "enter addresses" to "main menu".
Is this a drawing error or is this on purpose?

The metafile data is still a bit larger than the BB 1.6 version.
This comes from additional application specific data that is stored in the metafile under function type META_ESCAPE.
It is about 2/3 of the overall size.
I guess that ominc used an editor that did not produce any such extensions and therefore it
used even less memory. Overall, this Designer is really great and produces reasonable metafiles.

- Josef
Ivan Denisov
Posts: 1700
Joined: Tue Sep 17, 2013 12:21 am
Location: Russia

Re: issue-#100 new fixes in documentation

Post by Ivan Denisov »

Josef Templ wrote:One question regarding the figure in Tut-1:
In BB 1.6 as well as in the current version there is one line that does not have a double arrow but a single arrow.
It points from "enter addresses" to "main menu".
Is this a drawing error or is this on purpose?
IMHO, it is on purpose. This is demonstration of modal interfaces. In this case you can not "enter addresses" directly from "main menu" before "entering terminals".
User avatar
Josef Templ
Posts: 2047
Joined: Tue Sep 17, 2013 6:50 am

Re: issue-#100 new fixes in documentation

Post by Josef Templ »

the new text in Tut-3 needs a fix:

'starts with an letter'

should be changed to

'starts with a letter'


In Obx/Conf there is also a need for a fix:
'Furthermore, the characters would have to be converted...'

'Furthermore' does not give sense after deleting the MacOS paragraph before it.
Another consequence of deleting the MacOS paragraph is that the commented code in the example source is inconsistent
because it refers to the Mac version (it uses TEXT instead of TXT). This can be fixed easily by changing the comment from TEXT to TXT.

A possible formulation would be:
'Actually, the characters would have to be converted...'
I would prefer not to introduce a new paragraph for this.


In System/Controls:
It is not clear what the new text '(For the keyboard shortcut).' means.
Why is it in brackets? Isn't it completely out of context?
Also the previous text is wrong. Label is applicable to all controls
because it always serves to define the keyboard shortcut.
But this important fact is not visible from the text.

A possible correction would be:

This is the displayed name of the control and, optionally, serves to define the keyboard shortcut.
The keyboard shortcut must be marked by a preceding "&" character. It will be underlined in the displayed name.
If you want "&" to appear in the displayed name, use the escape sequence "&&".
Controls that do not have a displayed name, for example text fields, use this property only for defining the keyboard shortcut.


Further below change the line:
'String label of the control. Ignored for fields, list boxes, selection boxes, combo boxes and tree controls.'
to
Displayed name and keyboard shortcut of the control.

- Josef
Ivan Denisov
Posts: 1700
Joined: Tue Sep 17, 2013 12:21 am
Location: Russia

Re: issue-#100 new fixes in documentation

Post by Ivan Denisov »

This fixes were applied.
Post Reply