Board Logo
« Building Blocks - mission statement - ? »

Welcome Guest. Please Login or Register.
Nov 20th, 2017, 10:24pm


Conforums Terms of Service | Membership Rules | Home | Search | Recent Posts | Notification | Format Your Message | Installation FAQ


« Previous Topic | Next Topic »
Pages: 1  Notify Send Topic Print
 thread  Author  Topic: Building Blocks - mission statement - ?  (Read 1677 times)
tsh73
JB-Supporter


member is offline

Avatar




PM

Gender: Male
Posts: 3614
xx Building Blocks - mission statement - ?
« Thread started on: Aug 22nd, 2010, 1:34pm »

Could someone explain me:
- what is the goal of "Building Blocks" section in Wiki?
("mission statement")
- how it supposed to be different from JB helpfile?
(now I just fail to see much difference)
- how detailed pages supposed to be (should it include every usage possible, tricks discovered, bugs related)?
User IP Logged

Q: "And if I took your codes and compile them, and sell them for a profit"?
A: Go ahead. I had my share of good then I coded it for fun, if you can make better use of it - please do.
(enjoying JB 1.01 on WinXP, netbook and desktop)
Facundo
Moderator
ImageImageImageImageImage


member is offline

Avatar




PM

Gender: Male
Posts: 1301
xx Re: Building Blocks - mission statement - ?
« Reply #1 on: Aug 22nd, 2010, 3:48pm »

Quote:
Building Blocks are small, runable pieces of code that demonstrate a single statement, function, method, or idea. They must be well-commented.


I think that the Building Blocks shouldn't go into detail. When Stefan told me about this project, I searched for the definition of Building Blocks online, but better I searched for images:
Image Search. So what came to mind was: something to start building with, the basics of each command, the ABC.
Then I visualized that popup that some IDE have, which shows you how to write a command or Function, and a little explanation.
Of course it could serve as a online help file as well.


Some directions:

Some pages have a Hints section, that is the place to write something like 'do this' and 'don't do this'.

The not officially supported 'features' should not be in the Building Blocks pages.

Taking the description from the help file is allowed. Except when the description needs to be updated.


I know Stefan has a better explanation regarding your queries.
User IP Logged

cundo aka MSlayer
jaba
Global Moderator
ImageImageImageImageImage


member is offline

Avatar




PM

Gender: Male
Posts: 1049
xx Re: Building Blocks - mission statement - ?
« Reply #2 on: Aug 22nd, 2010, 4:39pm »

In response to comments regarding the content on the BB wiki, I've edited the BB___DATA page. Anyone who is interested, please review this last edit and compare with the one before. Maybe simpler is better?
Thanks,
Jack
User IP Logged

JACK - Windows 8.1 64-bit; 2.5 GHz Intel i3 processor; 6.00 GB RAM;
Stefan Pendl
Administrator
ImageImageImageImageImage


member is offline

Avatar

Let's talk JB ...


Homepage PM

Gender: Male
Posts: 3711
xx Re: Building Blocks - mission statement - ?
« Reply #3 on: Aug 22nd, 2010, 5:32pm »

on Aug 22nd, 2010, 1:34pm, tsh73 wrote:
Could someone explain me:
- what is the goal of "Building Blocks" section in Wiki?
("mission statement")

The goal is to have a brief description of the keywords of JB, which can be easily edited to include the latest information about the keywords.
As already stated, the RB building blocks were used as an inspiration, but the direction can be a different one.

Quote:
- how it supposed to be different from JB helpfile?
(now I just fail to see much difference)

The help file is static and many people are struggling to use it successfully.
The building blocks can be changed easily and updated to included the latest information.
The FILES command for instance could include a recursive tree listing procedure as a useful function.

Quote:
- how detailed pages supposed to be (should it include every usage possible, tricks discovered, bugs related)?

How detailed pages should get is not yet defined and the future will show, what needs to be included and what needs to be separated from them.

I would suggest to start out simple and add to the pages slowly.
In same cases it is even better to have a separate page and only a link to it from the BB page.

If the page does not get to bloated, then we could split the examples into beginner, intermediate and advanced; but this will be a by-page-decision.



Finally building blocks should be simple and easy to understand, so programmers of any level can update/refresh their knowledge.
User IP Logged

Stefan - Homepage

Remember to read the forum rules board wink

Just BASIC 1.01, Windows 10 Professional x64, Intel Core i7-4710MQ 2.5GHz, 16GB RAM
Pages: 1  Notify Send Topic Print
« Previous Topic | Next Topic »

Conforums Terms of Service | Membership Rules | Home | Search | Recent Posts | Notification | Format Your Message | Installation FAQ

Donate $6.99 for 50,000 Ad-Free Pageviews!

| |

This forum powered for FREE by Conforums ©
Sign up for your own Free Message Board today!
Terms of Service | Privacy Policy | Conforums Support | Parental Controls