issue-#100 new fixes in documentation

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

issue-#100 new fixes in documentation

Post 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
User avatar
DGDanforth
Posts: 1061
Joined: Tue Sep 17, 2013 1:16 am
Location: Palo Alto, California, USA
Contact:

Re: issue-#100 new fixes in documentation

Post by DGDanforth »

also
if their contents has been modified
should be
if their contents have been modified

plural items have been modified
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 »

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.
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 »

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.
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 »

I had fixed User-Man and also improved the formatting of Component Pascal language report.
http://blackboxframework.org/unstable/i ... c1.664.zip
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 »

I forgot about New Window.

Also Arial font set for new sections of P-S-I.
http://blackboxframework.org/unstable/i ... c1.666.zip
User avatar
DGDanforth
Posts: 1061
Joined: Tue Sep 17, 2013 1:16 am
Location: Palo Alto, California, USA
Contact:

Re: issue-#100 new fixes in documentation

Post 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
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 »

Fixed in my local branch. Maybe somebody want to add something about documentation? For I can join changes in one commit.
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 »

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.
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 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
Post Reply