Programming reference

Conventions

The following are the intended coding style guidelines for screem, I probably haven't stuck to them everywhere though.

Indentation & Formating:

Naming styles:

Braces: function braces are as follows function() { } block statement braces, and brackets are as follows if( TRUE ) { } else { } while( TRUE ) { } etc. Line length: lines should be no longer than 80 characters. If a function call is longer then break it up as follows function_call_that_wont_fit( parameter, parameter, paramter_that_would_go_over_80_chars ) If it can't be broken up try removing the spaces after brakets and commas. If it still isn't possible put the entire call on one line.

Tag Tree

As such I have decided that the tag tree will be stored using xml. This will make it very simple to construct the tree as the xml parser can build it, then its just a simple matter of making a GtkCTreeNode for each node in the xml tree.

This will also allow a child depth of more than 1. The widget used will be changed from a GtkTree widget to a GtkCTree widget as well. this will also allow for nodes to have an icon to go with them.

As part of this the plan is as follows: the tag tree will consist of:

[image]

Screem will be distributed with the HTML node and its children as standard. The user can add any other nodes they want, such as javascript, php etc.

Plugins

Screem utilises shared libraries as a plugin system.

If you wish to create a plugin then take a look at the colourWizard, as it is possibly the simplest code.

Helpers

Tasks

The following features that were mentioned in the spec for 0.1 were not implemented:

The missing features from the 0.1 specification should be included in 0.2.x