Wireless Data Server XSLT extension functions

---

This appendix details the functions that Wireless Data Server provides to extend the standard XSLT stylesheet language. To use these functions, you must specify Steltor's namespace by including the following line in the <xsl:stylesheet> tag at the beginning of your XSL document:

xmlns:wds="http://www.steltor.com/WDS/XSLT/Functions"

You may then access any of the functions described below by prefacing the function name with wds:. For example, you could use the locale-string() function to print a string from the localization files Wireless Data Server maintains for a given language using the following syntax in your XSL stylesheet:

<xsl:value-of select="wds:locale-string(...)"/>

These functions fall into three broad categories:

• Getting string values from localization files
• String manipulation
• Date manipulation

They are also listed alphabetically in the table below.

Table D.1 · Wireless Data Server XSLT extension functions

Function name	Description	Page
confirmation-symbol()	Returns the configured symbols for accepted and declined meetings	104
date-to-sec()	Returns a date as the number of seconds from a fixed point	108
encode-string()	Converts a string value to a specified MIME encoding	105
extract-initials()	Returns the initials for any specified name	106
format-date()	Returns a formatted date when given date and time components	107
format-date-sec()	Returns a formatted date when given a value in seconds	109
isolatin1-representation()	Converts a string value to isolatin1 encoding	106
locale-service-string()	Returns the localized string representing a Wireless Data Server mobile-originated command	103
locale-string()	Returns a specified string from a Wireless Data Server locale file	102
string-replace-all()	Replaces all occurrences of a given substring within a given string	105

---

Getting string values from localization files

locale-string()

The locale-string() function returns a specified string from a Wireless Data Server localization file.

Usage

locale-string(locale,category,key,default)

Arguments

locale

A string, enclosed in single quotes, that matches one of the languages listed in the value of the wdslocale.ini [WDS] locales parameter.

category

Can have either of two possible values:

• 'GLOSSARY': Specifies that the localized string is to be found in the [GLOSSARY] section of the file in /etc/locale/ that corresponds to the locale argument.
• 'CONFIGURATION': Specifies that the localized string is to be found in the /etc/config/wdslocale.ini file, in the section that corresponds to the value of the locale argument.

key

A string, enclosed in single quotes, that matches any parameter in the file and section specified by the locale and category arguments. The locale-string() function returns the value of this parameter.

default

Optional. If no entry is found corresponding to the key, category and locale arguments, locale-string() will return this default value.

Example

• To retrieve the Italian translation of "Created by":

  locale-string('ITALIAN','GLOSSARY','CREATED-BY')

  The locale-string() function returns:

  Creato da

locale-service-string()

The locale-service-string() function returns a specified Wireless Data Server mobile-originated command.

Usage

locale-service-string(locale,service,key,default)

Arguments

locale

A string, enclosed in single quotes, that matches one of the languages listed in the value of the wdslocale.ini [WDS] locales parameter. This value determines in which section of the file specified by the service argument the localized string can be found.

service

A string, enclosed in single quotes, that matches one of the services listed in the value of the wds.ini [WDS] services parameter. Wireless Data Server will look for the localized string in the file specified by the localefilename parameter in the section of wds.ini. specified by the service argument.

key

A string, enclosed in single quotes, that matches any parameter in the file and section specified by the service and locale arguments. The locale-string() function returns the value of this parameter.

default

Optional. May be any string enclosed in single quotes. If no entry is found corresponding to the key, service and locale arguments, locale-service-string() will return this default value.

Example

• To retrieve the French translation of the snapshot command:

  locale-service-string('FRENCH','CALENDAR','CMD-SNAPSHOT','D')

  By default, the locale-service-string() function would return:

  S

confirmation-symbol()

The confirmation-symbol() function returns a character indicating the recipient's attendance status.

Usage

confirmation-symbol(status)

Arguments

status

A string, enclosed in single quotes, that accepts the following values:

• Accepted: Causes the function to return the + sign, indicating that the user has chosen to accept the current meeting.
• Declined: Causes the function to return the - sign, indicating that the user has chosen to accept the current meeting.
• Any other value: Causes the function to return the ? sign, indicating that the user has not yet replied to this meeting.

Example

• To print a + sign, indicating that the meeting has been accepted:

  confirmation-symbol('ACCEPTED')

---

String manipulation

encode-string()

The encode-string() function converts a specified string to a MIME encoding.

Usage

encode-string(encoding,str)

Arguments

encoding

A string, enclosed in single quotes, that determines the encoding to use for the specified string. Currently accepts only 'QUOTED-PRINTABLE'.

service

A string to encode, enclosed in single quotes.

Example

• To encode the string "this value = text to convert":

  encode-string('QUOTED-PRINTABLE','this value = text to convert')

  By default, the encode-string() function would return:

  this%20value%20=3D%20text%20to%20convert

string-replace-all()

The string-replace-all() function replaces all occurrences of a given substring with another.

Usage

string-replace-all(str,from,to)

Arguments

str

A string, enclosed in single quotes, within which to replace a given substring.

from

A substring to replace, enclosed in single quotes.

to

A substring with which to replace the from substring, enclosed in single quotes.

Example

• To remove all line breaks in the string 'First line\nSecond line\nThird line' with semicolons:

  string-replace-all('First line\nSecond line\nThird line','\n',';')

  By default, the string-replace-all() function would return:

  First line;Second line;Third line

