NST WUI

From NST Wiki
Revision as of 07:38, 6 March 2007 by Paul Blankenbaker (talk | contribs) (New page: = Overview = == Directory Layout == The following lists the major directories a developer should be aware of when working with the '''NST WUI''' source code: ; '''config/''' : Common co...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Overview

Directory Layout

The following lists the major directories a developer should be aware of when working with the NST WUI source code:

config/ 
Common configuration directory (several @macros() are defined here).
wui/ 
Root directory of the NST WUI (where you run: make).
wui/cgi-bin 
Root directory of CGI source files (bash scripts) making up the NST WUI.
wui/php 
Root directory of PHP source files making up the NST WUI.
include/skins/default/images 
Common (shared) image files.
wui/images 
Image files unique to the NST WUI.
include/skins/default/css 
Common (shared) CSS files.
wui/css 
CSS files unique to the NST WUI.
include/javascript 
Repository of JavaScript files.
include/atmacros 
Formal definition of @macros().
html/include/at 
HTML @macros() (loaded and then "tweaked" by NST WUI specific adjustments ).
wui/include/at 
NST WUI specific adjustments to @macros().
src/include/functions 
Collection of bash functions which will be installed to: "/nstwui/cgi-bin/include" when building the NST WUI.

Coding Tips

Referencing CSS and Image Files

Use the @imageDirUrl() and @cssDirUrl() when referencing image and CSS files. For example:

@p("See the image: @link("@imageDirUrl()/new_users.gif") or
the CSS file: @link("@cssDirUrl()/site.css").")