UIZE JavaScript Framework

MODULES UizeSite.Build.Files.SimpleDocPages

SEARCHEXAMPLESSOURCEDEPSTEST

1. Introduction

The UizeSite.Build.Files.SimpleDocPages build script recurses through all folders of the UIZE Web site project, building pages from all the Simple Doc (.simple) files that it finds, as well as building HTML reference documentation pages from all JavaScript modules that it finds in the modules folder.

DEVELOPERS: Chris van Rensburg

1.1. Simple Doc Pages

An HTML page is generated for each Simple Doc (.simple) file.

The build script recurses through all the folders, finding Simple Doc (.simple) files. For each file, it builds an HTML page from the Simple Doc document, using the ~SIMPLE-DOC-TEMPLATE.html.jst template file that is contained inside the same folder as the Simple Doc file. The built HTML page is then output to the same folder as the Simple Doc file, where the filename of the built file is the filename of the Simple Doc file with the .simple file extension replaced with the .html extension.

FILE NAMING EXAMPLE

javascript-build-scripts.simple --> PRODUCES --> javascript-build-scripts.html

1.2. Module Reference Pages

An HTML reference documentation page is generated for each JavaScript module contained inside the modules folder.

The build script iterates through all the JavaScript modules contained inside the modules folder (as specified by the modulesFolder build environment variable). For each file, it extracts all the Simple Doc comments, stitches all those comments together into a single Simple Doc document, and then builds an HTML page from that document, using the ~SIMPLE-DOC-TEMPLATE.html.jst template file that is contained inside the reference/ folder of the UIZE Web site project. The built HTML reference documentation page is then output to the reference/ folder, where the filename of the built file is the filename of the JavaScript module with the .js file extension replaced with the .html extension.

FILE NAMING EXAMPLE

js/Uize.Widget.js --> PRODUCES --> reference/Uize.Widget.html

For more information on Simple Doc - such as its rules on document structure, inline formatting, etc. - refer to the guide JavaScript Documentation System.

NOTES

the summary info for this build script is output to the log file UizeSite.Build.Files.SimpleDocPages.log

1.3. Examples

There are no dedicated showcase example pages for the UizeSite.Build.Files.SimpleDocPages module.

SEARCH FOR EXAMPLES

Use the link below to search for example pages on the UIZE Web site that reference the UizeSite.Build.Files.SimpleDocPages module...

SEARCH

1.4. Implementation Info

The UizeSite.Build.Files.SimpleDocPages module defines the UizeSite.Build.Files.SimpleDocPages class, which is a subclass of UizeSite.Build.Files.

INHERITANCE CHAIN

Uize.Class −> Uize.Build.Files −> UizeSite.Build.Files −> UizeSite.Build.Files.SimpleDocPages

1.4.1. Features Introduced in This Module

No features have been introduced in this module.

1.4.2. Features Overridden in This Module

The features listed in this section have been overridden in this module.

The module that an overridden feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.

INSTANCE METHODS

valueOf

STATIC METHODS

UizeSite.Build.Files.SimpleDocPages.determineFilesToBuild

STATIC PROPERTIES

UizeSite.Build.Files.SimpleDocPages.moduleName | UizeSite.Build.Files.SimpleDocPages.nonInheritableStatics

1.4.3. Features Inherited From Other Modules

The features listed in this section have been inherited from other modules.

The module that an inherited feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.

INSTANCE METHODS

fire | get | is | isMet | kill | met | onChange | once | set | toggle | unmet | unwire | whenever | wire

STATIC METHODS

UizeSite.Build.Files.SimpleDocPages.addFiles | UizeSite.Build.Files.SimpleDocPages.alphastructor | UizeSite.Build.Files.SimpleDocPages.declare | UizeSite.Build.Files.SimpleDocPages.doMy | UizeSite.Build.Files.SimpleDocPages.dualContextMethods | UizeSite.Build.Files.SimpleDocPages.dualContextProperties | UizeSite.Build.Files.SimpleDocPages.fire | UizeSite.Build.Files.SimpleDocPages.get | UizeSite.Build.Files.SimpleDocPages.instanceMethods | UizeSite.Build.Files.SimpleDocPages.instanceProperties | UizeSite.Build.Files.SimpleDocPages.mixins | UizeSite.Build.Files.SimpleDocPages.omegastructor | UizeSite.Build.Files.SimpleDocPages.perform | UizeSite.Build.Files.SimpleDocPages.set | UizeSite.Build.Files.SimpleDocPages.singleton | UizeSite.Build.Files.SimpleDocPages.stateProperties | UizeSite.Build.Files.SimpleDocPages.staticMethods | UizeSite.Build.Files.SimpleDocPages.staticProperties | UizeSite.Build.Files.SimpleDocPages.subclass | UizeSite.Build.Files.SimpleDocPages.toggle | UizeSite.Build.Files.SimpleDocPages.unwire | UizeSite.Build.Files.SimpleDocPages.wire

