Web Core Library - 5.15.2

Tag reference sheet

Tag library reference for the following tag libraries:

Menu Tree Tag - version 1.1

Menu tree tag

Namespace definition: xmlns:menuTree="http://www.silverpeas.com/tld/menuTree"

Tags

  • head Loads the css and javascript file relating to tree menu

Required attributes are marked with a*

<menuTree:head>

Loads the css and javascript file relating to tree menu

Can contain:JSP

Attributes

Name Description Type
contextName* context application name String
displayCssFile* Indicates if the css File must be display String
displayIconsStyles* Indicates if the icons components must be display String
displayJavascriptFile* Indicates if the javascript File must be display String

Context Menu - version 1.0

Context Menu library

Namespace definition: xmlns:menu="http://www.silverpeas.com/tld/contextMenu"

Tags

Required attributes are marked with a*

<menu:simpleDocument>

Tag to print out contextual menu of an SimpleDocument.

Can contain:empty

Attributes

Name Description Type
attachment* The attachment related to the current menu. org.silverpeas.attachment.model.SimpleDocument
showMenuNotif* To indicate if notification is enabled. String
useContextualMenu* To indicate if contextual menu is enabled. String
useWebDAV* To indicate if the attachment may be edited with webdav. String
useXMLForm* To indicate if there is a xml form attached to the attachment. String

Silverpeas Functions - version 1.0

Silverpeas Functions core library

Namespace definition: xmlns:silfn="http://www.silverpeas.com/tld/silverFunctions"

EL Functions

Required attributes are marked with a*

silfn:applicationURL()

Function class: com.stratelia.silverpeas.peasCore.URLManager

Function signature: java.lang.String getApplicationURL()

Function that returns the URL of the application.

silfn:attachmentImages(java.lang.String, java.lang.String)

Function class: org.silverpeas.wysiwyg.control.WysiwygController

Function signature: java.util.List getImages(java.lang.String, java.lang.String)

Function that returns the images attached to an object in an application.

silfn:booleanValue( java.lang.String )

Function class: com.silverpeas.util.StringUtil

Function signature: boolean getBooleanValue( java.lang.String )

Function that returns the boolean value of a String.

silfn:buildHtmlListDynamicValue(java.lang.String, java.lang.String, java.lang.String)

Function class: com.silverpeas.wysiwyg.dynamicvalue.control.DynamicValueReplacement

Function signature: java.lang.String buildHTMLSelect(java.lang.String, java.lang.String, java.lang.String)

Function that returns the html code of the list of dynamic value in wysiwyg.

silfn:capitalize(java.lang.String)

Function class: org.apache.commons.lang3.StringUtils

Function signature: java.lang.String capitalize(java.lang.String)

Function that returns capitalized string

silfn:componentURL(java.lang.String)

Function class: com.stratelia.silverpeas.peasCore.URLManager

Function signature: java.lang.String getComponentInstanceURL(java.lang.String)

Function that returns the component URL of the specified component instance identifier.

silfn:componentsFileStorage()

Function class: org.silverpeas.wysiwyg.control.WysiwygController

Function signature: java.util.List getStorageFile()

Function that returns the list of components kmelia (object com.stratelia.webactiv.beans.admin.ComponentInstLight) dedicated to file storage.

silfn:componentsImageStorage()

Function class: org.silverpeas.wysiwyg.control.WysiwygController

Function signature: java.util.List getGalleries()

Function that returns the list of components gallery (object com.stratelia.webactiv.beans.admin.ComponentInstLight) dedicated to image storage.

silfn:constantValue( java.lang.String )

Function class: org.silverpeas.jstl.constant.reflect.ClassConstantInspector

Function signature: java.lang.Object getValue( java.lang.String )

Function that returns the value of a class constant.

silfn:countTotalNumberOfPagesOfPagination(int,int)

Function class: com.stratelia.webactiv.util.viewGenerator.html.pagination.PaginationUtil

Function signature: int countTotalNumberOfPages(int,int)

Function to count the total number of pages to display.

Example

      <c:out value="${silfn:countTotalNumberOfPages(15,50)}">

silfn:defaultEmptyString(java.lang.String)

Function class: com.silverpeas.util.StringUtil

Function signature: java.lang.String defaultStringIfNotDefined(java.lang.String)

Use empty string if the one passed is not defined.

silfn:defaultString(java.lang.String,java.lang.String)

Function class: com.silverpeas.util.StringUtil

Function signature: java.lang.String defaultStringIfNotDefined(java.lang.String,java.lang.String))

Use default string if the first passed is not defined.

silfn:escapeHtml( java.lang.String )

Function class: com.silverpeas.util.EncodeHelper

Function signature: java.lang.String javaStringToHtmlString( java.lang.String )

Function to encode a java String into a HTML String.

silfn:escapeHtmlWhitespaces( java.lang.String )

Function class: com.silverpeas.util.EncodeHelper

Function signature: java.lang.String convertWhiteSpacesForHTMLDisplay( java.lang.String )

Function to encode a java whitespace String into a HTML whitespace String.

silfn:escapeJs( java.lang.String )

Function class: com.silverpeas.util.EncodeHelper

Function signature: java.lang.String javaStringToJsString( java.lang.String )

Function to encode a java String into a Javascript String.

silfn:estimateDownload( long )

Function class: com.stratelia.webactiv.util.FileRepositoryManager

Function signature: java.lang.String getFileDownloadTime( long )

