BlackBox Framework Center

I found the following errors in the documentations of the Beta version:

Com/Docu/KoalaExe
A blank is missing between the word "file" and the link "Com/Reg/EKoala1.reg".

Com/Docu/Sys-Map
"Map to the COM Examples." should change to "Map to the Direct-To-COM Examples."

Ctl/Docu/Dev-Man
The StdLogos are missing.

Dev/Docu/Analyzer
Is it allowed to delete the sentence "Contacting the Author" ?

Dev/Docu/Browser
Forgot to delete the "Mac OS: part".

Dev/Docu/Build-Tool
The StdLogos are missing.

Dev/Docu/Commanders
"Insert EndCommander" or "Insert End Commander" ?

Dev/Docu/Linker
StdLogos is missing.

Dev/Docu/P-S-I
Missing entries in table of contents.

Dev/Docu/Selectors
Why added Stores only and Ports not added ? Should Stores and Ports insert or deleted?

Dev/Docu/Sys-Map
View is too small.

Dev/Docu/User-Man
1x Windows: not deleted and 2x modifier not changed to ctrl.

Docu/BB-Road
Roadmap has a link to itself instead to the Guided Tour
Custom Commands not not changed to Std Subsystem.
Links to Ctl Subsystem and link to Direct-To-COM Compiler are missing.

Docu/DTC-Intro
StdLogos is missing. Chapter BlackBox Component Builder is missing.

Docu/Tour
StdLogos and the picture text are missing.

Docu/Tut-1
END before END Main is missing and optional not deleted before Direct-To-COM.

Docu/Tut-3
starts with an letter and Silent Trap are missing.

Docu/Tut-4
The word respectively not deleted.

Form/Docu/User-Man
3x modifier key not changed to ctrl key.

Obx/Docu/Conv
Forgot to delete the "Mac OS: part".

Sql/Docu/Dev-Man
Forgot to delete Windows:

Std/Docu/Api
If a non-standard language is selected ... is not valid for OpenAux !!!

Std/Docu/Stamps
Modifier-clicking not changed to Ctrl-clicking.

System/Docu/Controls
(For the keyboard shortcut). is missing

System/Docu/Dates
UTC = Coordinated Universal Time, also known as Greenwich Mean time (GMT).

System/Docu/Dialog
serverMode discription is missing

System/Docu/Kernel
support is written with 3 p and another sentences ends with 2 point.

System/Docu/Log
The Sentence is missing: It is generally advised that applications calling StdLog instead of Log routines where possible.

System/Docu/User-Man
Uppercase TO instaedt of lowercase to

Text/Docu/Mappers
integer]] "}".) not changed to integer]} ] "}".)

Text/Docu/Setters
sString lines are not deleted.

Text/Docu/User-Man
modifier-clicking is not changed to ctrl-clicking

The documentation should be changed more carefully.
Helmut

Helmut, can you please make this changes and attach new files here? Or can you try to use git for publishing this changes?

Ivan Denisov wrote:Helmut, can you please make this changes and attach new files here? Or can you try to use git for publishing this changes?

Here there are the complete documentation with all changes descript in my last post. Some of them may change after discussion.
- Helmut

Today I had time to adopt the half of the changes. I compared half of all the docu file by file.
http://blackboxframework.org/unstable/i ... b1.519.zip

Some comments:
- 12pt size for subtitles looks better, so I am changing subtitles size in all documents.
- I do not think, that we should paste StdLogos into DTC documentation. It was there from the times when DTC was promoted as proprietary software.
- All links should follow the same style, so I am not removing underlines from documentation files.

I will continue this work tomorrow.

I adopted all changes. Please take a look for the results:
http://blackboxframework.org/unstable/i ... b1.525.zip

I also found the bug in HostBitmaps. The 1-bit images imported as 32-bit. I will explore this issue and describe later.

The result is better
- Helmut

I want to fix few figures and then make voting. It will take few days, so if somebody have some ideas what we can fix more in documentation, please, post here.

In the docu of CommTCP we should add a note about the important special IP address 0.0.0.0 for localAdr.
This address serves to listen on any interface if multiple interfaces are available
or to connect to a remote server using any available interface.
The localhost (127.0.0.1) can only be used to connect clients on the local machine.
So, 0.0.0.0 is similar to 127.0.0.1 but clients can connect locally and remotely.
I spent several hours finding this out and I don't want to ever forget it.

A possible formulation appended at the end of the docu of CommTCP (no new paragraph) would be:

The special IP address "0.0.0.0" means all available IP addresses on the local machine (including "127.0.0.1"). This can be used for listening on all available network interfaces or for connecting to a server using any available network interface. In this case network traffic may leave the local machine.

- Josef

I prepared two images for documentation. However all my attempts to paste them leading to big increasing of files size. I tried 1-bit images, they gives not such big increasing, but looks ugly.

Does anyone have experience how to paste BMP correctly?

Ivan, what exactly are you doing?