home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 2007 September / maximum-cd-2007-09.iso / Assets / data / AssaultCube_v0.93.exe / docs / cuberef.txt < prev    next >
Encoding:
Text File  |  2007-05-03  |  1.9 KB  |  38 lines
  1.   CubeRef Recommendations
  2.   
  3.     General
  4.       * see the xml schemas for details on the elements
  5.       * do not use any xml editor that rapes the formatting
  6.       * do not write tutorial-like content, this is a reference. therefore focus on the 
  7.         technical description of identifiers as a single unit
  8.       * use a CDATA section for content that requires special characters
  9.   
  10.     Sections
  11.       * a section represents a group of identifiers
  12.       * chose sections based on the usage areas of identifiers
  13.   
  14.       Identifiers
  15.         * an identifier represents a command, variable or an alias that is available through cubescript
  16.         * identifiers must be unique across sections
  17.         * custom aliases located in default.cfg must not be documented
  18.         
  19.         Description
  20.           * provide a short an concise description of what the identifier does or represents, omit details
  21.       
  22.         Arguments
  23.           * use a single character token if possible
  24.           * keep the argument description simple, write a remark for details
  25.           * write restricted integer values in the way of 0..3 (0 to 3) and 1..* (0 to 'infinite')
  26.           * if no restrictions apply to values, specify the pseudo data type
  27.           * if the meaning of the arguments depends on other arguments, create multiple identifiers
  28.             with the name containing the depending argument. example: 'newent type v1 v2 v3 v4' depends 
  29.             on the type, therefore it's split to 'newent light', 'newent ammo', etc.
  30.             
  31.         Remarks
  32.           * describe details and special behavior
  33.           * give _short_ examples if needed
  34.           
  35.         References
  36.           * refer to other identifiers that are _directly_ related
  37.           * refer to _official_ online sources like the wiki
  38.           * name other (offline) sources without url or identifier