Index: openacs-4/packages/acs-core-docs/www/eng-standards-filenaming.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/eng-standards-filenaming.html,v diff -u -r1.8.2.1 -r1.8.2.2 --- openacs-4/packages/acs-core-docs/www/eng-standards-filenaming.html 24 Nov 2002 21:29:17 -0000 1.8.2.1 +++ openacs-4/packages/acs-core-docs/www/eng-standards-filenaming.html 29 Mar 2003 20:44:52 -0000 1.8.2.2 @@ -1,5 +1,5 @@ -ACS File Naming and Formatting Standards

ACS File Naming and Formatting Standards

By michael@arsdigita.com and +ACS File Naming and Formatting Standards

ACS File Naming and Formatting Standards

By michael@arsdigita.com and aure@arsdigita.com


OpenACS docs are written by the named authors, but may be edited by OpenACS documentation staff. @@ -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,4 +229,4 @@
     

    Tcl Library Files

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

    ($Id$)
    View comments on this page at openacs.org
    +

    ($Id$)
    View comments on this page at openacs.org