Difference between revisions of "Live Inline Expressions"

From MSX - Wiki
Jump to navigation Jump to search
Line 11: Line 11:
 
|-
 
|-
 
| <code>{creation:time:{LIVE_TIME_FORMAT}}</code> || <code>{creation:time:hh:mm:ss}</code> || data-sort-value=70|'''0.1.70''' ||  
 
| <code>{creation:time:{LIVE_TIME_FORMAT}}</code> || <code>{creation:time:hh:mm:ss}</code> || data-sort-value=70|'''0.1.70''' ||  
−
Time of creation timestamp of the live object in live time format. The <code>{LIVE_TIME_FORMAT}</code> part must be replaced with the format. Please see [[Live Time Format]] for possible values.
+
Time of creation timestamp of the live object in live time format. The <code>{LIVE_TIME_FORMAT}</code> part must be replaced with the format. Please see [[#Live Time Format]] for possible values.
 
|-
 
|-
 
| <code>{from:date:{LIVE_DATE_FORMAT}}</code> || <code>{from:date:mm/dd/yy}</code> || data-sort-value=70|'''0.1.70''' ||  
 
| <code>{from:date:{LIVE_DATE_FORMAT}}</code> || <code>{from:date:mm/dd/yy}</code> || data-sort-value=70|'''0.1.70''' ||  
−
Date of start timestamp of the live object in live date format. The <code>{LIVE_DATE_FORMAT}</code> part must be replaced with the format. Please see [[Live Date Format]] for possible values.
+
Date of start timestamp of the live object in live date format. The <code>{LIVE_DATE_FORMAT}</code> part must be replaced with the format. Please see [[#Live Date Format]] for possible values.
  
 
'''Note: This expression only returns a value if the <code>type</code> property of the live object has been set to <code>"schedule"</code> or <code>"lifetime"</code>.'''
 
'''Note: This expression only returns a value if the <code>type</code> property of the live object has been set to <code>"schedule"</code> or <code>"lifetime"</code>.'''
 
|-
 
|-
 
| <code>{from:time:{LIVE_TIME_FORMAT}}</code> || <code>{from:time:hh:mm:ss}</code> || data-sort-value=70|'''0.1.70''' ||  
 
| <code>{from:time:{LIVE_TIME_FORMAT}}</code> || <code>{from:time:hh:mm:ss}</code> || data-sort-value=70|'''0.1.70''' ||  
−
Time of start timestamp of the live object in live time format. The <code>{LIVE_TIME_FORMAT}</code> part must be replaced with the format. Please see [[Live Time Format]] for possible values.
+
Time of start timestamp of the live object in live time format. The <code>{LIVE_TIME_FORMAT}</code> part must be replaced with the format. Please see [[#Live Time Format]] for possible values.
  
 
'''Note: This expression only returns a value if the <code>type</code> property of the live object has been set to <code>"schedule"</code> or <code>"lifetime"</code>.'''
 
'''Note: This expression only returns a value if the <code>type</code> property of the live object has been set to <code>"schedule"</code> or <code>"lifetime"</code>.'''
 
|-
 
|-
 
| <code>{to:date:{LIVE_DATE_FORMAT}}</code> || <code>{to:date:mm/dd/yy}</code> || data-sort-value=70|'''0.1.70''' ||  
 
| <code>{to:date:{LIVE_DATE_FORMAT}}</code> || <code>{to:date:mm/dd/yy}</code> || data-sort-value=70|'''0.1.70''' ||  
−
Date of end timestamp of the live object in live date format. The <code>{LIVE_DATE_FORMAT}</code> part must be replaced with the format. Please see [[Live Date Format]] for possible values.
+
Date of end timestamp of the live object in live date format. The <code>{LIVE_DATE_FORMAT}</code> part must be replaced with the format. Please see [[#Live Date Format]] for possible values.
  
 
'''Note: This expression only returns a value if the <code>type</code> property of the live object has been set to <code>"schedule"</code> or <code>"lifetime"</code>.'''
 
'''Note: This expression only returns a value if the <code>type</code> property of the live object has been set to <code>"schedule"</code> or <code>"lifetime"</code>.'''
 
|-
 
|-
 
| <code>{to:time:{LIVE_TIME_FORMAT}}</code> || <code>{to:time:hh:mm:ss}</code> || data-sort-value=70|'''0.1.70''' ||  
 
| <code>{to:time:{LIVE_TIME_FORMAT}}</code> || <code>{to:time:hh:mm:ss}</code> || data-sort-value=70|'''0.1.70''' ||  
−
Time of end timestamp of the live object in live time format. The <code>{LIVE_TIME_FORMAT}</code> part must be replaced with the format. Please see [[Live Time Format]] for possible values.
+
Time of end timestamp of the live object in live time format. The <code>{LIVE_TIME_FORMAT}</code> part must be replaced with the format. Please see [[#Live Time Format]] for possible values.
  
 
'''Note: This expression only returns a value if the <code>type</code> property of the live object has been set to <code>"schedule"</code> or <code>"lifetime"</code>.'''
 
'''Note: This expression only returns a value if the <code>type</code> property of the live object has been set to <code>"schedule"</code> or <code>"lifetime"</code>.'''
 
|-
 
|-
 
| <code>{now:date:{LIVE_DATE_FORMAT}}</code> || <code>{now:date:mm/dd/yy}</code> || data-sort-value=70|'''0.1.70''' ||  
 
| <code>{now:date:{LIVE_DATE_FORMAT}}</code> || <code>{now:date:mm/dd/yy}</code> || data-sort-value=70|'''0.1.70''' ||  
−
Date of current timestamp in live date format. The <code>{LIVE_DATE_FORMAT}</code> part must be replaced with the format. Please see [[Live Date Format]] for possible values.
+
Date of current timestamp in live date format. The <code>{LIVE_DATE_FORMAT}</code> part must be replaced with the format. Please see [[#Live Date Format]] for possible values.
 
|-
 
|-
 
| <code>{now:time:{LIVE_TIME_FORMAT}}</code> || <code>{now:time:hh:mm:ss}</code> || data-sort-value=70|'''0.1.70''' ||  
 
| <code>{now:time:{LIVE_TIME_FORMAT}}</code> || <code>{now:time:hh:mm:ss}</code> || data-sort-value=70|'''0.1.70''' ||  
−
Time of current timestamp in live time format. The <code>{LIVE_TIME_FORMAT}</code> part must be replaced with the format. Please see [[Live Time Format]] for possible values.
+
Time of current timestamp in live time format. The <code>{LIVE_TIME_FORMAT}</code> part must be replaced with the format. Please see [[#Live Time Format]] for possible values.
 
|-
 
|-
 
| <code>{duration:position}</code> || <code>{duration:position}</code> || data-sort-value=70|'''0.1.70''' ||  
 
| <code>{duration:position}</code> || <code>{duration:position}</code> || data-sort-value=70|'''0.1.70''' ||  
Line 43: Line 43:
 
|-
 
|-
 
| <code>{duration:time:{LIVE_DURATION_FORMAT}}</code> || <code>{duration:time:hh:mm:ss}</code> || data-sort-value=70|'''0.1.70''' ||  
 
| <code>{duration:time:{LIVE_DURATION_FORMAT}}</code> || <code>{duration:time:hh:mm:ss}</code> || data-sort-value=70|'''0.1.70''' ||  
−
Duration of the live object in live duration format. The <code>{LIVE_DURATION_FORMAT}</code> part must be replaced with the format. Please see [[Live Duration Format]] for possible values.
+
Duration of the live object in live duration format. The <code>{LIVE_DURATION_FORMAT}</code> part must be replaced with the format. Please see [[#Live Duration Format]] for possible values.
 
|-
 
|-
 
| <code>{duration:text:{LIVE_DURATION_TEXT}}</code> || <code>{duration:text:hms}</code> || data-sort-value=70|'''0.1.70''' ||  
 
| <code>{duration:text:{LIVE_DURATION_TEXT}}</code> || <code>{duration:text:hms}</code> || data-sort-value=70|'''0.1.70''' ||  
−
Duration of the live object as live duration text. The <code>{LIVE_DURATION_TEXT}</code> part must be replaced with the text values. Please see [[Live Duration Text]] for possible values.
+
Duration of the live object as live duration text. The <code>{LIVE_DURATION_TEXT}</code> part must be replaced with the text values. Please see [[#Live Duration Text]] for possible values.
 
|-
 
|-
 
| <code>{progress:position}</code> || <code>{progress:position}</code> || data-sort-value=70|'''0.1.70''' ||  
 
| <code>{progress:position}</code> || <code>{progress:position}</code> || data-sort-value=70|'''0.1.70''' ||  
Line 55: Line 55:
 
|-
 
|-
 
| <code>{progress:time:{LIVE_DURATION_FORMAT}}</code> || <code>{progress:time:hh:mm:ss}</code> || data-sort-value=70|'''0.1.70''' ||  
 
| <code>{progress:time:{LIVE_DURATION_FORMAT}}</code> || <code>{progress:time:hh:mm:ss}</code> || data-sort-value=70|'''0.1.70''' ||  
−
Progress of the live object in live duration format. The <code>{LIVE_DURATION_FORMAT}</code> part must be replaced with the format. Please see [[Live Duration Format]] for possible values.
+
Progress of the live object in live duration format. The <code>{LIVE_DURATION_FORMAT}</code> part must be replaced with the format. Please see [[#Live Duration Format]] for possible values.
 
|-
 
|-
 
| <code>{progress:text:{LIVE_DURATION_TEXT}}</code> || <code>{progress:text:hms}</code> || data-sort-value=70|'''0.1.70''' ||  
 
| <code>{progress:text:{LIVE_DURATION_TEXT}}</code> || <code>{progress:text:hms}</code> || data-sort-value=70|'''0.1.70''' ||  
−
Progress of the live object as live duration text. The <code>{LIVE_DURATION_TEXT}</code> part must be replaced with the text values. Please see [[Live Duration Text]] for possible values.
+
Progress of the live object as live duration text. The <code>{LIVE_DURATION_TEXT}</code> part must be replaced with the text values. Please see [[#Live Duration Text]] for possible values.
 
|-
 
|-
 
| <code>{countdown:position}</code> || <code>{countdown:position}</code> || data-sort-value=70|'''0.1.70''' ||  
 
| <code>{countdown:position}</code> || <code>{countdown:position}</code> || data-sort-value=70|'''0.1.70''' ||  
Line 71: Line 71:
 
|-
 
|-
 
| <code>{countdown:time:{LIVE_DURATION_FORMAT}}</code> || <code>{countdown:time:hh:mm:ss}</code> || data-sort-value=70|'''0.1.70''' ||  
 
| <code>{countdown:time:{LIVE_DURATION_FORMAT}}</code> || <code>{countdown:time:hh:mm:ss}</code> || data-sort-value=70|'''0.1.70''' ||  
−
Countdown of the live object in live duration format. The <code>{LIVE_DURATION_FORMAT}</code> part must be replaced with the format. Please see [[Live Duration Format]] for possible values.
+
Countdown of the live object in live duration format. The <code>{LIVE_DURATION_FORMAT}</code> part must be replaced with the format. Please see [[#Live Duration Format]] for possible values.
  
 
'''Note: This expression returns for state <code>"coming"</code> and <code>"running"</code> the actual countdown value.'''
 
'''Note: This expression returns for state <code>"coming"</code> and <code>"running"</code> the actual countdown value.'''
 
|-
 
|-
 
| <code>{countdown:text:{LIVE_DURATION_TEXT}}</code> || <code>{countdown:text:hms}</code> || data-sort-value=70|'''0.1.70''' ||  
 
| <code>{countdown:text:{LIVE_DURATION_TEXT}}</code> || <code>{countdown:text:hms}</code> || data-sort-value=70|'''0.1.70''' ||  
−
Countdown of the live object as live duration text. The <code>{LIVE_DURATION_TEXT}</code> part must be replaced with the text values. Please see [[Live Duration Text]] for possible values.
+
Countdown of the live object as live duration text. The <code>{LIVE_DURATION_TEXT}</code> part must be replaced with the text values. Please see [[#Live Duration Text]] for possible values.
  
 
'''Note: This expression returns for state <code>"coming"</code> and <code>"running"</code> the actual countdown value.'''
 
'''Note: This expression returns for state <code>"coming"</code> and <code>"running"</code> the actual countdown value.'''
Line 84: Line 84:
 
|-
 
|-
 
| <code>{overflow:time:{LIVE_DURATION_FORMAT}}</code> || <code>{overflow:time:hh:mm:ss}</code> || data-sort-value=70|'''0.1.70''' ||  
 
| <code>{overflow:time:{LIVE_DURATION_FORMAT}}</code> || <code>{overflow:time:hh:mm:ss}</code> || data-sort-value=70|'''0.1.70''' ||  
−
Overflow of the live object in live duration format. The <code>{LIVE_DURATION_FORMAT}</code> part must be replaced with the format. Please see [[Live Duration Format]] for possible values.
+
Overflow of the live object in live duration format. The <code>{LIVE_DURATION_FORMAT}</code> part must be replaced with the format. Please see [[#Live Duration Format]] for possible values.
 
|-
 
|-
 
| <code>{overflow:text:{LIVE_DURATION_TEXT}}</code> || <code>{overflow:text:hms}</code> || data-sort-value=70|'''0.1.70''' ||  
 
| <code>{overflow:text:{LIVE_DURATION_TEXT}}</code> || <code>{overflow:text:hms}</code> || data-sort-value=70|'''0.1.70''' ||  
−
Overflow of the live object as live duration text. The <code>{LIVE_DURATION_TEXT}</code> part must be replaced with the text values. Please see [[Live Duration Text]] for possible values.
+
Overflow of the live object as live duration text. The <code>{LIVE_DURATION_TEXT}</code> part must be replaced with the text values. Please see [[#Live Duration Text]] for possible values.
 
|-
 
|-
 
| <code>{txt:{COLOR}:{LIVE_INLINE_EXPRESSION}}</code> ||  
 
| <code>{txt:{COLOR}:{LIVE_INLINE_EXPRESSION}}</code> ||  

Revision as of 14:27, 14 January 2021

Some live content properties support live inline expressions for adding formatted dates and times of the current state.

Syntax[edit]

Expression syntax of live inline expressions
Expression Example Since Version Description
{creation:date:{LIVE_DATE_FORMAT}} {creation:date:mm/dd/yy} 0.1.70

Date of creation timestamp of the live object in live date format. The {LIVE_DATE_FORMAT} part must be replaced with the format. Please see #Live Date Format for possible values.

{creation:time:{LIVE_TIME_FORMAT}} {creation:time:hh:mm:ss} 0.1.70

Time of creation timestamp of the live object in live time format. The {LIVE_TIME_FORMAT} part must be replaced with the format. Please see #Live Time Format for possible values.

{from:date:{LIVE_DATE_FORMAT}} {from:date:mm/dd/yy} 0.1.70

Date of start timestamp of the live object in live date format. The {LIVE_DATE_FORMAT} part must be replaced with the format. Please see #Live Date Format for possible values.

Note: This expression only returns a value if the type property of the live object has been set to "schedule" or "lifetime".

{from:time:{LIVE_TIME_FORMAT}} {from:time:hh:mm:ss} 0.1.70

Time of start timestamp of the live object in live time format. The {LIVE_TIME_FORMAT} part must be replaced with the format. Please see #Live Time Format for possible values.

Note: This expression only returns a value if the type property of the live object has been set to "schedule" or "lifetime".

{to:date:{LIVE_DATE_FORMAT}} {to:date:mm/dd/yy} 0.1.70

Date of end timestamp of the live object in live date format. The {LIVE_DATE_FORMAT} part must be replaced with the format. Please see #Live Date Format for possible values.

Note: This expression only returns a value if the type property of the live object has been set to "schedule" or "lifetime".

{to:time:{LIVE_TIME_FORMAT}} {to:time:hh:mm:ss} 0.1.70

Time of end timestamp of the live object in live time format. The {LIVE_TIME_FORMAT} part must be replaced with the format. Please see #Live Time Format for possible values.

Note: This expression only returns a value if the type property of the live object has been set to "schedule" or "lifetime".

{now:date:{LIVE_DATE_FORMAT}} {now:date:mm/dd/yy} 0.1.70

Date of current timestamp in live date format. The {LIVE_DATE_FORMAT} part must be replaced with the format. Please see #Live Date Format for possible values.

{now:time:{LIVE_TIME_FORMAT}} {now:time:hh:mm:ss} 0.1.70

Time of current timestamp in live time format. The {LIVE_TIME_FORMAT} part must be replaced with the format. Please see #Live Time Format for possible values.

{duration:position} {duration:position} 0.1.70

Duration of the live object in simple position format.

{duration:time:{LIVE_DURATION_FORMAT}} {duration:time:hh:mm:ss} 0.1.70

Duration of the live object in live duration format. The {LIVE_DURATION_FORMAT} part must be replaced with the format. Please see #Live Duration Format for possible values.

{duration:text:{LIVE_DURATION_TEXT}} {duration:text:hms} 0.1.70

Duration of the live object as live duration text. The {LIVE_DURATION_TEXT} part must be replaced with the text values. Please see #Live Duration Text for possible values.

{progress:position} {progress:position} 0.1.70

Progress of the live object in simple position format.

{progress:percentage} {progress:percentage} 0.1.70

Progress of the live object in percentage.

{progress:time:{LIVE_DURATION_FORMAT}} {progress:time:hh:mm:ss} 0.1.70

Progress of the live object in live duration format. The {LIVE_DURATION_FORMAT} part must be replaced with the format. Please see #Live Duration Format for possible values.

{progress:text:{LIVE_DURATION_TEXT}} {progress:text:hms} 0.1.70

Progress of the live object as live duration text. The {LIVE_DURATION_TEXT} part must be replaced with the text values. Please see #Live Duration Text for possible values.

{countdown:position} {countdown:position} 0.1.70

Countdown of the live object in simple position format.

Note: This expression returns for state "coming" and "running" the actual countdown value.

{countdown:percentage} {countdown:percentage} 0.1.70

Countdown of the live object in percentage.

Note: This expression returns for state "coming" a fixed value (i.e. 100%) and in state "running" the actual countdown value.

{countdown:time:{LIVE_DURATION_FORMAT}} {countdown:time:hh:mm:ss} 0.1.70

Countdown of the live object in live duration format. The {LIVE_DURATION_FORMAT} part must be replaced with the format. Please see #Live Duration Format for possible values.

Note: This expression returns for state "coming" and "running" the actual countdown value.

{countdown:text:{LIVE_DURATION_TEXT}} {countdown:text:hms} 0.1.70

Countdown of the live object as live duration text. The {LIVE_DURATION_TEXT} part must be replaced with the text values. Please see #Live Duration Text for possible values.

Note: This expression returns for state "coming" and "running" the actual countdown value.

{overflow:position} {overflow:position} 0.1.70

Overflow of the live object in simple position format.

{overflow:time:{LIVE_DURATION_FORMAT}} {overflow:time:hh:mm:ss} 0.1.70

Overflow of the live object in live duration format. The {LIVE_DURATION_FORMAT} part must be replaced with the format. Please see #Live Duration Format for possible values.

{overflow:text:{LIVE_DURATION_TEXT}} {overflow:text:hms} 0.1.70

Overflow of the live object as live duration text. The {LIVE_DURATION_TEXT} part must be replaced with the text values. Please see #Live Duration Text for possible values.

{txt:{COLOR}:{LIVE_INLINE_EXPRESSION}}

{txt:msx-red:creation:date:mm/dd/yy}
{txt:msx-green:creation:time:hh:mm:ss}
{txt:msx-yellow:duration:position}
{txt:msx-blue:duration:percentage}

 0.1.70

Colored live inline expression. The {COLOR} part must be replaced with a color value and the {LIVE_INLINE_EXPRESSION} part must be replaced with any live inline expression without the braces.

Live Date Format[edit]

Format of live date
Format Example Since Version
m|d|D|M 1|24|Thu|Jan 0.1.70

Live Time Format[edit]

Format of live time
Format Example Since Version
h|m|s 14|16|4 0.1.70

Live Duration Format[edit]

Format of live duration
Format Example Since Version
h|m|s 1|34|0 0.1.70

Live Duration Text[edit]

Values of live duration text
Values Example Since Version
dhms 1 hr 34 min 0.1.70
Retrieved from "https://msx.benzac.de/wiki/index.php?title=Live_Inline_Expressions&oldid=422"