ACS File Naming and Formatting Standards

By Michael Yoon and Aurelius Prochazka

-======= -ACS File Naming and Formatting Standards

Prev	Chapter 11. Engineering Standards	Next

ACS File Naming and Formatting Standards

By Michael Yoon and Aurelius Prochazka

->>>>>>> 1.46 +ACS File Naming and Formatting Standards

Prev	Chapter 12. Engineering Standards	Next

ACS File Naming and Formatting Standards

By Michael Yoon and Aurelius Prochazka

OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff.

@@ -100,11 +95,7 @@ This can be at the top or bottom of the file.

Using ad_page_contract

For non-library Tcl files (those not in the private Tcl directory), -<<<<<<< eng-standards-filenaming.html -use ad_page_contract -======= use ad_page_contract ->>>>>>> 1.46 after the file path comment (this supersedes set_the_usual_form_variables and ad_return_complaint). Here is an example of using ad_page_contract, which serves both documentation and page input @@ -150,11 +141,7 @@ set_the_usual_form_variables. The use of bind variables makes such previous variable syntax obsolete.

Using ad_library

-<<<<<<< eng-standards-filenaming.html -For shared Tcl library files, use ad_library after -======= For shared Tcl library files, use ad_library after ->>>>>>> 1.46 the file path comment. Its only argument is a doc_string in the standard (javadoc-style) format, like ad_page_contract. Don't forget to put the @cvs-id in @@ -178,11 +165,7 @@ -- author -- created -- -<<<<<<< eng-standards-filenaming.html --- $Id$ -======= -- $Id$ ->>>>>>> 1.46

Of course, replace "--" with the comment delimiter appropriate for the language in which you are programming. @@ -245,8 +228,4 @@

Tcl Library Files

Further standards for Tcl library files are under discussion; we plan to include naming conventions for procs. -<<<<<<< eng-standards-filenaming.html

($Id$)

Prev	Home	Next
Constraint naming standard	Up	PL/SQL Standards

docs@openacs.org

View comments on this page at openacs.org -======= -

($Id$)