Function that display the estimated download time.

silfn:formatDate(java.util.Date,java.lang.String)

Function class: com.stratelia.webactiv.util.DateUtil

Function signature: java.lang.String getOutputDate(java.util.Date,java.lang.String)

Function to format a date.

Example

      <c:out value="${silfn:formatDate(date, "fr")}">

silfn:formatDateAndHour(java.util.Date,java.lang.String)

Function class: com.stratelia.webactiv.util.DateUtil

Function signature: java.lang.String getOutputDateAndHour(java.util.Date,java.lang.String)

Function to format a date.

Example

      <c:out value="${silfn:formatDateAndHour(date, "fr")}">

silfn:formatMemSize(long)

Function class: org.silverpeas.util.UnitUtil

Function signature: java.lang.String formatMemSize(long)

Function that formats as memory size the given byte value.

silfn:formatPaginationFromCurrentPageIndex(int,int,int)

Function class: com.stratelia.webactiv.util.viewGenerator.html.pagination.PaginationUtil

Function signature: java.lang.String formatFromCurrentPageIndex(int,int,int)

Function to format a pagination.

Example

      <c:out value="${silfn:formatPagination(15,50,2)}">

silfn:formatPaginationFromFirstIndexOfItem(int,int,int)

Function class: com.stratelia.webactiv.util.viewGenerator.html.pagination.PaginationUtil

Function signature: java.lang.String formatFromFirstIndexOfItem(int,int,int)

Function to format a pagination.

Example

      <c:out value="${silfn:formatPagination(15,50,30)}">

silfn:formatStringDate(java.lang.String,java.lang.String)

Function class: com.stratelia.webactiv.util.DateUtil

Function signature: java.lang.String getOutputDate(java.lang.String,java.lang.String)

Function to format a date.

Example

      <c:out value="${silfn:formatStringDate("yyyy/MM/dd", "fr")}">

silfn:formatStringDateAndHour(java.lang.String,java.lang.String)

Function class: com.stratelia.webactiv.util.DateUtil

Function signature: java.lang.String getOutputDateAndHour(java.lang.String,java.lang.String)

Function to format a date.

Example

      <c:out value="${silfn:formatStringDateAndHour("yyyy/MM/dd HH:mm", "fr")}">

silfn:fullApplicationURL(javax.servlet.http.HttpServletRequest)

Function class: com.stratelia.silverpeas.peasCore.URLManager

Function signature: java.lang.String getFullApplicationURL(javax.servlet.http.HttpServletRequest)()

Function that returns the Full URL of the application.

silfn:getGreatestRoleOfCurrentUserOn(java.lang.String)

Function class: com.stratelia.webactiv.SilverpeasRole

Function signature: com.stratelia.webactiv.SilverpeasRole getGreatestOfCurrentUserOn(java.lang.String)

Gets the greatest role on the component represented by the given identifier the current user has.

silfn:getMemData(long)

Function class: org.silverpeas.util.UnitUtil

Function signature: org.silverpeas.util.memory.MemoryData getMemData(long)

Function that converts as a memory data the given byte value.

silfn:getMemorySizeConvertedTo(org.silverpeas.util.memory.MemoryData,org.silverpeas.util.memory.MemoryUnit)

Function class: org.silverpeas.util.UnitUtil

Function signature: java.math.BigDecimal convertAndRoundTo(org.silverpeas.util.memory.MemoryData,org.silverpeas.util.memory.MemoryUnit)

Function that converts as a desired memory size the given byte value.

silfn:getTimeData(long)

Function class: org.silverpeas.util.UnitUtil

Function signature: org.silverpeas.util.time.TimeData getTimeData(long)

Function that converts as a time data the given long time value.

silfn:humanReadableSize(long)

Function class: org.silverpeas.util.UnitUtil

Function signature: java.lang.String formatMemSize(long)

Function that display the file size in a human readable format.

silfn:i18nLanguageLabel( java.lang.String, java.lang.String)

Function class: com.silverpeas.util.i18n.I18NHelper

Function signature: java.lang.String getLanguageLabel( java.lang.String, java.lang.String)

Function to tell if Silverpeas is in mode i18N.

silfn:isDefined( java.lang.String )

Function class: com.silverpeas.util.StringUtil

Function signature: boolean isDefined( java.lang.String )

Function that indicates if a String is defined.

silfn:isDynamicValueActivate()

Function class: com.silverpeas.wysiwyg.dynamicvalue.control.DynamicValueReplacement

Function signature: boolean isActivate()

Function that indicates if the dynamic value functionality in wysiwyg is active.

silfn:isI18n()

Function class: com.silverpeas.util.i18n.I18NHelper

Function signature: boolean isI18nContentEnabled()

Function to tell if Silverpeas is in mode i18N.

silfn:isNotDefined( java.lang.String )

Function class: com.silverpeas.util.StringUtil

Function signature: boolean isNotDefined( java.lang.String )

Function that indicates if a String is not defined.

silfn:isPreviewable( java.lang.String )

Function class: org.silverpeas.viewer.ViewerFactory

Function signature: boolean isPreviewable( java.lang.String )

Function that indicates if a file is previewable.

silfn:isViewable( java.lang.String )

Function class: org.silverpeas.viewer.ViewerFactory

Function signature: boolean isViewable( java.lang.String )

Function that indicates if a file can be displayed with FlexPaper.

silfn:mimeType( java.lang.String )

Function class: com.silverpeas.util.FileUtil

Function signature: java.lang.String getMimeType( java.lang.String )

Function that display the file mime type.

silfn:regexReplace(java.lang.String,java.lang.String,java.lang.String)

Function class: com.silverpeas.util.StringUtil

Function signature: java.lang.String regexReplace(java.lang.String,java.lang.String,java.lang.String)

Function that replace regex text parts by a replacement text

silfn:repeat(java.lang.String,int)

Function class: org.apache.commons.lang3.StringUtils

Function signature: java.lang.String repeat(java.lang.String,int)

Function that repeat x times a string to obtain the final string.

silfn:split(java.lang.String,java.lang.String)

Function class: org.apache.commons.lang3.StringUtils

Function signature: java.lang.String[] split(java.lang.String,java.lang.String)

Splits the provided text into an array, using whitespace as the separator.

silfn:splitOnWhitespace(java.lang.String)

Function class: org.apache.commons.lang3.StringUtils

Function signature: java.lang.String[] split(java.lang.String)

Splits the provided text into an array, using whitespace as the separator.

silfn:truncate(java.lang.String,int)

Function class: com.silverpeas.util.StringUtil

Function signature: java.lang.String truncate(java.lang.String,int)

Truncate the specified text to the specified length if necessary.

silfn:webSiteImages(java.lang.String, java.lang.String)

Function class: org.silverpeas.wysiwyg.control.WysiwygController

Function signature: java.lang.String[][] getWebsiteImages(java.lang.String, java.lang.String)

Function that returns the images attached to the path for the website application.

View Generator - version 1.0

View Generator 1.1 core library

Namespace definition: xmlns:view="http://www.silverpeas.com/tld/viewGenerator"

