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_sitePaths

API Reference

fwp_modulePaths (Type)

Description

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

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_mPath->'folderName'

Parameters & Member Tags

The following instance vars are available:

->'module' = the module folder
->'root' = the _resources folder of the module

->'configs' = folder of module-specific configuration files
->'controls' = folder of module-specific control graphics
->'css' = folder of module-specific CSS style sheets
->'libs' = folder of module-specific libraries
->'logs' = folder of module-specific libraries
->'panels' = folder of reusable page snippets used within a site module
->'tags' = folder of module-specific custom tags
->'types' = folder of module-specific custom types

->'media' = root folder of module-specific media assets
->'audio' = folder of module-specific general audio files
->'banners' = folder of banner ad files used within a site module
->'downloads' = folder of general download files available within a site module
->'flash' = folder of module-specific general flash files
->'images' = folder of module-specific general images
->'text' = folder of text files available within a site module
->'video' = folder of module-specific general video files

->'msthd' = root folder of module-specific masthead items
->'nav' = folder of module-specific masthead page navigation snippets
->'headers' = folder of module-specific masthead page header snippets
->'footers' = folder of module-specific masthead page footer snippets
->'templates' = folder of module-specific page templates

->'msthdImgs' = folder of module-specific masthead graphics
->'navImgs' = folder of module-specific page navigation graphics
->'headerImgs' = folder of module-specific masthead page header graphics
->'footerImgs' = folder of module-specific masthead page footer graphics
->'rolloverImgs' = folder of module-specific rollover graphics

Examples

<img src="[($fw_mPath->'images') + 'mySpiffyPhoto.jpg']" />

[include: ($fw_mPath->'panels') + 'newUserHelp.dsp']