MODULES UizeSite.Build.Files.SourceCodePages
- Contents
- 1. Introduction
- 2. Instance Methods
-
3. Static Methods
- 3.1. UizeSite.Build.Files.SourceCodePages.addFiles
- 3.2. UizeSite.Build.Files.SourceCodePages.alphastructor
- 3.3. UizeSite.Build.Files.SourceCodePages.declare
- 3.4. UizeSite.Build.Files.SourceCodePages.determineFilesToBuild
- 3.5. UizeSite.Build.Files.SourceCodePages.doMy
- 3.6. UizeSite.Build.Files.SourceCodePages.dualContextMethods
- 3.7. UizeSite.Build.Files.SourceCodePages.dualContextProperties
- 3.8. UizeSite.Build.Files.SourceCodePages.fire
- 3.9. UizeSite.Build.Files.SourceCodePages.get
- 3.10. UizeSite.Build.Files.SourceCodePages.instanceMethods
- 3.11. UizeSite.Build.Files.SourceCodePages.instanceProperties
- 3.12. UizeSite.Build.Files.SourceCodePages.mixins
- 3.13. UizeSite.Build.Files.SourceCodePages.omegastructor
- 3.14. UizeSite.Build.Files.SourceCodePages.perform
- 3.15. UizeSite.Build.Files.SourceCodePages.set
- 3.16. UizeSite.Build.Files.SourceCodePages.singleton
- 3.17. UizeSite.Build.Files.SourceCodePages.stateProperties
- 3.18. UizeSite.Build.Files.SourceCodePages.staticMethods
- 3.19. UizeSite.Build.Files.SourceCodePages.staticProperties
- 3.20. UizeSite.Build.Files.SourceCodePages.subclass
- 3.21. UizeSite.Build.Files.SourceCodePages.toggle
- 3.22. UizeSite.Build.Files.SourceCodePages.unwire
- 3.23. UizeSite.Build.Files.SourceCodePages.wire
- 4. Static Properties
1. Introduction
The UizeSite.Build.Files.SourceCodePages build script builds HTML pages for viewing the source code of JavaScript modules and examples pages for the UIZE Web site.
DEVELOPERS: Chris van Rensburg
1.1. JavaScript Module Source Code Pages
A source code page is generated for every JavaScript module under the modules folder, including modules that are built from various non-JavaScript source files (such as CSS template files with the .csst file extension).
The build script iterates through all the JavaScript modules contained inside the modules folder, builds a source code page for each module using the JavaScript template ~SOURCE-CODE-TEMPLATE.html contained inside the reference/source-code folder and places the built source code page inside that folder, where the source code page's filename is the name of the module with the file extension .html appended (e.g. Uize.Widget.html for the Uize.Widget module).
1.2. Example Source Code Pages
A source code page is generated for every example page contained inside the examples folder.
The build script iterates through all the example pages contained inside the examples folder, ignoring experimental examples prefixed with a "~" (tilde) character, builds a source code page for each example using the JavaScript template ~SOURCE-CODE-TEMPLATE.html contained inside the examples/source-code folder and places the built source code page inside that folder, where the source code page's filename is the same as the example page's filename.
NOTES
the summary info for this build script is output to the log file UizeSite.Build.Files.SourceCodePages.log under the logs folder |
1.3. Examples
There are no dedicated showcase example pages for the UizeSite.Build.Files.SourceCodePages module.
SEARCH FOR EXAMPLES
Use the link below to search for example pages on the UIZE Web site that reference the UizeSite.Build.Files.SourceCodePages module...
SEARCH
1.4. Implementation Info
The UizeSite.Build.Files.SourceCodePages module defines the UizeSite.Build.Files.SourceCodePages class, which is a subclass of UizeSite.Build.Files.
INHERITANCE CHAIN
Uize.Class −> Uize.Build.Files −> UizeSite.Build.Files −> UizeSite.Build.Files.SourceCodePages
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
STATIC METHODS
UizeSite.Build.Files.SourceCodePages.determineFilesToBuild
STATIC PROPERTIES
UizeSite.Build.Files.SourceCodePages.moduleName | UizeSite.Build.Files.SourceCodePages.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.SourceCodePages.addFiles | UizeSite.Build.Files.SourceCodePages.alphastructor | UizeSite.Build.Files.SourceCodePages.declare | UizeSite.Build.Files.SourceCodePages.doMy | UizeSite.Build.Files.SourceCodePages.dualContextMethods | UizeSite.Build.Files.SourceCodePages.dualContextProperties | UizeSite.Build.Files.SourceCodePages.fire | UizeSite.Build.Files.SourceCodePages.get | UizeSite.Build.Files.SourceCodePages.instanceMethods | UizeSite.Build.Files.SourceCodePages.instanceProperties | UizeSite.Build.Files.SourceCodePages.mixins | UizeSite.Build.Files.SourceCodePages.omegastructor | UizeSite.Build.Files.SourceCodePages.perform | UizeSite.Build.Files.SourceCodePages.set | UizeSite.Build.Files.SourceCodePages.singleton | UizeSite.Build.Files.SourceCodePages.stateProperties | UizeSite.Build.Files.SourceCodePages.staticMethods | UizeSite.Build.Files.SourceCodePages.staticProperties | UizeSite.Build.Files.SourceCodePages.subclass | UizeSite.Build.Files.SourceCodePages.toggle | UizeSite.Build.Files.SourceCodePages.unwire | UizeSite.Build.Files.SourceCodePages.wire
STATIC PROPERTIES
UizeSite.Build.Files.SourceCodePages.fileBuilder | UizeSite.Build.Files.SourceCodePages.fileSystem | UizeSite.Build.Files.SourceCodePages.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.SourceCodePages 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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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.SourceCodePages.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 |