MMBase taglib documentation

• cloud
  Which cloud to use. This is an optional argument, and if it is omitted then the tag will refer to the direct parent. Only if there is more than one cloud (for instance within a nested transaction tag) you might want to use this attribute to refer to the main cloud.
  

• jspvar
• commitonclose

• inverse
  Inverts the condition: the body of the tag will only be executed if the condition does not evaluate to true. This is an optional attribute with its default value set to 'false'.
  

  true
  false

• container
  Refer to the container with this id. If you want to explicitly not refer to any container (e.g. function-tags on node), then you can specify an non-existing id.
  

• referid
  Reuses a previously defined tag of the same type.
  

• id

• context

Context-referrer tags refer to the context. This means that (most of) their attributes can contain `context' variables (referred to by `$'). All tags are context-referrers or specializations of it.

Note that if you use JSP 2, variables can be accessed by ${}. So this also works in MMBase tags. In MMBase 1.7 the JSP2 variables did not coincide with MMBase variables. In MMBase 1.8 they can coincide.

An example is for instance the use: <mm:listnodes type="$nodetype">, here the 'nodetype' variable from the context is referred to.

• context
  If you want to use variables from another context than the direct parent, then you can specify the id of the parent context tag with this attribute, to indicate it.
  

• id
  With the `id' attribute you define an unique identifier for this context referrer. Nested tags can refer to this directly and other tags by means of a context.
  

• context

• field
  If the tag is living in more than one field provider, and you don't want the direct parent, then you use this attribute to refer to it.
  

A function tag (of which there are many different types) evaluate a function. Functions can be defined in three locations:

• The nodemanager (for functions located in builder code)
• A function set
• A specific class name

Parameters to the function can be specified in two ways:

• By using the 'referids' attribute: these are named variables which are passed on to the function
• By putting the function call in a 'function container', and by using <mm:param> tags within the function container

The several tags of this type differ only in the way they deal with the function value. E.g. a 'booleanfunction' works as a `condition' tag (evaluating the body if the function value is `true' and not evaluating the body if it is false). A 'nodelistfunction' tag will execute the function and then iterate the body of the tag for all the nodes in the nodelist.

• name
  

  The name of the function to evaluate.

  
  
• nodemanager
  The name of the nodemanager on which the function must be evaluated.
  
• set
  The `functionset' from which the function must be taken. These are a kind of static functions (no mmbase object is associated with them). These `sets' of functions are a bit like name-spaces.
  
• classname
  

  The java class name from which the function must be taken. The function will be interpreted as a `bean' function, meaning that you can set parameters with `set' methods, and get function values with any method with no arguments.

  There are two exceptions to this:

  • If the value of the attribute is 'THISPAGE', a method of the current JSP will be called (a 'method function').
  • If the value of the attribute starts with 'THISPAGE.', an inner class of the current JSP will be used as a bean (the name of the inner class is that what follows the dot).
  
  
• module
  The name of the module on which the function must be evaluated.
  
• referids
  Similar to `referids' attribute of mm:url, a simple way to provide (named) arguments to the function.
  see: referids attribute of url
  

• node

A list provider has a body which is evaluated repeatedly, it is mainly just an iterator tag.

When the list is acting as a contextwriter (if the 'id' parameter is specified), then the body is still evaluated but within the body of the tag the variable refers to the current element. Then after evaluation of the tag, the entire list of elements is available in the context with the type 'java.util.List'.

The attributes to tags of this type (comparator, retain, etc.) all have more or less the same behaviour as the methods of the java.util.Collection interface.

• comparator (since: MMBase-1.7)
  

  Give the class name of a class that implements the java.util.Comparator interface. Give either a fully qualified name, or a single name. When it is a single name the class must be defined as a static inner class in the jsp (see example)

  The Comparator may have a method init(PageContext), which will be called first if it has (since 1.8.1).

  
  

  SHUFFLE	For shuffling you don't need to implement a comparator (which is principally possible). This will use Collections.shuffle in stead.
  REVERSE	This pseudo-comparator simply reverses the order of the list (using Collections.reverse).
  NATURAL	Sorts the objects by their natural ordering.
  CASE_INSENSITIVE	Sorts Strings case-insensitively.

  MyCollator

  If you use a value like this, then it will be supposed that this Comparator is implemented in this jsp. E.g.: <%! /** * Comparator to order mmbase nodes on their field named "title". */ static private final Collator DUTCH_COLLATOR = Collator.getInstance(new Locale("nl", "NL")); static { // PRIMARY strength ignores differences between &eacute; and e, and between e and E DUTCH_COLLATOR.setStrength(Collator.PRIMARY); } static public class DutchCaseInsensitiveCollator implements Comparator { public int compare(Object o1, Object o2) { String title1 = ((org.mmbase.bridge.Node) o1).getStringValue("title"); String title2 = ((org.mmbase.bridge.Node) o2).getStringValue("title"); return DUTCH_COLLATOR.compare(title1, title2); } } %>; <mm:listnodescontainer> <!-- make sure the list is not gigantic, when sorting with comparator it happens in memory, not by database! --> <mm:ageconstraint maxage="7" /> <mm:listnodes comparator="DutchCaseInsensitiveCollator"> ... </mm:listnodes> </mm:listnodescontainer>

  nl.myorg.OurComparator

  You can also use a fully qualified class name.

• add (since: MMBase-1.8)
  

  Adds to this list all elements represented by the value of this attribute. The value refers to some taglib variable, like the id of another list, or the id of a node (which is only one element then).

  This method is similar to the behavior of the 'add()' and 'addAll()' methods from the java.util.Collection interface.

  It is also possible to postfix the referid with '?', in which case no error will occur if the variable with this id does not exist.

  
  
• retain (since: MMBase-1.8)
  

  Removes all the elements from the list, except the ones that are also present in the list which is specified by this attribute.

  This method is similar to the behavior of the 'retainAll()' method from the java.util.Collection interface.

  It is also possible to postfix the referid with '?', in which case no error will occur if the variable with this id does not exist.

  
  
• remove (since: MMBase-1.8)
  

  Removes all the elements from the list which are present in the object referred by this attribute.

  This method is similar to the behavior of the 'removeAll()' method from the java.util.Collection interface.

  It is also possible to postfix the referid with '?', in which case no error will occur if the variable with this id does not exist.

  
  
• varStatus (since: MMBase-1.9)
  

  Like varStatus of c:forEach.

  
  

      
<mm:import id="list1" vartype="list">a,b,c,d,e</mm:import>
<mm:import id="list2" vartype="list">c,d,e,f</mm:import>

<mm:stringlist id="list3" referid="list1" add="list2" />
<mm:stringlist id="list4" referid="list1" retain="list2" />
<mm:stringlist id="list5" referid="list1" remove="list2" />

<mm:write referid="list3" /> / <mm:write referid="list4" /> / <mm:write referid="list5" />

      
      This will print the following:
      
a,b,c,d,e,c,d,e,f / c,d,e / a,b
      
    

• list
  Which list to use, if the tag is in the body of more than one list, and you don't want the direct parent.
  

• jspvar
  A jspvar of type Node can be created.
  
• commitonclose (since: MMBase-1.8)
  Whether the node must be committed after evaluation of the body. The default is true.
  

  true	If 'commit on close' is true for a NodeProvider, and the current tag (perhaps using 'referid') made changes to it, then on the close of the tag, the 'commit' method of the Node is called. That means that if there are invalid values, an exception may occur.
  false	If 'commit on close' is false for a NodeProvider, and the current tag (perhaps using 'referid') made changes to it, then on the close of the tag, the 'commit' method of the Node is called. That means that if there are invalid values, an exception may occur.

• node
  Which node to use. You can use this attribute if your Node referrer is living in more than one node provider, and you don't want the direct parent.
  

A `Query' container is a container for one of the `node list' tags (list providers that are node providers too). A query container is actually a wrapper for a `Query' on the database, to which constraints can be added using the <mm:constraint> tag, sort order can be specified, etc. If a 'node list tag' is inside a corresponding `nodelist container', it will use the query specified by the container.

For examples, have a look at one of the tags of this type.

• cachepolicy (since: MMBase-1.8)
  Determines how results of the query generated by this container are cached.
  

  never	Never cache the result
  always	Always cache the result (default)

• id
  Used in conjunction with 'container' attribute of querycontainerreferrers.
  see: container attribute of containerreferrer
  
• jspvar (since: MMBase-1.8.1)
  JspVar of the type org.mmbase.bridge.Query.
  

• container

• jspvar
  The name of the variable to be created. Normally, but not always, the scope of this variable is the body of the tag. This attribute can never contain context variables.
  
• vartype
  

  The type of the variable to be created. Usually there is a reasonable default for this attribute. This attribute can never contain context variables.

  The value of this is used for the `jspvar' if you create it, but it is also used for the 'context' variables. It is less often essential then, but it is essential to set it right e.g. when you want to use the `isgreaterthan' tag, because strings compare differently than numbers.

  
  see: isgreaterthan
  

  Object	java.lang.Object
  String	java.lang.String
  Node	org.mmbase.bridge.Node
  Cloud	org.mmbase.bridge.Cloud
  Transaction	org.mmbase.bridge.Transaction
  decimal	java.math.BigDecimal
  Integer	java.lang.Integer
  Vector	java.util.Vector. It's better to use List, normally.
  List	java.util.List
  Long	java.lang.Long
  Double	java.lang.Double
  Float	java.lang.Float
  Date	java.util.Date
  Field	org.mmbase.bridge.Field
  FieldValue	org.mmbase.bridge.FieldValue
  Boolean	java.lang.boolean
  fileitem	org.apache.commons.fileupload.FileItem. Can be used in multipart file uploads (comfortable in combination with EL)

• write
  Whether to write to the page or not. Normally the default value will suffice. If you don't write to the page, the produced string can e.g. be used by sub tags, or only written to a context variable.
  

  true
  false

• escape (since: MMBase-1.7)
  Override the default escape behaviour determined by the surrounding Content-tag.

  Escaper
  text/plain	This equals no escaping
  none	No escaping
  text/html	Escapes for use in HTML.
  text/html/attribute	Escapes for use in HTML atributes
  text/xml	Escapes for use in XML (or XHTML).
  inline	Interpret as 'enriched' ASCII for 'inline' HTML parts (so no blocks)
  p	Interpret as 'enriched' ASCII for 'block' HTML parts. It normally generates one or more p-tags (everything is enclosed by a p tag, including lists).
  pp	As 'p', but only one sequences of one br-tags are produced
  p-ommit-surrounding	as p, but surrounding p /p tags are omitted (you must place them by hand). This can be needed for 'read-more' links.
  pp-ommit-surrounding
  pl	Interpret as 'enriched' ASCII for 'block' HTML parts. It normally generates one or more p-tags. Lists (ul tags) are placed outside the paragraphs. As such a block may start or end with an ul tag.
  ppl	As 'p2', but only one sequences of one br-tags are produced
  pl-ommit-surrounding	as p2, but surrounding p /p tags are omitted (you must place them by hand).
  ppl-ommit-surrounding	as pp2, but surrounding p /p tags are omitted (you must place them by hand).
  wiki	Generates piece of XHTML2 compatible XML
  sql	Escapes for use in SQL (escaping of quotes). You will _not_ have to use this if use mm:constraint.
  js-single-quotes	Escapes single quotes for use in Javascript (with \').
  js-double-quotes	Escapes double quotes for use in Javascript (with ").
  js-both-quotes	Escapes both quote types (' and ") for use in Javascript (with \').
  url	Escapes for use in an URL (using escaping with %). When you use mm:url with mm:param tags you will not have to use this.
  urlparam	Similar to 'url' but also escapes '+'
  uppercase	Converts to all uppercase.
  lowercase	Converts to all lowercase.
  identifier	Replaces anything which is not alphanumeric by underscores.
  censor	Finds and replaces 'forbidden' words.
  swallow	Everything disappears
  links	Finds and makes clickable URL's.
  plainlinks	Finds and makes clickable URL's, assuming plain/text input.
  figlet	Filters through the command-line tool 'figlet', which can have amusing results.
  trimmer	Trims leading and trailing whitespace
  cp1252	Escapes the CP1252 characters which are not in ISO-8859-1. You don't want to serve your pages as CP1252 (it is not a standard encoding). It is adviceable to do it using UTF-8, but if you really want to use ISO-8859-1, you can create reasonable surrogates by this (nicer then question marks).
  cp1252wrong	Escapes the CP1252 characters, but suppose that the String was originally wrongly encoded (CP1252 bytes were incorrectly supposed ISO-8859-1)
  spaceremover	Replace 1 or more white space characters by one space, unless, those are the first or last of the string, those are replaced with nothing.
  spaceswallower	Removes all whitespace.
  roman	This works on integers only, and converts them to a roman numbers (lowercase, so see also 'uppercase'). This works only for natural numbers smaller than 4000.
  rot13	Performs 'rot 13' encoding of the string, to scramble letters. Can be decoded by doing a rot13 again.
  rot5	Performs 'rot 5' encoding of the string. This scrambles the digits.
  md5
  adler32	Performs a 'adler32' checksum.
  crc32	Performs a 'crc32' checksum.
  java	Escapes non-ASCII characters to java escape sequences.
  reducespace	Replaces groups of one and more newlines by one new line, and one or more space by one space. This spares bandwidth and makes the result better readable. This is default for most XML-like content types.
  entities	Any non-ASCII character will be replaced by an XML-entity.
  xmetodo	Replaces ĉ, ĝ, ĥ, ĵ, ŝ, ŭ with cx, gx, hx, jx, sx, ux
  hmetodo	Replaces ĉ, ĝ, ĥ, ĵ, ŝ, ŭ with ch, gh, hh, jh, sh, u
  perl	Interpret the complete body as a perl program, and write the result.
  sitestat	Rewrites the input to the characters which are alowed in Sitestat keys for page statistics, being: "A-Z, a-z, 0-9, - . _".

  The value can also refer to the id of an escaper tag

  
  see: content | escaper | format attribute of formatter
  

• writer
  Which writer to use. If the tag is living in more than one writer, and you want to refer to another then the direct parent.
  

• constraint
  

• container

• element
  The step to which the nodes must be added
  
• number
  The node(s) to be added
  

• container

In MMBase, objects on default do not have a `creation time' field. But the `number' field can be used to estimate the age (in days), because for every day a `day mark' is remembered. This tag gives easy access to this functionality.

Note that in MMBase 1.8 it is possible to define creation and lastmodified time fields of DATETIME database type. Age-constraints can then also be accomplished by constraints on the date parts of such a field.

• element (since: MMBase-1.8)
  If the surrounding nodelist container is a list container then the constraint can be on the several elements from the path. With this attribute you must indicate to which. This is not needed for listnodes and relatednodes containers.
  see: listcontainer | listnodescontainer
  
• field
  If the surrounding nodelist container is a list container then the constraint can be on the several elements from the path. With this attribute you must indicate to which. This is not needed for listnodes and relatednodes containers (and probably would be a `number' field otherwise). This attribute is deprecated in favour of 'element'.
  see: element attribute of ageconstraint | listcontainer | listnodescontainer
  
• minage (since: MMBase-1.7)
  Minimal age of the object in days.
  
• maxage
  Maximal age of the object in days.
  
• inverse
  Inverses the constraint. So adds a NOT.
  

• container

<mm:listnodescontainer type="typedef">
  <mm:ageconstraint maxage="100" />
  <mm:listnodes>
    <mm:field name="name" />
  </mm:listnodes>
</mm:listnodescontainer>
    

• element
  
  see: listcontainer | listnodescontainer
  
• name
  The name of the alias, or (since MMBase-1.8) a list of possible aliases.
  
• inverse
  Inverses the constraint. So adds a NOT.
  

• container

<%-- list all portals except the two portals with alias 'portalhome' and 'portalkids' --%>
<mm:listnodescontainer type="portals">
  <mm:aliasconstraint name="portalhome,portalkids" inverse="true" />
  <mm:listnodes>
    <mm:field name="title" />
  </mm:listnodes>
</mm:listnodescontainer>

• node

• jspvar
• vartype
• write
• escape

• comparator
• add
• retain
• remove
• varStatus

• referid

• id

• context

<mm:listnodes type="list">
  <mm:field name="title" />
  has the following aliases:
  <mm:aliaslist>
     <mm:write /> <mm:last inverse="true">,</mm:last>
  </mm:aliaslist><br/>
</mm:listnodes>
  

Application context

Signature: java.util.Map applicationContext(java.lang.String)

Returns an URL to the attachment servlet. This is a NodeReferrer and consequently has to live as a child of a (attachment) node.

Using this tag makes your pages more portable to other system, and hopefully less sensitive for future changes in how the attachment servlet works.

• element (since: MMBase-1.7.4)
  see: element attribute of node
  
• absolute (since: MMBase-1.9.1)
  

  Whether the used url will be 'absolute' or not. Defaults to 'server'.

  
  see: absolute attribute of url
  
• disposition
  see: disposition attribute of image
  

• node

• jspvar
• vartype
• write
• escape

• id

• context

 <mm:listnodes type="attachments">
  <a href="<mm:attachment />">Download</a>
</mm:listnodes>
    

Gets the function value of function `name'. The function value is supposed to be Boolean, and this tag acts as a `condition' tag.

For more information about how function tags work generally see the the `functiontag' entry of this reference.

• inverse

• referid

• id

• context

• name
• nodemanager
• set
• classname
• module
• referids

• node

• container

<%!
public static boolean booleanFunction() {
    return System.currentTimeMillis() % 2 == 0;
}
%>
<mm:booleanfunction set="THISPAGE" name="booleanFunction" id="yes">
  YES
</mm:booleanfunction>
<mm:booleanfunction referid="yes" inverse="true">
  NO
</mm:booleanfunction>

• transaction
  The id of the transaction.
  

See the example for tag `transaction'.

Can be used in a list to determine if this item has changed compared to the previous one. The criteria applies to the first field given in the orderby attribute of the accompanying list. This field should also be included in the fields attribute of a list or related tag, to make the field accessible.

The first item of a list is always considered `changed'.

• inverse

• list

See the example for tag `first'.

• name
  The name of the cloud. On default it is `mmbase'. The default will normally suffice, so you don't need not use this attribute.
  

  mmbase

• username
  

  The authentication name to use (account). When used together with e.g. the method="http" option, validation only succeeds if the username equals this attribute. In this case it is also possible to supply a list of user names here (comma separated)

  It can also be used in combination with the `password' attribute, in which case authentication will happen automatically with the specified credentials.

  
  
• logon
  Synonym to `username'
  see: username attribute of cloud
  
• rank
  The required rank. This is another way to force a special user when using several methods. Often, you should use this attribute in combination with some `method' attribute, because if the `current' cloud (of the session) does not have a user of at least this required rank, then it needs to know how to log in again then. If there is no method in that case, then the body will be skipped, and no error will be shown (This behaviour may be useful to `check' a cloud only).
  

  administrator
  basic user

• loginpage
  

  You can use the loginpage attribute to specify the (relative) path to a security login page. i.e.:

          
  <mm:cloud name="mmbase" loginpage="login.jsp">
  ...
  </mm:cloud>
          
          

  The attribute has effect whenever someone who is not already logged on to the cloud requests the page containing the cloud tag. In that case, the tag checks whether the page has been called with a predefined set of parameters.

  If the page was called with the `command' parameter set to `login', the tag assumes a request is being made to log on using the parameters passed. The actual names of the parameter passed differs by security method chosen, which is defined by the `authenticate' attribute. For instance, with authenticate method `username/password', the following additional parameters are recognized:

  • cloud: similar to the cloudtag's `name' attribute
  • username: similar to the cloudtag's `username' attribute
  • password: similar to the cloudtag's `password' attribute
  If login succeeds, the page continues and displays normally. If the login fails, or if no `command=login' attribute was specified, the request is redirected to the page specified in the attribute. This `login page' can then take care of authentication, i.e. by displaying a form that allows the user to enter and submit the appropriate parameters (username/password) back to the originally called page. The page may also implement its own method of authentication. The `command=login' parameter has no effect when the loginpage attribute was not specified.

  The page should link page to the page which is supplied in the reference parameter. The login page itself should have a parameter `command' with value `login', `authenticate' with the authentication method which is wanted. Additional parameters will be passed to the underlying security implementation. A simple login page could contain the following jsp-code:

          
  <%@ taglib uri="http://www.mmbase.org/mmbase-taglib-1.0"  prefix="mm"%>
  <html>
  <mm:import externid="referrer" required="true" />
  <mm:import externid="reason">please</mm:import>
  <mm:write referid="reason">
    <mm:compare value="failed">
      <font color="red">Failed to log in. Try again</font>
    </mm:compare>
  </mm:write>
      <form method="post" action="<mm:url page="$referrer" />" >
      <input type="hidden" name="command" value="login">
      <input type="hidden" name="cloud" value="mmbase"><!-- also default -->
      <input type="hidden" name="authenticate" value="name/password">
  
      <input type="text" name="username" value="">
      <br />
      <input type="password" name="password" value="">
      <br />
      <input type="submit" name="Login" value="login">
  </form>
  </html>
          
          

  When a user is logged in, a call in that page, with parameter `command' and value `logout' causes the user to be logged out.

  There are different situations on which the cloud tag with the attribute loginpage can react, they are:

  • scenario 1 : not logged-in, no parameter with value login: Stop current page processing, show the login.jsp, which is a form with parameter command with value login. Parameters can be specified inside a form. When the button submit is pressed, this parameters will be send to the referencing page (foo.jsp). The login page will be called with a `reference' attribute containing this page's URL, and a `reason' attribute `please'.
  • scenario 2 : not logged-in, a parameter with value login: The parameters will be retrieved from the request. These parameters will be passed to the security (CloudContext.getCloud(cloud, authenticate, otherparameters)), and the cloud retrieved will be stored inside the context.(from now you are logged in) Page processing of foo.jsp will continue, unless the authentications failed, because then again is redirected to the login page, but this time with `reason' `failed'.
  • scenario 3: logged-in Page foo.jsp will simply be processed. (Unless e.g. the `logon' attribute is not satisfied).
  • scenario 4: logged-in with parameter command with value logout The cloud in the session will be removed (you are now logged out) and we can continue here from scenario 1. Can also be done with method='logout'.
  
  
• password
  

  The password to use to logon to the cloud. Always consider using method="pagelogon" when you use this attribute, because the default method will otherwise be "sessionlogon". Then, the resulting cloud-object is written to the session, and the visitor of your page can abuse this to gain authorisation also on other pages.

  You could also use 'class' authentication to avoid all passwords in JSP-code.

  
  
• pwd
  Synonym to `password'
  see: password attribute of cloud
  
• method
  Describes how to get the authentication information. The default behaviour is as described in `asis'.
  

  http	Use http protocol to ask name and password from the user. If the `username' attribute is specified too, then logging on will fail if the user does not use that username. The `password' (or `pwd') attribute will be ignored.
  logout	When using `http' to log on, the browser will store name and password. If you want to log on again, you have to `logout' first. In this case the `realm' of the http authentication will be changed, and you obtain a new possibility to log on after that. The cloud you obtain is anonymous.
  anonymous	Ignore the `logon' attribute and create (or reuse) a cloud with an anonymous user.
  asis	Ignore the `logon' attribute and reuse the cloud as it is in the session, or create an `anonymous' cloud, if there is not cloud in the session.
  pagelogon	This method should be used together with the "password" attribute, to indicate that the resulting cloud should only be available to the current page, and not to the session.
  sessionlogon	This method can be used together with "password" attribute, to indicate that the resulting cloud must be written in the session, and can be picked up with method="asis" in another page. Visitors of the page using the login-method should be trusted, because they could perhaps exploit this cloud-object in the session. For backwards compatibility reasons this method is the default method if you use the `password' attribute, but a warning will be logged to encourage to state this explicitly, because it is good that you are aware of the consequences. A page using a non-anonymous cloud in the session should not be cached publicly, that is another reason to use `pagelogon'.
  delegate	Delegates logging in to the security's authentication implementation itself. The current request and response objects are given as credentials (e.g. to redirect to an external authentication server). You can also be authenticated only based on class (if in classauthentication.xml this jsp's class was mentioned).
  sessiondelegate	As delegate, only the resulting cloud is written to the session (and can be picked up with `asis'). This should only be used if the user is trusted (and not e.g. when using `class' security, because then the class is trusted, rather then the user).

• sessionname
  

  The name the cloud must get in the session. Using this it is possible to avoid retyping your password when switching between two sites which both use http authentication, but don't share users.

  You can also use a different sessionname for editor pages, so that editors need to log in separately on the front-end, which makes it easier for them to see how pages look for normal users.

  
  
• authenticate
  The authentication module which must be used by the security system. The default is "name/password", which will do in many cases. Other values are often needed when method="delegate" or method="sessiondelegate".
  

  name/password	The most common authentication method. You somehow have to supply a name/password combination.
  class	This can be used in combination with method="delegate". The 1.8 class security (which can be installed in 1.7) feature can recognize this, and supply a cloud based on the class name of this jsp.

• uri
  The uri in case the cloud has to be retrieved using the RMMCI. This makes it possible to display remote content.
  

  local	Get a local cloud.
  rmi://...	RMMCI cloud.

  rmi://www.mmbase.org/remotecontext

• jspvar
  The name of The JSP variable to create that contains a reference to the cloud.
  

• referid

• id

• context

<!-- Show titles of all news articles from user kamer
    (which are in pool kamer_pool) only to user kamer -->
<mm:cloud jspvar="cloud" logon="kamer" method="http">
logged on as: <bean:write name="cloud" property="user.identifier" /><br />
<mm:node number="kamer_pool" id="my_node">
  <mm:related paths="news" orderby="number" directions="DOWN">
     <mm:first>
        <!-- show a small heading,
            which also contains the node-number of the pool -->
        <mm:field node="my_node" name="number" />:
        <mm:field name="number" />
            <mm:fieldinfo type="guiname" />
        </mm:field>:
        <mm:field name="title" />
            <mm:fieldinfo type="guiname" />
        </mm:field>:
     </mm:first>
     <mm:field name="number" />: <mm:field name="title" /><br />
  </mm:related>
</mm:node>
</mm:list>
</mm:cloud>
    

<!-- To logon on as a different user on my_page.jsp,
    make a ref to a page -->
<mm:cloud method="logout" />
<% response.sendRedirect("http://my_host/my_page.jsp"); %>
    

<mm:cloud>
   <!-- show some data, in this case, the first 'typedef', 
        because this type is availabe in every MMBase installation -->
   <mm:listnodes type="typedef" max="1">
     <mm:field name="name" /> : <mm:field name="description" />
   </mm:listnodes>
</mm:cloud>

<mm:cloud method="http" jspvar="cloud">
  logged on as: <%= cloud.getUser().getIdentifier() %><br />
</mm:cloud>
<a href="<mm:url page="logout.jsp" />">logout</a>

<mm:cloud method="logout" />
<br />
<a href="<mm:url page="cloud.jsp" />">back to cloud.jsp</a>

• type
  

  name	The name of the cloud (Usually just `mmbase')
  user	The identifier of the user of this cloud. You can show who is logged in by this.
  rank	The rank of the user of this cloud, as a String
  rankint	The rank of the user of this cloud, as an Integer
  mmbaseversion	The version of the current instance of MMBase to which this cloud refers.

• jspvar
• vartype
• write
• escape

• cloud

• id

• context

      You are <mm:cloudinfo type="user" /> (<mm:cloudinfo type="rank" />)
      <mm:hasrank value="administrator">
        You are administrator !!
      </mm:hasrank>
      <mm:hasrank minvalue="administrator" inverse="true">
        You are not administrator!
      </mm:hasrank>
        Cloud: <mm:cloudinfo type="name" />

• transaction
  The id of the transaction.
  

See the example for tag `transaction'.

• referid
  Which context variable to compare. It this attribute is missing, then the value of the parent `writer' is taken.
  
• value (Either `value', `valueset', `referid2' or 'regexp' must be present.)
  The value to which you want to compare, this is always a String.
  
• valueset (Either `value', `valueset', `referid2' or 'regexp' must be present.) (since: MMBase-1.7)
  List of values. Compare is done with each, and total result is true if one of them evaluates true.
  
• referid2 (Either `value', `valueset', `referid2' or 'regexp' must be present.)
  The value can also be another context variable, which is not necessarily a string. The type (set by `vartype') is taken into account.
  see: vartype attribute of writer
  
• regexp (Either `value', `valueset', `referid2' or 'regexp' must be present.) (since: MMBase-1.8)
  Matches value to a regular expression. See javadoc of java.util.regex.Pattern
  

• inverse

• writer

    <mm:import id="carry_out">yes</mm:import>
    <mm:compare referid="carry_out" value="yes">
        Body should be carried out!
    </mm:compare>
    <mm:compare referid="carry_out" value="no">
        Body should not be carried out!
    </mm:compare>
    

      <mm:compare referid="zipcode" regexp="(?i)[0-9]{4}\s?[a-z]{2}">
         zip-code correct.
      </mm:compare>

    

• name
  The name of the component of which a block must be rendered.
  
• block
  The name of the block which must be rendered. If this is empty, the default block of the component will be rendered.
  
• windowstate
  
• render
  

  head
  body
  processor

• debug
  see: debug attribute of include
  

• context

• operator
  The operator to be used in the comparison. Defaults to `AND'
  

  OR
  AND

• inverse (since: MMBase-1.8.7)
  see: inverse attribute of constraint
  

• container

The following code lists all users with username 'admin' or 'test'.

<mm:listnodescontainer type="people">
  <mm:composite operator="OR">
    <mm:constraint field="username" value="admin" operator="LIKE" />
    <mm:constraint field="username" value="test" operator="LIKE" />
  </mm:composite>
  <mm:listnodes>
    <mm:field name="username" /> <br />
  </mm:listnodes>
</mm:listnodescontainer>
        

• field
  The field to which the constraint must be applied.
  
• field2
  Another field the field is to be compared with.
  
• value
  The value the field is to be compared with.
  
• referid
  The value the field is to be compared.
  
• value2
  Needed for BETWEEN operator.
  
• referid2
  Needed for BETWEEN operator.
  
• inverse
  Inverses the constraint. So adds a NOT.
  
• casesensitive
  Changes the given constraint's `case sensitivity' (if applicable). Default it is false.
  
• part (since: MMBase-1.8)
  Designates a part of a date field to compare.
  

  CENTURY
  YEAR
  MONTH
  QUARTER
  WEEK
  DAY
  DAYOFYEAR
  DAYOFMONTH
  DAYOFWEEK
  HOUR
  MINUTE
  SECOND

• operator
  The operator to be used in the comparison. Defaults to `='
  

  EQUAL
  =
  LESS
  <
  LESS_EQUAL
  <=
  GREATER
  >
  GREATER_EQUAL
  >=
  LIKE
  BETWEEN	Should also use value2 or referid2
  IN	The value can be a comma separated String of values. You can also refer to some list with `referid' (e.g. to a nodelist tag)
  NULL	Tests whether the value of the field is NULL (or NOT NULL if inverse="true"). The `value' attributes are ignored.

• container

<mm:listnodescontainer type="people">
  <mm:composite operator="OR">
    <mm:constraint field="username" value="admin" operator="LIKE" />
    <mm:constraint field="username" value="test" operator="LIKE" />
  </mm:composite>
  <mm:listnodes>
    <mm:field name="username" /> <br />
  </mm:listnodes>
</mm:listnodescontainer>
    

Tests whether a collection contains a certain element. This can be used in JSP 2 expressions.

Signature: boolean contains(java.util.Collection, java.lang.Object)

      <c:if test="&#x24;{mm:contains(list, case)}">
    

The content tag is meant to put around your whole page, and set general properties, like language, taglib behaviour, content type.

The content-tag can also provide a default `escaping' behavior for surrounded `writer' tags.

It also tries to set reasonable cache-headers. Make sure to read the documentation of the `expires' attribute.

• language
  The language in which this page is supposed to be written. This information is available to sub-tags (like cloud-tag).
  see: language attribute of locale
  
• country
  see: country attribute of locale
  
• variant (since: MMBase-1.8)
  see: variant attribute of locale
  
• timezone (since: MMBase-1.8.1)
  see: timezone attribute of locale
  
• jspvar
  
• type
  

  The Content-Type of this page.

  Setting the content-type can also trigger a default `escaper' and `postprocessor'.

  Id	Content-Type	Default escaper	Default postprocessor	Default encoding
  html	text/html	text/html	reducespace	NOTSPECIFIED
  xhtml	application/xhtml+xml	text/xml	reducespace
  xml	application/xml	text/xml	reducespace
  text/html	text/html	text/html	reducespace	NOTSPECIFIED
  text/xml	text/xml	text/xml	reducespace	NOTSPECIFIED
  application/xml	application/xml	text/xml	reducespace
  application/xhtml+xml	application/xhtml+xml	text/xml	reducespace
  audio/x-pn-realaudio	audio/x-pn-realaudio	none	reducespace
  application/smil	application/smil	text/xml	reducespace
  text/vnd.rn-realtext	text/vnd.rn-realtext	text/xml	reducespace
  video/x-ms-wmp	video/x-ms-wmp	text/xml	reducespace
  text/javascript	text/javascript	none	reducespace
  text/css	text/css	none	reducespace

  
  
• encoding
  The output text encoding. Don't attribute too much value too this. Normally it's better to arrange this with the page-directive of JSP. Certainly this attribute cannot arrange the pageEncoding (or the coding of the JSP source itself).
  

  UTF-8

• expires
  

  Defines when this page expires (in seconds after now). If you set this, this has influence on some http header being set ('Cache-Control' and `Expires'). This default to one minute public-caching if there is no session used on the page, and to no caching otherwise.

  Setting this to 0 has the effect of disabling all proxy-caching.

  If expires is is set to a value greater than 0, and there is a Cloud-tag in the page which wrote a non-anonymous cloud object to the session, then the Cache-Control header is `private', rather than public, because such a situation implies that there is something on the page which is not public.

  
  
• disposition (since: MMBase-1.8.5)
  Provides a proposal filename for the response. The content-disposition of the resonse will be set to 'attachment', and this filename.
  
• postprocessor
  

  If this attribute is set the complete body-result is piped through this. If you specified `type', then a default postprocessor might be defined.

  The following postprocessors can be specified (besides the ones defined with mm:escaper tags).

  Postprocessor
  reducespace	Replaces groups of one and more newlines by one new line, and one or more space by one space. This spares bandwidth and makes the result better readable. This is default for most XML-like content types.
  entities	Any non-ASCII character will be replaced by an XML-entity.
  xmetodo	Replaces ĉ, ĝ, ĥ, ĵ, ŝ, ŭ with cx, gx, hx, jx, sx, ux
  hmetodo	Replaces ĉ, ĝ, ĥ, ĵ, ŝ, ŭ with ch, gh, hh, jh, sh, u
  perl	Interpret the complete body as a perl program, and write the result.
  sitestat	Rewrites the input to the characters which are alowed in Sitestat keys for page statistics, being: "A-Z, a-z, 0-9, - . _".

  
  see: escaper
  
• escaper
  

  The default value of the escape attribute of all writer tags in the body. The values are defined in taglibcontent.xml. Reasonable defaults apply if you explicitly specify a type.

  The `escape' attribute of the surrounded writers can be used to override this. (E.g. if the writer itself produces HTML (e.g. mm:function name="gui"), then you should use escape="none").

  The following `escapers' can be specified (besides the ones defined with mm:escaper tags):

  Escaper
  text/plain	This equals no escaping
  none	No escaping
  text/html	Escapes for use in HTML.
  text/html/attribute	Escapes for use in HTML atributes
  text/xml	Escapes for use in XML (or XHTML).
  inline	Interpret as 'enriched' ASCII for 'inline' HTML parts (so no blocks)
  p	Interpret as 'enriched' ASCII for 'block' HTML parts. It normally generates one or more p-tags (everything is enclosed by a p tag, including lists).
  pp	As 'p', but only one sequences of one br-tags are produced
  p-ommit-surrounding	as p, but surrounding p /p tags are omitted (you must place them by hand). This can be needed for 'read-more' links.
  pp-ommit-surrounding
  pl	Interpret as 'enriched' ASCII for 'block' HTML parts. It normally generates one or more p-tags. Lists (ul tags) are placed outside the paragraphs. As such a block may start or end with an ul tag.
  ppl	As 'p2', but only one sequences of one br-tags are produced
  pl-ommit-surrounding	as p2, but surrounding p /p tags are omitted (you must place them by hand).
  ppl-ommit-surrounding	as pp2, but surrounding p /p tags are omitted (you must place them by hand).
  wiki	Generates piece of XHTML2 compatible XML
  sql	Escapes for use in SQL (escaping of quotes). You will _not_ have to use this if use mm:constraint.
  js-single-quotes	Escapes single quotes for use in Javascript (with \').
  js-double-quotes	Escapes double quotes for use in Javascript (with ").
  js-both-quotes	Escapes both quote types (' and ") for use in Javascript (with \').
  url	Escapes for use in an URL (using escaping with %). When you use mm:url with mm:param tags you will not have to use this.
  urlparam	Similar to 'url' but also escapes '+'
  uppercase	Converts to all uppercase.
  lowercase	Converts to all lowercase.
  identifier	Replaces anything which is not alphanumeric by underscores.
  censor	Finds and replaces 'forbidden' words.
  swallow	Everything disappears
  links	Finds and makes clickable URL's.
  plainlinks	Finds and makes clickable URL's, assuming plain/text input.
  figlet	Filters through the command-line tool 'figlet', which can have amusing results.
  trimmer	Trims leading and trailing whitespace
  cp1252	Escapes the CP1252 characters which are not in ISO-8859-1. You don't want to serve your pages as CP1252 (it is not a standard encoding). It is adviceable to do it using UTF-8, but if you really want to use ISO-8859-1, you can create reasonable surrogates by this (nicer then question marks).
  cp1252wrong	Escapes the CP1252 characters, but suppose that the String was originally wrongly encoded (CP1252 bytes were incorrectly supposed ISO-8859-1)
  spaceremover	Replace 1 or more white space characters by one space, unless, those are the first or last of the string, those are replaced with nothing.
  spaceswallower	Removes all whitespace.
  roman	This works on integers only, and converts them to a roman numbers (lowercase, so see also 'uppercase'). This works only for natural numbers smaller than 4000.
  rot13	Performs 'rot 13' encoding of the string, to scramble letters. Can be decoded by doing a rot13 again.
  rot5	Performs 'rot 5' encoding of the string. This scrambles the digits.
  md5
  adler32	Performs a 'adler32' checksum.
  crc32	Performs a 'crc32' checksum.
  java	Escapes non-ASCII characters to java escape sequences.
  reducespace	Replaces groups of one and more newlines by one new line, and one or more space by one space. This spares bandwidth and makes the result better readable. This is default for most XML-like content types.
  entities	Any non-ASCII character will be replaced by an XML-entity.
  xmetodo	Replaces ĉ, ĝ, ĥ, ĵ, ŝ, ŭ with cx, gx, hx, jx, sx, ux
  hmetodo	Replaces ĉ, ĝ, ĥ, ĵ, ŝ, ŭ with ch, gh, hh, jh, sh, u
  perl	Interpret the complete body as a perl program, and write the result.
  sitestat	Rewrites the input to the characters which are alowed in Sitestat keys for page statistics, being: "A-Z, a-z, 0-9, - . _".

  
  see: escape attribute of writer | function | escaper
  
• unacceptable (since: MMBase-1.8.5)
  

  What to do if the to-be-produced content-type seems to be unacceptable for the client.

  
  

  	Like not using the attribute, i.e. send the content anyway.
  CRIPPLE<:message>	Try to cripple the type (degrade application/xtml+xml to text/html), until it is acceptable. If not possible the message can be used for the NOT_ACCEPTABLE response
  <:message>	Send a NOT_ACCEPTABLE with this message. If message = "_" it will be leaft empty.

`Contextwriter' tags inside a context tag supplying the `id' attribute register themselves in the context. Other tags can refer to this id. See for example how the createrelation tag works. A special case of a another tag referring to this id is a tag of the same type. Normally with an attribute `referid' you could `repeat' the tag.

With the import tag you can explicitly put things from outside this context into this context, e.g. from the parameter list or from a parent context. It is also possible to put new strings in the context with the import tag.

There are several ways to refer to objects in the context.

When you are adding a new object then the used attribute is `id'.

The `id' of an `external' object like a request parameter is referred to as `externid' (only in the import tag).

If you are reusing the same object, for example you have put a node in the context, and are using it again then an attribute `referid' is used.

If some attribute wants to use the value of an object in the context, and it is an attribute which can refer to the context (which most attributes are), then you can use something like <context-id;>.<object-id>. The `context-id' is optional when you are in the same context, or sub-context. The value of a context variable can be written to the page with the `write' tag. The {}-parentheses are optional too.

And finally there are some attributes which can only refer. For example if some tag has to live as a child of another tag but you want it to refer not to its direct parent, then there should be an attribute with the name of the parent in which you can put the id of the parent which it has to refer to. For example the field tag has an attribute `node'. This kind of referring does not function per the ContextTag, and is only good for finding ancestor tags. Other tags, like the createrelation tag have attributes like `source' and `destination' attributes which also simply contain the node id's. Please find the examples.

In TCP there is a `tag' called `create', which is comparable to `context'.

On default a context has no id. The implicit `page' context also doesn't have. If a context has no id, there is no way of referring to variables of it if you are not in the context itself (or one of the sub-contexts).

• referid (since: MMBase-1.7)
  Pick up existing context.
  
• scope (since: MMBase-1.8)
  Pick up existing context.
  

  page
  request
  session
  application

• id

• context

Use a context inside another context (inside the default `context')
                and import parameters:
<mm:import id="hoi">greetings from amsterdam</mm:import>
<mm:import id="alias" externid="hoi" required ="true" />
<mm:context id="other_context">
  <mm:import externid="alias" />
  <mm:write referid="alias" /><br/>
  <mm:import id="hoi_again">greetings from hilversum</mm:import>
  <mm:write referid="hoi_again" />
</mm:context>

<mm:import id="hoi" externid="haj" from="parameters" required="true" jspvar="groet" />

<mm:write referid="hoi" />,
<mm:write referid="hoi" jspvar="greet">
  <%= greet %>
</mm:write>

<mm:context id="A">  
  <mm:import id="hoi">hola!</mm:import>
  In context A we also create the variable 'hoi'. This time its value
 is 'hola!' </p><p>
  <mm:context id="B">
    Within a 'child' context of A (we named it B), you can write easily the variable
    from the parent context:
	<mm:write referid="hoi" /></p><p>
    Imagine that also in this context B we create a variable 'hoi', so
    that now we already have three variable named 'hoi'.
	<mm:import id="hoi">foobar</mm:import>
    <mm:context id="C">
     Then we could also demonstrate the use of the attribute
	'context'. It is not really necessary but exist for symmetry
	reasons. With it you can indicate in which of the parent contexes
	the write tag must be evaluated: <mm:write context="A"
	referid="hoi" />, <mm:write referid="A.hoi" />, <mm:write
	context="B" referid="hoi" />, <mm:write referid="A.B.hoi" />,
	<mm:write referid="hoi" /> </p>
    <p>The most upper value of the
	variable 'hoi' in this page (the one which was gotten with 'haj')
	is not accessible here in context C, because the implicit page
	context is unnamed and the 'hoi' variables of contextes A and B
	are shielding it.
    </mm:context>
  </mm:context>
</mm:context>

<mm:write referid="A.B.hoi" />, 
<mm:write referid="A.hoi" />, 
<mm:write referid="hoi" />

• type
  If specified only the number of relations to the type of nodes specified by this attribute are returned.
  
• searchdir (since: MMBase-1.7)
  
  
• role (since: MMBase-1.7)
  
  

• jspvar
• vartype
• write
• escape

• node

• referid

• id

• context

<mm:listnodes type="list">
    <mm:field name="title" /> has <mm:countrelations /> relation(s)<br/>
</mm:listnodes>
    

• name
  In stead of giving it in the body, you can also indicate it with this parameter.
  

• node

<mm:listnodes type="list" max="1">
    <mm:createalias>my_list</mm:createalias>
</mm:listnodes>
    

• type
  The type (NodeManager name) of the new node.
  

  news
  people

• jspvar
• commitonclose

• id

• context

• cloud

 <mm:createnode type="news" id="new_news">
   <mm:setfield name="title">Create node example</mm:setfield>
</mm:createnode>
    

• role
  The role for the new relation.
  
• source
  The id of the node which will be on the source side of the relation.
  
• destination
  The id of the node which will be on the destination side of the relation.
  

• jspvar
• commitonclose

• cloud

• id

• context

<mm:cloud>
<mm:transaction id="my_transaction">
<mm:createnode type="news" id="my_news">
   <mm:setfield name="title">Todays news</mm:setfield>
   <mm:setfield name="subtitle">There happened a lot today</mm:setfield>
</mm:createnode>
<mm:node number="1808" id="my_author" />
<mm:createrelation role="author" source="my_author" destination="my_news" />
</mm:transaction>
</mm:cloud>
    

• base
  
• id
  
• nodemanager
  
• field
  

• cloud

Lives in a NodeProvider. Deletes the body content as an alias for the node.

Why should deletealias live in a NodeProvider? That is because on the `bridge', deleteAlias is on Node too.

• name
  In stead of giving it in the body, you can also indicate it with this parameter.
  

• node

Delete the alias "my_news" from one of the news nodes:
<mm:listnodes type="news">
    <mm:deletealias name="my_news" />
</mm:listnodes>
    

• deleterelations
  

  true
  false

• number
• notfound
• element

• jspvar
• commitonclose

• node

• cloud

• referid

• id

• context

<mm:listnodes type="list" max="1">
  <mm:maydelete>
    <mm:deletenode deleterelations="true"/>
  </mm:maydelete>
</mm:listnodes>>
  

• referid

• id

• context

• jspvar
• vartype
• write
• escape

Calculates the directory part of a certain string. If string ends with / the string itself.

Signature: java.lang.String directory(java.lang.String)

      <mm:xslt page="${mm:directory(referrer)}/bla.xml" />
    

• value
  `true' (default) or `false'.
  

  true
  vale

• container

<mm:listcontainer path="mags,news,people" fields="mags.title,people.firstname">
  <!-- This will return 5 identical rows -->
  <mm:list>
    <mm:field name="mags.title" /> - <mm:field name="people.firstname" />
  </mm:list>
  <mm:distinct />
  <!-- This returns one row -->
  <mm:list>
    <mm:field name="mags.title" /> - <mm:field name="people.firstname" />
  </mm:list>
</mm:listcontainer>

Makes the fields it contains in its body 'editable' or reachable for an editor for that matter.

• type
  

  The type of editor you wish to use which should be specified in the tag's resource file. The rest of it is configured using parameters.

  
  

<mm:edit type="yammeditor">
  <%--
      optional parameters

  <mm:param name="url" value="/yammeditor/yammeditor.jsp" />
  <mm:param name="icon">/mmbase/edit/my_editors/img/mmbase-edit.gif</mm:param>
  --%>
  <mm:node number="default.mags" notfound="skip">
    <h2><mm:field name="title" /></h2>
    <mm:relatednodes role="posrel" orderby="posrel.pos"  type="news">
      <h3><mm:field name="title" /></h3>
      <mm:relatednodes type="people">
        by <mm:field name="email" />
      </mm:relatednodes>
    </mm:relatednodes>
  </mm:node>
</mm:edit>

Performs taglib-escaping.

Signature: java.lang.String escape(java.lang.String, java.lang.Object)

      <a href="${node.url}" title="${mm:escape('text/html/attribute', node.title)}" .../>
    

• escape
  
  see: escape attribute of writer
  

• cloud

• id
  By the id the escaper is available.
  
• referid
  Reuses the escaper identified by this.
  
• type
  What kind of escaper.

  Parameterized Escaper		Parameters
  regexps	Regexp-replacing.	Parameter name Description patterns A list of entries describing regular expresions replacements. Replacements happens per word.
  wrap	Word wrapping. Works on plain/text, and wraps with newlines. Can be converted to HTML with a chained escaper.	Parameter name Description length Length of lines (default to 80).
  substring	Take substring.	Parameter name Description from to ellipsis Can be used to put those three dots ('...') at the end of a 'substringed' line.
  paragraph	Wraps a text in paragraph (p) tags, unless it is empty or that textstarts with a p tag (in which case it is already wrapped). Use this for fields that contain HTML, but for which you are unsure if they have parahraph tags already	Parameter name Description class A class name to give to the paragraph tag.
  resourcebundle	Replaces the words which are present as key in given resourcebundle with the values. Since resource bundles are localized, this gives a way to translate (mm:write is nearly fmt:message). E.g. mm:write escape="resourcebundle(org.mmbase.datatypes.resources.ordinals)" value="5".	Parameter name Description basename mode locale
  ordinals	Replaces numerics with ordinals ('first', 'second'...).	Parameter name Description basename mode locale
  google	Explores the request for the 'referer' http header. If this is from google, the google search words are highlighted in the text.	Parameter name Description
  encryption	Encrypts or decrypts the given input using a cryptographic algorithm that is specified as a parameter.	Parameter name Description key The key used to encrypt the data. eg. AES uses a 128 bit key. format The in-/output format of the ecrypted data. 'hex'(default) or 'base64' algorithm The algorithm used for the encryption. eg. 'AES'(default), 'DES', 'Blowfish', etc. direction The direction of encryption. 'encrypt'(default) or 'decrypt'
  codesample	Escapes the code between the tags you define. This escaper enables the use of two different escapers in one piece of text. It was started to simplify the inclusion of a code snippet in html but can be used for other purposes as well. You can specify the tags between which you wish to escape your text, the escaper to use and you can set an escaper for the rest of the text. It needs to be rewritten to support all escapers/transformers. It only supports the escapers p, pp, p-ommit-surrounding, pp-ommit-surrounding, inline, text/html and text/xml for now. All parameters may be ommitted then it defaults to <pre> and 'text/html'. Use it like f.e.: <mm:import id="texttext"> This is an example: <% String foo = "bar"; %> </mm:import> <mm:escaper type="codesample" id="testsample" /> <mm:write referid="testtext" escape="testsample" />	Parameter name Description starttag The starttag, f.e. <pre>. closetag The closetag, f.e. </pre>. escapecode The escaper to use between the start- and closetag. escaperest The escaper to use on the rest of the text.
  tagstripper	Changes existing HTML markup.	Parameter name Description tags Either XSS or NONE. XSS will strip all tags and attributes which may have been present in the HTML to try cross-site-scripting. NONE will strip all tags, and produce plain text. addbrs If true, then newlines are replaced by br-tags. This can be used to make better html from a kind of pseudo-html. escapeamps Html 4 entities are resolved. This indicated whether the remaining ampersands must be replaced with &amp;. Default to false. But see also the 'toxml' escaper.
  toxml	This filters HTML-4, and cleanes it up, so that it is valid XML. At the moment, like tagstrippers(XSS), with escapeamps is true.	Parameter name Description tags addbrs escapeamps

  
  
• inverse
  Turns the escaper arround (so, will call the 'transformBack' methods).
  

<mm:escaper id="vervang"><!-- define a new 'escaper' which is a combination of 3 other escapers -->
  <mm:escaper type="regexps">
    <mm:param name="patterns"><!-- the regexps type escapers need a parameter named 'patterns' -->
      <!-- this parameter must be a list of name-value's. We can simply use sub-param-tags for that -->
      <mm:param name="aaa" value="bbb" />
      <mm:param name="ccc" value="ddd" />
    </mm:param>
  </mm:escaper>
  <mm:escaper referid="uppercase" /> <!-- simply reuse an existing one here -->
  <mm:escaper type="substring">
     <mm:param name="from" value="2" />
  </mm:escaper>
</mm:escaper>
<p>
  <mm:write value="aba aaa b ccc " escape="vervang" /><!-- will write A BBB B DDD -->
</p>

• inverse

• list

See the example for tag `first'.

• name
  

  The name of the field to get. It could also be field-like `functions' which can be recognized by the appearing of parentheses. Which functions are available is principally dependent on the node-type. Functions can also be accessed more cleanly by `function' tags.

  When this attribute is missing, then the field is copied from a parent FieldProvider (e.g. another field tag), which must be present then.

  
  

  title	Returns the value of the field `title'
  gui()	Returns an html `GUI' representation of the node. It is nicer to use the mm:function tag for this
  gui(handle)	Returns an html `GUI' representation of the field `handle'. It is nicer to use the mm:function tag for this.
  cache(s(100))	Only for images. Returns the icache node number of a image rescaled to 100. It is nicer to use the mm:function tag for this.
  html(body)	Returns the body field converted to (bad) HTML. It is nicer to use the attribute escape="p" for this.
  wrap(title,10)	Wraps the title to 10 chars.

• notfound (since: MMBase-1.8)
  

  If the node doesn't have the given field, what to do then?

  
  

  skip|skipbody	Simply skip the body if the field is not available
  message	Simply write to the page that the field it not available
  throw|throwexception	Throw an exception if the field is not available (default)
  null|providenull	Provides null as the value for the field
  log	Like 'skip' but logs a message.

• jspvar
• vartype
• write
• escape

• field

• node

• referid

• id

• context

See the example for tag `node'.

The fieldinfo tag can be used inside a FieldProvider. It's basic goal is to provide information about the field, though it sometimes can do a little more. It can for example in some case also change the field.

If the parent fieldprovider is a fieldlist then this fieldlist does not always provide a node as well. In that case not every type of information is available.

• type
  The type of information which must be returned
  

  name	The name of the field
  guiname	The GUI name of the field (can be in other language)
  description	The description of the field (can be in other language)
  datatype	A String identifying the datatype of the field
  datatypedescription	A description for the datatype of the field
  input	A form entry for the field. If the surrounding FieldList has an id, the names of the form entries will be prefixed with it, so it is possible to use it for the same fields in the same form more than once. The post of the form should be treated with corresponding mm:fieldinfo type='useinput's.
  useinput	If you have created a form with type="input" and this form was submitted, then you can use type="useinput", and it will get the request/post parameter produced by "input" and make the right changes to the parent field. The necessary externid's for this will be implicitly imported in the context. You don't have to worry about them. `useinput' is exceptional because it doesn't really produce any `info' about the field, but rather changes it. Can only be used if the parent FieldProvider also provides a Node.
  searchinput	A form entry for the field, fit for use for searching. That means that no textareas will be used and such.
  usesearchinput	If you have created a form with type="searchinput" and this form was submitted, then you can use this. It will produce a part of a where clause which you can use to construct a whole `where' for the list tag you are going to use.
  reusesearchinput	Adds the search query to the surrounding param-handler, like an mm:url.
  value	The value of this field. Can only be used if the parent FieldProvider also provides a Node.
  guivalue	The guivalue of this field. Can only be used if the parent FieldProvider also provides a Node (can be in other language).
  type	The storage type of this field. Which is an integer. You may like typedescription.
  typedescription	The storage type of this field, as a string. Like 'string', 'integer', 'long', 'xml'.
  guitype	The guitype of this field. The guitype further specializes on the type, and can be found in the guitype field of builder xml's. The combination of type/guitype is used by e.g. the `input' version of this tag, to create feasible HTML input entries.
  check	Only checks whether the field's value is valid. If not, that is reported to a parent form tag.
  errors	Like 'check', but displays the error messages if not valid.

• options
  Specify additional parameters for the presentation/manipulation of the field.
  

  datetime	If the value is a date-time, treat it as a date time combination. This is deprecated. In 1.8 you can indicate this with the pattern setting on the datatype.
  time	If the value is a date-time, treat it as time only This is deprecated. In 1.8 you can indicate this with the pattern setting on the datatype.
  date	If the value is a date-time, treat it as date only. This is deprecated. In 1.8 you can indicate this with the pattern setting on the datatype.
  extra:onchange='doStuff()'	if the type is `input' then you might want to add javascript on the onchange (or add other attributes, like `style' or so) This is deprecated. In 1.8 the produces input entries have very precise CSS classing, which can be used to implicitely attach events on load of the window.
  noempty	if the type is `input', then in certain cases (e.g. when using AJAX), you want that never empty textareas are produced
  trim	if the type is `useinput', then the value is trimmed first. Used in conjunction with the 'noempty' option on the corresponding input field

• datatype (since: MMBase-1.8)
  On default, the datatype of the specified field is used. But this can be overridden.
  

• field

• node

• id

• context

• jspvar
• vartype
• write
• escape

See the example for tags `cloud' and `nodeinfo'.

A list of fields. A fieldlist can be inside a NodeProvider in which case the NodeManager is found by means of the parent node. It can also be standalone, then you have to supply the type of the node (the name of the `node manager').

If the 'container' attribute is used, then it can refer to one of the 'NodeQueryContainers' which also provide a NodeManager.

• nodetype
  
• fields
  

  You can specify a comma separated list of fields you want to list too. If you specify this together with the type attribute, these fields will be added (to the end) of the ones defined in that way.

  If a field does not exist, it is ignored if you postfix it with `?'. This makes it possible to make more generic editors, or add optional fields to a nodemanager.

  
  
• type
  The type of fields that should be returned. If not specified, all fields are returned.
  

  create	This results in a list of all `real' fields.
  edit	Return only those fields that should appear in the input area of the editor.
  list	Return only those fields that should appear in the list area of the editor.
  search	Return only those fields that should appear in the search area of the editor.
  all	Return all fields.

• jspvar (since: MMBase-1.7)
  You can make a jspvar of type `Field' of `FieldValue' (only if that is logically possible) available to the body
  
• vartype (since: MMBase-1.7)
  The type of the variable to be created.
  

  field
  fieldvalue

• comparator
• add
• retain
• remove
• varStatus

• referid

• id

• context

• field

• node

• container

See the example for tag `nodeinfo'.

      <mm:fieldlist nodetype="insrel" id="insrelfields" type="list" />
      <table>
        <mm:listrelationscontainer id="container" role="$role" type="$destination" searchdir="$search">
          <tr>
            <th>${search}</th>
            <th>#</th>
            <mm:fieldlist id="fields" container="container" type="list" remove="insrelfields">
              <th><mm:fieldinfo type="name" /></th>
            </mm:fieldlist>
          </tr>
        </mm:listrelationscontainer>
      </table>
      
    

• inverse

• list

<mm:listnodes type="typedef">
 <mm:first><ul></mm:first>
 <li>
   <mm:field name="name"/> is: <mm:field name="description"/>
   Index: <mm:index />
   <mm:odd>(odd item)</mm:odd>
   <mm:even>(even item)</mm:even>
   <mm:changed>(different from previous item)</mm:changed>
 </li>
 <mm:last></ul></mm:last>
</mm:listnodes>
    

• mode
  

  url	Produces an URL for an HTML form only (available in the body), and (reuses) an MMBase transaction. Only explicit commit/cancel
  form	Produces an HTML form, and (reuses) an MMBase transaction. Only explicit commit/cancel (with mm:commit, mm:cancel, or 'commitonclose'). This value is the default
  validate	Does nothing, besides communicating with mm:fieldinfo's and mm:valid's. Does not produce any content. Implicitely cancels the transaction if not committed.
  transaction	Does not produce any content. Besides communicating with children fieldinfo's and valid's ehaves like mm:transaction. Only difference is that on default it does not commit on close.

• page
  to use in action attribute of produced form.
  see: page attribute of url
  
• styleClass (since: MMBase-1.8.1)
  If form-tag is produced, you may want to have it a class-attribute too. By the way, it always has an mm_form class.
  see: styleClass attribute of image
  
• absolute (since: MMBase-1.9)
  see: absolute attribute of url
  

• name
• jspvar
• commitonclose

• id

• context

• cloud

• xslt
  Path to the XSLT file which must, relative to the current JSP file. If you want to use default MMBase XSLT's, then you can prefix by `mm:', and searching will begin in the mmbase configuration directory.
  
• format
  

  A few transformations are predefined in MMBase. If they are XSL transformations then you can put your extensions in e.g. xslt/2xhtml.xslt. This xslt can be extended from the `basic' xslt by beginning it with: <xsl:import href="mm:2xhtml.xslt" />.

  So basically, when you do specify the format attribute there can happen two different things:

  • It is a shortcut for certain values for the `xslt' attribute. E.g. format="xhtml" is shorthand for xslt="xstl/2xhtml.xslt".
  • It give access to certain java functionality present in the formatter tag's implementation. It is e.g. senseless to escape XML with a XSL style sheet, when it can be done so easily in Java.
  
  

  none	No transformation done by this tag itself. Simply writes out the body, it considers the 'escape' attribute though, so this can be used to apply escapers to body-text.
  xhtml	An XSLT. Transforms nodes or fields to an XHTML presentation.
  rich	An XSLT. Transforms mmxf fields to simple text only presentation.
  presentxml	An XSLT. Tries to make a nice presentation of XML in XHTML, with colors and so on.
  code	An XSLT. Doesn't work well. To present taglib code.
  escapexml	Escapes characters which make something XML. This way you can easily present XML in XHTML pages. This option is obsoleted by the 'escape' attributes of writers.
  escapexmlpretty	Similar to escapexml, but the XML is nicely formatted for human consumption first. This required the XML to be valid, otherwise you get an exception.

• options
  You can give options to the transformation. Parameters can be done with 'referids' or mm:param sub-tags.
  
• referids (since: MMBase-1.8)
  Similar to `referids' attribute of mm:url
  see: referids attribute of url
  
• wants
  

  This tags can communicate in two ways with its body. Normally the default way will do what you expect, but occasionally it can be that it doesn't. then this attribute will come in handy.

  If you don't understand this attribute, then don't worry. You will when you need it.

  
  

  string	Means that the tag simply takes its body as a string.
  DOM	Means that the tag must contains sub-tags, which can communicate themselves to this formatter tag and are put in a DOM Document (created by org.mmbase.bridge.xml.Generator)
  default	This is the default, and means that the way in which the formatter tag get its information is determined smartly. This means that it is `DOM' iff the body contains only tags which can communicate themselves to this tag, or don't produce output themselves (are not writer tags) and the `format' is an XSLT-format.

• namespaceaware (since: MMBase-1.8)
  Whether the generated DOM (if that happens) must be created with the name-space http://www.mmbase.org/objects. Defaults to true.
  

• id

• context

• context

• jspvar
• vartype
• write
• escape

• name
  The name of the parameter. If this attribute is missing, the value is interpreted as a , separated list of name=value pairs.
  
• value
  The value of the parameter. Is this attribute, and 'referid', is missing, then the body of the param tag is used.
  
• referid
  The value of the parameter, as referred from the variable context.
  
• vartype
  The `vartype' of the parameter. In principle url-parameters should always be string. When using this attribute, the value is first cast to this type. You could e.g. set it to `integer' if you want to ensure the variable is parseable as an integer.
  

See the example for tag `url'.

Gets the function value of function `name'. The function value is available as a writer.

For more information about how function tags work generally see the the `functiontag' entry of this reference.

• jspvar
• vartype
• write
• escape

• name
• nodemanager
• set
• classname
• module
• referids

• node

• referid

• id

• context

• container

<mm:function name="gui" escape="none" />
    

<mm:listnodes type="object" max="5" orderby="number" directions="down">
  <p>
    Node #<mm:field name="number" />: <mm:function name="gui" escape="none" />
  </p>
</mm:listnodes>

<%!
public static class MyClass {

  public MyClass() {
  }
  private String p;
  public void setMyParameter(String p) {
    this.p = p;
  }
  public String myfunction() {
   return p;
  }
}
%>
<mm:functioncontainer>
   <mm:param name="myParameter">Kloink</mm:param>
   <mm:function  classname="MyClass" name="myfunction" />
</mm:functioncontainer>

<mm:functioncontainer>
   <mm:param name="parameter1">Kloink</mm:param>
   <mm:param name="parameter2">5</mm:param>
   <p>
     Some function of the given bean: 
     <mm:function classname="org.mmbase.util.functions.ExampleBean" 
                  name="stringFunction" />
   </p>
   <p>
     Another function of the same bean:
     <mm:function classname="org.mmbase.util.functions.ExampleBean" 
                  name="integerFunction">
       <mm:isgreaterthan value="9">
         <mm:write /> is greater than 9!
       </mm:isgreaterthan>
     </mm:function>
   </p>
</mm:functioncontainer>

<%!
  public static String myFunction() {
    return "abracadabra";
  }
%>
<mm:function set="THISPAGE" name="myFunction" />

<mm:import externid="number">7</mm:import>
<mm:function referids="number@parameter2" 
             classname="org.mmbase.util.functions.ExampleBean" 
             name="integerFunction" />

• referids
  Similar to `referids' attribute of mm:url
  see: referids attribute of url
  

• name
• nodemanager
• set
• classname
• module
• referids

• node

• id

• context

<mm:functioncontainer>
  <mm:listnodes id="thisgroup" type="mmbasegroups">
     <mm:param name="grouporuser"><mm:field name="number" /></mm:param>
     <tr>
     <mm:stringlist referid="operations">
        <mm:param name="operation"><mm:write /></mm:param>
        <td <mm:booleanfunction node="currentcontext" name="parentsallow">
               class="parent"
           </mm:booleanfunction>
          >
          <mm:booleanfunction  node="currentcontext" name="maygrant">
          <input type="checkbox" name="<mm:write />:<mm:field name="number" />"
             <mm:booleanfunction node="currentcontext" name="allows">
               checked="checked"
             </mm:booleanfunction>
          />
          </mm:booleanfunction>
          <mm:booleanfunction node="currentcontext" name="maygrant" inverse="true">
            <mm:booleanfunction node="currentcontext" name="allows">
            X
             </mm:booleanfunction>
          </mm:booleanfunction>
        </td>
        </mm:stringlist>
      </tr>
  </mm:listnodes>
</mm:functioncontainer>

• referid

• id

• context

As mm:hasalias

Signature: java.lang.Boolean hasAlias(org.mmbase.bridge.Node, java.lang.String)

Checks only whether node has a certain alias.

• name
  

• inverse

• node

• referid

• id

• context

Checks only whether certain field is available. To make it possible to make more generic code.

• name
  Name of the field.
  
• nodetype (since: MMBase-1.8.4)
  

• inverse

• node

• referid

• id

• context

<mm:listnodes type="object">
  <mm:hasfield name="title">
    Title of node <mm:field name="number" /> (<mm:nodeinfo type="type" />): <mm:field name="title" />
  </mm:hasfield>
</mm:listnodes>

Checks only whether certain function is available. To make it possible to make more generic code.

• inverse

• name
• nodemanager
• set
• classname
• module
• referids

• node

• referid

• id

• context

• container

<mm:hasfunction name="index"><mm:function name="index" /></hasfunction>
    

Checks only whether certain node is available. To make it possible to make more generic code. It has the same working as <mm:node number="abc" notfound="skipbody" />

• number
  Number (or alias) of the node.
  

• inverse

• cloud

• referid

• id

• context

<mm:hasnode number="some-alias">
  <mm:node number="some-alias">
    Hello world
  </mm:node>
</mm:hasnode>

Checks only whether certain nodemanager is available. To make it possible to make more generic code.

• name
  Name of the node-manager.
  

• inverse

• cloud

• referid

• id

• context

<mm:hasnodemanager name="people">
  <mm:listnodes type="people">
    <mm:field name="firstname" />
  </mm:listnodes>
</mm:hasnodemanager>

Checks for the availability of a certain JSP on this server.

• page
  The page to check. It must be a JSP on the same server, so it can either be relative to current JSP, or relative to context root (if it starts with '/').
  

• inverse

<mm:haspage page="extra.jsp">
  <mm:include page="extra.jsp" />
</mm:haspage>

• value
  Checks for precisely one certain rank.
  
• minvalue
  A minimal value for the rank. If it is `anonymous' then this is no limitation, because anonymous is the lowest possible rank. It can also be specified as an integer.
  
• maxvalue
  A maximal value for the rank. If it is `administrator' then this is no limitation, because administrator is the highest possible rank. It can also be specified as an integer.
  

• inverse

• cloud

Checks only whether certain relation manager is available. To make it possible to make more generic code.

• sourcemanager
  Name of the source node-manager (defaults to 'object'). For convenience, one may also specify a node here (using $), in which case the nodes nodemanager is requested.
  
• destinationmanager
  Name of the destination node-manager (default to 'object'). For convenience, one may also specify a node here (using $), in which case the nodes nodemanager is requested.
  
• role
  Role of the relation manager.
  

• inverse

• cloud

• referid

• id

• context

• inverse

• node

• referid

• id

• context

• name
  
• component
  

• cloud

• inverse

Returns an URL to the image servlet. This is a NodeReferrer and consequently has to live as a child of a (image) node.

Using this tag makes your pages more portable to other system, and hopefully less sensitive for future changes in how the image servlet works.

• template
  

  A `transformation' template.

  In the font option, mm: stands for `mmbase configuration directory'. In this way it is easy to make sure that fonts are available.

  
  

  s(100x100)
  s(200x200!)+font(mm:fonts/Arial.ttf)+fill(ffffff)+pointsize(20)+gravity(NorthEast)+text(0,20,'MM Base')
  s(180)+modulate(120,0)+gamma(1/1/2)+bordercolor(8c9c23)+border(10x0)
  s(200)+fill(ffffff)+circle(20,20 30,30)
  s(200x200!)+part(100,100,150,150)
  s(200)+fill(ffffff)+draw(rectangle 100,100 150,150)+dia+flipx
  s(200)+colorizehex(f01010)
  s(200)+f(gif)+paint(10)
  s(100x100>)	Fit to 100x100 if it is bigger

• mode
  

  What to produce.

  
  

  url	An URL to the image (default)
  attributes	The attributes 'src' 'height' and 'width' for the img-tag of HTML.
  img	A img-tag of HTML

• absolute (since: MMBase-1.9.1)
  

  Whether the used url will be 'absolute' or not. Defaults to 'server'.

  
  see: absolute attribute of url
  
• disposition (since: MMBase-1.9.1)
  
  
  

  attachment	The image will be served out as an attachment.
  inline	The image will be served out inline.

• element (since: MMBase-1.7.4)
  see: element attribute of node
  
• width
  

  This width is used for a re-size of the image when no `transformation' template is provided.

  
  
• height
  

  This height is used for a re-size of the image when no `transformation' template is provided.

  
  
• crop
  

  Defines if an image should be cropped when no `transformation' template is provided. The image will be cropped when it does not fit the re-size area defined by the height and width attributes.

  
  

  begin	The re-size area will be positioned at the left top corner.
  middle	The re-size area will be positioned in the middle.
  end	The re-size area will be positioned at the right bottom corner.

• styleClass
  

  Class attribute of html img-tag. Only applied when mode=img.

  
  
• style
  

  Style attribute of html img-tag. Only applied when mode=img.

  
  
• align
  

  Align attribute of html img-tag. Only applied when mode=img.

  
  
• border
  

  Border attribute of html img-tag. Only applied when mode=img.

  
  
• hspace
  

  Hspace attribute of html img-tag. Only applied when mode=img.

  
  
• vspace
  

  Vspace attribute of html img-tag. Only applied when mode=img.

  
  
• alt (since: MMBase-1.8.5)
  

  Alt attribute of html img-tag. Only applied when mode=img.

  
  

• node

• jspvar
• vartype
• write
• escape

• id

• context

    <mm:node number="<%= image_number %>">
        <img src="<mm:image template="s(100)" />" width="100" border="0">
    </mm:node>
    

• id (Either `id' or `externid' or both must be supplied.)
  This is the key by which the object will be registered in the context. This key may not already exist. You must use the remove tag first, if you need to change the value of the registered object. If you do not supply this attribute, it is supposed to have the same value as `externid' which should be present then.
  
• externid (Either `id' or `externid' or both must be supplied.)
  

  The `externid' is the name of an attribute in the session, parameter in the request, or id in the parent context. The value of this thing is imported in the current context, with the id given by the attribute `id'.

  If there is no attribute `externid' then the value of the new object in the context is taken from the body of this import tag. In that way you can create a variable.

  
  
• required
  Whether the object to be imported is required. If nothing can be found by externid and a default value in the body is missing too, then an exception will follow. It is advised to use this on pages which do nothing sensible without a value for this. Typically read-more pages and so on, which simply cannot show anything if they are not informed what to show. This also serves to document the implementation of the JSP, because the imported variables marked as 'required' are at once recognizable as essential for the page's functionality.
  
• reset
  

  On default, this tag will throw an exception if the id to be registered is registered already. This will protect you against accidentally using the same id twice, thus obfuscating your code.

  If though you really want it then you can set the attribute `reset' to true.

  Consider also `scoping' your variables with a mm:context tag (especially useful for static includes).

  
  see: context
  
• from
  Where to search the externid in. On default it is searched in several sources, but you can limit it with this attribute. In this way it is also possible to get different variables with the same name from different sources.
  

  parent	Imports the variable from a parent context.
  page	Import the variable from the standard JSP `page context'.
  session	Import the variable from the session.
  cookie	Import the variable from a user cookie.
  parameters	Import the variable from a POST (a simple form) or GET (the URL) parameter.
  multipart	If the form is a `multipart' form (enctype="multipart/form-data"), which is necessary e.g. for images, then you can read the results with this. `postparameters' is a synonym for this, but `multipart' is probably a clearer description.
  multipart?	As multipart, if that is possible. Ignored otherwise. If you specify 'multipart' but the request is not a multipart post, it would otherwise give an error.
  request	There can be attributes set on a request object. These are principally importable into taglib as well. See JavaDoc.
  application	There can be attributes set on the `application'.
  this	Especially when you use a list of `from' locations, then the `this' location can be useful. It represent the current value, if there is one. Using this implies reset="true" (because of course you want to reset if current value is an option).

  parameters,session

  You can also specify a list of locations. This one means: If an attribute cannot be found in the parameters, try it in the session.

• jspvar
  If you specify `jspvar' a JSP-variable with this name will be created too. It is available after the closing of the tag. JSP-variables can also be created with the `write' tag. A write tag has more precise scoping possibilities.
  see: jspvar attribute of writer
  
• vartype
  see: vartype attribute of writer
  
• escape
  The import tag does not write anything to the page, so for that the `escape' attribute is not useful. The escape attribute from the import tag is therefore used to escape the actual value of the generated taglib variable. You can for example use it to uppercase an URL parameter or so (for searching).
  see: escape attribute of writer
  
• listdelimiter (since: MMBase-1.8)
  If the vartype is 'list', but a String is received, then it will be converted to a List of String, using this delimiter. It defaults to a comma.
  

• context

<!-- Create a variable `hoi' from the parameter `haj',
     Generate an exception if this parameter is not present -->
<mm:import id="hoi" externid="haj" from="parameters" required="true" />

<!-- Create a variable `hoi' from the parameter `haj',
     If this parameter is not present, hoi becomes `hello' -->
<mm:import id="hoi" externid="haj" from="parameters" >hello</mm:import>

<!-- Create a variable `hoi' with value `hello' -->
<mm:import id="hoi">hello</mm:import>

<!-- Create a variable `hoi'. The value will come from an external source,
like the parameter list or the session (where ever it is available) -->
<mm:import externid="hoi" />

Does an include. This tag is rather similar to mm:url, but in stead of returning the url, it returns the page itself. In that respect it is also very similar to jsp:include. The advantage above jsp:include is that this tag is aware of the context parameters and knows the `param' sub tag.

mm:include also can be used to include `external' URLs, so you can `steal' from another server. But be aware that this causes your server to do an http-request itself to another server. It depends on your server's configuration and of its network's setup, if it is allowed to do this.

If this version of MMBase is running on the Orion application server even `internal' URLs, so pointing to files on the same server, will work like this. In other words, Orion will do an http-request to itself. This was the way the include-tag worked always in MMBase 1.5.

You can also consider using the jsp <%@include file="" %>. This will include the code of that page in place and compile it together with your page. So in that aspect it is much different from this tag, which "includes" a stand-alone page. Using the `context' tag you can still give this included file its own scope.

Also 'tagfiles' provide a nice way to make pieces of taglib code generic.

See JSP Syntax Reference

See MMBase documentation on include mechanisms in MMBase taglib..

• referids
  see: referids attribute of url
  
• page
  see: page attribute of url
  
• component
  see: component attribute of url
  
• referid
  see: referid attribute of url
  
• debug
  For debugging you can print the used URL in the page as comments..
  

  none	No debugging on the page (default)
  html	Use html comments
  xml	Use XML comments
  css	Use css comments

• cite
  Whether to `cite' the page. This only works for `relative' urls on the same server. Only also if you have sufficiently rights to do that. Citing means that the page is acquired directly, so without interpreting/compiling by the web-server. Mainly useful for documentation of page-creating/taglib itself.
  
• encoding (since: MMBase-1.7.1)
  The encoding of the to-be-included page. If the included page does provide the right information about this, then there should be no need to use this attribute ever. But if it fails, then you can explicitly try to repair it, using this attribute.
  
• attributes (since: MMBase-1.7.4)
  Like 'referids', but sets the variables as request attributes.
  see: from attribute of import | request attribute of write
  
• notfound (since: MMBase-1.8)
  Specify the behaviour when the file cannot be found. Default is 'message', but you can change this to give an exception for non-existing files that are included.
  

  skip	Do not generate any error if the file cannot be found
  message	Just write a message to the page if the resource could not be found
  exception	Raise an exception if the file cannot be found
  log	Log a warning if the file cannot be found

• resource (since: MMBase-1.8)
  Specifies any resource relative to the WebRoot ResourceLoader to be included. This is more or less equivalent to using cite="true", and using page="..". The only difference is that, when using this, there are no restrictions (so you can also show resources in WEB-INF). So, never use this with user input.
  
• timeout (since: MMBase-1.9)
  For 'external' includes you can indicate a 'timeout' in milliseconds. A _responseCode variable will be produced.
  

• jspvar
• vartype
• write
• escape

<mm:include page="codesamples/index.jsp.1" />
    

      <os:cache>
        <mm:include page="http://site.which.sometimes.does.not.work.com" timeout="200" />
        <c:if test="${_responseCode ne 200}">
          <os:usecached />
        </c:if>
      </os:cache>
    

• offset
  Where do you want to start counting. The default is determined by the list it is in, and for most lists this is 1. It is not one for example in the `batches' lists, because for them `index' is the page.
  see: previousbatches | nextbatches
  

• id

• context

• jspvar
• vartype
• write
• escape

• list

See the example for tag `first'.

See the example for tag `nextbatches'.

This tag can be used to call getInfo from Module and NodeManager. The result of `getInfo' is a string which on default is written to the page. Most of this functionality doesn't have much to do with MMBase, and can be acquired with JSP or other taglibs too.

Consider using function tags in stead, which offer greater possibilities and flexibility.

• nodemanager
  
• module
  
• command
  The command which is given
  

• jspvar
• vartype
• write
• escape

• id

• context

a password:     <mm:info nodemanager="users" command="newpassword" />
user hostname:  <mm:info module="info" command="USER-HOSTNAME" />
    

• nodemanager
  
• descendants
  see: descendants attribute of typeconstraint
  

• node

• inverse

• referid
  see: referid attribute of compare
  

• inverse

• writer

<mm:field name="title">
  <mm:isempty>
    No title!
  </mm:isempty>
  <mm:isnotempty>
    <mm:write />
  </mm:isnotempty>
</mm:field>
     

<mm:field name="title" write="true">
  <mm:isempty>
    No title!
  </mm:isempty>
</mm:field>
     

<mm:field name="subtitle" write="true">
  <mm:isempty>
    <mm:field name="title" />
  </mm:isempty>
</mm:field>

• referid
• value
• valueset
• referid2
• regexp

• inverse

• writer

<mm:import id="number" vartype="integer" >5</mm:import>
<mm:import id="compare" vartype="integer" >6</mm:import>
<mm:write referid="number">
   <mm:isgreaterthan value="$compare">
       <mm:write /> greater than <mm:write referid="compare" />
   </mm:isgreaterthan>
   <mm:islessthan value="$compare">
       <mm:write /> less than <mm:write referid="compare" />
   </mm:islessthan>
</mm:write>
    

• referid
• value
• valueset
• referid2
• regexp

• inverse

• writer

See the example for tag `isgreaterthan'.

• referid
  see: referid attribute of compare
  

• inverse

• writer

<mm:field name="title">
  <mm:isempty>
    No title!
  </mm:isempty>
  <mm:isnotempty>
    <mm:write />
  </mm:isnotempty>
</mm:field>
     

• name
  

• inverse

• field

• referid

• id

• context

<mm:jdbc max="2"
         throwexception="true"
         mode="nodes"
         query="select e.number from $PREFIX_emails e
                                     left join $PREFIX_insrel i on e.number = i.dnumber
                                     left join  $PREFIX_mailboxes b  on i.snumber = b.number
                                     where b.number is null">
   <mm:deletenode />
</mm:jdbc>

    

• inverse

• list

See the example for tag `first'.

Lives in a tree-container tag. Constraints inside this tag are not defined as normal tree constraints but as 'leaf' constraint, which means that they are only taken into constraint on the 'leafs' of the tree.

Practically, this means that it can be used to search a tree.

• on
  Decides whether the leaf-constraint is going to work on the template, or on the trunk.
  

  template	The constraints in this tag will be applied on all the new branches of the tree when they are still 'leafs', so it applies to the template for that (determined by the attributes of treecontainer)
  trunk	The constraints in this tag will be applied to the trunk query, which is normally defined by the surrounding nodequery container of the treecontainer. This makes it possible to also consider the trunk when searing a tree.

• referid

• id

• context

• objectlist
  The list of objects
  
• notfound (since: MMBase-1.8)
  Specify the behaviour when the file cannot be found. Default is 'exception', but you can change this to silently fail if the file does not exist.
  

  skip	Do not generate any error if the file cannot be found
  exception	Raise an exception if the file cannot be found

• referids
• page
• block
• referid
• escapeamps
• encode
• absolute
• internal
• process

• jspvar
• vartype
• write
• escape

• id

• context

• cloud

See the example for tag `leafinclude'.

• objectlist
  The list of objects
  

• referids
• page
• component
• referid
• debug
• cite
• encoding
• attributes
• notfound
• resource
• timeout

• jspvar
• vartype
• write
• escape

Object with id `100' is an object from builder `portals'
Object with id `101' is an object from builder `subsites'.

When leafinclude is called with page='page.jsp' and objectlist='101,102',
the following files will be tried to be included, in order of priority:
100/101/page.jsp
100/subsites/page.jsp
portals/subsites/page.jsp.
The default behavior of getSmartPath is that the directory `100' is chosen
for objectid `100'.
Of course, the default behavior of getSmartPath can still be overridden.
    

Simple version of the 'url' tag, which can be used more concisely directly in a href attribute or so. Using a ThreadLocal pageContext (set by any mmbase tag, so you should e.g. use an mm:cloud or mm:content).

Signature: java.lang.String link(java.lang.String)

      <link media="screen" type="text/css" href="${mm:link('/css/general.css')}" rel="stylesheet" />
    

• referids
• page
• block
• referid
• escapeamps
• encode
• absolute
• internal
• process

• jspvar
• vartype
• write
• escape

• id

• context

• cloud

• id

• context

• cloud

<mm:link>
  <mm:param name="h">hallo</mm:param>
    Change
</mm:link>
    

• nodes
  Comma-separated list of node numbers that should be used as start nodes. The start nodes don't have to be a member of the first node manager in the path. For example, if the start nodes belong to the second node manager in a path with a length of three node managers, traversals will go into two directions at the same time. All traversals that make up a complete path are returned. If a node belongs to the last node manager in a path traversals will go from right to left starting at the last node manager. All start nodes specified in this attribute have to belong to the same node manager. Nodes that belong to a different node manager than the first node are ignored In case this attribute is not specified all nodes from the first node manager in the path are used as start nodes.
  
• path ( `path' or `referid' is mandatory. )
  A comma-separated list of node managers which specifies the path that should be followed. It is possible to explicitly specify a relation manager that should be used to go from one node to an other. If no relation manager is specified between two node managers, all possible relation managers that can be used to go to the next specified node in the path are followed. It is possible to add a digit (0-9) to the node manager name and refer to this node manager with his name and this digit appended. This can be useful if a node manager is used more than once in a path.
  

  mags
  mags,news
  mags,related,news
  mags,news,images
  mags,related,news,related,images
  pools,pools0,urls
  pools1,pools2,urls,pools3

• fields
  Comma-separated list of fields that should be made available in the page. The fields are selected from attributes of the corresponding node managers defined in type. It is required to append a prefix to each field listed e.g. fields="mags.title,news.title".
  
• constraints
  Constraints to prevent records from being included in the returned list. These constraints follow the syntax of the SQL where clause. It's a good practice to use uppercase letters for the operators and lowercase letters for the field names. There are also a (new) `constraint' tags, which are more flexible (especially when constructing the constraints automatically).
  see: constraint
  

  url.number = 100	!=, <, >, <= and >= can also be used
  person.name = `admin'
  person.email IS NULL	indicating the email field should be empty
  person.email LIKE `%.org'	indication the email should end with .org
  url.number BETWEEN 30 AND 50
  person.name IN ('admin', `anonymous')
  NOT (url.number = 100)
  person.email IS NOT NULL	indicating the email field should not be empty
  person.email NOT LIKE `%.org'	indication the email should not end with .org
  url.number NOT BETWEEN 30 AND 50
  person.name NOT IN ('admin', `anonymous')
  LOWER(user.name) = `admin'	this will also allow `Admin' to be returned
  LENGTH(user.name) > 5	this will only allow name with a length greater than 5 to be returned
  ((number=100) OR (name='admin') AND email LIKE `%.org')	Linking constraints together using AND and OR
  name='aaa''bbb'	To only retrieve the string aaa'bbb. A single quote can be escaped using it twice for every single occurrence.

• orderby
  A comma-separated list of field names on which the returned list should be sorted.
  
• directions
  A comma-separated list of values indicating whether to sort up (ascending) or down (descending) on the corresponding field in the orderby parameter or null if sorting on all fields should be up. The value DOWN (case insensitive) indicates that sorting on the corresponding field should be down, all other values (including the empty value) indicate that sorting on the corresponding field should be up. If the number of values found in this parameter are less than the number of fields in the orderby parameter, all fields that don't have a corresponding direction value are sorted according to the last specified direction value.
  

  UP
  DOWN
  UP,DOWN,UP

• distinct
  If set to `true' or `yes' all records who have exactly the same values will not be added a second time to the returned list.
  
• max
  The maximum number of records to return. Can do it also with the maxnumber tag in the container.
  see: maxnumber
  
• offset
  The first number of records to skip. Can do it also with the `offset' tag in the container
  see: offset
  
• searchdir
  Determines how directionality affects the search. If set to "destination" relations in a path will only be followed if valid relation exist from source to destination. If set to "source" relations in a path will only be followed if valid relations exist from destination to source. To follow all relations ignoring their directionality set this attribute to "all". Any other value for this attribute will follow relations the way they are defined (either source to destination, destination to source or both).
  

• jspvar
• commitonclose

• comparator
• add
• retain
• remove
• varStatus

• referid

• id

• context

• cloud

• container

<mm:list nodes="123" path="mags,news"
                fields="mags.title,news.number">
  <mm:first>magazine list</mm:first>
  <mm:field name="mags.title" />
</mm:list>

<mm:list nodes="123" path="mags,posrel,news"
                orderby="posrel.pos" fields="news.title">
  <mm:first>news in this magazine, ordered</mm:first>
  <mm:field name="news.title" />
</mm:list>

<mm:list path="pools,pools0,urls"
                fields="pools.name,pools0.name,urls.url">
  <mm:field name="pools.name" />
  <mm:field name="pools0.name" />
  <mm:field name="urls.url" />
</mm:list>

• value
  The `value' of the condition, in other words what the condition is, described with a string. There is a limited set available now. They are also available as `macro'-tags on this tag.
  

  first	Show only in first row.
  last	Show only in last row.
  odd	Show only when row number is odd.
  even	Show only when row number is even.
  changed	Show only when this row differs from the previous row (or when it is the first).

• inverse