ACS File Naming and Formatting Standards

By Michael Yoon and Aurelius Prochazka

+ +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.

@@ -64,7 +65,7 @@ just the directory name, for both relative links (subdir/) and absolute links (/top-level-dir/). If linking to the directory in which -the page is located, use the empty string (""), which +the page is located, use the empty string (""), which browsers will resolve correctly.

File Headers and Page Input

Include the appropriate standard header in all scripts. The first @@ -166,7 +167,7 @@ -- -- $Id$

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

Page Construction

Construct the page as one Tcl variable (name it @@ -177,25 +178,25 @@

For example:

-set page_content "[ad_header "Page Title"]
+set page_content "[ad_header "Page Title"]
 
 <h2>Page Title</h2>
 
 <hr>
 
 <ul>
-"
+"
 
 db_foreach get_row_info {
     select row_information 
     from bar
 } {
-    append page_content "<li>row_information\n"
+    append page_content "<li>row_information\n"
 }
 
-append page_content "</ul>
+append page_content "</ul>
 
-[ad_footer]"
+[ad_footer]"
 
 doc_return 200 text/html $page_content

@@ -213,7 +214,7 @@ the query is running.)

Local procedures (i.e., procedures defined and used only within one -page) should be prefixed with "module_" and +page) should be prefixed with "module_" and should be used rarely, only when they are exceedingly useful.

All files that prepare HTML to display should end with [ad_footer] or