STATIC PROPERTIES

UizeSite.Build.Files.SimpleDocPages.fileBuilder | UizeSite.Build.Files.SimpleDocPages.fileSystem | UizeSite.Build.Files.SimpleDocPages.pathToResources

1.4.4. Modules Directly Under This Namespace

There are no modules directly under this namespace.

1.4.5. Unit Tests

There is no dedicated unit tests module for the UizeSite.Build.Files.SimpleDocPages module.

2. Instance Methods

2.1. fire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.2. get

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.3. is

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.4. isMet

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.5. kill

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.6. met

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.7. onChange

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.8. once

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.9. set

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.10. toggle

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.11. unmet

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.12. unwire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.13. valueOf

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)

IMPLEMENTATION INFO

2.14. whenever

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.15. wire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

3. Static Methods

3.1. UizeSite.Build.Files.SimpleDocPages.addFiles

Inherited from Uize.Build.Files.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Build.Files, first introduced in Uize.Build.Files)
this static feature is inherited by subclasses

3.2. UizeSite.Build.Files.SimpleDocPages.alphastructor

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.3. UizeSite.Build.Files.SimpleDocPages.declare

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.4. UizeSite.Build.Files.SimpleDocPages.determineFilesToBuild

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Build.Files)
this static feature is inherited by subclasses

3.5. UizeSite.Build.Files.SimpleDocPages.doMy

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.6. UizeSite.Build.Files.SimpleDocPages.dualContextMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.7. UizeSite.Build.Files.SimpleDocPages.dualContextProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.8. UizeSite.Build.Files.SimpleDocPages.fire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.9. UizeSite.Build.Files.SimpleDocPages.get

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.10. UizeSite.Build.Files.SimpleDocPages.instanceMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.11. UizeSite.Build.Files.SimpleDocPages.instanceProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.12. UizeSite.Build.Files.SimpleDocPages.mixins

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.13. UizeSite.Build.Files.SimpleDocPages.omegastructor

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.14. UizeSite.Build.Files.SimpleDocPages.perform

Inherited from Uize.Build.Files.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Build.Files, first introduced in Uize.Build.Files)
this static feature is inherited by subclasses

3.15. UizeSite.Build.Files.SimpleDocPages.set

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.16. UizeSite.Build.Files.SimpleDocPages.singleton

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.17. UizeSite.Build.Files.SimpleDocPages.stateProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.18. UizeSite.Build.Files.SimpleDocPages.staticMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.19. UizeSite.Build.Files.SimpleDocPages.staticProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.20. UizeSite.Build.Files.SimpleDocPages.subclass

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.21. UizeSite.Build.Files.SimpleDocPages.toggle

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.22. UizeSite.Build.Files.SimpleDocPages.unwire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

3.23. UizeSite.Build.Files.SimpleDocPages.wire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4. Static Properties

4.1. UizeSite.Build.Files.SimpleDocPages.fileBuilder

Inherited from Uize.Build.Files.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Build.Files, first introduced in Uize.Build.Files)
this static feature is inherited by subclasses

4.2. UizeSite.Build.Files.SimpleDocPages.fileSystem

Inherited from Uize.Build.Files.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Build.Files, first introduced in Uize.Build.Files)
this static feature is inherited by subclasses

4.3. UizeSite.Build.Files.SimpleDocPages.moduleName

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.4. UizeSite.Build.Files.SimpleDocPages.nonInheritableStatics

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)
this static feature is not inherited by subclasses

4.5. UizeSite.Build.Files.SimpleDocPages.pathToResources

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses