View File | Revision Log | Show Annotations | Download File | View Changeset
/hippo/hippo-collab/trunk/site/src/main/webapp/WEB-INF/hst-core.tld
Revision: 22659
Committed: Tue May 4 12:55:39 2010 UTC (11 years, 5 months ago) by wko
Content type: text/plain
File size: 37966 byte(s)
Log Message:
COLLAB-2: Rearranging projects

File Contents

# Content
1 <?xml version="1.0" ?>
2 <!--
3 Copyright 2008 Hippo
4
5 Licensed under the Apache License, Version 2.0 (the "License");
6 you may not use this file except in compliance with the License.
7 You may obtain a copy of the License at
8
9 http://www.apache.org/licenses/LICENSE-2.0
10
11 Unless required by applicable law or agreed to in writing, software
12 distributed under the License is distributed on an "AS IS"
13 BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 See the License for the specific language governing permissions and
15 limitations under the License.
16 -->
17 <!DOCTYPE taglib PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN" "http://java.sun.com/j2ee/dtd/web-jsptaglibrary_1_2.dtd">
18 <taglib xmlns="http://java.sun.com/xml/ns/javaee" version="2.1"
19 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20 xsi:schemaLocation="http://java.sun.com/xml/ns/javaee/web-jsptaglibrary_2_1.xsd">
21
22 <tlib-version>1.0</tlib-version>
23 <jsp-version>1.2</jsp-version>
24 <short-name>hst-core-tags</short-name>
25 <uri>http://www.hippoecm.org/jsp/hst/core</uri>
26 <description>HST Core Tag Library</description>
27
28 <tag>
29 <name>include</name>
30 <tag-class>org.hippoecm.hst.tag.HstIncludeTag</tag-class>
31 <body-content>empty</body-content>
32 <description> A HstComponent can include the content of its child HstComponent with this
33 tag. </description>
34 <attribute>
35 <name>ref</name>
36 <required>true</required>
37 <rtexprvalue>true</rtexprvalue>
38 <type>java.lang.String</type>
39 <description>The name of the child HstComponent to be included.</description>
40 </attribute>
41 <example><![CDATA[
42 <!-- Threecolumnlayout -->
43 <table class="main">
44 <tr>
45 <td class="leftmenu">
46 <hst:include ref="leftmenu"/>
47 </td>
48 <td class="content">
49 <hst:include ref="content"/>
50 </td>
51 <td class="rightmenu">
52 <hst:include ref="right"/>
53 </td>
54 </tr>
55 </table>
56 ]]></example>
57 </tag>
58
59 <tag>
60 <name>param</name>
61 <tag-class>org.hippoecm.hst.tag.ParamTag</tag-class>
62 <body-content>empty</body-content>
63 <description> This param tag can be nested into renderURL and actionURL to provide
64 parameters. </description>
65 <attribute>
66 <name>name</name>
67 <required>true</required>
68 <rtexprvalue>true</rtexprvalue>
69 <type>java.lang.String</type>
70 <description>The name of the parameter</description>
71 </attribute>
72 <attribute>
73 <name>value</name>
74 <required>false</required>
75 <rtexprvalue>true</rtexprvalue>
76 <type>java.lang.String</type>
77 <description>The value of the parameter</description>
78 </attribute>
79 <example><![CDATA[
80 <ul id="paging-nav">
81 <c:forEach var="pageNr" items="${searchResults.pageNumbersArray}" varStatus="status">
82 <c:set var="active" value="" />
83 <c:if test="${searchResults.currentPage == pageNr}">
84 <c:set var="active" value=" class=\"active\"" />
85 </c:if>
86 <hst:renderURL var="pagelink">
87 <hst:param name="page" value="${pageNr}" />
88 <hst:param name="query" value="${query}" />
89 </hst:renderURL>
90 <li${active}><a href="${pagelink}" title="${pageNr}">${pageNr}</a></li>
91 </c:forEach>
92 </ul>
93 ]]></example>
94 </tag>
95
96 <tag>
97 <name>renderURL</name>
98 <tag-class>org.hippoecm.hst.tag.HstRenderURLTag</tag-class>
99 <tei-class>org.hippoecm.hst.tag.HstRenderURLTag$TEI</tei-class>
100 <body-content>JSP</body-content>
101 <description> A HstComponent can make a render URL with this tag with adding some
102 parameters. This renderURL will invoke the current page with different parameters for
103 the HstComponent including this tag. </description>
104 <attribute>
105 <name>var</name>
106 <required>false</required>
107 <rtexprvalue>false</rtexprvalue>
108 <type>java.lang.String</type>
109 <description>The variable name of the renderURL</description>
110 </attribute>
111 <example><![CDATA[
112 <ul id="paging-nav">
113 <c:forEach var="pageNr" items="${searchResults.pageNumbersArray}" varStatus="status">
114 <c:set var="active" value="" />
115 <c:if test="${searchResults.currentPage == pageNr}">
116 <c:set var="active" value=" class=\"active\"" />
117 </c:if>
118 <hst:renderURL var="pagelink">
119 <hst:param name="page" value="${pageNr}" />
120 <hst:param name="query" value="${query}" />
121 </hst:renderURL>
122 <li${active}><a href="${pagelink}" title="${pageNr}">${pageNr}</a></li>
123 </c:forEach>
124 </ul>
125 ]]></example>
126 </tag>
127
128 <tag>
129 <name>actionURL</name>
130 <tag-class>org.hippoecm.hst.tag.HstActionURLTag</tag-class>
131 <tei-class>org.hippoecm.hst.tag.HstActionURLTag$TEI</tei-class>
132 <body-content>JSP</body-content>
133 <description> A HstComponent can make a action URL with this tag. This tag is often used for
134 building a form action URL. This actionURL will invoke the current page with submitting
135 the parameters to the HstComponent including this tag. </description>
136 <attribute>
137 <name>var</name>
138 <required>false</required>
139 <rtexprvalue>false</rtexprvalue>
140 <type>java.lang.String</type>
141 <description>The variable name of the actionURL</description>
142 </attribute>
143 </tag>
144
145 <tag>
146 <name>resourceURL</name>
147 <tag-class>org.hippoecm.hst.tag.HstResourceURLTag</tag-class>
148 <tei-class>org.hippoecm.hst.tag.HstResourceURLTag$TEI</tei-class>
149 <body-content>JSP</body-content>
150 <description> A HstComponent can make a resource URL with this tag with resource ID. This
151 resourceURL will invoke the current page with the resourceID for the HstComponent
152 including this tag. </description>
153 <attribute>
154 <name>var</name>
155 <required>false</required>
156 <rtexprvalue>false</rtexprvalue>
157 <type>java.lang.String</type>
158 <description>The variable name of the resourceURL</description>
159 </attribute>
160 <attribute>
161 <name>resourceId</name>
162 <required>false</required>
163 <rtexprvalue>true</rtexprvalue>
164 <type>java.lang.String</type>
165 <description> The resourceID to be used by the HstComponent. </description>
166 </attribute>
167 </tag>
168
169 <tag>
170 <name>link</name>
171 <tag-class>org.hippoecm.hst.tag.HstLinkTag</tag-class>
172 <tei-class>org.hippoecm.hst.tag.HstLinkTag$TEI</tei-class>
173 <body-content>JSP</body-content>
174 <description> This tag creates links. It knows whether to include or exclude the contextpath
175 and servletpath. The attributes 'link' and 'node' get the current servletpath in their
176 result, the 'path' attribute doen *not* get the servletpath. The reasoning is that the
177 'path' attribute is used for static links, like for css and images. You should use one
178 of the three attributes (link|path|node) within one tag, and not more then one. </description>
179 <attribute>
180 <name>var</name>
181 <required>false</required>
182 <rtexprvalue>false</rtexprvalue>
183 <type>java.lang.String</type>
184 <description>The variable name of the link tag</description>
185 </attribute>
186 <attribute>
187 <name>link</name>
188 <required>false</required>
189 <rtexprvalue>true</rtexprvalue>
190 <type>org.hippoecm.hst.core.linking.HstLink</type>
191 <description>A HstLink object, containing a already rewritten object</description>
192 </attribute>
193 <attribute>
194 <name>linkByBeanPath</name>
195 <required>false</required>
196 <rtexprvalue>true</rtexprvalue>
197 <type>java.lang.String</type>
198 <description>
199 A bean path of HstLink object which can be retrieved via pageContext.
200 NOTE: This is mainly for allowing script templates (such as Freemarker) to set object property by bean name.
201 JSP developers could ignore this attribute and use 'link' attribute instead directly with object property value.
202 </description>
203 </attribute>
204 <attribute>
205 <name>path</name>
206 <required>false</required>
207 <rtexprvalue>true</rtexprvalue>
208 <type>java.lang.String</type>
209 <description>A string path, typically a location relative to the webapp</description>
210 </attribute>
211 <attribute>
212 <name>hippobean</name>
213 <required>false</required>
214 <rtexprvalue>true</rtexprvalue>
215 <type>org.hippoecm.hst.content.beans.standard.HippoBean</type>
216 <description>A HippoBean object. This is typically one of your bean mapped
217 objects</description>
218 </attribute>
219 <attribute>
220 <name>hippobeanByBeanPath</name>
221 <required>false</required>
222 <rtexprvalue>true</rtexprvalue>
223 <type>java.lang.String</type>
224 <description>
225 A bean path of HippoBean object which can be retrieved via pageContext.
226 NOTE: This is mainly for allowing script templates (such as Freemarker) to set object property by bean path.
227 JSP developers could ignore this attribute and use 'hippobean' attribute instead directly with object property value.
228 </description>
229 </attribute>
230 <attribute>
231 <name>external</name>
232 <required>false</required>
233 <rtexprvalue>true</rtexprvalue>
234 <type>java.lang.Boolean</type>
235 <description>If value is 'true' the created link will be external, thus containing
236 'http://' or 'https://' etc</description>
237 </attribute>
238 <attribute>
239 <name>canonical</name>
240 <required>false</required>
241 <rtexprvalue>true</rtexprvalue>
242 <type>java.lang.Boolean</type>
243 <description>If the link that is created should be the canonical link, use this attr with value true</description>
244 </attribute>
245 <example><![CDATA[
246 <!-- In a body component: A list of document names with summaries and links to those documents: -->
247
248 <c:forEach var="child_document" items="${document_list}">
249 <tr>
250 <hst:link var="link" hippobean="${child_document}"/>
251 <td class="title">
252 <a href="${link}">${child_document.name}</a>
253 </td>
254 <td>${child_document.summary}</td>
255 </tr>
256 </c:forEach>
257
258 <!-- In a <head>: -->
259
260 <hst:link var='screencss' path='/css/community/screen.css'></hst:link>
261 <link media='screen' href='${screencss}' type='text/css' rel='stylesheet'></link>
262
263 <!-- In a menu: -->
264
265 <ul id="nav-main">
266 <c:forEach var="item" items="${menu.menuItems}">
267 <c:choose >
268 <c:when test="${! empty item.externalLink}">
269 <li>
270 <a href="${item.externalLink}"><b>${item.name}</b></a>
271 </li>
272 </c:when>
273 <c:when test="${item.expanded}">
274 <li class="active">
275 ${item.name}
276 </li>
277 </c:when>
278 <c:otherwise>
279 <li>
280 <hst:link var="link" link="${item.hstLink}" />
281 <a href="${link}">
282 ${item.name}
283 </a>
284 </li>
285 </c:otherwise>
286 </c:choose>
287 </c:forEach>
288 </ul>
289 ]]></example>
290
291 </tag>
292
293 <tag>
294 <name>sitemapitem</name>
295 <tag-class>org.hippoecm.hst.tag.SiteMapItemTag</tag-class>
296 <body-content>JSP</body-content>
297 <description>This sitemapitem tag can nested into a hst link tag to provide a preferred sitemap item to create the link for. You can define the
298 preferred sitemap item by choosing one (no more) of these attributes: preferItem, preferItemId, preferItemPath or preferItemByPath. Optionally
299 add a fallback attr which is a boolean true or false</description>
300 <attribute>
301 <name>preferItem</name>
302 <required>false</required>
303 <rtexprvalue>true</rtexprvalue>
304 <type>org.hippoecm.hst.configuration.sitemap.HstSiteMapItem</type>
305 <description>A HstSiteMapItem object. The preferred sitemap item to use for linkrewriting</description>
306 </attribute>
307 <attribute>
308 <name>preferItemId</name>
309 <required>false</required>
310 <rtexprvalue>true</rtexprvalue>
311 <type>java.lang.String</type>
312 <description>
313 The id of the preferred sitemap item to use for linkrewriting
314 </description>
315 </attribute>
316 <attribute>
317 <name>preferPath</name>
318 <required>false</required>
319 <rtexprvalue>true</rtexprvalue>
320 <type>java.lang.String</type>
321 <description>
322 The path of the preferred sitemap item to use for linkrewriting. If the path starts with a /, the / is removed and ignored.
323 </description>
324 </attribute>
325 <attribute>
326 <name>preferItemByPath</name>
327 <required>false</required>
328 <rtexprvalue>true</rtexprvalue>
329 <type>java.lang.String</type>
330 <description>
331 A bean path of HstSiteMapItem object which can be retrieved via pageContext.
332 NOTE: This is mainly for allowing script templates (such as Freemarker) to set object property by bean path.
333 JSP developers could ignore this attribute and use 'hippobean' attribute instead directly with object property value.
334 </description>
335 </attribute>
336 <attribute>
337 <name>fallback</name>
338 <required>false</required>
339 <rtexprvalue>true</rtexprvalue>
340 <type>boolean</type>
341 <description>
342 whether to fallback to normal linkrewriting when this preferred sitemap item is not suited to be used for the link
343 </description>
344 </attribute>
345 </tag>
346
347
348 <tag>
349 <name>facetnavigationlink</name>
350 <tag-class>org.hippoecm.hst.tag.HstFacetNavigationLinkTag</tag-class>
351 <tei-class>org.hippoecm.hst.tag.HstFacetNavigationLinkTag$TEI</tei-class>
352 <body-content>JSP</body-content>
353 <description>This tag can be used in faceted navigation as a helper. You can use the 'remove' attribute to
354 remove a chosen facet-value combination from the current link. It returns a link according the 'link' tag
355 described above</description>
356 <attribute>
357 <name>var</name>
358 <required>false</required>
359 <rtexprvalue>false</rtexprvalue>
360 <type>java.lang.String</type>
361 <description>The variable name of the facetnavigationlink tag</description>
362 </attribute>
363 <attribute>
364 <name>current</name>
365 <required>false</required>
366 <rtexprvalue>true</rtexprvalue>
367 <type>org.hippoecm.hst.content.beans.standard.facetnavigation.HippoFacetSubNavigation</type>
368 <description>A HippoFacetSubNavigation object. This is the current state of the faceted navigation, from
369 which you for example want to remove one facet-value combi.</description>
370 </attribute>
371 <attribute>
372 <name>currentByBeanPath</name>
373 <required>false</required>
374 <rtexprvalue>true</rtexprvalue>
375 <type>java.lang.String</type>
376 <description>
377 A bean path of a HippoFacetSubNavigation object which can be retrieved via pageContext.
378 NOTE: This is mainly for allowing script templates (such as Freemarker) to set object property by bean path.
379 JSP developers could ignore this attribute and use 'hippobean' attribute instead directly with object property value.
380 </description>
381 </attribute>
382 <attribute>
383 <name>remove</name>
384 <required>false</required>
385 <rtexprvalue>true</rtexprvalue>
386 <type>org.hippoecm.hst.content.beans.standard.facetnavigation.HippoFacetSubNavigation</type>
387 <description>A HippoFacetSubNavigation object.</description>
388 </attribute>
389 <attribute>
390 <name>removeByBeanPath</name>
391 <required>false</required>
392 <rtexprvalue>true</rtexprvalue>
393 <type>java.lang.String</type>
394 <description>
395 A bean path of a HippoFacetSubNavigation object which can be retrieved via pageContext.
396 NOTE: This is mainly for allowing script templates (such as Freemarker) to set object property by bean path.
397 JSP developers could ignore this attribute and use 'hippobean' attribute instead directly with object property value.
398 </description>
399 </attribute>
400 <attribute>
401 <name>removeList</name>
402 <required>false</required>
403 <rtexprvalue>true</rtexprvalue>
404 <type>java.util.List</type>
405 <description>The List of HippoFacetSubNavigation's to be removed.</description>
406 </attribute>
407 <attribute>
408 <name>removeListByBeanPath</name>
409 <required>false</required>
410 <rtexprvalue>true</rtexprvalue>
411 <type>java.lang.String</type>
412 <description>
413 A bean path of a HippoFacetSubNavigation object which can be retrieved via pageContext.
414 NOTE: This is mainly for allowing script templates (such as Freemarker) to set object property by bean path.
415 JSP developers could ignore this attribute and use 'hippobean' attribute instead directly with object property value.
416 </description>
417 </attribute>
418 </tag>
419
420 <tag>
421 <name>surfandeditlink</name>
422 <tag-class>org.hippoecm.hst.tag.HstSurfAndEditTag</tag-class>
423 <tei-class>org.hippoecm.hst.tag.HstSurfAndEditTag$TEI</tei-class>
424 <body-content>JSP</body-content>
425 <description>This tag can be used to create a surfandedit cms url. Only in preview mode, the
426 tag will output something. In live, it will be ignored.</description>
427 <attribute>
428 <name>var</name>
429 <required>false</required>
430 <rtexprvalue>false</rtexprvalue>
431 <type>java.lang.String</type>
432 <description>The variable name of the surf and edit link</description>
433 </attribute>
434 <attribute>
435 <name>hippobean</name>
436 <required>false</required>
437 <rtexprvalue>true</rtexprvalue>
438 <type>org.hippoecm.hst.content.beans.standard.HippoBean</type>
439 <description>A HippoBean object. This is typically one of your bean mapped
440 objects</description>
441 </attribute>
442 <attribute>
443 <name>hippobeanByBeanPath</name>
444 <required>false</required>
445 <rtexprvalue>true</rtexprvalue>
446 <type>java.lang.String</type>
447 <description>
448 A bean path of HippoBean object which can be retrieved via pageContext.
449 NOTE: This is mainly for allowing script templates (such as Freemarker) to set object property by bean name.
450 JSP developers could ignore this attribute and use 'hippobean' attribute instead directly with object property value.
451 </description>
452 </attribute>
453 </tag>
454
455 <tag>
456 <name>html</name>
457 <tag-class>org.hippoecm.hst.tag.HstHtmlTag</tag-class>
458 <tei-class>org.hippoecm.hst.tag.HstHtmlTag$TEI</tei-class>
459 <body-content>JSP</body-content>
460 <description/>
461 <attribute>
462 <name>var</name>
463 <required>false</required>
464 <rtexprvalue>false</rtexprvalue>
465 <type>java.lang.String</type>
466 <description>The variable name of the html tag</description>
467 </attribute>
468 <attribute>
469 <name>hippohtml</name>
470 <required>false</required>
471 <rtexprvalue>true</rtexprvalue>
472 <type>org.hippoecm.hst.content.beans.standard.HippoHtml</type>
473 <description>A HippoHtml object. This is typically one of your bean mapped
474 objects</description>
475 </attribute>
476 <attribute>
477 <name>hippohtmlByBeanPath</name>
478 <required>false</required>
479 <rtexprvalue>true</rtexprvalue>
480 <type>java.lang.String</type>
481 <description>
482 A bean name of HippoHtml object which can be retrieved from pageContext.
483 NOTE: This is mainly for allowing script templates (such as Freemarker) to set object property by bean name.
484 JSP developers could ignore this attribute and use 'hippohtml' attribute instead directly with object property value.
485 </description>
486 </attribute>
487 <attribute>
488 <name>contentRewriter</name>
489 <required>false</required>
490 <rtexprvalue>true</rtexprvalue>
491 <type>org.hippoecm.hst.content.rewriter.ContentRewriter</type>
492 <description>A ContentRewriter object.</description>
493 </attribute>
494 <attribute>
495 <name>contentRewriterByBeanPath</name>
496 <required>false</required>
497 <rtexprvalue>true</rtexprvalue>
498 <type>java.lang.String</type>
499 <description>
500 A bean name of ContentRewriter object which can be retrieved from pageContext.
501 NOTE: This is mainly for allowing script templates (such as Freemarker) to set object property by bean name.
502 JSP developers could ignore this attribute and use 'contentRewriter' attribute instead directly with object property value.
503 </description>
504 </attribute>
505 <example><![CDATA[
506 <div>
507 <hst:html hippohtml="${document.intro}"/>
508 </div>
509 ]]></example>
510 </tag>
511
512 <tag>
513 <name>attribute</name>
514 <tag-class>org.hippoecm.hst.tag.HstAttributeTag</tag-class>
515 <body-content>JSP</body-content>
516 <description> This tag can be used only inside a element tag to set an attribute for the DOM
517 element created by the containing element tag. The attribute value can be set by the
518 value attribute, but it can be set by the text content of this tag also. If the value
519 attribute of this tag is not set, this tag will look for the body text content to set
520 the value of this attribute. If the value attribute is not set at all, then it will
521 remove the attribute by the name. </description>
522 <attribute>
523 <name>name</name>
524 <required>true</required>
525 <rtexprvalue>true</rtexprvalue>
526 <type>java.lang.String</type>
527 <description>The attribute name for the element</description>
528 </attribute>
529 <attribute>
530 <name>value</name>
531 <required>false</required>
532 <rtexprvalue>true</rtexprvalue>
533 <type>java.lang.String</type>
534 <description>The attribute value for the element</description>
535 </attribute>
536 </tag>
537
538 <tag>
539 <name>element</name>
540 <tag-class>org.hippoecm.hst.tag.HstElementTag</tag-class>
541 <tei-class>org.hippoecm.hst.tag.HstElementTag$TEI</tei-class>
542 <body-content>JSP</body-content>
543 <description> This tag can be used to create DOM Element to create head contribution
544 element. If you create a DOM Element via this tag and pass the variable to a
545 head-contribution tag, then the head-contribution element does not need to parse the
546 text content to create the head contribution DOM element. So, this tag provides an
547 optimized way to create a head-contribution element. This tag can contain zero, one or
548 more attribute tags to set attributes. Also, this tag can contain text content to set
549 the text content of the DOM element. </description>
550 <attribute>
551 <name>var</name>
552 <required>true</required>
553 <rtexprvalue>true</rtexprvalue>
554 <type>java.lang.String</type>
555 <description>The variable name of the created DOM element</description>
556 </attribute>
557 <attribute>
558 <name>name</name>
559 <required>true</required>
560 <rtexprvalue>true</rtexprvalue>
561 <type>java.lang.String</type>
562 <description>The tag name of the created DOM element</description>
563 </attribute>
564 </tag>
565
566 <tag>
567 <name>head-contribution</name>
568 <tag-class>org.hippoecm.hst.tag.HeadContributionTag</tag-class>
569 <body-content>JSP</body-content>
570 <description>Deprecated: use headContribution instead.
571 </description>
572 <attribute>
573 <name>keyHint</name>
574 <required>false</required>
575 <rtexprvalue>false</rtexprvalue>
576 <type>java.lang.String</type>
577 <description>Tag is Deprecated: use headContribution instead.
578 </description>
579 </attribute>
580 <attribute>
581 <name>element</name>
582 <required>false</required>
583 <rtexprvalue>true</rtexprvalue>
584 <type>org.w3c.dom.Element</type>
585 <description>Tag is Deprecated: use headContribution instead.
586 </description>
587 </attribute>
588 <attribute>
589 <name>elementByBeanPath</name>
590 <required>false</required>
591 <rtexprvalue>true</rtexprvalue>
592 <type>java.lang.String</type>
593 <description>Tag is Deprecated: use headContribution instead.
594 </description>
595 </attribute>
596 <attribute>
597 <name>category</name>
598 <required>false</required>
599 <rtexprvalue>false</rtexprvalue>
600 <type>java.lang.String</type>
601 <description>Tag is Deprecated: use headContribution instead.
602 </description>
603 </attribute>
604 </tag>
605
606 <tag>
607 <name>headContribution</name>
608 <tag-class>org.hippoecm.hst.tag.HeadContributionTag</tag-class>
609 <body-content>JSP</body-content>
610 <description> A HstComponent can contribute HTML HEAD elements to the page aggregation.
611 Because the output of a HstComponent is usually put in the middle of BODY area, it is
612 not recommended to include some javascripts or style definitions in its view page. If
613 the view page uses this head-contribution tag including some head element, then the
614 container will include the head element at the final page aggregation phase. </description>
615 <attribute>
616 <name>keyHint</name>
617 <required>false</required>
618 <rtexprvalue>false</rtexprvalue>
619 <type>java.lang.String</type>
620 <description> To avoid multiple inclusion of the same HEAD element like javascript
621 library, this keyHint attribute can be provided to set the key for the HEAD element.
622 If two HstComponents contribute HEAD elements with same keyHint attribute, the
623 container will include the HEAD element only once. If the component does not provide
624 keyHint attribute, the container will make a keyHint automatically by stringifying
625 the included HEAD element by this tag. </description>
626 </attribute>
627 <attribute>
628 <name>element</name>
629 <required>false</required>
630 <rtexprvalue>true</rtexprvalue>
631 <type>org.w3c.dom.Element</type>
632 <description> For more optimized way to create and use DOM element, this tag supports
633 setting a DOM element by element attribute. If this attribute is set, then the
634 head-contribution tag will not try to parse the body content to create a DOM
635 element. Instead, it will use the passed DOM element by this attribute.
636 </description>
637 </attribute>
638 <attribute>
639 <name>elementByBeanPath</name>
640 <required>false</required>
641 <rtexprvalue>true</rtexprvalue>
642 <type>java.lang.String</type>
643 <description>
644 A bean name of Element object which can be retrieved from pageContext.
645 NOTE: This is mainly for allowing script templates (such as Freemarker) to set object property by bean name.
646 JSP developers could ignore this attribute and use 'element' attribute instead directly with object property value.
647 </description>
648 </attribute>
649 <attribute>
650 <name>category</name>
651 <required>false</required>
652 <rtexprvalue>false</rtexprvalue>
653 <type>java.lang.String</type>
654 <description> Category name of the contributed head element.
655 The head elements can be filtered in or filtered out by this attribute.
656 By the way, this attribute does not affect anything in portal/portlet environment. </description>
657 </attribute>
658 <example><![CDATA[
659 <hst:headContribution keyHint="generator">
660 <meta name="generator" content="Hippo Site Toolkit 2"/>
661 </hst:headContribution>
662 ]]></example>
663 </tag>
664
665 <tag>
666 <name>head-contributions</name>
667 <tag-class>org.hippoecm.hst.tag.HeadContributionsTag</tag-class>
668 <body-content>empty</body-content>
669 <description>Deprecated: use headContributions instead.</description>
670 <attribute>
671 <name>xhtml</name>
672 <required>false</required>
673 <rtexprvalue>false</rtexprvalue>
674 <type>boolean</type>
675 <description>Tag is Deprecated: use headContributions instead.
676 </description>
677 </attribute>
678 <attribute>
679 <name>categoryIncludes</name>
680 <required>false</required>
681 <rtexprvalue>false</rtexprvalue>
682 <type>java.lang.String</type>
683 <description>Tag is Deprecated: use headContributions instead.
684 </description>
685 </attribute>
686 <attribute>
687 <name>categoryExcludes</name>
688 <required>false</required>
689 <rtexprvalue>false</rtexprvalue>
690 <type>java.lang.String</type>
691 <description>Tag is Deprecated: use headContributions instead.
692 </description>
693 </attribute>
694 </tag>
695
696 <tag>
697 <name>headContributions</name>
698 <tag-class>org.hippoecm.hst.tag.HeadContributionsTag</tag-class>
699 <body-content>empty</body-content>
700 <description> All the HEAD elements contributed by each HstComponent can be accessed only by
701 the root HstComponent. The root HstComponent will be responsible for rendering all the
702 contributed HEAD elements. By inserting this tag, the root HstComponent can render all
703 the contributed HEAD elements. </description>
704 <attribute>
705 <name>xhtml</name>
706 <required>false</required>
707 <rtexprvalue>false</rtexprvalue>
708 <type>boolean</type>
709 <description> If this attribute is true, then the output will be generated as XHTML
710 format. By default, this value is false. </description>
711 </attribute>
712 <attribute>
713 <name>categoryIncludes</name>
714 <required>false</required>
715 <rtexprvalue>false</rtexprvalue>
716 <type>java.lang.String</type>
717 <description> Comma separated category list string for category includes.
718 Contributed head elements can be filtered in by this attribute.
719 If a contributed head element has a category and this attribute contains
720 the category, then the head element would be written into the page.
721 By the way, this attribute does not affect anything in portal/portlet environment. </description>
722 </attribute>
723 <attribute>
724 <name>categoryExcludes</name>
725 <required>false</required>
726 <rtexprvalue>false</rtexprvalue>
727 <type>java.lang.String</type>
728 <description> Comma separated category list string for category excludes.
729 Contributed head elements can be filtered out by this attribute.
730 If a contributed head element has a category and this attribute does not contain
731 the category, then the head element would be written into the page.
732 By the way, this attribute does not affect anything in portal/portlet environment. </description>
733 </attribute>
734 </tag>
735
736 <tag>
737 <name>write-head-contributions</name>
738 <tag-class>org.hippoecm.hst.tag.HeadContributionsTag</tag-class>
739 <body-content>empty</body-content>
740 <description>Deprecated: use writeHeadContributions instead.
741 </description>
742 <attribute>
743 <name>xhtml</name>
744 <required>false</required>
745 <rtexprvalue>false</rtexprvalue>
746 <type>boolean</type>
747 <description>Tag is deprecated: use writeHeadContributions instead.</description>
748 </attribute>
749 <attribute>
750 <name>categoryIncludes</name>
751 <required>false</required>
752 <rtexprvalue>false</rtexprvalue>
753 <type>java.lang.String</type>
754 <description>Tag is deprecated: use writeHeadContributions instead.</description>
755 </attribute>
756 <attribute>
757 <name>categoryExcludes</name>
758 <required>false</required>
759 <rtexprvalue>false</rtexprvalue>
760 <type>java.lang.String</type>
761 <description>Tag is deprecated: use writeHeadContributions instead.</description>
762 </attribute>
763 </tag>
764
765 <tag>
766 <name>writeHeadContributions</name>
767 <tag-class>org.hippoecm.hst.tag.HeadContributionsTag</tag-class>
768 <body-content>empty</body-content>
769 <description> All the HEAD elements contributed by each HstComponent can be accessed only by
770 the root HstComponent. The root HstComponent will be responsible for rendering all the
771 contributed HEAD elements. By inserting this tag, the root HstComponent can render all
772 the contributed HEAD elements. </description>
773 <attribute>
774 <name>xhtml</name>
775 <required>false</required>
776 <rtexprvalue>false</rtexprvalue>
777 <type>boolean</type>
778 <description> If this attribute is true, then the output will be generated as XHTML
779 format. By default, this value is false. </description>
780 </attribute>
781 <attribute>
782 <name>categoryIncludes</name>
783 <required>false</required>
784 <rtexprvalue>false</rtexprvalue>
785 <type>java.lang.String</type>
786 <description> Comma separated category list string for category includes.
787 Contributed head elements can be filtered in by this attribute.
788 If a contributed head element has a category and this attribute contains
789 the category, then the head element would be written into the page.
790 By the way, this attribute does not affect anything in portal/portlet environment. </description>
791 </attribute>
792 <attribute>
793 <name>categoryExcludes</name>
794 <required>false</required>
795 <rtexprvalue>false</rtexprvalue>
796 <type>java.lang.String</type>
797 <description> Comma separated category list string for category excludes.
798 Contributed head elements can be filtered out by this attribute.
799 If a contributed head element has a category and this attribute does not contain
800 the category, then the head element would be written into the page.
801 By the way, this attribute does not affect anything in portal/portlet environment. </description>
802 </attribute>
803 </tag>
804
805 <tag>
806 <name>namespace</name>
807 <tag-class>org.hippoecm.hst.tag.NamespaceTag</tag-class>
808 <body-content>empty</body-content>
809 <description> Because there could be multiple HstComponents in a page, it is necessary to
810 separate its namespace from each other during writing some javascript functions or HTML
811 elements. Using this tag, each HstComponent can write unique name for its elements.
812 </description>
813 </tag>
814
815 <tag>
816 <name>defineObjects</name>
817 <tag-class>org.hippoecm.hst.tag.DefineObjectsTag</tag-class>
818 <tei-class>org.hippoecm.hst.tag.DefineObjectsTag$TEI</tei-class>
819 <body-content>empty</body-content>
820 </tag>
821
822 </taglib>

Properties

Name Value
svn:eol-style native
svn:keywords Id
svn:mime-type text/plain