- OpenACS docs are written by the named authors, but may be edited
- by OpenACS documentation staff.
-
+ OpenACS docs are written by the named authors, but may be edited
+ by OpenACS documentation staff.
+
To ensure consistency (and its collateral benefit, maintainability),
we define and adhere to standards in the following areas:
File Nomenclature
@@ -37,7 +37,7 @@
For example, the page to view the properties of an
ecommerce product is
/ecommerce/product.tcl.
-
For naming files in a page flow, use the convention:
foobar.extension (Step 1)
foobar-2.extension (Step 2)
...
foobar-N.extension (Step N)
+
For naming files in a page flow, use the convention:
foobar.extension (Step 1)
foobar-2.extension (Step 2)
...
foobar-N.extension (Step N)
where foobar is determined by the above
rules.
@@ -94,7 +94,7 @@
</p>
This can be at the top or bottom of the file.
-
Using ad_page_contract
+
Using ad_page_contract
For non-library Tcl files (those not in the private Tcl directory),
use ad_page_contract
after the file path comment (this supersedes set_the_usual_form_variables and
@@ -141,7 +141,7 @@
QQvariables, which were automatically created by ad_page_variables and
set_the_usual_form_variables. The use of bind variables makes such
previous variable syntax obsolete.
-
Using ad_library
+
Using ad_library
For shared Tcl library files, use ad_library after
the file path comment. Its only argument is a doc_string in the
standard (javadoc-style) format, like
@@ -156,7 +156,7 @@
@author John Doe (jdoe@arsdigita.com)
@cvs-id file-standards.html,v 1.2 2000/09/19 07:22:45 ron Exp
}
-
Non-Tcl Files
+
Non-Tcl Files
For SQL and other non-Tcl source files, the following file header structure is recommended:
-- path relative to the ACS root directory
@@ -229,6 +229,4 @@
Tcl Library Files
Further standards for Tcl library files are under discussion; we plan to
include naming conventions for procs.
-