Documentation #100

Review all the existing documentation

Added by I. Denisov over 3 years ago. Updated almost 3 years ago.

Status:ClosedStart date:01/25/2016
Priority:NormalDue date:
Assignee:I. Denisov% Done:

100%

Category:-
Target version:1.7
Forum topic:

Description

The following fixes and more should be done in the existing documentation of BlackBox.

1. Remove MacOS references
2. There are several typos (for example: "dangLing pointers" in Tour)
3. One view should be moved from ObxCtrls sources to ObxCtrls docu
4. add docu of compiler options
5. add default range checking behavior
etc.

Associated revisions

Revision ec63adbb
Added by I. Denisov over 3 years ago

Move form view from ObxCtrls sources to docu. Refs: #100

Revision 42314e96
Added by I. Denisov over 3 years ago

Fix typo in Tour. Refs: #100

Revision 7d73bc7b
Added by I. Denisov over 3 years ago

Duplicating documentation removed + small fixes. Refs: #100

Revision cabefcee
Added by I. Denisov over 3 years ago

Table of content was improved. Refs: #100

Revision 0067d802
Added by I. Denisov over 3 years ago

The module providing Oberon Microsystem logo view was removed. Refs: #100

Revision b6dc64fc
Added by I. Denisov over 3 years ago

Logo view was removed from several docoments. Refs: #100

Revision 8b0dfd36
Added by I. Denisov over 3 years ago

Mac OS refenrences removed. Formatting of docu was improved. Refs: #100

Revision f960d1d2
Added by I. Denisov over 3 years ago

Set default color and Arial font in docu, improve docu formatting, remplace modifier to ctrl', change title for tutorial. Refs: #100

Revision 08d35ee3
Added by I. Denisov over 3 years ago

Typo in Tut-B was fixed. Default font for Strings files. Arial font for DTC documentation. Refs: #100

Revision 1706f7a2
Added by I. Denisov over 3 years ago

Set syntax was fixed in TextMappers Docu. Refs: #100.

Revision 62b82db0
Added by I. Denisov over 3 years ago

Typo in Help. Refs: #100.

Revision 072d58a2
Added by I. Denisov over 3 years ago

Remove underlines from Help dialog. Links hover underline was implemented. Refs: #100

Revision 6f29100f
Added by I. Denisov over 3 years ago

Re-wording of DTC references in PSI. Remove comparison of 1.2 and 1.3 version of DTC. Refs: #100

Revision 37d6293f
Added by I. Denisov over 3 years ago

Revert links behavior. Refs: #100

Revision 680fbeda
Added by I. Denisov over 3 years ago

Remove text about resize of view, because in browser mode it can not be resized. Refs: #100

Revision 0309369a
Added by I. Denisov over 3 years ago

Change formatting a bit. Refs: #100

Revision 86487781
Added by I. Denisov over 3 years ago

Master merged to the topic branch. Refs: #100

Revision 38095ad6
Added by I. Denisov over 3 years ago

Add two links (Ctl and COM) into help menu. Refs: #100

Revision bf17bf52
Added by I. Denisov over 3 years ago

Documentation for Log. Refs: #100

Revision a16ca015
Added by I. Denisov over 3 years ago

Typeface fixed. Refs: #100

Revision 6f66e965
Added by J. Templ over 3 years ago

Docu for StdFolds updated. Refs: #100.

Revision 5c0223f8
Added by I. Denisov over 3 years ago

Log docu improved by Josef. Refs: #100

Revision 4d7fa8ca
Added by I. Denisov over 3 years ago

Fix User Mans formatting, link in Logo docu and the Link in Help dialog. Refs: #100

Revision d396bb63
Added by I. Denisov over 3 years ago

Improve docu according Helmut Zinn suggestions. Subtitles enlarged to 12pt. DTC formatting improved. Imgs aligned to center in Forms Tutorial. Refs: #100.

Revision 89afdf6f
Added by I. Denisov over 3 years ago

Titles for Sys-Map enlarged. Some documents were made wider. Refs: #100.

Revision 5577e113
Added by I. Denisov over 3 years ago

Documentation improved. Refs: #100.

Revision 2d62c4e5
Added by I. Denisov over 3 years ago

Small fixes in documentation. Refs: #100

Revision bffa07e5
Added by I. Denisov about 3 years ago

Figure 1.1 and 2.4 fixed. Refs: #100

Revision 2b7bbc3d
Added by I. Denisov about 3 years ago

The information about address 0.0.0.0 was added. Refs: #100

Revision bc6eaa56
Added by I. Denisov about 3 years ago

Few corrections by Josef Templ. Refs: #100

Revision 9a5ade53
Added by I. Denisov about 3 years ago

Description for coverters updated. Refs: #100.