Tags

  • a A HTML TAG OVERRIDE
  • applyTemplate Tag that display a StringTemplate content
  • areaOfOperationOfCreation Simple tag to create HTML to display operations of creation
  • arrayCellText Tag to create a new cell in the current line of the ArrayPane
  • arrayColumn Tag to create a column header for an ArrayPane
  • arrayLine Tag to create a new line in the ArrayPane
  • arrayPane Tag to create an ArrayPane: a table to display a list of data
  • attachmentPane Tag to print out the panel of management of the attachements for a given component instance and for a given resource
  • authenticatedUser Tag that checks the user is currently authenticated and that he is not an anonymous user
  • board Simple tag to display a Board
  • browseBar Simple tag to define a Window browse bar
  • browseBarElt Simple tag to define an element of a Window browsebar
  • button Simple tag to display a button
  • buttonPane Simple tag to display a button pane
  • commentEdition Tag to print out an edition form for adding new comments on a given resource
  • commentListing Tag to print out a list of comments on a given resource
  • comments Tag to print out both a list of comments and an edition form for adding new comments on a given resource/ The edition form is printed only for non-guest users
  • componentParam Obtain the value of the parameter for the specified component instance
  • componentPath Tag to print out the full path of an application
  • componentUrl Tag to print out the URL of a Silverpeas component instance
  • confirmComponentSubscriptionNotificationSending This TAG must be called into body of Button TAG
  • confirmResourceSubscriptionNotificationSending This TAG must be called into body of Button TAG
  • constantsMap Establishes a scoped variable that contains a java
  • dateReminder Tag that display date reminder
  • displayResult Generate HTML search result element
  • displayWysiwyg Display the content of a Wysiwyg
  • encodeHtml Simple tag to encode a java String into an HTML String
  • encodeHtmlParagraph Simple tag to encode a java String into an HTML Paragraph String
  • encodeJs Simple tag to encode a java String into a Javascript String
  • encodeXml Simple tag to encode a java String into a XML escaped String
  • fileUpload Simple tag to manage upload of files
  • form FORM HTML TAG OVERRIDE
  • formatDate Tag to print out a date localized from the specified language
  • formatDateTime Tag to print out a date and time localized from the specified language
  • frame Simple tag to display a frame
  • highlight Tag to highlight some terms contained in his body
  • icon Simple tag to display an icon
  • icons Simple tag to display a list of icons
  • image Tag to print out the img HTML tag with the path of the targeted image computed from the tag's attributes
  • includePlugin Tag to print out a javascript plugin inclusion
  • langSelect Tag that displays the available languages
  • link LINK HTML TAG OVERRIDE
  • looknfeel Simple tag to create HTML to access the look and feel
  • map Generate HTML for the site Map
  • mimeTypeIcon Simple tag to display a div with the style corresponding to the mime type
  • navigationList Simple tag to display a navigation item list
  • navigationListItem Simple tag to display a navigation item list
  • operation Simple tag to define an operation in an OperationPane
  • operationOfCreation Simple tag to define an operation of creation in an OperationPane
  • operationPane Simple tag to define an operationPane: a panel with a list of operations (could be a menu)
  • operationSeparator Simple tag to define a separator line between two operations in an OperationPane
  • pagination Simple tag to define a pagination navigation bar
  • pdcClassification Tag to print out the HTML/javascript widget with which the classification on the PdC of a given resource content is opened and can be edited
  • pdcClassificationPreview Tag to print out the HTML/javascript widget within which a preview of the classification on the PdC of a given resource content is rendered
  • pdcNewContentClassification Tag to print out an HTML/javascript widget to classify new content that will published into a given component instance
  • pdcPositions Tag to print out javascript code to get the positions of a classification on the PdC of a content
  • pdcPredefinedClassification Tag to print out an HTML/javascript widget with which the predefined classification on the PdC of a component instance or of a node (a topic, a category,
  • pdcValidateClassification Tag to print out javascript code to validate the classification on the PdC that was done through the tag pdcNewContentClassification for a new content
  • progressMessage Simple tag to display a progress message
  • script SCRIPT HTML TAG OVERRIDE
  • setBundle Equivalent of the JSTL fmt:setBundle tag but with support for the ResourceWrapper
  • setConstant Creates a scoped variable representing the value of the referenced class constant
  • settings Establishes a scoped variable that contains the value of the defined settings
  • tab Simple tag to display a list of tabs
  • tabs Simple tag to display a list of tabs
  • templateParam Parameter of a StringTemplate Tag
  • timeout Tag that checks the validity of the current session and forwards to the error page
  • username Tag to print out the full name of the current user and to use with it the userzoom silverpeas plugin
  • video Simple tag to play a video in flowplayer
  • window Simple tag to display a window
  • wysiwyg Tag that display javascript initialization of Wysiwyg editor

EL Functions

Required attributes are marked with a*

<view:a>

A HTML TAG OVERRIDE

Can contain:JSP

Attributes

Name Description Type
classes * String
href * String
id * String
name * String
onClick * String
style * String

<view:applyTemplate>

Tag that display a StringTemplate content.

Can contain:JSP

Attributes

Name Description Type
locationBase* The base of the location of the template. It is separated into two parts by a colon character. First part corresponds at the namespace. If it is defined "core" then template location base starts from the CORE root path of templates. Otherwise, the name of a component instance has to be defined and template location base starts from the COMPONENT root path of templates (for example "kmelia:publication/content" indicates that the COMPONENT root path of templates is used and that the location base after parsing is "COMPONENT_ROOT_PATH/kmelia/publication/content"). Second part represents the base of templates location, from the CORE or the COMPONENT starting node, into which templates are performed. String
name* Name of the template to apply (without the language suffix). String

<view:areaOfOperationOfCreation>

Simple tag to create HTML to display operations of creation.

Can contain:JSP

This tag has no attributes.

<view:arrayCellText>

Tag to create a new cell in the current line of the ArrayPane.

Can contain:JSP

Attributes

Name Description Type
text The text to be displayed if the body is empty String

<view:arrayColumn>

Tag to create a column header for an ArrayPane

Can contain:empty

Attributes

Name Description Type
sortable If the column is sortable String
title The String to be displayed as a title in the Column Header String

<view:arrayLine>

Tag to create a new line in the ArrayPane

Can contain:JSP

Attributes

Name Description Type
id The String to identified this line String

<view:arrayPane>

Tag to create an ArrayPane: a table to display a list of data.

Can contain:JSP

Attributes

Name Description Type
export Export data parameter. boolean
exportURL URL to be used to export data. String
numberLinesPerPage Defines number of lines displayed per page String
routingAddress URL to be used to sort the content. String
sortableLines Defines if lines can be explicitly sorted boolean
summary * String
title * String
var* Name of the ArrayPane in the SessionScope String

<view:attachmentPane>

Tag to print out the panel of management of the attachements for a given component instance and for a given resource.

Can contain:empty

Attributes

Name Description Type
componentId* The unique identifier of the component instance the resource belongs to. String
readOnly Indicates if the attachment pane must be display in read only view. By default, it is in editable view. String
resourceId* The unique identifier of the resource that accepts the attachements. String

<view:authenticatedUser>

Tag that checks the user is currently authenticated and that he is not an anonymous user.

Can contain:JSP

This tag has no attributes.

<view:board>

Simple tag to display a Board. A Board should be used inside a Frame.

Can contain:JSP

This tag has no attributes.

<view:browseBar>

Simple tag to define a Window browse bar. It should be declared and used before a Window.

Can contain:JSP

Attributes

Name Description Type
clickable Allows to display a non clickable breadcrumb boolean
componentId Forces componentId (usefull in portlets case) String
extraInformations Extra information to be displayed. String
ignoreComponentLink Permit to use component's link given by setComponentName(name, link) method boolean
path Path to be displayed. String
spaceId Forces spaceId (usefull in portlets page and space homepage) String

<view:browseBarElt>

Simple tag to define an element of a Window browsebar. It should be declared and used before a Window.

Can contain:JSP

Attributes

Name Description Type
id Id for the element data for the current component. String
label* The content to be displayed for the browseBar element. String
link* The url for the browseBar element. String

<view:button>

Simple tag to display a button.

Can contain:JSP

Attributes

Name Description Type
action* The action of the button. String
disabled true or false to indicate if the button is disabled or not. String
label* The display label in the button. String

<view:buttonPane>

Simple tag to display a button pane.

Can contain:JSP

Attributes

Name Description Type
disabled true or false to indicate if the button is disabled or not. String
height The height of the panel. String
horizontalPosition Indicates if the button are added horizontically boolean
verticalPosition Indicates if the button are added vertically. boolean

<view:commentEdition>

Tag to print out an edition form for adding new comments on a given resource. The edition is printed only for non-guest users.

Can contain:JSP

Attributes

Name Description Type
callback A javascript callback to call at each event on the comments. At event reception, the function will be invoked with as parameter an object having two attributes: the event that occured (a value among: 'listing', 'addition', 'deletion', or 'udpate'), and the object concerned by the event (either a comment or the list of comments for listing). String
componentId* The identifier of the Silverpeas component instance to which the commented resource belongs String
indexed New comments should be indexed? If not set or valued with '1', 'yes' or 'true', all new comments will be indexed by Silverpeas. String
resourceId* The identifier of the resource in Silverpeas that is commented out and for which the comments must be printed. String
userId* The identifier of the user that request the adding of a new comment. String

<view:commentListing>

Tag to print out a list of comments on a given resource

Can contain:JSP

Attributes

Name Description Type
callback A javascript callback to call at each event on the comments. At event reception, the function will be invoked with as parameter an object having two attributes: the event that occured (a value among: 'listing', 'addition', 'deletion', or 'udpate'), and the object concerned by the event (either a comment or the list of comments for listing). String
componentId* The identifier of the Silverpeas component instance to which the commented resource belongs String
resourceId* The identifier of the resource in Silverpeas that is commented out and for which the comments must be printed. String
userId* The identifier of the user that request the comments. String

<view:comments>

Tag to print out both a list of comments and an edition form for adding new comments on a given resource/ The edition form is printed only for non-guest users.

Can contain:JSP

Attributes

Name Description Type
callback A javascript callback to call at each event on the comments. At event reception, the function will be invoked with as parameter an object having two attributes: the event that occured (a value among: 'listing', 'addition', 'deletion', or 'udpate'), and the object concerned by the event (either a comment or the list of comments for listing). String
componentId* The identifier of the Silverpeas component instance or the tool to which the commented resource belongs String
indexed New comments should be indexed? If not set or valued with '1', 'yes' or 'true', all new comments will be indexed by Silverpeas. String
resourceId* The identifier of the resource in Silverpeas that is commented out and for which the comments must be printed. String
resourceType* The type of the resource in Silverpeas that is commented out and for which the comments must be printed. Usually this value is that of the getContributionType method from SilverpeasContent interface implemented by the resource. String
userId* The identifier of the user that request the adding of a new comment. String

<view:componentParam>

Obtain the value of the parameter for the specified component instance.

Can contain:JSP

Attributes

Name Description Type
componentId* The component identifier. String
parameter* Parameter name. String
scope Scope to store the value. String
var* The name of the scoped variable to create. String

<view:componentPath>

Tag to print out the full path of an application

Can contain:empty

Attributes

Name Description Type
componentId* The unique identifier of the application String
includeComponent Is the application must be displayed at the end of path. True by default. String
separator String to separate path items. ' > ' by default. String

<view:componentUrl>

Tag to print out the URL of a Silverpeas component instance.

Can contain:JSP

Attributes

Name Description Type
componentId* The identifier of the Silverpeas component instance. String
componentName The name of the Silverpeas component instance. String

<view:confirmComponentSubscriptionNotificationSending>

This TAG must be called into body of Button TAG. It permits to handle a user confirmation of subscription notification sending.

Can contain:JSP

Attributes

Name Description Type
jsValidationCallbackMethodName Specify the name of the method to call in order to validate the data filled by a user. The method must return true if data filled are ok, false otherwise. String

<view:confirmResourceSubscriptionNotificationSending>

This TAG must be called into body of Button TAG. It permits to handle a user confirmation of subscription notification sending.

Can contain:JSP

Attributes

Name Description Type
jsValidationCallbackMethodName Specify the name of the method to call in order to validate the data filled by a user. The method must return true if data filled are ok, false otherwise. String
subscriptionResourceId* The identifier of the resource on which the subscription is registered String
subscriptionResourceType* The type of the resource subscription handled com.silverpeas.subscribe.constant.SubscriptionResourceType

<view:constantsMap>

Establishes a scoped variable that contains a java.util.Map of a named class constants.

Can contain:empty

Attributes

Name Description Type
className* The fully qualified name of the class whose class constants are to be established in the generated Map instance. String
scope The scope in which the scoped variable is to be created. String
var* The name of the scoped variable to create. String

<view:dateReminder>

Tag that display date reminder

Can contain:JSP

Attributes

Name Description Type
language* Language of current user String
resourceId* Id of current resource String
resourceType* Type of current resource String
userId* Id of current user String

<view:displayResult>

Generate HTML search result element.

Can contain:JSP

Attributes

Name Description Type
activeSelection Active selection String
exportEnabled Export enabled String
gsr* Global Silver Result com.stratelia.silverpeas.pdcPeas.model.GlobalSilverResult
settings* Settings of search engine com.stratelia.silverpeas.util.ResourcesWrapper
sortValue* Sort value String
userId* User identifier String

<view:displayWysiwyg>

Display the content of a Wysiwyg.

Can contain:empty

Attributes

Name Description Type
axisId The id of the classification scheme axis to which this wysiwyg is attached for highlighting. String
componentId* The id of the component to which this wysiwyg is attached. String
highlightFirst To indicate if the highlight is first or not. String
language* The language of the wysiwyg to display. String
objectId* The id of the object to which this wysiwyg is attached. String

<view:encodeHtml>

Simple tag to encode a java String into an HTML String.

Can contain:JSP

Attributes

Name Description Type
string* Java String String

<view:encodeHtmlParagraph>

Simple tag to encode a java String into an HTML Paragraph String.

Can contain:JSP

Attributes

Name Description Type
string* Java String String

<view:encodeJs>

Simple tag to encode a java String into a Javascript String.

Can contain:JSP

Attributes

Name Description Type
string* Java String String

<view:encodeXml>

Simple tag to encode a java String into a XML escaped String.

Can contain:JSP

Attributes

Name Description Type
string* Java String String

<view:fileUpload>

Simple tag to manage upload of files.

Can contain:JSP

Attributes

Name Description Type
dragAndDropDisplay Default value is true. If true drop zone area is displayed on compatible web browsers. If false a standard input file is displayed in any case. String
fieldset Pass true if the UI has to be displayed in a fieldset. String
id If not filled, default id is 'fileUpload'. String
jqueryFormSelector By this attribute is passed the jQuery selector that permits to identify html forms to manage. If files are being upload, all the html forms aimed by the given selector can not be submitted. When an html forms can not be submitted, a modal warning message is displayed to the user. String
multiple Choose several files at one time. If not filled, default is true. If the web browser is not compatible with multiple file selection, the feature is deactivated. String
nbFileLimit If filled with a positive value, when the number of uploads reaches the value, it is no more possible to upload files. String

<view:form>

FORM HTML TAG OVERRIDE

Can contain:JSP

Attributes

Name Description Type
action* * String
id * String
method* * String
name* * String

<view:formatDate>

Tag to print out a date localized from the specified language

Can contain:JSP

Attributes

Name Description Type
language The language to use for localizing the date. If not set, then the resources wrapper usually carried in the request is used. String
value* The date to format java.util.Date

<view:formatDateTime>

Tag to print out a date and time localized from the specified language

Can contain:JSP

Attributes

Name Description Type
language The language to use for localizing the date and time. If not set, then the resources wrapper usually carried in the request is used. String
value* The date and time to format java.util.Date

<view:frame>

Simple tag to display a frame. A Frame should be used inside a Window.

Can contain:JSP

Attributes

Name Description Type
title * String

<view:highlight>

Tag to highlight some terms contained in his body

Can contain:JSP

Attributes

Name Description Type
axisId* The Glossary identifier (pdc axis). String
className* The css class used to highlight a word . String
language* indicates the language used to display the definition term. String
onlyFirst indicates if all a term occurrences must be highlight or only the fisrt String

<view:icon>

Simple tag to display an icon.

Can contain:JSP

Attributes

Name Description Type
action action associee a l'icone String
altText texte alternatif String
iconName* clef de l'icone a afficher String
imagePath clef de l'icone a afficher String

<view:icons>

Simple tag to display a list of icons.

Can contain:JSP

Attributes

Name Description Type
orientation orientation de la liste des icones (vertical, horizontal) String
spacing espacement des icones String

<view:image>

Tag to print out the img HTML tag with the path of the targeted image computed from the tag's attributes. This tag is used to refer a dynamic resized version of an existing image; the size of an image can be passed as such to the tag or can be computed from its type or using context. The types of the images are defined in the org.silverpeas.lookAndFeel.generalLook.properties bundle under the key prefix image.size.

Can contain:empty

Attributes

Name Description Type
alt A short description of the image as an alternative way to render it if the image cannot be displayed for any reasons. String
css A name of a CSS class to apply to the img HTML tag. If this attribute isn't valued, then the CSS class of the image is by default valued with the type of the image (see type attribute) with each point replaced by a minus. If the attribute type isn't valued, then no CSS class is provided. String
id The HTML element identifier in the HTML DOM. String
size An explicit size of the targeted image. This attribute is applied over the type one. It is predominant over the type attribute. The path of the image is then computed according to this size. The size should be in the form of WIDTHxHEIGH with WIDTH the width in pixels of the image and HEIGHT the height in pixels of the image; one of these parameters can be omitted but the 'x' character must be present. String
src* The relative path of the source image from the web context. The exact URL will be computed by the tag itself. String
type The type of the image. The types of an image are defined in the org.silverpeas.lookAndFeel.generalLook.properties bundle under the key prefix image.size. For example, the type avatar.original is defined by the key image.size.avatar.original. The type of the image is used to fetch the size with which the targeted image is asked. The path of the image is then computed according to this size. If the size attribute is also valued, then only the size attribute will be taken into account. String

<view:includePlugin>

Tag to print out a javascript plugin inclusion. Versions of the plugin is taken in charge by the tag. If the javascript requires a stylesheet, it is also included with the script. Currently, the supported plugins (JQuery as well Silverpeas ones) are defined in the enum com.stratelia.webactiv.util.viewGenerator.html.SupportedJavaScriptPlugins.

Can contain:empty

Attributes

Name Description Type
name* The plugin name (plugin identifier). For example, qtip for the JQuery qtip plugin String

<view:langSelect>

Tag that displays the available languages.

Can contain:empty

Attributes

Name Description Type
elementId Id for the input field/select String
elementName Name for the input field/select String
includeLabel Include label before the input field/select String
langCode Current lang String
readOnly If true, only the language label of langCode attribute is displayed String

<view:link>

LINK HTML TAG OVERRIDE

Can contain:empty

Attributes

Name Description Type
applicationContext * String
href* Specify the script href without the webContext. The webContext is automatically added to the href. If already filled, the webContext is not added again. If the webContext is not the default one, it can be set by applicationContext attribute. String

<view:looknfeel>

Simple tag to create HTML to access the look and feel.

Can contain:JSP

Attributes

Name Description Type
withCheckFormScript Include checkform automatically boolean
withFieldsetStyle Include fieldset automatically boolean

<view:map>

Generate HTML for the site Map.

Can contain:JSP

Attributes

Name Description Type
spaceId* Space Identifier String

<view:mimeTypeIcon>

Simple tag to display a div with the style corresponding to the mime type.

Can contain:JSP

Attributes

Name Description Type
divId The unique id for the div element. String
fileExtension The file's extension. String
fileName The file's name. String

<view:navigationList>

Simple tag to display a navigation item list.

Can contain:JSP

Attributes

Name Description Type
nbCol The number of columns that must be displayed String
title* The title of the navigation list String

<view:navigationListItem>

Simple tag to display a navigation item list.

Can contain:JSP

Attributes

Name Description Type
action* The action that must be performed on HTML event (click for example) String
description The additional information String
label* The label of the item of the navigation list String
nbElem The number of elements the item can display String
universalLink The universal link associated to the item String

<view:operation>

Simple tag to define an operation in an OperationPane.

Can contain:JSP

Attributes

Name Description Type
action* The action for this operation. String
altText* Alternative text to the icon of this operation. String
icon The icon for this operation. String

<view:operationOfCreation>

Simple tag to define an operation of creation in an OperationPane.

Can contain:JSP

Attributes

Name Description Type
action* The action for this operation. String
altText* Alternative text to the icon of this operation. String
icon* The icon for this operation. String

<view:operationPane>

Simple tag to define an operationPane: a panel with a list of operations (could be a menu). It should be declared and used before a Window. It contains a list of operation tags.

Can contain:JSP

Attributes

Name Description Type
type Set type of OperationPane (personal, space or component) com.stratelia.webactiv.util.viewGenerator.html.operationPanes.OperationPaneType

<view:operationSeparator>

Simple tag to define a separator line between two operations in an OperationPane.

Can contain:JSP

This tag has no attributes.

<view:pagination>

Simple tag to define a pagination navigation bar.

Can contain:JSP

Attributes

Name Description Type
action* The action is a link or javascript method name with one parameter. String
actionIsJsFunction Lien de l'action. String
altGoToAction Alt message for go to page. String
altNextAction Alt message for next page. String
altPreviousAction Alt message for previous page. String
currentPage* Index of current page. String
nbItemsPerPage Total number of items per page. String
nbPages Total number of pages. String
pageParam Param name to pass the page number (starting at 0) to be displayed. String
totalNumberOfItems Total number of handled items. String

<view:pdcClassification>

Tag to print out the HTML/javascript widget with which the classification on the PdC of a given resource content is opened and can be edited. If the PdC was parametrized for the given component instance, only the axis used by this later will be loaded.

Can contain:empty

Attributes

Name Description Type
componentId* The identifier of the component instance for which the PdC is configured. String
contentId* The identifier of the resource content for which the classification on the PdC has to be rendered. String
editable Is this classification on the PdC should be editable? By default, if not set, the classification isn't editable String
id The identifier to set for the HTML element within the classificiation will be rendered String

<view:pdcClassificationPreview>

Tag to print out the HTML/javascript widget within which a preview of the classification on the PdC of a given resource content is rendered.

Can contain:empty

Attributes

Name Description Type
componentId* The identifier of the component instance for which the PdC is configured. String
contentId* The identifier of the resource content for which the classification on the PdC has to be rendered. String

<view:pdcNewContentClassification>

Tag to print out an HTML/javascript widget to classify new content that will published into a given component instance. The created classification can be retrieved with the tag pdcPositions and it can be validated with the tag pdcValidateClassification. The widget has no side effect with the Silverpeas collaborative portal.

Can contain:empty

Attributes

Name Description Type
componentId* The identifier of the component instance for which the PdC is configured. If a default classification exists for the specified component instance, then it will be taken into account for classifying the content. String
nodeId The identifier of the node (if any) to which the new content will belong. If this attribute is set and a predefined classification exists for this node, then it will be taken into account instead of the component's one for classifying the content. String

<view:pdcPositions>

Tag to print out javascript code to get the positions of a classification on the PdC of a content.

Can contain:empty

Attributes

Name Description Type
setIn* The name of the Javascript variable that will accept the positions set through the pdcNewClassification tag. String

<view:pdcPredefinedClassification>

Tag to print out an HTML/javascript widget with which the predefined classification on the PdC of a component instance or of a node (a topic, a category, ...) can be defined or modified.

Can contain:empty

Attributes

Name Description Type
componentId* The identifier of the component instance for which the PdC is configured. String
nodeId The identifier of the node for which the predefined classification on the PdC has to be rendered. If not specified, the predefined classification on the PdC for a parent node or for the whole component instance is taken into account. String

<view:pdcValidateClassification>

Tag to print out javascript code to validate the classification on the PdC that was done through the tag pdcNewContentClassification for a new content. The tag generates javascript instruction that returns the error message if the classification isn't valid, otherwise an empty message.

Can contain:empty

Attributes

Name Description Type
errorCounter* The name of the Javascript variable representing the counter of detected errors in the form validation and that will be incremented by one at the classification validation failure. String
errorMessager* The name of the Javascript variable that will accept the error message when the classification of the content isn't valid. The message is concatenated at the variable'value. String
errorWebRender Indicates if the render of the error is by WEB way. String

<view:progressMessage>

Simple tag to display a progress message.

Can contain:JSP

Attributes

Name Description Type
messages Alternative messages to default ones java.util.List

<view:script>

SCRIPT HTML TAG OVERRIDE

Can contain:empty

Attributes

Name Description Type
applicationContext * String
src* Specify the script src without the webContext. The webContext is automatically added to the src. If already filled, the webContext is not added again. If the webContext is not the default one, it can be set by applicationContext attribute. String

<view:setBundle>

Equivalent of the JSTL fmt:setBundle tag but with support for the ResourceWrapper

Can contain:JSP

Attributes

Name Description Type
basename Basename of the bundle. String
bundle The ResourceBundle. java.util.ResourceBundle
scope Scope to store the bundle. String
var The name of the variable containing the bundle. String

<view:setConstant>

Creates a scoped variable representing the value of the referenced class constant.

Can contain:empty

Attributes

Name Description Type
constant* The fully qualified name of the class constant. String
scope The scope in which the scoped variable is to be created. String
var* The name of the scoped variable to create. String

<view:settings>

Establishes a scoped variable that contains the value of the defined settings.

Can contain:empty

Attributes

Name Description Type
defaultValue The default value for the corresponding setting. The type of the value returned is based on the type of the default value. String
key* The key of the wanted settings. String
scope The scope in which the scoped variable is to be created. String
settings* The fully qualified name of the ResourceLocator to be used for the settings. String
var* The name of the scoped variable to create. String

<view:tab>

Simple tag to display a list of tabs. It should be used inside a Window.

Can contain:JSP

Attributes

Name Description Type
action* Action for the tab. String
label* Display lable inside the tab. String
selected* true or false, to indicate if this tab is selected of not. String

<view:tabs>

Simple tag to display a list of tabs.

Can contain:JSP

This tag has no attributes.

<view:templateParam>

Parameter of a StringTemplate Tag. This parameter represents a StringTemplate attribute.

Can contain:empty

Attributes

Name Description Type
name* Name of the parameter. String
value* Value of the parameter. String

<view:timeout>

Tag that checks the validity of the current session and forwards to the error page.

Can contain:JSP

This tag has no attributes.

<view:username>

Tag to print out the full name of the current user and to use with it the userzoom silverpeas plugin.

Can contain:empty

Attributes

Name Description Type
userId* The unique identifier of the user String
zoom Is the userzoom plugin has to be used with this user? By default, it is activated. This attribute is to deactivate it. String

<view:video>

Simple tag to play a video in flowplayer.

Can contain:JSP

Attributes

Name Description Type
autostart Set to true if you want the video to start automatically String
height Height String
url* URL to the flash video String
width Width String

<view:window>

Simple tag to display a window. A window can contain TabbedPane, Frames and Boards. It should be used after the BrowseBar and the OperationPane.

Can contain:JSP

Attributes

Name Description Type
browseBarVisible true or false to indicate if the browse bar is displayed or not. String
popup true or false to indicate if the window is displayed in a popup page String

<view:wysiwyg>

Tag that display javascript initialization of Wysiwyg editor

Can contain:JSP

Attributes

Name Description Type
browseInfo Name of current object for browseBar String
componentId Id of current component String
componentName Name of current component String
displayFileBrowser False if the button to browse files has not to be displayed boolean
height Height of wysiwyg editor String
language* Language of wysiwyg editor UI String
objectId Id of current object String
replace* Id of HTML element to replace by wysiwyg editor String
spaceId Id of current space String
spaceName Name of current space String
toolbar Toolbar used by wysiwyg editor String
width Width of wysiwyg editor String

view:booleanValue( java.lang.String )

Function class: com.silverpeas.util.StringUtil

Function signature: boolean getBooleanValue( java.lang.String )

Function that returns the boolean value of a String.

view:constantValue( java.lang.String )

Function class: org.silverpeas.jstl.constant.reflect.ClassConstantInspector

Function signature: java.lang.Object getValue( java.lang.String )

Function that returns the value of a class constant.

view:escapeHtml( java.lang.String )

Function class: com.silverpeas.util.EncodeHelper

Function signature: java.lang.String javaStringToHtmlString( java.lang.String )

Function to encode a java String into a HTML String.

view:escapeJs( java.lang.String )

Function class: com.silverpeas.util.EncodeHelper

Function signature: java.lang.String javaStringToJsString( java.lang.String )

Function to encode a java String into a Javascript String.

view:estimateDownload( long )

Function class: com.stratelia.webactiv.util.FileRepositoryManager

Function signature: java.lang.String getFileDownloadTime( long )

Function that display the estimated download time.

view:formatMemSize(long)

Function class: org.silverpeas.util.UnitUtil

Function signature: java.lang.String formatMemSize(long)

Function that formats as memory size the given value.

view:humanReadableSize(long)

Function class: org.silverpeas.util.UnitUtil

Function signature: java.lang.String formatMemSize(long)

Function that display the file size in a human readable format.

view:isDefined( java.lang.String )

Function class: com.silverpeas.util.StringUtil

Function signature: boolean isDefined( java.lang.String )

Function that indicates if a String is defined.

view:isPreviewable( java.lang.String )

Function class: org.silverpeas.viewer.ViewerFactory

Function signature: boolean isPreviewable( java.lang.String )

Function that indicates if a file is previewable.

view:isViewable( java.lang.String )

Function class: org.silverpeas.viewer.ViewerFactory

Function signature: boolean isViewable( java.lang.String )

Function that indicates if a file can be displayed with FlexPaper.

view:mimeType( java.lang.String )

Function class: com.silverpeas.util.FileUtil

Function signature: java.lang.String getMimeType( java.lang.String )

Function that display the file mime type.