MMBase taglib 1.1.0 documentation

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

• jspvar

• inverse
  Turns the condition around, such that precisely the inverse will happen. This attribute is of course false on default. You can set it to true.
  

  true
  false

• container
  Refer to the container with this id. If you want to explicitily 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
  If you want to get it from another context than the direct parent.
  

• 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 fieldprovider, and you don't need the direct parent.
  

Evaluates 'function' on e.g. a node or something else. It is determined from which the function must be taken by the 'nodemanager', 'set' and 'module' attributes, of which precisely one or none must be present. If none of those is present, the function is supposed to be a 'node' function and the tag works as a 'node referrer'. Otherwise it works as a function from a 'nodemanager' 'set' or 'module' respectively.

Parameters of the function are supplied with the 'referids' attribute, or by a surrounding 'functioncontainer' tag with param sub-tags.

The several tags of these type differ only in the way they deal with the function value. E.g. a 'boolean' function works as a 'condition' tag (evaluating the body if the function value is 'true' and not evaluating the body if it is false).

• name
  

  The name of the function to evaluate.

  
  
• nodemanager
  The name of the nodemanager on which the function must be evaluated.
  
• set
  The 'set' from which the function must be taken. These are a kind of static functions (no object is associated with them). These 'sets' of functions are a bit like namespaces.
  
• module
  The name of the module on which the function must be evaluated.
  
• referids
  Similar to 'referids' attribute of mm:url, a simply way to provide (named) arguments to the function.
  see: referids attribute of url
  

• node

• 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)

  
  

  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).

  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.

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

• jspvar
  A jspvar of type Node can be created.
  

• node
  Which node to use. You can use this attribute if your Nodereferrer is living in more than one nodeprovider, and you don't need the direct parent.
  

• 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

• write
  Whether to write to the page or not. Normally the default value will suffice.
  

  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.
  pp	As 'p', but no br-tags are produces
  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
  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 \").
  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.
  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)
  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: content
  

• 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.
  

• 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 wich. This is not needed for listnodes and relatednodes containers (and probably would be a 'number' field otherwise).
  see: 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

• 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

• node

• jspvar
• vartype
• write
• escape

• comparator

• 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>
  

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
  see: element attribute of node
  

• node

• jspvar
• vartype
• write
• escape

• id

• context

• inverse

• referid

• id

• context

• name
• nodemanager
• set
• module
• referids

• node

• container

• 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'.
  

  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 usernames here (comma separated)

  It can also be used in combination with the 'password' attribute, in which case authentication will happen by that.

  
  
• 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 login 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 usefull 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 apge' 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 itselve 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 attibute 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 wil 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" whey 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.
  
• 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 explicitely, because it is good that you are aware of the consequences. A page using a non-anymous 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 implemenation 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.
  
• authenticate
  The authentication module which must be used by the security system. The default is "name/password", which will do in most cases.
  

  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.
  

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

  rmi://www.mmbase.org/remotecontext

• jspvar
  The name of the JSP variable to export by 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"); %>
    

• 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' or `referid2' must be present.)
  The value to which you want to compare, this is always a String.
  
• valueset (Either `value', 'valueset' or `referid2' 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' or `referid2' 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
  

• 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>
    

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

  OR
  AND

• 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> 
        

• 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.
  
• 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 seperated String of values. You can also refer to some list with 'referid' (e.g. to a nodelist tag)
  NULL	Tests wether the value of the field is NULL (or NOT NULL if inverse="true"). The 'value' attributes are ignored.

• container

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.

• 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
  
• jspvar
  
• type
  

  The Content-Type of this page.

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

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

  
  
• encoding
  The output text encoding.
  

  UTF-8

• expires
  

  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.

  
  

  UTF-8

• 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.

  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, - . _".

  
  
• 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 explicitely speficy 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:

  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.
  pp	As 'p', but no br-tags are produces
  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
  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 \").
  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.
  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)
  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
  

'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.
  

• 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>

• 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

• 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

• 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>
    

Lives in a NodeProvider. Deletes the bodycontent 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

• 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

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

  true
  vale

• container

• 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.

  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.

• 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)
  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.
  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).

• 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
  time	If the value is a date-time, treat it as time only
  date	If the value is a date-time, treat it as date only
  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)

• field

• id

• context

• jspvar
• vartype
• write
• escape

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

• 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 genetric 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 logicly possible) available to the body
  
• vartype (since: MMBase-1.7)
  The type of the variable to be created.
  

  field
  fieldvalue

• comparator

• referid

• id

• context

• field

• node

See the example for tag 'nodeinfo'.

• 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>
    

• 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 basicly, 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.
  
  

  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
  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.
  
• 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.

• context

• jspvar
• vartype
• write
• escape

• jspvar
• vartype
• write
• escape

• name
• nodemanager
• set
• module
• referids

• node

• referid

• id

• context

• container

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

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

<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

• inverse

• node

• referid

• id

• context

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)

• 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

• element
  see: element attribute of node
  

• 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
  If this object is required to be present. If it has to be present, then the present tag will always evaluate. If nothing can be found by externid and a default value in the body is missing too, then an exception will follow if required is true.
  
• reset
  

  On default, this tag will throw an exception if the id to be registered is registered already. This will protect you against accidentely 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 includes and list bodies).

  
  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.
  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 usefull. 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 usefull. 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
  

• 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' URL's, 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' URL's, 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. If this will do the trick for you then it is perhaps best to use this rather then the mm:include tag.

See JSP Syntax Reference

• 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
  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 documenation 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 explicitely 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 | attribute attribute of write
  

• referids
• page
• referid
• escapeamps

• jspvar
• vartype
• write
• escape

• id

• context

• cloud

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

• 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'.

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.

• 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" />
    

• 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>
     

• referid
• value
• valueset
• referid2

• 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

• 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>
     

• inverse

• list

See the example for tag 'first'.

• objectlist
  The list of objects
  

• referids
• page
• referid
• escapeamps

• jspvar
• vartype
• write
• escape

• id

• context

• cloud

See the example for tag 'leafinclude'.

• objectlist
  The list of objects
  

• debug
• cite
• encoding
• attributes

• referids
• page
• referid
• escapeamps

• jspvar
• vartype
• write
• escape

• id

• context

• cloud

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.
    

• 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 automaticly).
  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

• comparator

• 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

• list

<mm:listcondition value="first">(first)</mm:listcondition>
is equivalent to: <mm:first>(first)</mm:first>
    

• path
  A path.
  
• searchdirs
  For every path element the 'searchdir' can be specified. Defaults to the previous searchdir.
  
• id
  Id for reference by subtags and reuse.
  
• fields
  see: fields attribute of list
  
• nodes (since: MMBase-1.7.1)
  see: nodes attribute of list
  

• comparator

• referid

• id

• context

• name
• nodemanager
• set
• module
• referids

• node

• container

• jspvar
• vartype
• write
• escape

<mm:listnodes type="mediasources" max="10">
  <mm:function name="mimetype" />:  <mm:function name="format" />
  <ul>
    <mm:listfunction name="urls" jspvar="uc">
      <li><%= ((org.mmbase.applications.media.urlcomposers.URLComposer)uc).getURL() %></li>
    </mm:listfunction>
  </ul>
</mm:listnodes> 

• type
  The name of the node manager managing the type of nodes that should be listed.
  
• constraints
  See constraints attribute of list, but notice that it is not necessary to prefix the field names with `node manager' names. You can put the field names in [] to enable 'key word escaping'. E.g. in some databases 'status' is not a valid field name. [status] will translate the field name in the right way. Consider using 'constraint' tags and listnodescontainer for more flexibility.
  see: constraints attribute of list | constraint
  
• orderby
  see: orderby attribute of list
  
• directions
  see: directions attribute of list
  
• max
  see: max attribute of list | maxnumber
  
• offset
  see: offset attribute of list | offset
  
• path (since: MMBase-1.7.1)
  see: path attribute of listnodescontainer
  
• element (since: MMBase-1.7.1)
  see: element attribute of listnodescontainer
  
• searchdirs (since: MMBase-1.7.1)
  see: searchdirs attribute of listnodescontainer
  
• nodes (since: MMBase-1.7.1)
  see: nodes attribute of list
  

• cloud

• jspvar

• comparator

• referid

• id

• context

• container

<mm:listnodes type="mags"  >
  <mm:first>magazine list</mm:first>
  <mm:field name="title" />
</mm:listnodes>

• type
  see: type attribute of listnodes
  
• path
  Though a relatednodescontainer is to query real nodes (so not clusternodes), this does not mean that there can only one node type in the query. Only one element of this path is actually queried, but constraints and sortorderds can be applied to the other ones.
  see: path attribute of list
  
• searchdirs
  Per element in the path you can indicate an alternative 'searchdir' (source, destination or both)
  
• element
  The 'element' of the path to be queried. This defaults to the first element, but the other ones can be pointed to as well.
  see: element attribute of node
  
• id
  Id for reference by subtags and reuse.
  
• nodes (since: MMBase-1.7.1)
  see: nodes attribute of list
  

• type
  Only list the relations where the other node is of this type.
  
• role
  Only list the relations which are of this role.
  
• searchdir (since: MMBase-1.7)
  Only list the relations in this direction.
  
• max (since: MMBase-1.7)
  see: max attribute of list
  
• offset (since: MMBase-1.7)
  see: offset attribute of list
  

• jspvar

• node

• referid

• id

• context

<mm:listnodes type="news">
    <mm:field name="title" />
    <mm:listrelations role="posrel" type="page">
        is news item <mm:field name="pos" /> on page
        <mm:relatednode><mm:field name="title" /></mm:relatednode>
    </mm:listrelations>
    <br/>
</mm:listnodes>
    

• type
  see: type attribute of listrelations
  
• role
  see: role attribute of listrelations
  
• searchdir
  see: searchdir attribute of listrelations
  

• node

Sets a locale. Tags living in its body can request the Locale from it, if they need it. A `locale' is more or less like a `language', but it is a little more. E.g. when formatting a date it is needed to know what the conventions are for the order of the fields, and what kind of characters to use to separate them. Another example is the formatting of numbers, which is also ruled by 'locale' conventions.

See JavaDoc for Locale class (A little technical, but at least you'll find links to possible languages and countries, and another short description of what a Locale actually is).

Since 1.7 there is also a content tag, which is an extension of the locale tag. You could probably just as well use only an mm:content.

• language
  A two letter language code according to ISO 639.
  

  nl
  en

• country
  A two letter country code according to ISO 3166.
  

  BE
  GB

• jspvar
  A jspvar of type Locale can be created.
  

• jspvar
  If this attribute is present, the body will not be logged, but in the body this jspvar is available, which is of the type 'Logger'. This can be handy if your page contains a lot of Java code.
  

<mm:log>Log this to the log file</mm:log>
Generates something like this in the mmbase log file:
19:16:04,030 SERVICE - 0: Log this to the log file
The 0 is just counter, which starts at 0 on every page.
    

• value
  An integer.
  

  20
  $max

• container

• node

• inverse

• type
  

• cloud

• inverse

<mm:maycreate type="list">
    <mm:createnode type="list" id="this_list">
        <mm:setfield name="title">Create node example</mm:setfield>
    </mm:createnode>
</mm:maycreate>
    

• role
  see: role attribute of createrelation
  
• source
  see: source attribute of createrelation
  
• destination
  see: destination attribute of createrelation
  

• cloud

• inverse

<mm:maycreate type="list">
    <mm:createnode type="list" id="this_list">
        <mm:setfield name="title">
            Node with relation to page 97
        </mm:setfield>
    </mm:createnode>
</mm:maycreate>
<mm:node number="97" id="my_page" />
<mm:maycreaterelation role="posrel"
    source="my_page" destination="this_list">
    <mm:createrelation role="posrel"
        source="my_page" destination="this_list" />
</mm:maycreaterelation>
<delete referid="this_list">
<delete referid="my_page">
    

• node

• inverse

See the example for tag 'deletenode'.
    

• node

• inverse

<mm:listnodes type="list" max="1">
    <mm:maywrite>
        <mm:setfield name="title">New title</mm:setfield>
    </mm:maywrite>
</mm:listnodes>
    

This 'listprovider' tag provides a way to implement 'paging' or 'batching' for large search results. It requests the 'offset' and 'maxnumber' settings of the surrounding querycontainer and calculates the next possible 'offsets'. This is done by counting the query result without 'maxnumber'. You get an exception if the 'maxnumber' or 'offset' tags are not used.

As a list, this tag produces Strings, which you could for example use in its body with <write />. These string represents 'offsets' which you can use in an url. You can of course also in the normal way give the list an id, and use the 'referids' attribute of the url tag.

If you prefer to have a 'page' rather then an offset, then the 'index' tag can be used. The default 'offset' for the index tag is set to let it be 'batch numbers'.

• max
  The maximum number of batches to be produces. For really huge result, even the number of batches can be too large, so you want to limit it. You should also use it (max="1") if you only want to implement a 'next page' button.
  
• maxtotal
  In stead of 'max' you could also use maxtotal. The tag will calculate how many batches 'previousbatches' did need, and if that is zero, there can be 'maxtotal' next batches. If it is more then zero, nextbatches will get less. If there are both many next batches and previous batches, then they get both the half of 'maxtotal' batches.
  
• indexoffset
  The produced indexes can be used as page numbers. Default this page-numbering starts at 0, with this you can change it, e.g. set it to 1.
  

• node

• jspvar
• vartype
• write
• escape

• comparator

• referid

• id

• context

• container

• number ( 'number', 'element' or 'referid' must be supplied. If none of them, then the node refers to a parent NodeProvider. )
  The node number or alias identifying this node in MMBase.
  
• notfound
  What to do if the node is not found. The default is to throw an exception.
  

  skip|skipbody	Simply skip the body if the node is not found
  throw|throwexception	Throw an exception if the node is not found
  null|providenull	Will not throw an exception, but will evaluate the body, simply providing 'null' as node. This will probably lead to other (less clear) exceptions. But if you prefer it that way, it is possible. Use on own risk!

• element (Either 'number', 'element' or 'referid' must be supplied.)
  The name of a node field of the current node. This can for instance be the 'rnumber' field of a relation, the 'destination' field of an oalias, etc. A common use is to specify the name of the node manager to identify a node in a list or related list tag (clusternode providers). In this case, the nodemanager name behaves like a special virtual node field of the surrounding cluster node, indicating the individual nodes that make up the cluster node.
  see: clusternodeprovider
  

• jspvar

• node

• cloud

• referid

• id

• context

Assume that node with number has a field title.
Then the following code can be used to
access the value of title:
<mm:node number="456">
    <mm:field name="title" write="true" />
</mm:node>
     

• jspvar

• referid

• id

• context

• name
• nodemanager
• set
• module
• referids

• node

• container

• type
  

  type	The type of the node (the name of it's NodeManager).
  guitype	The GUI representation of the type (NodeManager) of the node.
  plural_guitype	The plural GUI representation of the type (NodeManager) of the node.
  description	The description of the type (NodeManager) of the node.
  number	The node number

• nodetype
  Actually, the node-info tag also is the 'nodemanager' info tag. If for some reason you need information about a node-manager, without having a node, you can specify it with this attribute.
  

• jspvar
• vartype
• write
• escape

• node

• id

• context

<mm:node number="1645">
Node of type <mm:nodeinfo type="guitype" /><br />
  <mm:fieldlist type="edit">
    <em><mm:fieldinfo type="guiname" /></em>:
        <mm:fieldinfo type="value" /><br />
  </mm:fieldlist>
</mm:node>

• max
  see: max attribute of list
  
• offset
  see: offset attribute of list
  

• comparator

• referid

• id

• context

• name
• nodemanager
• set
• module
• referids

• node

• jspvar

• container

• referid

• inverse

• context

See the example for tag 'present'

• inverse

• list

See the example for tag 'first'.

• value
  An integer.
  

  10
  $offset

• container

• referid

• id

• context

• name
  The name of the parameter.
  
• value
  The value of the parameter. Is this attribute is missing, then the body of the param tag is used.
  
• vartype (since: MMBase-1.7)
  The 'vartype' of the parameter. In principle url-parameters should always be string. When using this attribute, the value is first casted 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'.

• referid
  Which context variable.
  

• inverse

• context

    <mm:context id="other_context">
      <mm:import id="hoi_again">greetings from hilversum</mm:import>
      <mm:present referid="hoi_again">
        is present in other_context<br />
      </mm:present>
    </mm:context>
    <mm:notpresent referid="hoi_again">
        is not present in default context<br />
    </mm:notpresent>
    

• max
  Maximal number of batches to be produces. If more 'previous' batches are available than this number, the list is truncated from the beginning (of course).
  
• maxtotal
  see: maxtotal attribute of nextbatches
  
• indexoffset
  see: indexoffset attribute of nextbatches
  

• node

• jspvar
• vartype
• write
• escape

• comparator

• referid

• id

• context

• container

As mm:url but redirects to the generated URL.

• referids
  see: referids attribute of url
  
• page
  see: page attribute of url
  
• referid (since: MMBase-1.7)
  see: referid attribute of url
  

• context

• id

• context

• nodes
  Comma separated list of node numbers that should be used instead of the default node.
  
• path ( 'path' or 'referid' is mandatory. )
  This attribute is the same as the path attribute of the list tag except that the first node manager should be omitted. The first node manager is implied by the parent node and prefixed to the path automaticly.
  see: path attribute of list
  
• fields
  see: fields attribute of list
  
• constraints
  see: constraints attribute of list
  
• orderby
  see: orderby attribute of list
  
• directions
  see: directions attribute of list
  
• distinct
  see: distinct attribute of list
  
• max
  see: max attribute of list
  
• offset
  see: offset attribute of list
  
• searchdir
  see: searchdir attribute of list
  

• jspvar

• node

• comparator

• referid

• id

• context

• container

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

<mm:node number="456"> <!-- node 456 is of type mags -->
  <mm:field name="title" />
  <mm:related path="news0" fields="mags0.title">
    <mm:first>related magazines</mm:first>
    <mm:field name="mags0.title" />
  </mm:related>
</mm:node>

• path
  
  see: path attribute of listcontainer
  
• searchdirs
  see: searchdirs attribute of listcontainer
  
• id
  Id for reference by subtags and reuse.
  
• fields
  see: fields attribute of list
  

• node

• listrelations
  To refer to another listrelations tag then the direct parent.
  

• jspvar

• id

• context

See the example for tag 'listrelations'.
    

• type ( You cannot use 'orderby' or 'constraints' if you do not use 'type'. )
  see: type attribute of listnodes
  
• constraints ( You also need to supply 'type'. )
  see: constraints attribute of list
  
• orderby ( You also need to supply 'type'. )
  see: orderby attribute of list
  
• directions
  see: directions attribute of list
  
• searchdir
  see: searchdir attribute of list
  
• max
  see: max attribute of list
  
• offset
  see: offset attribute of list
  
• role
  see: role attribute of list
  
• path (since: MMBase-1.7.1)
  see: path attribute of listnodescontainer
  
• element (since: MMBase-1.7.1)
  see: element attribute of listnodescontainer
  
• searchdirs (since: MMBase-1.7.1)
  see: searchdirs attribute of listnodescontainer
  

• jspvar

• node

• comparator

• referid

• id

• context

• container

<mm:node number="Magazine" >
<mm:relatednodes type="news" >
  <mm:first>news in this magazine</mm:first>
  <mm:field name="title" />
</mm:relatednodes>

• type
  see: type attribute of relatednodes
  
• role
  see: role attribute of relatednodes
  
• path
  see: path attribute of listnodescontainer
  
• searchdirs
  see: searchdirs attribute of listnodes
  
• element
  see: element attribute of listnodescontainer | element attribute of node
  
• id
  Id for reference by subtags and reuse.
  

• referid
  The id of the variable to be removed>
  

     Set variable 'a' to something.
     <mm:import id="a">aaaa</mm:import>
     Set the value of a to another value.
     <mm:remove referid="a" /><mm:import id="a">aaab</mm:import>
    

• list

• referid

• id

• context

Change the context of a node. This has nothing to do with the `contexts' of the taglib, but with security. With every node a `context' is associated (in fact the `owner' field is currently used for this), by which is is determined who may do what to it.

You'll need this if you are creating an editor and want to add the possibility to change the rights on a node.

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

• node

• name
  The name of the field to set. If this field is not set this tag will look for a surrounding fieldlist tag to retrieve name and node from.
  

• id

• context

• field

• node

See the example for tag 'createnode'.

• referid

• id

• context

• jspvar
• vartype
• write
• escape

• id

• context

• jspvar
• vartype
• write
• escape

• list

• container

<mm:listnodes type="news">
    <mm:first><mm:size /></mm:first>
</mm:listnodes>
    

<mm:listnodescontainer type="news">
    number of news items: <mm:size />
    <mm:listnodes >
       ....
    </mm:listnodes>
</mm:listnodescontainer>
    

<mm:list path="news">
    <mm:first><mm:size /></mm:first>
</mm:list>
    

• field
  On which field to sort.
  
• direction
  
  

  UP
  DOWN

• container

A simple list iterating some list, coming from the 'context. So the 'referid' is required for this list. The original list can for example have been produced by the import tag with vartype="list"

You can also use 'aliaslist' for this (as can be done in MMBase 1.6) but that is a bit silly, if you are not actually listing node aliases.

• referid
  This tag can only reuse Lists, so you have to use this attribute.
  

• node

• jspvar
• vartype
• write
• escape

• comparator

• referid

• id

• context

• time
  The time attribute specifies the time to be used, this can be done in multiple ways, in order of preference: 1) If the 'inputformat' attribute is used, this is used to parse the content of the 'time' attribute, one can define 'human readable format' like this. 2) Specify the time in seconds from EPOC (this is the way how MMBase handles times). 3) By using keywords, such as: yesterday, tomorrow, today, now.
  
• inputformat
  The inputformat attribute cat be used to specify how the time attribute should be parsed. The comprehensive syntax for this attribute can be found at http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html . Notice that if times have the following form they will be parsed automatically, and this attribute can be omitted: yyyy/MM/dd hh:mm:ss, yyyy/MM/dd, and hh:mm:ss.
  
• offset
  The offset attribute can be used to change the time specified with the time attribute. The offset is expressed in seconds.
  
• format
  

  The format attribute specifies how to display the time. If the format attribute is not used the time will be displayed in seconds from EPOC. The syntax of the format attribute is identical to the syntax of the inputformat attribute. Instead of using the format attribute you can also use the MMBase formatter taglib.

  Alternatively, you can also symbolicly indicate how verbosely the date and or time must be presented. You do this by starting this string with a semicolon (:) followed by one or two constants separated by a dot. The first constant is for the date part, the second for the time part. Both these constants can take the following values 'FULL', 'LONG', 'MEDIUM' and 'SHORT'.

  
  

  y	Only the year part of the speficied time
  e	Day of the week as in integer (7=Saturday, 1=Sunday). This is not done by SimpleDateFormat, because it doesn't support that (Don't ask me why).
  :FULL.FULL	Fully specified date and time formatted according to the present Locale.
  :MEDIUM	Mediumly verbosely specified localized date.
  MM/dd/yyyy	Gives e.g. 11/20/2003.

• precision (since: MMBase-1.7)
  Specifies the 'precision' of the produced time. Times are rounded off to the beginning of the specified unit. This can have several purposes. One of them being that such a rounded of time can be used in queries, without resulting to much different queries ('now' with a precision of minutes, will e.g. result a new 'now' only once a minute, so a query with a constraint containing 'now' has to be redone only once a minute (in stead of every second)).
  

  seconds	This is the default. Times are produced to 'second' accuracy (the maximum in MMBase).
  minutes
  hours
  days
  weeks
  months
  years

• timezone (since: MMBase-1.7)
  The time-zone for which the time must be shown. Defaults to the server's time-zone.
  

  CET	Central European Time
  GMT	Greenwich Mean Time