OutputFileNode
An OutputFileNode represents a file that will be output to the built site tree.
Read-only Properties
- type: returns a NodeType constant
- path: returns the path to this resource (relative to the root folder the generator is working with)
- filename: returns the filename (including file extension)
- filenameWithoutExtension: returns the filename (without file extension)
Methods
addPageIterator(name, outputNodes)
Returns true
or false
; whether the iterator named name was successfully added to the fileNode.
outputNodes should be an array of OutputFileNodes that will be included in the iterator.
assignVariable(name, value)
No return. Assigns value to the variable named name. Will create a new variable, if necessary, or overwrite the value for an existing variable.
getVariable(name)
Returns the value of the variable named name, or null
if it does not exist.
addMixin(name)
No return. Adds the mixins name to the page.
setPathOutputFormat(pathFormatConstant)
Returns true
or false
; whether the path output format was successfully set or not. This affects the output of @path directives within this node.
pathFormatConstant should be a PathFormatConstant.