Differences

This shows you the differences between two versions of the page.

--- token:ICUDateTime [2020/05/28 21:16] – [Using Variables with These Date/Time Tokens] Clarify use of Parameters JMichaelTX
+++ token:ICUDateTime [2023/01/03 05:19] (current) – ccstone
@@ Line 3: / Line 3: @@
 The //%ICUDateTime%//, //%ICUDateTimePlus%//, //%ICUDateTimeMinus%// and //%ICUDateTimeFor%// tokens return the a date formatted in a specific format.  More details are provided in the [[:Dates_and_Times|Dates and Times]] article.
-===== Fields & Format Used by These Tokens =====
+===== Required Parameters for ICUDateTime Tokens =====
+The parameters are specified between `%` signs after the main ICDDateTime token.
-* //%ICUDateTime%**format**%// - the current date and time.
+* %**ICUDateTime**%*[output date format]*%
-* //%ICUDateTimeFor%NOW()+20%**format**%// - the specified [[:unixtime]] date.
+  * Returns the current date and time in the specified format.
-* //%ICUDateTimePlus%3+6%Hours%**format**%// - the current time plus a specified number of the specified time units.
+  * Example: ''%ICUDateTime%EEE, MMM d, yyyy h:mm%'' ⇢ //Mon, Jan 2, 2023 11:17//
-* //%ICUDateTimeMinus%3+6%Hours%**format**%// - the current time minus a specified number of the specified time units.
-===== Time Units =====
+* %**ICUDateTimeFor**%*[unixtime]*%*[output date format]*%
+  * Returns Date/Time specified by the [[:unixtime]], in the user's local time zone.
+* %**ICUDateTimePlus**%*[amount of time]*%*[unit of time]*%*[output date format]*%
+  * Returns Date/Time calculated by the Current Date/Time **plus** the *[amount of time]*.
+* %**ICUDateTimeMinus**%*[amount of time]*%*[unit of time]*%*[output date format]*%
+  * Returns Date/Time calculated by the Current Date/Time **minus** the *[amount of time]*.
+where:
+  * *[output date format]* must conform to the [ICU Date/Time codes](https://www.keyboardmaestro.com/action/linkthru?icudatetimereference).
+  * *[unixtime]* is the total number of seconds since the start of 1970, GMT (see [[:unixtime]]).
+  * *[unit of time]* is a unit as described below.
+  * *[amount of time]* is a calculation, being the number of *[unit of time]* units to add or subtract.
+===== Unit of Time =====
 The available time units for //%ICUDateTimePlus%// and //%ICUDateTimeMinus%// are:
@@ Line 54: / Line 68: @@
 The **format** is a specified with an [ICU Date Time Format Specifier](http://www.stairways.com/action/linkthru?icudatetimereference) which allows you to produce the date in almost any format you desire.
-Keep in mind that TIME is in GMT and the output of ICUDateTimeFor is in local time, so when doing this sort of thing it is best to use midday instead of midnight:
+You can use the *Insert ICU Date Field* menu in the *Edit* menu to insert various ICU Date Field format tokens. The *Insert ICU Date Field by Name…* menu item may be particularly helpful to quickly insert field components.
+Keep in mind that [[:unixtime]] is in GMT and the output of ICUDateTimeFor is in local time, so when doing this sort of thing it is best to use midday instead of midnight:
 ```
@@ Line 64: / Line 80: @@
 ===== Using Variables with These Date/Time Tokens =====
-You can use a number, Variable, and formula using Variables, in the _numeric_ parameters, like the amount of time in the  ICUDateTimePlus token, which has this format: \\
+You can use any [[manual:Calculations|calculation]] in the _numeric_ parameters, like the *[amount of time]* and *[unit of time]* fields.
-%**ICUDateTimePlus**%<color blue><amount of time></color>%<color #22b14c>[unit of time]</color>%<color #22b14c>[output date format]</color>%
-where \\
-  * angle brackets <color blue>< ></color> denote a numeric parameter, may use a Variable and/or formula
-  * square brackets <color #22b14c>[ ]</color> denote a text-only parameter, cannot use a Variable
 The _text-only_ parameters must be plain text, and be a valid choice for that parameter.