[Gambas-devel] Example project metadata

[Tobias Boege]

Hi Benoit,

the last couple of days I implemented Fabien's approach[0] to better example
projects - halfways.

There is a patch to the IDE attached which changes the following:

- Project.module: Add Niveau and Tags Public variables. An ".example" file
  in the project directory makes a project an "example project". If it is
  missing, it is not an example project. The data is written in
  WriteProject() and read in ReadProject() - if the .example file exists;
- FCreateProject: New "Example project" CheckBox in the "Options" and a new
  wizard step to enter example Niveau and Tags. The project creator is
  forced to write a project description here, too. If the CheckBox is
  ticked, the ".example" file is created here;
- FProjectProperties: CheckBox to make/unmake the project an "example"
  project and a new TabPanel page to manipulate Niveau and Tags. Note that
  this TabPanel page is only visible when the project is an example project.
  That new page is not very populated - not to say it looks ugly. The
  aforementioned CheckBox may also be misplaced but I didn't want to mess
  around with the usual layout. Any ideas? Based on the value of the
  CheckBox, the ".example" file is created or delete here.

Please tell me what you don't like.

What's missing?

- Displaying the niveau and tags in FWelcome and FOpenProject;
- Sorting examples by niveau;
- Filtering by tags;
- The gambasdoc.org page with official example guidelines (just a few notes
  I planned).

I couldn't get behind the sources of FWelcome and FOpenProject yet. Maybe a
new control to display examples which is shared by the two forms suits
better.

As for the examples themselves, I have gone through 1/3 of them which I
understand (this excludes, e.g. DBus, MySQLExample, ReportExample). Mainly I
fixed these things:

- Naming conventions;
- Comments;
- Style and educational things (based on MHO).

We could also just leave things as-is and I just commit the overhauled
examples and not the changes to the IDE if you think the IDE stuff could not
be a good idea at all.

Regards,
Tobi

[0] http://sourceforge.net/mailarchive/message.php?msg_id=30788433
-------------- next part --------------
A non-text attachment was scrubbed...
Name: gambas3-rev5709~gambas3-3.4.90.patch
Type: text/plain-8bit
Size: 13871 bytes
Desc: not available
URL: <http://lists.gambas-basic.org/pipermail/devel/attachments/20130704/8b513ee7/attachment.bin>