Page 1 of 2
issue-#100 new fixes in documentation
Posted: Sat Sep 03, 2016 4:40 am
by Josef Templ
here are some observations regarding the docu that I came across when working on #127.
Figure 5-15 in the text tutorial is not showing the new folds.
The command "New Window" in System/Docu/User-Man.odc is inconsistently documented.
It should be changed to use < > instead of ( ).
same file: Would be nice but this does not work for me.
{window}
... Document window titles are in boldface if their contents has been modified.
- Josef
Re: issue-#100 new fixes in documentation
Posted: Sat Sep 03, 2016 7:32 am
by DGDanforth
also
if their contents has been modified
should be
if their contents
have been modified
plural items have been modified
Re: issue-#100 new fixes in documentation
Posted: Sun Sep 04, 2016 3:16 am
by Ivan Denisov
DGDanforth wrote:also
if their contents has been modified
should be
if their contents
have been modified
plural items have been modified
HostMenus.WindowList is not working. There is HALT(127) in this procedure.
{window}
Command: HostMenus.WindowList
Guard:
Here the list of open windows is appended, the front window at the top (checked). Document window titles are in boldface if their contents has been modified.
Also the 9.2 section should be updated for new Green 000AF00H.
Green
Command: StdCmds.Color(000AF00H)
Guard: StdCmds.ColorGuard(000AF00H)
Checked: if text to the left and to the right of the caret is green, or if the selection is homogeneously green
Sets the selection's color to green.
Re: issue-#100 new fixes in documentation
Posted: Sun Sep 04, 2016 3:24 am
by Ivan Denisov
And this part should be removed
Neither development tools (the Dev-subsystem) nor documentation may be distributed. However, all other parts of BlackBox may be freely distributed along with applications; there are no royalties or other fees.
I will now create new branch issue-#100 for this.
Re: issue-#100 new fixes in documentation
Posted: Sun Sep 04, 2016 5:05 am
by Ivan Denisov
I had fixed User-Man and also improved the formatting of Component Pascal language report.
http://blackboxframework.org/unstable/i ... c1.664.zip
Re: issue-#100 new fixes in documentation
Posted: Sun Sep 04, 2016 5:46 am
by Ivan Denisov
I forgot about New Window.
Also Arial font set for new sections of P-S-I.
http://blackboxframework.org/unstable/i ... c1.666.zip
Re: issue-#100 new fixes in documentation
Posted: Sun Sep 04, 2016 11:03 am
by DGDanforth
StdDebug
DEFINITION StdDebug;
END StdDebug.
For a distribution version of an BlackBox application or component, use this limited version of the BlackBox debugger. This limited version doesn't allow to follow pointers and similar interactions, it only creates a passive display of the error state. Since this is a text document that can be saved, it enables the user to send error information to the developer (e.g., via StdCoder).
StdDebug is installed during startup of BlackBox, if the full DevDebug could not be found.
Ivan,
"an" is used only before words that start with a vowel or are pronounced like a vowel (e.g an 's' or an '8' or an 'n'). I believe there are several other places where "an" is not correctly used.
Let's see ...
ah yes, in ObxConv there is "... from the platform's ASCII format to
an BlackBox text"
That's it.
-Doug
Re: issue-#100 new fixes in documentation
Posted: Sun Sep 04, 2016 3:51 pm
by Ivan Denisov
Fixed in my local branch. Maybe somebody want to add something about documentation? For I can join changes in one commit.
Re: issue-#100 new fixes in documentation
Posted: Mon Sep 05, 2016 3:40 am
by Ivan Denisov
I had prepared new version. Articles mentioned by Doug were fixed. Also there are many improvements of formatting.
http://blackboxframework.org/unstable/i ... c1.668.zip
Let's vote to include this documentation fixes before the final release.
Re: issue-#100 new fixes in documentation
Posted: Mon Sep 05, 2016 5:52 am
by Josef Templ
The HostMenus.WindowList command in the menu does work although it is implemented as HALT().
Please look at HostMenus.AddItem to see why. No need to change the docu for this.
One minor suggestion for improvement over 1.6:
{window}
... The front window at the top is checked.
simplify to:
The front window is checked.
This was confusing because there is only one front window.
In addition, the front window is not at the top of the windows list in the menu.
This can be misleading.
- Josef