[binarycloud-cvs-commit] cvs: r2 /binarycloud/docs/dev R2Classes.txt

[alex <bin...@li...>]

alex		Sun Sep  9 00:36:47 2001 EDT

  Modified files:              
    /r2/binarycloud/docs/dev	R2Classes.txt 
  Log:
  Added the naming conventions.
  
  
Index: r2/binarycloud/docs/dev/R2Classes.txt
diff -u r2/binarycloud/docs/dev/R2Classes.txt:1.1 r2/binarycloud/docs/dev/R2Classes.txt:1.2
--- r2/binarycloud/docs/dev/R2Classes.txt:1.1	Sat Sep  8 23:57:11 2001
+++ r2/binarycloud/docs/dev/R2Classes.txt	Sun Sep  9 00:36:47 2001
@@ -195,3 +195,37 @@
 		msg/
 
 *Note how the build tree contains many more directories, like ent, msg, etc. This is because make will use the naming conventions below to move files from module and other directories into a single location. That means files must not have naming conflicts, etc - but it keeps the source tree, and the installation process simple.
+
+
+Naming 'special' files for processing by make:
+---------------------
+-Something.ent.xml = entity xml definition
+
+-Something.qry.xml = query xml definition
+
+-Something.form.xml = form xml definition
+
+-Something.list.xml = list xml definition
+
+-Something.wizard.xml = wizard xml definition
+
+-Something.calendar.xml = calendar xml definition
+
+-Something.email.xml = email xml definition
+
+-Something.fax.xml = fax xml definition
+
+-Something.pdf.xml = pdf xml definition
+
+-Something.role.xml = role xml definition
+
+-SomeValidator.php = 'Validator' means this file will be placed in 
+binarycloud/mgr/validators from a module directory.
+
+-SomeProcessor.php = 'Processor' means this file will be placed in binarycloud/mgr/processors from a module directory
+
+-Something.php.xml = this file will be processed from xml to php using default xml2php rules and written out in the same location in the build tree with the extension .php.
+
+-Something.lang.xml will be used by LangKeyer at make-time to key in nagive-language strings into source files.
+
+-Something.lang_code.php (i.e. Something.de.php or Something.en.php) means the file will replace Something.php in same directory when the language code is the same as lang_code. Useful for writing the same module that does different things based on the location/language.