issue-#100 Controls documentation

Shall we include the document changes for Controls?

YES
6
86%
NO
0
No votes
ABSTAIN
1
14%
 
Total votes: 7

User avatar
DGDanforth
Posts: 1061
Joined: Tue Sep 17, 2013 1:16 am
Location: Palo Alto, California, USA
Contact:

issue-#100 Controls documentation

Post by DGDanforth »

This voting is about including the changes to the documentation for Controls with the current unstable release.

Here is the discussion on the topic
http://forum.blackboxframework.org/view ... f=48&t=468

and here is the Diff file
http://redmine.blackboxframework.org/pr ... 456e/diff/
User avatar
Robert
Posts: 1024
Joined: Sat Sep 28, 2013 11:04 am
Location: Edinburgh, Scotland

Re: issue-#100 Controls documentation

Post by Robert »

A push button is either linked to a parameterless exported procedure.
1 - This is not English, or rather it is poor English.

2 - It is wrong. Command Buttons, as they were called, can be linked to other procedures than just parameterless Commands. For clarity some rewording in necessary. (And is parameterless a word?)

I don't have time myself to look at this this week. (I suddenly find I am more busy than planned as I have just realised that I only have until Friday to upgrade my PC from XP to Windows 10. Another job that is bound to take longer than one thinks it will.)
User avatar
Josef Templ
Posts: 2047
Joined: Tue Sep 17, 2013 6:50 am

Re: issue-#100 Controls documentation

Post by Josef Templ »

In addition to Robert's concerns, which I share, I would like to point out that
there are numerous places in BlackBox where the term 'command button' is used
for a push button. The Controls docu should document this alias name in some way.
This was so in the previous version and is important information that must not be removed.

In its current form I vote NO.
If the bugs are fixed I will of course change my vote.

- Josef
User avatar
DGDanforth
Posts: 1061
Joined: Tue Sep 17, 2013 1:16 am
Location: Palo Alto, California, USA
Contact:

Re: issue-#100 Controls documentation

Post by DGDanforth »

Thank you both.
Here is a list of "command button" usage

Location
Dev/Docu/Inspector.odc
command button [2]
Docu/BB-Road.odc
command button [1]
Docu/Tour.odc
command button [2]
Docu/Tut-2.odc
command button [1]
Docu/Tut-4.odc
command button [26]
Docu/Tut-5.odc
command button [1]
Docu/Tut-6.odc
command button [1]
Form/Docu/Gen.odc
command button [1]
Form/Docu/User-Man.odc
command button [2]
Obx/Docu/Address0.odc
command button [1]
Obx/Docu/Controls.odc
command button [5]
Obx/Docu/FileTree.odc
command button [1]
Obx/Docu/Graphs.odc
command button [1]
Obx/Docu/ParCmd.odc
command button [3]
Obx/Docu/Sys-Map.odc
command button [1]
Sql/Docu/Dev-Man.odc
command button [1]
Std/Docu/Coder.odc
command button [2]
System/Docu/Properties.odc
command button [1]

18 Files found
15 Dirs searched
313 Files searched
0.281 Search time (seconds)

So I agree that reference to command button must be restored in Controls.
I'll take a look at it.
-Doug
User avatar
DGDanforth
Posts: 1061
Joined: Tue Sep 17, 2013 1:16 am
Location: Palo Alto, California, USA
Contact:

Re: issue-#100 Controls documentation

Post by DGDanforth »

Modifications made.
Here are the Diffs from the last push.
http://redmine.blackboxframework.org/pr ... 4b36/diff/
-Doug
User avatar
Robert
Posts: 1024
Joined: Sat Sep 28, 2013 11:04 am
Location: Edinburgh, Scotland

Re: issue-#100 Controls documentation

Post by Robert »

DGDanforth wrote:Modifications made.
Still misleading. Command Buttons can be linked to many PROCEDURE signatures, not just parameterless ones.
User avatar
DGDanforth
Posts: 1061
Joined: Tue Sep 17, 2013 1:16 am
Location: Palo Alto, California, USA
Contact:

Re: issue-#100 Controls documentation

Post by DGDanforth »

Robert wrote:
DGDanforth wrote:Modifications made.
Still misleading. Command Buttons can be linked to many PROCEDURE signatures, not just parameterless ones.
Got ya (I didn't actually know that). Josef has pointed me to StdInterpreter which explains those procedures. I have
modified the Controls text to mention that. Take a look at what I wrote at http://forum.blackboxframework.org/view ... f=48&t=468
and tell me if that is better.
-Doug
Zinn
Posts: 476
Joined: Tue Mar 25, 2014 5:56 pm
Location: Frankfurt am Main
Contact:

Re: issue-#100 Controls documentation

Post by Zinn »

About which version do we vote here?
Doug's text or Robert's text?
To the latest link 593 I have to say no. I prefer Robert's version of change.
- Helmut
Ivan Denisov
Posts: 1700
Joined: Tue Sep 17, 2013 12:21 am
Location: Russia

Re: issue-#100 Controls documentation

Post by Ivan Denisov »

User avatar
DGDanforth
Posts: 1061
Joined: Tue Sep 17, 2013 1:16 am
Location: Palo Alto, California, USA
Contact:

Re: issue-#100 Controls documentation

Post by DGDanforth »

Here is the Diff file for the changes were are now voting on.

http://redmine.blackboxframework.org/pr ... d114f33298

Change your vote if appropriate.
-Doug
Locked