MODULES UizeSite.Build.Util
1. Introduction
The UizeSite.Build.Util package provides various utility methods to facilitate building of pages for the UIZE Web site.
DEVELOPERS: Chris van Rensburg
1.1. Examples
There are no dedicated showcase example pages for the UizeSite.Build.Util module.
SEARCH FOR EXAMPLES
Use the link below to search for example pages on the UIZE Web site that reference the UizeSite.Build.Util module...
SEARCH
1.2. Implementation Info
The UizeSite.Build.Util module defines the UizeSite.Build.Util package under the UizeSite.Build namespace.
1.2.1. Features Introduced in This Module
The features listed in this section have been introduced in this module.
STATIC METHODS
UizeSite.Build.Util.getIndexableFiles
STATIC PROPERTIES
UizeSite.Build.Util.moduleName | UizeSite.Build.Util.pathToResources
1.2.2. Features Overridden in This Module
No features have been overridden in this module.
1.2.3. Features Inherited From Other Modules
This module has no inherited features.
1.2.4. Modules Directly Under This Namespace
There are no modules directly under this namespace.
1.2.5. Unit Tests
There is no dedicated unit tests module for the UizeSite.Build.Util module.
2. Static Methods
2.1. UizeSite.Build.Util.getIndexableFiles
Returns an array, containing the paths for all the indexable files in the specified folder.
SYNTAX
indexableFilePathsARRAY = UizeSite.Build.Util.getIndexableFiles ( sourcePathSTR, indexableFolderUnderSourceSTR, indexableFileExtensionREGEXP );
This method returns all the files in the folder specified by the indexableFolderUnderSourceSTR parameter, that is under the source path specified by the sourcePathSTR parameter, and that match the file extension regular expression specified by the indexableFileExtensionREGEXP parameter. This method excludes all files whose filenames start with a "~" (tilde) character, since these files are considered veiled and not ready for primetime.
IMPLEMENTATION INFO
| this feature was introduced in this module |