Revision b614db01
Added by I. Denisov about 3 years ago

Description for Converters.Register updated. Refs: #100.
There was a possible misunderstanding that converters can only be registered in Config.
This should be clarified now. They can be registered anywhere but if they need to be available at
startup of BlackBox they should be registered in Config.

Revision 200f9f4f
Added by Douglas G Danforth about 3 years ago

Merge pull request #116 from BlackBoxCenter/issue-#100

Description for Converters.Register updated. Refs: #100.

Revision 3f112671
Added by I. Denisov about 3 years ago

Controls documentation fixed by Douglas Danforth. Refs: #100

Revision 3951c846
Added by D. G. Danforth about 3 years ago

Docu for Controls updated. Refs: #100.
Add signed-off-by

Revision c4a1e460
Added by D. G. Danforth about 3 years ago

Documentation for controls updated. Refs: #100.

Revision 8b411825
Added by I. Denisov about 3 years ago

Controls documantation improved by Douglas Danforth. Refs: #100.

Revision 4ae777ad
Added by D. G. Danforth about 3 years ago

Fixed sentence in System/Docu/Controls.odc and added "(also called a command button)". Refs: #100.

Signed-off-by: DGDanforth <>

Revision 46184fff
Added by D. G. Danforth about 3 years ago

Controls docu updated. Refs: #100.

Signed-off-by: DGDanforth <>

Revision 687d92c7
Added by D. G. Danforth about 3 years ago

Browser mode for Controls set. Refs: #100.

Signed-off-by: DGDanforth <>

Revision 8fd0f36e
Added by D. G. Danforth about 3 years ago

Browser mode changed to edit mode. Refs: #100.

Signed-off-by: DGDanforth <>

Revision a14711f5
Added by D. G. Danforth about 3 years ago

Helmut version. Refs: #100.

Signed-off-by: DGDanforth <>

Revision e2e30e8e
Added by J. Templ almost 3 years ago

CP compiler options documented. Refs #100.
Kernel.val docu extended.
Default run-time range checking documented.

Signed-off-by: Josef Templ <>

Revision fbc56e94
Added by J. Templ almost 3 years ago

minor improvements of the wording. Refs #100.

Signed-off-by: Josef Templ <>

Revision 39837d3f
Added by J. Templ almost 3 years ago

further improvements of the wording. Refs #100.

Signed-off-by: Josef Templ <>

Revision f2cc235c
Added by J. Templ almost 3 years ago

further improvements of the wording. Refs #100.

Signed-off-by: Josef Templ <>

Revision 7e888af7
Added by J. Templ almost 3 years ago

further improvements of the wording. Refs #100.

Signed-off-by: Josef Templ <>

Revision 6fcd1e59
Added by J. Templ almost 3 years ago

CP compiler options and range checking documented. Refs: #100.
Table for Kernel.err and Kernel.val extended according to DevDebug.Trap.

Signed-off-by: Josef Templ <>

Revision afb74f4c
Added by I. Denisov almost 3 years ago

Merge pull request #130 from BlackBoxCenter/issue-#100

CP compiler options and range checking documented. Refs: #100.

Revision 692f3728
Added by I. Denisov almost 3 years ago

User-Man was fixed. Formatting of Language Report was improved. Refs: #100.

Revision d73d2bc6
Added by I. Denisov almost 3 years ago

Folds img replaced to folds demonstration. Formatting improved. Refs: #100.

Revision f9176781
Added by I. Denisov almost 3 years ago

New Window description was updated. Arial font for new sections of P-S-I. Refs: #100.

Revision ced6a6e7
Added by I. Denisov almost 3 years ago

Few articles were fixed. The formatting was improved for several documents. Refs: #100.

Revision 6776b18d
Added by I. Denisov almost 3 years ago

Information in Hello0 updated and small corrections in User-Man. Refs: #100.

Revision 40f0766f
Added by I. Denisov almost 3 years ago

Fixed lost line in Language Report. Refs: #100.

Revision 7dde944f
Added by J. Templ almost 3 years ago

Merge pull request #135 from BlackBoxCenter/issue-#100

Refs: #100.

History

#1 Updated by I. Denisov over 3 years ago

  • Status changed from New to In Progress
  • % Done changed from 0 to 10

#2 Updated by I. Denisov over 3 years ago

  • % Done changed from 10 to 70

Now looking for better way for remove underline style from links.

#3 Updated by I. Denisov over 3 years ago

  • Tracker changed from 3 to Documentation

#4 Updated by I. Denisov over 3 years ago

  • Status changed from In Progress to Closed
  • % Done changed from 70 to 100

#5 Updated by J. Templ almost 3 years ago

  • Description updated (diff)

Also available in: Atom PDF