Attributes |
Name | Required | Request-time | Type | Description |
var | false | false | java.lang.String | The variable name of the link tag |
link | false | true | org.hippoecm.hst.core.linking.HstLink | A HstLink object, containing a already rewritten object |
path | false | true | java.lang.String | A string path, typically a location relative to the webapp |
subPath | false | true | java.lang.String | A string subPath which gets appended to the path with a delimiter './' . This makes it useful for creating REST links |
hippobean | false | true | org.hippoecm.hst.content.beans.standard.IdentifiableContentBean | An IdentifiableContentBean object. This is typically one of your bean mapped objects |
nodeId | false | true | java.lang.String | Identifier of an HippoBean object. This is a stringified identifier of one of your bean mapped objects |
siteMapItemRefId | false | true | java.lang.String | A string id, which is the refId of a sitemap item you want to link to. Note that the sitemapitem belonging to the refId should not be a wildcard matcher, and non of its ancestors should be a wildcard. Using this to create a link to a sitemap item can be handy when you know to which sitemap item you want to link, but not the path. For example, a single jsp is used for 2 languages which have their own sitemap. You want a link to 'contact' for English, and to 'kontakt' for Dutch. Using this attribute, you can link to a refId on the sitemap item. Both 'contact' and 'kontakt' should have the same refId then |
fullyQualified | false | true | java.lang.Boolean | If value is 'true' the created link will be a fully qualified link (URLs), thus starting with 'http://' or 'https://' etc |
canonical | false | true | java.lang.Boolean | If the link that is created should be the canonical link, use this attr with value true |
navigationStateful | false | true | java.lang.Boolean | If the link should be created in the context of the current URL, use this attr with value true. When having canonical='true', this attribute is ignored. |
mount | false | true | java.lang.String | Expert: Create a link for a mount with alias that has the value of this attribute. You can create cross-domain links with this, even to mounts having a different host name. Or to a mount belonging to REST calls. |
mountType | false | true | java.lang.String | Expert: Create a link for a mount with type that has the value of this attribute. You can create cross-mode links with this, even to preview mount or live mount. Also, you can combine this with 'mount' attribute to create cross-domain links with specific type. |
escapeXml | false | false | java.lang.Boolean | Whether or not to escape &,>,<,", and '. When escapeXml = true, the link can be safely used as a tag attribute (e.g, href, src, etc.) value. By default escapeXml is set to true. |
scope | false | false | java.lang.String | Scope of var or the localization context configuration variable. "page", "request", "session" or "application". "page" scope by default. |