Index: openacs-4/packages/acs-core-docs/www/xml/engineering-standards/filenaming.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/engineering-standards/filenaming.xml,v diff -u -r1.7 -r1.8 --- openacs-4/packages/acs-core-docs/www/xml/engineering-standards/filenaming.xml 27 Oct 2014 16:39:31 -0000 1.7 +++ openacs-4/packages/acs-core-docs/www/xml/engineering-standards/filenaming.xml 7 Aug 2017 23:47:54 -0000 1.8 @@ -33,7 +33,7 @@ -Under the page root (and the template root if using the Style package): +Under the page root: @@ -47,14 +47,14 @@ -For example, the page to erase a user's portrait from the database is +For example, the page to erase a user's portrait from the database is /admin/users/portrait-erase.tcl. However, modules typically deal with only one primary type of object - e.g., -the Bookmarks module deals mainly with bookmarks - and so action-type files in modules don't need to be specified by the object they act on. Example: the user pages +the Bookmarks module deals mainly with bookmarks - and so action-type files in modules don't need to be specified by the object they act on. Example: the user pages for the Bookmarks module live in the /bookmarks/ directory, and so there is no need to name the bookmark editing page with a redundant url: /bookmarks/bookmark-edit.tcl. Instead, we omit the object type, and use this convention: @@ -73,7 +73,7 @@
-one.extension +one.extension
@@ -179,7 +179,7 @@ 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. @@ -261,9 +261,9 @@ # www/register/user-login-2.tcl ad_page_contract { - Verify the user's password and issue the cookie. + Verify the user's password and issue the cookie. - @param user_id The user's id in users table. + @param user_id The user's id in users table. @param password_from_from The password the user entered. @param return_url What url to return to after successful login. @param persistent_cookie_p Specifies whether a cookie should be set to keep the user logged in forever. @@ -286,7 +286,7 @@ 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 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, @@ -297,7 +297,7 @@ ad_page_variables flags. There are new flags: trim, notnull and -optional. They do what you'd expect; values will not be +optional. They do what you'd expect; values will not be trimmed, unless you mark them for it; empty strings are valid input, unless you specify notnull; and a specified variable will be considered required, unless you declare it optional. @@ -323,7 +323,7 @@ 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 -ad_page_contract. Don't forget to put the @cvs-id in +ad_page_contract. Don't forget to put the @cvs-id in there. Here is an example of using ad_library: @@ -350,7 +350,7 @@ -- path relative to the ACS root directory -- --- brief description of the file's purpose +-- brief description of the file's purpose -- -- author -- created @@ -415,7 +415,7 @@ resource (namely, a database handle) for an unpredictable amount of time while sending packets back to the browser, and so it should be avoided in most cases. (On the other hand, for a page that requires an -expensive database query, it's better to call +expensive database query, it's better to call ad_return_top_of_page