Markup

LexicalSemanticStandardExampleFinishedProgressTodo

Lexical definitions

Formal lexical definitions are allways written in marked block like this:

This block contains a formal definition

The grammar is losely based on BNF:

foo         ::= bar | fubar [!]...

Semantic definition

Some definitions can not be made on a pure syntactic level. These definitions are intertwined with the more standard lexical defintions. Ocean specifies these with:

known-value : an expression which can be computed during compile time;

Italic words are defined elsewhere.

Standard Library

One specific part of Ocean is always there: the standard libary. It doesn't have its own namespace and for all intends and purposes it is part of Ocean proper, but for the fact that you could write it in Ocean itself.

# Comments are like manuals: a product is not finished without them.

Code Examples

Code examples are allways written in marked block like this:

# This block contains a code example
fub!!!
fubar
fubar!!!!

Conventions are described in these boxes:

Conventions are just that, they are never mandatory. However, all Ocean libraries (should) follow this convention, so they match the default style.

'Finished' items

Any item that will probably not change anymore is indicated by a light blue background.

'Work-in-Progress' items

Any item that will probably change a bit is indicated by a light yellow background.

'Unfinished' items

Any item that is not even close to its final form is indicated by a light red background.