Changes between Version 5 and Version 6 of en/doc-guidelines

Timestamp:

Jun 22, 2009, 3:22:49 PM (12 years ago)

Author:

afroxav

Comment:

--

en/doc-guidelines

@@ -17 +17 @@
 
 === Function names ===
-To specify a function name inside a paragraph, surround it with **. This will make the function name bold, and catch the eye easier.
+To specify a function name inside a paragraph, add @@M@ before and @@ after. This will make the function name catch the eye easier.
 {{{
-**jelixClass::function**
-**function** of the jelixClass
+@@M@jelixClass::function@@
+@@M@function@@ of the jelixClass
 }}}
 
 === Jelix terms ===
-All Jelix-specific terms should be in italics. This will separate generic terms from Jelix-specific terms. Surround the terms with //.
+All Jelix-specific terms or components name inside text should stand out a bit. Therefore, they should be surrounded by @@ before and @@ after.
 {{{
-//jelix term//
+@@jelix term@@
+}}}
+
+=== User defined/redefined component ===
+Any jelix component that is defined or redefined by the user inside the application should be surrounded by @@C@ before and @@ after. This does not include function names, which should always follow the function name guide.
+{{{
+@@C@user defined component@@
 }}}
 
@@ -54 +60 @@
  * Use clear variable names. Instead of using a variable called $x, use on called $numberOfResultProcessed.
  * Use !CamelCase. By enforcing a strict naming convention, code can be consistent.
+
+'''The current documentation guideline is frozen. Post any changes you might want to the forums and they will maybe be added.'''