Markup Expressions

(:Summary: PmWiki group header. Includes styles and trail.:)

(:Summary:String and formatting operations:) (:Audience: authors (advanced) :)

The {(...)} "expression markup" allows for a variety of string and formatting operations to be performed from within markup. Operations defined by this recipe include substr, ftime, strlen, rand, toupper / tolower, ucfirst, ucwords, pagename and asspaced.

substr

The "substr" expression extracts portions of a string. The first argument is the string to be processed, the second argument is the initial position of the substring, and the third argument is the number of characters to extract. Note that the initial position argument is zero-based (i.e., the first character is referenced via a "0").

 {(substr "PmWiki" 2 3)}
 {(substr "PmWiki" 2)}
 {(substr "PmWiki" 0 1)}
 {(substr "PmWiki" 0 -3)}

 {(substr "PmWiki" 2 3)}
 {(substr "PmWiki" 2)}
 {(substr "PmWiki" 0 1)}
 {(substr "PmWiki" 0 -3)}

To obtain the last n characters of a string use {(substr "string" -n)}
To truncate the last n characters of a string use (substr "string" 0 -n)}

ftime

"Ftime" expressions are used for date and time formatting. The generic form is

where fmt is a formatting string and when is the time to be formatted. The arguments can be in either order and may use the optional "fmt=" and "when=" labels.

Examples:

 {(ftime)}
 {(ftime fmt="%F %H:%M")}
 {(ftime %Y)}
 {(ftime fmt=%T)}
 {(ftime when=tomorrow)}
 {(ftime fmt="%Y-%m-%d" yesterday)}
 {(ftime week %F)}
 {(ftime fmt=%D month)}
 {(ftime fmt="%a%e %b" when="next
week")}

 {(ftime)}
 {(ftime fmt="H:%M")}
 {(ftime %Y)}
 {(ftime fmt=%T)}
 {(ftime when=tomorrow)}
 {(ftime fmt="m-%d" yesterday)}
 {(ftime week %F)}
 {(ftime fmt=%D month)}
 {(ftime fmt="e %b" when="next week")}

The fmt parameter is whatever is given by "fmt=", the first parameter containing a '%', or else the site's default. The formatting codes are described at http://php.net/strftime. In addition to those, 's' produces Unix timestamps. Some common formatting strings:

     %F                # ISO-8601 dates      "{(ftime %F)}"
     %s                # Unix timestamp      "{(ftime %s)}"
     %H:%M:%S          # time as hh:mm:ss    "{(ftime M:%S)}"
     %m/%d/%Y          # date as mm/dd/yyyy  "{(ftime %m/%d/%Y)}"
     "%A, %B %d, %Y"   # in words            "{(ftime "B Y")}"

The when parameter understands many different date formats. The when parameter is whatever is given by "when=", or whatever parameter remains after determining the format parameter. Some examples:

    2007-04-11            # ISO-8601 dates
    20070411              # dates without hyphens, slashes, or dots
    2007-03               # months
    @1176304315           # Unix timestamps (seconds since 1-Jan-1970 00:00 UTC)
    now                   # the current time
    today                 # today @ 00:00:00
    yesterday             # yesterday @ 00:00:00
    "next Monday"         # relative dates
    "last Thursday"       # relative dates
    "-3 days"             # three days ago
    "+2 weeks"            # two weeks from now

Note: If you want to convert a Unix timestamp you must prefix with the @. Thus, "{(ftime "%A, %B %d, %Y" @1231116927)}".

The when parameter uses PHP's strtotime function to convert date strings according to the GNU date input formats; as of this writing it only understands English phrases in date specifications.

The variable $FTimeFmt can be used to override the default date format used by the "ftime" function. The default $FTimeFmt is $TimeFmt.

strlen

The "strlen" expression returns the length of a string. The first argument is the string to be measured.

 {(strlen "{$:Summary}")}

 {(strlen "{$:Summary}")}

rand

The "rand" expression returns a random integer. The first argument is the minimum number to be returned and the second argument is the maximum number to be returned. If called without the optional min, max arguments rand() returns a pseudo-random integer between 0 and RAND_MAX. If you want a random number between 5 and 15 (inclusive), for example, use rand (5, 15).

 {(rand)}

 {(rand)}

toupper / tolower

The "toupper" and "tolower" expressions convert a string into uppercase or lowercase. The first argument is the string to be processed.

 {(toupper "{$:Summary}")}
 {(tolower "{$:Summary}")}

 {(toupper "{$:Summary}")}
 {(tolower "{$:Summary}")}

ucfirst

The "ucfirst" expression converts the first character of a string to uppercase. The first argument is the string to be processed.

 {(ucfirst "{$:Summary}")}

 {(ucfirst "{$:Summary}")}

ucwords

The "ucwords" expression converts the first character of each word in a string to uppercase. The first argument is the string to be processed.

 {(ucwords "{$:Summary}")}

 {(ucwords "{$:Summary}")}

pagename

The "pagename" expression builds a pagename from a string. The first argument is the string to be processed.

 {(pagename "{$:Summary}")}

 {(pagename "{$:Summary}")}

asspaced

The "asspaced" expression formats wikiwords. The first argument is the string to be processed.

 {(asspaced "{$FullName}")}

 {(asspaced "PmWiki.MarkupExpressions")}

Nesting expressions

Markup expressions can be nested:

 {(tolower (substr "Hello World" 2))}

 {(tolower (substr "Hello World" 2))}

Notes

• Some of the string-processing markups may not work properly on UTF-8 characters or escaped sequences.
• The ftime markup does not work with some ISO 8601 dates (because a time of 24:00 is invalid)such as:

 {(ftime fmt="%m/%d/%Y @ %H:%M:%S"
when="20070626T2400")}
 {(ftime fmt="%H:%M:%S"
when="20070626T2400")}

 {(ftime fmt="%m/%d/%Y @ M:%S" when="20070626T2400")}
 {(ftime fmt="M:%S" when="20070626T2400")}

• is it possible to display the time in another time zone, eg

NowTime: {(ftime fmt="%F %H:%M")}
 {(ftime when='TZ=:Europe/London" ')}
 {(ftime when='TZ=Europe/London" 0
days')}
 {(ftime when="TZ='Pacific/Auckland'
2004-10-31 08:30")}
 {(ftime when='TZ="Pacific/Auckland"
{$:NowTime}')}

 {(ftime when='TZ=:Europe/London" ')}
 {(ftime when='TZ=Europe/London" 0 days')}
 {(ftime when="TZ='Pacific/Auckland' 2004-10-31 08:30")}
 {(ftime when='TZ="Pacific/Auckland" {$:NowTime}')}

See also

• Page variables, Page text variables
• Conditional markup
• Cookbook:MarkupExprPlus