http://www.gramar.org/ 2026-06-03T22:07:14+00:00 http://www.gramar.org/ http://www.gramar.org/lib/tpl/dokuwiki/images/favicon.ico text/html 2016-06-27T20:35:00+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:index&rev=1467059700&do=diff org.gramar.base Extension org.gramar.base contains the core set of Gramar tags and functions Usage and examples Place a <taglib> element within <taglibs> element in the gramar.config file in the root of your gramar: <taglibs> <taglib prefix="c" extension="org.gramar.base" /> </taglibs> text/html 2016-06-27T20:35:01+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.addelement&rev=1467059701&do=diff addElement Tag The addElement tag adds a new child node with a given name to a given node in the model. Attribute Kind Required Purpose select node yes An XPath expression resolving to the node to which a new child node is to be added text/html 2016-06-27T20:35:08+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.addtextelement&rev=1467059708&do=diff addTextElement Tag The addTextElement tag adds a new child text node with a given name to a given node in the model. The content of the addTextElement tag becomes the text content of the new text node. Attribute Kind Required Purpose text/html 2016-06-27T20:35:17+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.choose&rev=1467059717&do=diff choose Tag The choose tag provides case-style conditional logic. The choose tag will have nested some number of when tags and possibly an otherwise tag. The first when tag to test true will be resolved to become the processing result of the entire choose tag. If no when tag tests true and an otherwise tag is present, the otherwise tag is resolved to produce the result of the entire choose tag. text/html 2016-06-27T20:35:10+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.copyelement&rev=1467059710&do=diff copyElement Tag The copyElement tag copies an element in a primary or secondary model to anoher location in the same or different model. The copy can be shallow or deep. Attribute Kind Required Purpose select node yes An XPath expression resolving onto the node to be copied. If the expression resolves into multiple nodes then only the first node in the list is copied text/html 2016-06-27T20:35:16+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.copyfile&rev=1467059716&do=diff copyFile Tag The copyFile tag copies a binary file from within the gramar to the output file store.. Attribute Kind Required Purpose target string yes The workspace-relative path of the file to be written. The first level should be the project name. text/html 2016-06-27T20:35:07+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.dump&rev=1467059707&do=diff dump Tag The dump tag Writes a string representation of the specified node and its children. Attribute Kind Required Purpose select node yes The node whose string representation is to be written. Full Form <c:dump select text/html 2016-06-27T20:34:59+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.file&rev=1467059699&do=diff file Tag The file tag copies a binary file from within the gramar to the output file store. Attribute Kind Required Purpose path string yes The workspace-relative path of the file to be written. The first level should be the project name. text/html 2016-06-27T20:35:16+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.flow&rev=1467059716&do=diff flow Tag The flow tag Allows for the text flow of the tag's content across several lines of output where each line must have a constant prefix, such as with a Javadoc comment. Attribute Kind Required Purpose (no attributes) Full Form text/html 2016-06-27T20:35:18+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.flowcontent&rev=1467059718&do=diff flowContent Tag The flowContent tag scopes the actual content to be flowed. The width attribute specifies the maximum length of each line of flowed text. The template content before the flowContent tag but after the containing flow tag is the prefix to be prepended to each flowed line of text. text/html 2016-06-27T20:35:02+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.folder&rev=1467059702&do=diff folder Tag The folder tag creates a new folder with the given name if that folder does not already exist. Attribute Kind Required Purpose path string yes The workspace-relative path of the folder to be created. The first level should be the project name. text/html 2016-06-27T20:35:06+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.formatnow&rev=1467059706&do=diff formatNow Tag The formatNow tag writes the current time using the format specified. Attribute Kind Required Purpose pattern string yes The format of the date to be written. See SimpleDateFormat for more specifics. Full Form text/html 2016-06-27T20:35:17+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.get&rev=1467059717&do=diff get Tag The get tag Resolves to the string representation of the value of an XPath expression Attribute Kind Required Purpose select string yes An XPath expression Full Form <c:get select=“” > Usage and Samples Return to text/html 2016-06-27T20:35:14+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.if&rev=1467059714&do=diff if Tag The if tag Evaluates an XPath expression and processes the tag content if the value is true. Attribute Kind Required Purpose test string yes An XPath expression to be resolved as a boolean value. The contents of the if tag are processed only if the value is true. text/html 2016-06-27T20:35:12+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.include&rev=1467059712&do=diff include Tag The include tag Processes another template in the gramar in-line as resolves to the text content produced by that template. Attribute Kind Required Purpose template string yes The gramar-relative pathname of the template to be processed in-line (included). text/html 2016-06-27T20:35:13+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.initialcode&rev=1467059713&do=diff initialCode Tag The initialCode tag Scopes a region of template processing that might be modified by the user after generation and should therefore be kept (not overwritten on subsequent gramar invocations). The initialCode tag is always nested within a userRegion tag and breaks that userRegion tag content into three sections: before eyecatcher, modifiable content and after eyecatcher. The before and after eyecatchers may contain other Gramar markup tags and are used to locate the modifiable … text/html 2016-06-27T20:34:58+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.iterate&rev=1467059698&do=diff iterate Tag The iterate tag Iterates over a collection of nodes. Attribute Kind Required Purpose select nodes yes An XPath expression that resolves to the iterated collection var string yes The name of a context variable to be associated with the current node of the iteration. The variable is scoped to the body of the tag. text/html 2016-06-27T20:35:00+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.load&rev=1467059700&do=diff load Tag The load tag parses the content of the tag into a secondary DOM. Attribute Kind Required Purpose url string yes The URL of the model to be loaded. var string yes The name of the context variable to be associated with the document (not the root node) of the parsed DOM. text/html 2016-06-27T20:35:05+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.loadcontent&rev=1467059705&do=diff loadContent Tag The loadContent tag parses the content of the tag into a secondary DOM. Attribute Kind Required Purpose var string yes The name of the context variable to be associated with the document (not the root node) of the parsed DOM. text/html 2016-06-27T20:34:59+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.log&rev=1467059699&do=diff log Tag The log tag processes and writes its content to the platform-appropriate console. Attribute Kind Required Purpose severity string yes Indicates the importance of the message to be logged. Full Form <c:log severity text/html 2016-06-27T20:35:06+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.milliseconds&rev=1467059706&do=diff milliseconds Tag The milliseconds tag resolves to the current epoch time in milliseconds. Attribute Kind Required Purpose (no attributes) Full Form <c:milliseconds > Usage and Samples Return to index text/html 2016-06-27T20:34:52+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.newmodel&rev=1467059692&do=diff newModel Tag The newModel tag Creates a new secondary DOM with a single root node. The node is given the specified name and is associated with the given context variable Attribute Kind Required Purpose var string yes The name of the context variable to be associated with the root node of the new secondary DOM. text/html 2016-06-27T20:35:15+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.otherwise&rev=1467059715&do=diff otherwise Tag The otherwise tag provides a “last-resort” case for a containing choose tag. If no when tags in that choose tag test true, the contents of the otherwise tag become the processing result of the choose tag. Attribute Kind Required text/html 2016-06-27T20:35:11+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.project&rev=1467059711&do=diff project Tag The project tag creates a new project with the given name if that project does not already exist. Attribute Kind Required Purpose name node yes The name of the project to be created Full Form <c:project name text/html 2016-06-27T20:35:05+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.removeelement&rev=1467059705&do=diff RemoveElement Tag The RemoveElement tag Removes a node from the model. All of the node's children will be removed as well. Attribute Kind Required Purpose select node yes An XPath expression resolving to a single node to be removed. text/html 2016-06-27T20:35:07+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.set&rev=1467059707&do=diff set Tag The set tag Sets the value of an attribute on a given node to the resolved content of the tag. If the given XPath expression resolves to multiple nodes, the tag acts against the first node in that collection. Attribute Kind Required text/html 2016-06-27T20:35:04+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.setusingnext&rev=1467059704&do=diff setUsingNext Tag The setUsingNext tag Set's an attribute on each of a set of nodes using an XPath expression sourced by each node's successor node Attribute Kind Required Purpose select nodes yes An XPath expression that resolves to a collection of nodes text/html 2016-06-27T20:34:57+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.setvariable&rev=1467059697&do=diff setVariable Tag The setVariable tag Sets a context variable to the resolved value of an XPath expression. Attribute Kind Required Purpose select node yes An XPath expression var node yes The name of a context variable to be associated with the resolved value of the XPath expression. text/html 2016-06-27T20:35:01+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.stringtokens&rev=1467059701&do=diff stringTokens Tag The stringTokens tag Parses a string into tokens and iterates over the tokens. Attribute Kind Required Purpose string string yes The string to be parsed var string yes The name of a context variable to be associated with the current token in the iteration. The variable is scoped to the body of the tag. text/html 2016-06-27T20:35:18+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.userregion&rev=1467059718&do=diff ==== userRegion Tag ==== The userRegion tag scopes a region of template processing that might be modified by the user after generation and should therefore be kept (not overwritten on subsequent gramar invocations). The userRegion tag will contain a single initialCode tag that breaks the userRegion tag content into three sections: before eyecatcher, modifiable content and after eyecatcher. The before and after eyecatchers may contain other Gramar markup tags and are used to locate the modifia… text/html 2016-06-27T20:35:09+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:tag.when&rev=1467059709&do=diff when Tag The when tag acts as a single case clause for a containing choose tag. Within a choose tag's scope, the first when tag to test true will become the processing result of the entire choose tag. Attribute Kind Required Purpose text/html 2016-06-27T20:35:09+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:xfn.camelcase&rev=1467059709&do=diff camelCase() Function The camelCase() function returns a single-token string from the given text where whitespace has been removed and the first character of each token has been upper-cased Argument Kind Required Purpose term text/html 2016-06-27T20:34:58+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:xfn.cardinality&rev=1467059698&do=diff ==== cardinality() Function ==== The cardinality() function returns a boolean value depending on whether the cardinality of the collection of nodes is present in the cards string If the collection of nodes is empty and the cards argument contains "0" return true. If the collection of nodes contains a single node and the cards argument contains "1" return true. If the collection of nodes contains more than one node and the cards argument contains "M" return true. Otherwise, return false. ^… text/html 2016-06-27T20:35:11+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:xfn.classname&rev=1467059711&do=diff className() Function The className() function returns the class name from a given fully-qualified Java class name Argument Kind Required Purpose fqn string yes a fully-qualified name of a Java class Usage and examples Place a text/html 2016-06-27T20:35:15+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:xfn.isvariabledefined&rev=1467059715&do=diff isVariableDefined() Function The isVariableDefined() function returns whether the specified variable has an associated value in the Gramar context Argument Kind Required Purpose varname string yes a variable name Usage and examples text/html 2016-06-27T20:35:14+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:xfn.lower-case&rev=1467059714&do=diff ==== lower-case() Function ==== The lower-case() function returns the given string value with every character appropriately lower-cased ^ Argument ^ Kind ^ Required ^ Purpose ^ |**term** |string |yes |a string value | === Usage and examples === Place a ... Return to [[org.gramar.base:index|index]] text/html 2016-06-27T20:35:03+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:xfn.lowercasefirst&rev=1467059703&do=diff lowercaseFirst() Function The lowercaseFirst() function returns the given string value with the first character appropriately lower-cased Argument Kind Required Purpose term string yes a string value Usage and examples text/html 2016-06-27T20:35:10+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:xfn.packagename&rev=1467059710&do=diff ==== packageName() Function ==== The packageName() function returns the package name from a given fully-qualified Java class name ^ Argument ^ Kind ^ Required ^ Purpose ^ |**fqn** |string |yes |a fully-qualified name of a Java class | === Usage and examples === Place a ... Return to [[org.gramar.base:index|index]] text/html 2016-06-27T20:35:12+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:xfn.singletoken&rev=1467059712&do=diff singleToken() Function The singleToken() function returns a single-token string from the given text where whitespace has been removed and the first character of each token, except the first, has been uppercased Unlike the camelCase() function, the singleToken() function will not lower-case any characters in a token that contains all upper-cased characters, such as an acronym. text/html 2016-06-27T20:35:02+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:xfn.sort&rev=1467059702&do=diff sort() Function The sort() function sorts and returns the given collection using the key XPath expression to calculate a sort key for each node in the collection. Argument Kind Required Purpose collection nodes yes an XPath expression that resolves to a collection of nodes text/html 2016-06-27T20:35:04+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:xfn.unique&rev=1467059704&do=diff ==== unique() Function ==== The unique() function filters and returns the given collection using the key XPath expression to calculate a key for each node in the collection. Only the first node for a given key will be returned. ^ Argument ^ Kind ^ Required ^ Purpose ^ |**collection** |nodes |yes |an XPath expression that resolves to a collection of nodes | |**key** |string |yes |a string containing an XPath expression that resolves to a key value for a given node … text/html 2016-06-27T20:35:13+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:xfn.upper-case&rev=1467059713&do=diff upper-case() Function The upper-case() function returns the given string value with every character appropriately upper-cased Argument Kind Required Purpose term string yes a string value Usage and examples Place a ... text/html 2016-06-27T20:35:03+00:00 http://www.gramar.org/doku.php?id=org.gramar.base:xfn.uppercasefirst&rev=1467059703&do=diff uppercaseFirst() Function The uppercaseFirst() function returns the given string value with the first character appropriately upper-cased Argument Kind Required Purpose term string yes a string value Usage and examples