Naming conventions
From Cyclone3 Wiki
Standards for naming the addon modules and their respective support files
Contents |
Servicetypes
Example:
l_400-article_clean.pub.type
The name should be compiled as follows:
- l - remember globalization of modules? same applies for type files, you just use l (local), g (global) and m (master)
- 401- - numeric addon representation optional
- article_clean - name, usually beginning with the addon's entity, that is primarily handled by the module
- pub - type of engine, that is used to process the type file pub (publisher - webpages, exports, ...), cron (cron system)
- type - Cyclone3 type file extension
Check out what a servicetype is.
Servicetype layers
Example:
default.cml_gen
The name should be compiled as follows:
- default - name, it is wise to name the layer files according to what they contain. In this case it's default, as it is the default layer for every page, but for a section type layer, you'd rather use section than default2
- cml_gen - Cyclone3 type file extension
Check out what a servicetype layer is.
Supermodule
Example:
401-article_view.lite.smdl
The name should be compiled as follows:
- 401 - numeric addon representation
- article_view - name, usually beginning with the addon's entity, that is primarily handled by the supermodule
- lite - version, usually a choice of superlite, lite, standard and enterprise (in older applications, 0 was used by default)
- smdl - Cyclone3 supermodule extension
Check out what a supermodule is.
Modules
Example:
401-article_view.lite.mdl
The naming is exactly the same as for the supermodules. Check out what a module is.
Module templates
Example:
401-article_view.lite.homepage.xsgn 401-article_view.tpl.homepage.tpl
The name should be compiled as follows:
- 401 - numeric addon representation
- article_view - name of the handling module
- lite - version of the handling module
- homepage - xsgn name, if no specific -xsgn var is specified/desired for the given module in type template, it should be default, to let the system search for it automatically
- xsgn or tpl - Cyclone3 module template extension
Check out what a module is.
Module template localizations
Example:
401-article_view.lite.xlng
The name should be compiled as follows:
- 401 - numeric addon representation
- article_view - name of the handling module
- lite - version of the handling module
- xlng - Cyclone3 module localization file extension
Check out what a module template localization is.
Cron modules
Example:
301-user.clean.cron
The name should be compiled as follows:
- 301 - numeric addon representation
- name - name
- lite - version
- cron - Cyclone3 cron module extension
Check out what a cron is.
Designmodules
Example:
23-header.default.sk.dmdl
The name should be compiled as follows:
- 23 - numeric addon representation (usually 0, 21, or 23)
- name - name
- default - xsgn name, if no specific -xsgn var is specified/desired for the given module in type template, it should be default, to let the system search for it automatically
- sk - language (this is automatically requested by the current viewing language, if the language version does not exist, raises a not-found error), can be overridden to all, to load the same dmdl for all languages by explicitly setting the module's language to all as follows:
<VAR id="-xlng" value="all" />
- dmdl - Cyclone3 cron module extension
Check out what a designmodule is.
