Theia installation has been updated - September 10, 2011
Theia
Theia's naming conventions « documentation » for developers
icon
Please help strengthen our documentation by rating items on how helpful they are, and by suggesting documentation, that we are missing and should focus on next.
posted on 16:54 - 26 December 2009 | posted by Lev
last modified on 14:29 - 23 December 2009 | last modified by Lev

To give keep code in Theia respectable and uniform, there are various naming conventions, which range from how functions, classes, modules, CSS and javascript functions are named.

Please note that there may be some aspects of the code in Theia that do not follow these conventions right now, which is the result of older code still being used which hasn't been updated yet. All new code introduced into Theia should contain these naming conventions, though if you (as a developer) build off of Theia you can name your elements however you desire and simply use these guidelines to understand how we do things.


Functions

All function names (which are not a part of a class) are written in all lowercase characters and use underscores to separate key words.

Here are some examples:

compare_versions

is_protected


Classes

All class names (which also includes any methods/functions of a class) are written in camel casing and do not contain spaces. The first letter of the class name (and method/function names of a class) are uppercase, unlike Javascript camel casing.

Here are some examples:

Chat

ActivityPoints


Modules

Though module names are not strictly bound to any aspect of Theia's coding, they still use their own convention, as do any references to these module names (in Javascript functions or CSS class names for example). Module names are written in all lowercase characters and do not contain spaces or underscores.

Here are some examples:

mitem

feditor


CSS Classes

For all CSS classes that do not belong to a specific module, they are written in all lowercase characters, with underscores separating keywords.

Here are some examples:

form_collapsed

over_caption_main

For CSS classes that belong to a specific module, they are written in all lowercase characters, with underscores separating keywords. Only, unlike the non-module-oriented class names, these classes are pre-pended with the module name and a hyphon (-).

Here are some examples:

feditor-input_select

mitem-row_right


Javascript Functions

All Javascript functions that do not belong to a specific module are written in camel casing, without spaces. Unlike the the camel casing used with classes and methods, the first character of a Javascript function name is lowercase.

Here are some examples:

updateCountDownChars

setCookie

For Javascript functions that do belong to a specific module, they are written in a similar manner as above, only they are pre-pended with the module's name.

Here are some examples:

mystatusDelete

rateVote

post reply
Bookmark item @
bookmarkbookmarkbookmarkbookmarkbookmark