issue-#100 Review all the existing documentation

Locked

Should we merge topic branch issue-#100 with master?

Yes
5
63%
No
0
No votes
Abstain
3
38%
 
Total votes: 8

Ivan Denisov
Posts: 1700
Joined: Tue Sep 17, 2013 12:21 am
Location: Russia

issue-#100 Review all the existing documentation

Post by Ivan Denisov »

This is voting about issue-#100.
http://redmine.blackboxframework.org/issues/100
The discussion

Changes list:
- "Mac OS" was removed from all the docu and some of cross-development descriptions also were removed for making the documentation simpler to read
- Duplicating Docu/Tut-Tot.odc removed
- Direct-To-COM compiler integrated with documentation
- Several links in Help dialog were renamed and two new links (Ctl subsystem + Direct-To-COM compiler) were added
- The formatting was improved in all the Tour, User-Man and others documents (space for left and right sides, justify, space lines to paragraphs)
- Oberon logo was removed from all the documentation (so StdLogos was removed)
- Control element was moved from sources to documentation of ObxCtrls
- Center copyright was added to LICENSE.txt and year was fixed in Docu/BB-License.odc
- The documentation of Log module was added
- Authorship from DevAnalyzer was removed
- Callback flag description was added to Dev/Docu/P-S-I.odc
- References to old releases 1.2 and 1.3 from Docu/CP-New.odc and Docu/DTC-Intro.odc were removed
- Definition of the array was fixed in Docu/Tut-B.odc (should be 0..length-1)
- The restrictions of debugger distribution were removed from Std/Docu/Debug.odc
- StdLinks documentation was improved according new filter terminology
- Dates module documentation was significantly improved
- Preconditions were fixed in Meta module
- The description of SET syntax is fixed in Text/Docu/Mappers.odc
- Several typos fixed

The BlackBox version for testing:
http://blackboxframework.org/unstable/i ... a1.510.zip
User avatar
DGDanforth
Posts: 1061
Joined: Tue Sep 17, 2013 1:16 am
Location: Palo Alto, California, USA
Contact:

Re: issue-#100 Review all the existing documentation

Post by DGDanforth »

I think "only time will tell" whether all of those changes are viable and have not introduced any inconsistencies.
Ivan Denisov
Posts: 1700
Joined: Tue Sep 17, 2013 12:21 am
Location: Russia

Re: issue-#100 Review all the existing documentation

Post by Ivan Denisov »

The voting is finished. Resulting version:
http://blackboxframework.org/unstable/m ... a1.512.zip
Locked