Changes between Version 1 and Version 2 of GUI_-_Coding_Conventions

Timestamp:

Apr 30, 2014, 8:01:28 AM (10 years ago)

Author:

Josh

Comment:

Remove some duplication and increase readability.

GUI_-_Coding_Conventions

@@ -1 +1 @@
 = Overview =
 
-Where possible, we should endeavour to share [wiki:Coding_Conventions Coding Conventions] with the engine programmers.
+Where possible, share the engine [wiki:Coding_Conventions Coding Conventions].
 
 = Naming Conventions =
 
-Use only '''alphanumerics''' (A..Z, a..z, 0-9) and '''underscores''' (_) for object names and parameters. Various special characters are reserved for use as delimiters and markers (particularly semicolons), so it's best not to use anything else.
+Use only '''alphanumerics''' (A..Z, a..z, 0-9) and '''underscores''' (_) for object names and parameters. Various special characters are reserved for use as delimiters and markers (particularly semicolons).
 
-Technically, the hyphen or dash (-) can be used interchangeably with hyphens, but you'll need to reference the string in a different way:
+Technically, the hyphen or dash (-) can be used interchangeably with hyphens, but you'll need to reference the string in a different way. For example:
 
 {{{
-  object.cell_id
+object.cell_id
 }}}
 
@@ -16 +16 @@
 
 {{{
-  object["cell-id"]
+object["cell-id"]
 }}}
-
-For consistency, though, it's best to just stick to alphanumerics and underscores.
 
 = Variable Casing =
 
-Functions, variables, and objects written in JavaScript should be created using ''camelCase capitalisation'' (the first word is in lower case, and any additional words in title-case eg: '''setModifiedFlag()''').
+Functions, variables, and objects written in JavaScript should be created using ''camelCase capitalisation'' (the first word is in lowercase, and any additional words in title-case eg: '''setModifiedFlag()''').
 
-For inherited components, however -- "core XML", exposed engine functions and built-in JS commands -- their own casing will of course need to be maintained in order for the commands to be recognised. These tend to be camelCase or lowercase for the most part. Endeavouring to use camelCase where possible should provide a reasonable middle ground.
+For XML names, use all title-casing. (Eg: '''MyExampleName''')
 
 Example of conventional scripted casing:
 
 {{{
-  <object name="exampleObject"
-          style="myStyle"
-  >
+<object name="ExampleObject" style="ModernStyle">
+        <action on="Press">
+            guiHide(this.name);
+        </action>
+</object>
+}}}
+
+= XML Formatting =
+Some JavaScript operators (like &&) interfere with the XML parser and need to be surrounded with <![CDATA[''someCode'']]>. The above example with CDATA looks like:
+{{{
+  <object name="ExampleObject" style="ModernStyle">
           <action on="Press"><![CDATA[
-                 guiHide (this.name);
+                 guiHide(this.name);
           ]]></action>
   </object>
 }}}
-
-= Formatting =
-
- * Use the "Good Bracketing" specified in [wiki:Coding_Conventions Coding Conventions] ({ } are horizontally aligned).
- * Use meaningful comments and variable names.