isolatin1-representation()

The isolatin1-representation() function converts each character in a given string to the isolatin1 representation of that character. This affects a variety of special characters that can be represented in the isolatin1 character set by unusual characters or multiple characters.

Usage

isolatin1-representation(encoding,str)

Arguments

encoding

A string, enclosed in single quotes, that determines the initial character set of the string. Currently accepts only 'UTF-8'.

service

A string to convert, enclosed in single quotes.

Example

• To convert the string "convert é":

  isolatin1-representation('UTF-8','convert é')

extract-initials()

The extract-initials() function returns the initials of a given name.

Usage

extract-initials(firstname,lastname)

Arguments

firstname

A string, enclosed in single quotes, that specifies a given name.

lastname

A string, enclosed in single quotes, that specifies a surname.

Example

• To get the initials from the name William Shakespeare:

  extract-initials('William','Shakespeare')

  By default, the extract-initials() function would return:

  WS

---

Date manipulation

format-date()

The format-date() function returns a given date in a specified output format.

Usage

format-date(year,month,day,hour,minute,second,format,locale)

Arguments

year

A four-digit number between 1991 and 2037 specifying the year.

month

A one- or two-digit number between 1 and 12 specifying the month.

day

A one- or two-digit number between 1 and 31 specifying the day of the month.

hour

A two-digit number between 00 and 23 specifying the hour of the day.

minute

A two-digit number between 00 and 59 specifying the minute of the hour.

second

A two-digit number between 00 and 59 specifying the second of the minute.

format

A string, enclosed in single quotes, specifying the format in which to display the given date. This format may include any of the following variables, as well as any desired separators and other text:

• %a: Abbreviated weekday name (e.g. Mon, Sun)
• %A: Full weekday name
• %b: Abbreviated month name (e.g. Jan, Dec)
• %B: Full month name
• %d: Day of the month (01-31)
• %H: Hour of the day in 24-hour format (00-23)
• %I: Hour of the day in 12-hour format (01-12)
• %m: Month number (01-12)
• %M: Minute of the hour (00-59)
• %p: a.m. / p.m. indicator
• %S: Second of the minute (00-59)
• %w: Weekday as a number (0-6, where Sunday is 0)
• %y: Two-digit year (00-99)
• %Y: Four-digit year (1991-2037)
• %%: Percentage symbol (%)

Any variables that produce text, such as %A, %B and %p will produce the text in the language specified by the locale argument.

locale

A string, enclosed in single quotes, that matches one of the languages listed in the value of the wdslocale.ini [WDS] locales parameter. Determines the language to be used for any variables included in the format argument that produce text.

Example

• To get the date formatted as Monday, February 12, 2002:

  format-date(2002,2,12,10,30,00,'%A, %B %d, %Y','ENGLISH-US')

date-to-sec()

The date-to-sec() function returns a given date as the number of seconds since 1 January 1991 00:00:00. This function is most useful in combination with the format-date() function.

Usage

date-to-sec(year,month,day,hour,minute,second)

Arguments

year

A four-digit number between 1991 and 2037 specifying the year.

month

A one- or two-digit number between 1 and 12 specifying the month.

day

A one- or two-digit number between 1 and 31 specifying the day of the month.

hour

A two-digit number between 00 and 23 specifying the hour of the day.

minute

A two-digit number between 00 and 59 specifying the minute of the hour.

second

A two-digit number between 00 and 59 specifying the second of the minute.

Example

• To get the number of seconds between 1 January 1991 00:00:00 and 12 February 2002 00:00:00:

  date-to-sec(2002,2,12,10,30,00)

format-date-sec()

The format-date-sec() function returns a date in a specified output format, given the number of seconds since 1 January 1991 00:00:00. This utility is most useful in combination with the date-to-sec() function.

Usage

format-date-sec(seconds,format,locale)

Arguments

seconds

A number specifying the seconds between 1 January 1991 00:00:00 and the date to be formatted.

format

A string, enclosed in single quotes, specifying the format in which to display the given date. This format may include any of the following variables, as well as any desired separators and other text:

• %a: Abbreviated weekday name (e.g. Mon, Sun)
• %A: Full weekday name
• %b: Abbreviated month name (e.g. Jan, Dec)
• %B: Full month name
• %d: Day of the month (01-31)
• %H: Hour of the day in 24-hour format (00-23)
• %I: Hour of the day in 12-hour format (01-12)
• %m: Month number (01-12)
• %M: Minute of the hour (00-59)
• %p: a.m. / p.m. indicator
• %S: Second of the minute (00-59)
• %w: Weekday as a number (0-6, where Sunday is 0)
• %y: Two-digit year (00-99)
• %Y: Four-digit year (1991-2037)
• %%: Percentage symbol (%)

Any variables that produce text, such as %A, %B and %p will produce the text in the language specified by the locale argument.

locale

A string, enclosed in single quotes, that matches one of the languages listed in the value of the wdslocale.ini [WDS] locales parameter. Determines the language to be used for any variables included in the format argument that produce text.

Example

• To get the date formatted as Monday, February 12, 2002:

  format-date(1013490000,'%A, %B %d, %Y','ENGLISH-US')

Copyright information