[play.webdev] Atomz Best Practices

From: "Chris McGrath (PLAY)" <cmcgrath@xxxxxxxxxxxxxx>
To: "'play.webdev@xxxxxxxxxxxxx'" <play.webdev@xxxxxxxxxxxxx>
Date: Tue, 14 Oct 2003 17:00:58 -0700

Hiya,

We're maintaining a list of Best Practices for Atomz development. If you
ever think of anything that should be added, send it to this mailing list.


Best Practices: Atomz Development


If a page element is optional, surround it with <publish-if-not-empty>. This
is especially important on global templates.


Include stylesheets on all pages. Surround it with
<publish-if-not-publishing> so it only shows up on the Atomz server. This
will make page components--headers, footers, nav bars, etc.--look like the
end product.


Use a global include for pre-defining commonly used elements. Use the file
/templates/_global_includes.pbt. Define things like clear gif spacers,
horizontal rules, etc.


Use pub:/ for the paths of all images and hyperlinks. For example,
pub:/_img/spacer.gif. pub:/ rewrites your URLs so that the path will be
correct even if you move something into a new directory. It is especially
important to use pub:/ on templates or on included files, which may be
referenced in several different directories.


Follow this pattern for naming tasks:

[Verb] [noun] - [modifiers]

In other words, [Create|Edit|Delete|Upload] [page|file|navigation|footer] -
[Top level|2nd level|Tech section|Finance section]

Examples:
   Create page - Vertical layout
   Create page - Horizontal layout
   Edit footer
   Edit header
   Upload files
   Upload PDFs, Word docs
   Edit navigation - Top level
   Edit navigation - 2nd level

Do not use words like 'a', 'an' or 'the'
Keep it very short
Group similar type tasks together--all 'Create' tasks together, then all
'Edit' tasks, etc.
If there are more than 6 or 8 tasks, break them into directories by site
structure
Delete all the pre-defined Atomz tasks


Follow this pattern for your directory structure:
/_img/
/_img/user_uploaded/
/_img/backgrounds/
/_img/nav/
/_inc/
/_docs/
/_css/
/_js/
/templates/
/templates/DO_NOT_MODIFY/  (for Playground Web Team only)


In Publish Settings, don't allow Administrators or Editors to edit Publish
settings at time of publish. We need admins to think carefully about editing
these settings. Make them go specifically to the Publish settings area.


c h r i s  m c g r a t h
internet systems analyst

  p l a y g r o u n d
 division of intrawest

www.greatplaygrounds.com
 telephone 604.675.7532

[play.webdev] Atomz Best Practices

Other related posts: