issue-#100 Review all the existing documentation

User avatar
Robert
Posts: 1024
Joined: Sat Sep 28, 2013 11:04 am
Location: Edinburgh, Scotland

Re: issue-#100 Review all the existing documentation

Post by Robert »

Ivan Denisov wrote:It is hard to draw our yellow puzzle using Ports primitives
A replacement to the current StdLogos, if wanted, could just draw a bitmap read from file rather than using Ports primitives.

Is the idea to remove Oms logos, or to replace Oms logos with Center ones?
Ivan Denisov
Posts: 1700
Joined: Tue Sep 17, 2013 12:21 am
Location: Russia

Re: issue-#100 Review all the existing documentation

Post by Ivan Denisov »

Josef Templ wrote: 'Tutorial: Component Software Using BlackBox Components' still sounds better to me.
'Tutorial: Component Software on Example of BlackBox Components' does not sound like correct English to me.
Also there is now 'Example' instead of 'case study', which is not much different.
It is a tutorial on BlackBox. Why should it be declared an example or a case study?
What do our native speakers think?
May be an even shorter form like 'BlackBox Tutorial' would be best.
But this Tut-* is not BlackBox Tutorial... That is an attempt to make some tutorial to ideas of Component Software engineering.
And the BlackBox is an demonstration object.
Zinn
Posts: 476
Joined: Tue Mar 25, 2014 5:56 pm
Location: Frankfurt am Main
Contact:

Re: issue-#100 Review all the existing documentation

Post by Zinn »

What about
"Tutorial: Component-based software development with BlackBox"
instead of
"Tutorial: Component Software on Example of BlackBox Components"
?
- Helmut
User avatar
Robert
Posts: 1024
Joined: Sat Sep 28, 2013 11:04 am
Location: Edinburgh, Scotland

Re: issue-#100 Review all the existing documentation

Post by Robert »

The two files \Text\Docu\Controllers.odc & \Text\Docu\Models.odc have a horrible mixture of colors.

Can they be changed to use defaultColor?

The other color is black, so if your default color is black you won't see the difference, but I see it and it has annoyed me for many years. However I have never felt able to complain before!

(My text is dark blue. I do this to reduce the contrast and eye strain. I also set the paper to very light brown.)

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

Re: issue-#100 Review all the existing documentation

Post by Josef Templ »

Zinn wrote:What about
"Tutorial: Component-based software development with BlackBox"
- Helmut
Excellent

@Robert, Doug: what are the native speakers thinking?


I browsed the tutorial and found the following overview in each part:
Part I of the BlackBox tutorial gives an introduction to the design patterns that are used throughout BlackBox. To know these patterns makes it easier to understand and remember the more detailed design decisions in the various BlackBox modules.

Part II of the BlackBox tutorial demonstrates how the most important library components can be used: control, form, and text components.

Part III of the BlackBox tutorial demonstrates how new views can be developed, by giving a series of examples that gradually become more sophisticated.
So for me this is really THE BlackBox tutorial and not a tutorial about Component Software in General. Can it be that the "case study" formulation was a marketing action from ominc for promoting their Component Software Book.

Anyway, I am happy if 'Tutorial' is mentioned somewhere and the rest is correct English.

- Josef
cfbsoftware
Posts: 204
Joined: Wed Sep 18, 2013 10:06 pm
Contact:

Re: issue-#100 Review all the existing documentation

Post by cfbsoftware »

At the risk of being picky if this is a title the significant words should be capitalised i.e.

"Tutorial: Component-based Software Development with BlackBox"

Cheers,
Chris

P.S. I think I'm the only native English speaker around here aren't I? Although I'm now officially an Aussie I was born and grew up in England. Robert is Scottish and Doug is American isn't he? ;)
Ivan Denisov
Posts: 1700
Joined: Tue Sep 17, 2013 12:21 am
Location: Russia

Re: issue-#100 Review all the existing documentation

Post by Ivan Denisov »

User avatar
Robert
Posts: 1024
Joined: Sat Sep 28, 2013 11:04 am
Location: Edinburgh, Scotland

Re: issue-#100 Review all the existing documentation

Post by Robert »

Josef Templ wrote:
Zinn wrote:What about
"Tutorial: Component-based software development with BlackBox"
- Helmut
Excellent

@Robert, Doug: what are the native speakers thinking?
Excellent.

(Adding capitals is also good.)
User avatar
Robert
Posts: 1024
Joined: Sat Sep 28, 2013 11:04 am
Location: Edinburgh, Scotland

Re: issue-#100 Review all the existing documentation

Post by Robert »

Docu: From Pascal to Component Pascal
Line # 9
Was: "Arrays are always defined over the integer range 0..max-1"
Should be: "Arrays are always defined over the integer range 0..max" or "Arrays are always defined over the integer range 0..count-1"
User avatar
Robert
Posts: 1024
Joined: Sat Sep 28, 2013 11:04 am
Location: Edinburgh, Scotland

Re: issue-#100 Review all the existing documentation

Post by Robert »

Docu: Stores
Procedure: WriteXString
Was:"This procedure is provided to simplify migration from Release 1.2 to 1.3."
Should be: Delete this line. Maybe delete the entire procedure ?

Also several other 'X' procedures.

I vote to keep the procedures, but delete the lines.


Slightly off-topic: The entire Module SMath (SHORTREAL versions of Cos, Exp, etc) went missing from the Oms distribution around about the time of BlackBox 1.3. I use it (not for speed, but to save space doing big sums). Should we consider including it?
Post Reply