- Tutorial or Documentation?

From: Douglas G. Danforth <"Douglas>
Date: Sat, 19 Mar 2005 00:13:35 -0500

----boundary-LibPST-iamunique-1307241236_-_-
Content-type: text/plain

Fyodor,
We need a joint effort. Little contributions from many people.

Where is ESPE21? Well I happen to know about CPC
(http://www.zinnamturm.de/#Epse21) but that is buried and not easily
accessible for new people. Where do I start with EPSE21? I didn't want
to install it so I just now unpacked it simply for its documentation.
Where to start? I wandered around reading some files (QuickStart first)
and finally found, in the outer directory, Map.odc! Very nice graphics
and rotating cube with ticker! But why the name Map?

So you see, the organization of what you have written is not right for a
manual of how find things in BlackBox/Component Pascal.

I suggest a single document (a large one) that is searchable (with
Ctrl-F) that contains chapters such as: Getting started, Files, GUI,
Serial communication, Web design, Scientific computing, ... and anything
else that people want and need.

So lets start with your documentation in ESPE21 but not use that name.
It needs to be called something like: BlackBox documentation, or
Development Manual, or Component Pascal Users guide, or ...

My preference for the structure of each 'article' of the Guide is

Article Title (e.g. Files)
Article Summary (a paragraph or two)
Article Example code (working snippet)
Article Hotlinks to other BlackBox documention.

EPSE21 does have nice hotlinks to code and documentation. My preference
would be to have as much as possible within a single document (self
contained).

Let me edit slight one small section of Fyodor's documentation within
the Epse21Obx0Hello file.

Original form:
"Programs written in Component Pascal consist of one or several modules.
In this case we have a module with one procedure Do."

Replace with:
"Programs written in Component Pascal consist of one or several modules.
A module is a syntactive piece of text in a file. Its compiled form
(also called a module) is a binary chunk that is dynamically brought
into memory at run time and can be release from memory when no other
module depends upon it.

Syntactically one uses the words MODULE and END to delimit the module:

MODULE myModuleName;
...
END myModuleName.

where ... represents the textual code of the body of the module.
"

Now, if I were actually modifying Fyodor's documentation I would expect
there to be an editor (other than Fyodor or myself) who would accept or
reject my modification or even modify my modifications and put them into
a working document that everyone else can see and additionally comment
on or modify.

Let's keep this going.

-Doug

Fyodor Tkachov wrote:
> Actually, what Rex suggests is, logically speaking, an extension of the effor
> with the ESPE21 package which is open to any extension of this kind.
> There is an introduction already there, and I hope to add a couple of simple lessons on I/O soon.
> That's already a framework.
>
> And the package targeted exactly the audience Rex has in view, if I understand him correctly.
>
> Proceeding in smaller specific steps might be more preferable than a big new project.
>
> Cheers
> Fyodor
>
>
> The package EPSE-21 may be a starting point

--- BlackBox
--- send subject HELP or UNSUBSCRIBE to blackbox{([at]})nowhere.xy



----boundary-LibPST-iamunique-1307241236_-_-
Content-type: application/rtf
Content-transfer-encoding: base64
Content-Disposition: attachment; filename="rtf-body.rtf"

e1xydGYxXGFuc2lcYW5zaWNwZzEyNTJcZnJvbXRleHQgXGRlZmYwe1xmb250dGJsDQp7XGYwXGZz
d2lzcyBBcmlhbDt9DQp7XGYxXGZtb2Rlcm4gQ291cmllciBOZXc7fQ0Ke1xmMlxmbmlsXGZjaGFy
c2V0MiBTeW1ib2w7fQ0Ke1xmM1xmbW9kZXJuXGZjaGFyc2V0MCBDb3VyaWVyIE5ldzt9fQ0Ke1xj
b2xvcnRibFxyZWQwXGdyZWVuMFxibHVlMDtccmVkMFxncmVlbjBcYmx1ZTI1NTt9DQpcdWMxXHBh
cmRccGxhaW5cZGVmdGFiMzYwIFxmMFxmczIwIEZ5b2RvcixccGFyDQpXZSBuZWVkIGEgam9pbnQg
ZWZmb3J0LiAgTGl0dGxlIGNvbnRyaWJ1dGlvbnMgZnJvbSBtYW55IHBlb3BsZS5ccGFyDQpccGFy
DQpXaGVyZSBpcyBFU1BFMjE/ICBXZWxsIEkgaGFwcGVuIHRvIGtub3cgYWJvdXQgQ1BDIFxwYXIN
CihodHRwOi8vd3d3Lnppbm5hbXR1cm0uZGUvI0Vwc2UyMSkgYnV0IHRoYXQgaXMgYnVyaWVkIGFu
ZCBub3QgZWFzaWx5IFxwYXINCmFjY2Vzc2libGUgZm9yIG5ldyBwZW9wbGUuICBXaGVyZSBkbyBJ
IHN0YXJ0IHdpdGggRVBTRTIxPyAgSSBkaWRuJ3Qgd2FudCBccGFyDQp0byBpbnN0YWxsIGl0IHNv
IEkganVzdCBub3cgdW5wYWNrZWQgaXQgc2ltcGx5IGZvciBpdHMgZG9jdW1lbnRhdGlvbi4gXHBh
cg0KV2hlcmUgdG8gc3RhcnQ/ICBJIHdhbmRlcmVkIGFyb3VuZCByZWFkaW5nIHNvbWUgZmlsZXMg
KFF1aWNrU3RhcnQgZmlyc3QpIFxwYXINCmFuZCBmaW5hbGx5IGZvdW5kLCBpbiB0aGUgb3V0ZXIg
ZGlyZWN0b3J5LCBNYXAub2RjISAgVmVyeSBuaWNlIGdyYXBoaWNzIFxwYXINCmFuZCByb3RhdGlu
ZyBjdWJlIHdpdGggdGlja2VyISAgQnV0IHdoeSB0aGUgbmFtZSBNYXA/XHBhcg0KXHBhcg0KU28g
eW91IHNlZSwgdGhlIG9yZ2FuaXphdGlvbiBvZiB3aGF0IHlvdSBoYXZlIHdyaXR0ZW4gaXMgbm90
IHJpZ2h0IGZvciBhIFxwYXINCm1hbnVhbCBvZiBob3cgZmluZCB0aGluZ3MgaW4gQmxhY2tCb3gv
Q29tcG9uZW50IFBhc2NhbC5ccGFyDQpccGFyDQpJIHN1Z2dlc3QgYSBzaW5nbGUgZG9jdW1lbnQg
KGEgbGFyZ2Ugb25lKSB0aGF0IGlzIHNlYXJjaGFibGUgKHdpdGggXHBhcg0KQ3RybC1GKSB0aGF0
IGNvbnRhaW5zIGNoYXB0ZXJzIHN1Y2ggYXM6IEdldHRpbmcgc3RhcnRlZCwgRmlsZXMsIEdVSSwg
XHBhcg0KU2VyaWFsIGNvbW11bmljYXRpb24sIFdlYiBkZXNpZ24sIFNjaWVudGlmaWMgY29tcHV0
aW5nLCAuLi4gYW5kIGFueXRoaW5nIFxwYXINCmVsc2UgdGhhdCBwZW9wbGUgd2FudCBhbmQgbmVl
ZC5ccGFyDQpccGFyDQpTbyBsZXRzIHN0YXJ0IHdpdGggeW91ciBkb2N1bWVudGF0aW9uIGluIEVT
UEUyMSBidXQgbm90IHVzZSB0aGF0IG5hbWUuIFxwYXINCkl0IG5lZWRzIHRvIGJlIGNhbGxlZCBz
b21ldGhpbmcgbGlrZTogQmxhY2tCb3ggZG9jdW1lbnRhdGlvbiwgb3IgXHBhcg0KRGV2ZWxvcG1l
bnQgTWFudWFsLCBvciBDb21wb25lbnQgUGFzY2FsIFVzZXJzIGd1aWRlLCBvciAuLi5ccGFyDQpc
cGFyDQpNeSBwcmVmZXJlbmNlIGZvciB0aGUgc3RydWN0dXJlIG9mIGVhY2ggJ2FydGljbGUnIG9m
IHRoZSBHdWlkZSBpc1xwYXINClxwYXINCkFydGljbGUgVGl0bGUgKGUuZy4gRmlsZXMpXHBhcg0K
QXJ0aWNsZSBTdW1tYXJ5IChhIHBhcmFncmFwaCBvciB0d28pXHBhcg0KQXJ0aWNsZSBFeGFtcGxl
IGNvZGUgKHdvcmtpbmcgc25pcHBldClccGFyDQpBcnRpY2xlIEhvdGxpbmtzIHRvIG90aGVyIEJs
YWNrQm94IGRvY3VtZW50aW9uLlxwYXINClxwYXINCkVQU0UyMSBkb2VzIGhhdmUgbmljZSBob3Rs
aW5rcyB0byBjb2RlIGFuZCBkb2N1bWVudGF0aW9uLiAgTXkgcHJlZmVyZW5jZSBccGFyDQp3b3Vs
ZCBiZSB0byBoYXZlIGFzIG11Y2ggYXMgcG9zc2libGUgd2l0aGluIGEgc2luZ2xlIGRvY3VtZW50
IChzZWxmIFxwYXINCmNvbnRhaW5lZCkuXHBhcg0KXHBhcg0KTGV0IG1lIGVkaXQgc2xpZ2h0IG9u
ZSBzbWFsbCBzZWN0aW9uIG9mIEZ5b2RvcidzIGRvY3VtZW50YXRpb24gd2l0aGluIFxwYXINCnRo
ZSBFcHNlMjFPYngwSGVsbG8gZmlsZS5ccGFyDQpccGFyDQpPcmlnaW5hbCBmb3JtOlxwYXINCiJQ
cm9ncmFtcyB3cml0dGVuIGluIENvbXBvbmVudCBQYXNjYWwgY29uc2lzdCBvZiBvbmUgb3Igc2V2
ZXJhbCBtb2R1bGVzLlxwYXINCkluIHRoaXMgY2FzZSB3ZSBoYXZlIGEgbW9kdWxlIHdpdGggb25l
IHByb2NlZHVyZSBEby4iXHBhcg0KXHBhcg0KUmVwbGFjZSB3aXRoOlxwYXINCiJQcm9ncmFtcyB3
cml0dGVuIGluIENvbXBvbmVudCBQYXNjYWwgY29uc2lzdCBvZiBvbmUgb3Igc2V2ZXJhbCBtb2R1
bGVzLlxwYXINCkEgbW9kdWxlIGlzIGEgc3ludGFjdGl2ZSBwaWVjZSBvZiB0ZXh0IGluIGEgZmls
ZS4gIEl0cyBjb21waWxlZCBmb3JtIFxwYXINCihhbHNvIGNhbGxlZCBhIG1vZHVsZSkgaXMgYSBi
aW5hcnkgY2h1bmsgdGhhdCBpcyBkeW5hbWljYWxseSBicm91Z2h0IFxwYXINCmludG8gbWVtb3J5
IGF0IHJ1biB0aW1lIGFuZCBjYW4gYmUgcmVsZWFzZSBmcm9tIG1lbW9yeSB3aGVuIG5vIG90aGVy
IFxwYXINCm1vZHVsZSBkZXBlbmRzIHVwb24gaXQuXHBhcg0KXHBhcg0KU3ludGFjdGljYWxseSBv
bmUgdXNlcyB0aGUgd29yZHMgTU9EVUxFIGFuZCBFTkQgdG8gZGVsaW1pdCB0aGUgbW9kdWxlOlxw
YXINClxwYXINCk1PRFVMRSBteU1vZHVsZU5hbWU7XHBhcg0KLi4uXHBhcg0KRU5EIG15TW9kdWxl
TmFtZS5ccGFyDQpccGFyDQp3aGVyZSAuLi4gcmVwcmVzZW50cyB0aGUgdGV4dHVhbCBjb2RlIG9m
IHRoZSBib2R5IG9mIHRoZSBtb2R1bGUuXHBhcg0KIlxwYXINClxwYXINCk5vdywgaWYgSSB3ZXJl
IGFjdHVhbGx5IG1vZGlmeWluZyBGeW9kb3IncyBkb2N1bWVudGF0aW9uIEkgd291bGQgZXhwZWN0
IFxwYXINCnRoZXJlIHRvIGJlIGFuIGVkaXRvciAob3RoZXIgdGhhbiBGeW9kb3Igb3IgbXlzZWxm
KSB3aG8gd291bGQgYWNjZXB0IG9yIFxwYXINCnJlamVjdCBteSBtb2RpZmljYXRpb24gb3IgZXZl
biBtb2RpZnkgbXkgbW9kaWZpY2F0aW9ucyBhbmQgcHV0IHRoZW0gaW50byBccGFyDQphIHdvcmtp
bmcgZG9jdW1lbnQgdGhhdCBldmVyeW9uZSBlbHNlIGNhbiBzZWUgYW5kIGFkZGl0aW9uYWxseSBj
b21tZW50IFxwYXINCm9uIG9yIG1vZGlmeS5ccGFyDQpccGFyDQpMZXQncyBrZWVwIHRoaXMgZ29p
bmcuXHBhcg0KXHBhcg0KLURvdWdccGFyDQpccGFyDQpGeW9kb3IgVGthY2hvdiB3cm90ZTpccGFy
DQo+IEFjdHVhbGx5LCB3aGF0IFJleCBzdWdnZXN0cyBpcywgbG9naWNhbGx5IHNwZWFraW5nLCBh
biBleHRlbnNpb24gb2YgdGhlIGVmZm9yIFxwYXINCj4gd2l0aCB0aGUgRVNQRTIxIHBhY2thZ2Ug
d2hpY2ggaXMgb3BlbiB0byBhbnkgZXh0ZW5zaW9uIG9mIHRoaXMga2luZC5ccGFyDQo+IFRoZXJl
IGlzIGFuIGludHJvZHVjdGlvbiBhbHJlYWR5IHRoZXJlLCBhbmQgSSBob3BlIHRvIGFkZCBhIGNv
dXBsZSBvZiBzaW1wbGUgbGVzc29ucyBvbiBJL08gc29vbi5ccGFyDQo+IFRoYXQncyBhbHJlYWR5
IGEgZnJhbWV3b3JrLlxwYXINCj4gXHBhcg0KPiBBbmQgdGhlIHBhY2thZ2UgdGFyZ2V0ZWQgZXhh
Y3RseSB0aGUgYXVkaWVuY2UgUmV4IGhhcyBpbiB2aWV3LCBpZiBJIHVuZGVyc3RhbmQgaGltIGNv
cnJlY3RseS5ccGFyDQo+IFxwYXINCj4gUHJvY2VlZGluZyBpbiBzbWFsbGVyIHNwZWNpZmljIHN0
ZXBzIG1pZ2h0IGJlIG1vcmUgcHJlZmVyYWJsZSB0aGFuIGEgYmlnIG5ldyBwcm9qZWN0LlxwYXIN
Cj4gXHBhcg0KPiBDaGVlcnNccGFyDQo+IEZ5b2RvclxwYXINCj4gXHBhcg0KPiBccGFyDQo+IFRo
ZSBwYWNrYWdlIEVQU0UtMjEgbWF5IGJlIGEgc3RhcnRpbmcgcG9pbnRccGFyDQpccGFyDQotLS0g
QmxhY2tCb3hccGFyDQotLS0gc2VuZCBzdWJqZWN0IEhFTFAgb3IgVU5TVUJTQ1JJQkUgdG8gYmxh
Y2tib3hAb2Jlcm9uLmNofX0AU1BFMjE/ICBXZQ==


----boundary-LibPST-iamunique-1307241236_-_---
Received on Sat Mar 19 2005 - 06:13:35 UTC

This archive was generated by hypermail 2.3.0 : Thu Sep 26 2013 - 06:28:21 UTC