| Prev | Chapter 12. Engineering Standards | Next |
|---|
By Michael Yoon and Aurelius Prochazka
+@@ -10,7 +10,7 @@
displaying objects and their properties
manipulating or acting on objects in some way (by creating, editing, linking, etc)
housing procedures, packages, data models and other prerequisite code Essentially, we want our files named in a fashion that reflects their purpose.
-Under the page root (and the template root if using the Style package): +Under the page root:
For naming files that enable a specific action on an object, use this format:
object-verb.extension
@@ -26,7 +26,7 @@
Thus, the page to edit a bookmark is /bookmarks/edit.tcl.
For naming files that display the properties of a primary object - such as the bookmark object within the bookmark module - use this convention:
-
one.extension+one.extension
For example, the page to view one bookmark is
/bookmarks/one.tcl. Note that no verb is necessary for display-type files.
@@ -55,7 +55,7 @@
ad-description-procs.tcl
File names also appear within pages, as linked URLs and
-form targets. When they do, always use abstract
+form targets. When they do, always use abstract
URLs (e.g., user-delete instead of
user-delete.tcl), because they enhance maintainability.
@@ -121,7 +121,7 @@
Salient features of ad_page_contract:
A mandatory documentation string is the first argument. This has -the standard form with javadoc-style @author, @cvs-id, etc, and should contain a short description of the recieved variables and any necessary explanations.
The second argument specifies the page +the standard form with javadoc-style @author, @cvs-id, etc, and should contain a short description of the received variables and any necessary explanations.
The second argument specifies the page inputs. The syntax for switches/flags (e.g. multiple-list, array, etc.) uses a colon (:) followed by any number of flags separated by commas (,), @@ -219,4 +219,4 @@