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
For example, the page to erase a user's portrait from the @@ -42,9 +41,7 @@
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-
For example, the page to view one bookmark is /bookmarks/one.tcl. Note that no verb is
+convention:
one.extension
For example, the page to view one bookmark is /bookmarks/one.tcl. Note that no verb is
necessary for display-type files.
Otherwise, if the object to be displayed is not the primary @@ -84,7 +81,7 @@
File names also appear within pages, as linked URLs and form
-targets. When they do, always use abstract URLs (e.g., user-delete instead of user-delete.tcl), because they enhance
+targets. When they do, always use abstract URLs (e.g., user-delete instead of user-delete.tcl), because they enhance
maintainability.
Similarly, when linking to the index page of a directory, do not
explicitly name the index file (index.tcl, index.adp, index.html, etc.). Instead, use just the
directory name, for both relative links (subdir/) and absolute links (/top-level-dir/). If linking to the
@@ -175,7 +172,7 @@
-- author
-- created
--
--- $Id: eng-standards-filenaming.html,v 1.48.2.10 2016/06/21 07:44:36 gustafn Exp $
+-- $Id$
Of course, replace "--" with the comment delimiter
appropriate for the language in which you are programming.
Further standards for Tcl library files are under discussion; we -plan to include naming conventions for procs.