API: Page

Filename:
_fwpAPI_initVars.lgc

Released With:
5.0.0

Current Version:

Status: Active

Min Lasso Tested: 8.1.0

Max Lasso Tested: 8.5.3

Related:

fwp_modulePaths

API Reference

fwp_sitePaths (Type)

Description

This data type defines the locations of numerous site level resource paths. Within _fwpAPI_initVars.lgc, the variable $fw_sPath is set to the fwp_sitePaths type. Technically any variable could be used, but several pageblocks framework tags and types expect $fw_sPath.

While the pageblocks framework does define a site structure convention, the developer is free to create any structure. By altering the values of the paths defined in this custom type, but leaving the existing instance var names, site structure can actually be changed around without breaking application code. It also allows developers to exchange code which may be organized differently yet still function correctly.

Syntax

$fw_sPath->'folderName'

Parameters & Member Tags

The following instance vars are available:

->'admin' = the root folder of the administration system
->'adminPanels' = folder for reusable page snippets (called Panels) used in the administration pages
->'adminControls' = folder for GUI control graphics (graphic buttons) used in the administration pages

->'api' = folder of API tags and types
->'apiLibs' = folder of API libraries

->'configs' = folder of configuration files
->'controls' = folder of general control graphics used site wide
->'css' = folder of site wide CSS style sheets
->'libs' = folder of site wide libraries
->'logs' = folder of site log files
->'panels' = folder of reusable page snippets used throughout the site
->'plugins' = folder of 3rd party tags, types, resources to extend FWPro
->'tags' = folder of site wide application specific custom tags
->'types' = folder of site wide application specific custom types

->'media' = folder of site wide media assets
->'audio' = folder of site wide general purpose audio files
->'banners' = folder of general purpose banner/ad files
->'downloads' = folder of general purpose download files
->'flash' = folder of site wide general purpose flash files
->'images' = folder of site wide general purpose images
->'text' = folder of general purpose text files
->'video' = folder of site wide general purpose video files

->'msthd' = root folder of masthead items
->'nav' = folder of masthead page navigation snippets
->'headers' = folder of masthead page header snippets
->'footers' = folder of masthead page footer snippets
->'templates' = folder of site wide Corral page templates

->'msthdImgs' = folder of masthead graphics
->'nav' = folder of masthead page navigation graphics
->'headers' = folder of masthead page header graphics
->'footers' = folder of masthead page footer graphics
->'rolloverImgs' = folder of site wide rollover menu graphics

Examples

include: ($fw_sPath->'libs') + 'myLibName.lgc';