flag

Parent Previous Next

flag


The flag attribute is used in conjunction with the defaultTemplate.documentControl file to associate the current node's flag value with the name value as detailed within the defaultTemplate.documentControl file. During documentation, if the associated flag was set to "False", then DOC xPress will skip the current node and will not include it within the documentation.


Syntax

This ChildObjects node returns all children of the parent node only if the flag "SQL.SecurityDetail" is set to "True" at the time of document generation:


<ChildObjects selector="./" flag="SQL.SecurityDetail" />



This Object node will only return the parent node if the flag "SQL.Database" is set to "True" at the time of document generation:


<Object selector="." flag="SQL.Database" >

</Object>



Associated Optional Nodes

ChildObjects - Used to create child pages within the documentation for each object that matches the selector.  


ChildObjectsSubStructure - Used to explicitly search for another Structure Map that matches the object type for each object that matches the selector.  


Object - Used to create a single child page within the documentation for each the first object that matches the selector.


RecursiveChildObjects - Used to recursively create the entire metadata tree for each object that matches the selector. This child node is most often used during the creation of a Structure Map to help display the entire structure of a set of objects.