Webtags/Parameters: Difference between revisions

# To explain each element in that format value, look in [[#Time formats]], [[#Year formats]], [[#Month formats]], [[#Day formats]], [[#Use of spaces]], [[#Including literals in format parameters]].

[[File:Badge vMx.png]]Again, there are extra complications with MX, the "d" modifier is not shown because it is inconsistent, the format it returns depends on which tag name it is used with - see [[#Date formats]] table later! For some tag names it returns just "day of month" (like "%d"), for others it returns the full "Short date format" (like "ddddd")!

!style="width:150px" | [[File:Badge v1.png]]}Delphi Specifier for Cumulus 1.9.x

[[File:Badge vMx.png]]Note that Cumulus MX requires a ' ' (space), '%' or another modifier to be included, as 'd' on its own is inconsistent - see [[#Date formats]] table).

| 27 produced by:

* [[File:Badge vMx.png]]<#metdate format="%d">

|Displays the day as an abbreviation (in Australian will output "Sun." to "Sat.") using the strings appropriate to the Locale (see note for month abbreviation).

|Displays the day as a full name (Sunday-Saturday) using the strings appropriate to the Locale.

The [[#Year formats]], [[#Month formats]], and [[#Day formats]] listed above can be combined to make up a date output modifier, but there are some other modifiers available that can produce whole dates.

[[#Locales]] will define a '''Short Date Format''' and a '''Long Date Format'''. You will see references to those in the table below explaining available output format modifiers, for example the single character output format modifier ('''G''' or '''c''') listed at the start of the table below.

If you are in the USA, Cumulus will only use your month first date internally for the start date (see [[Cumulus.ini (Cumulus 1)]] and [[Cumulus.ini|Cumulus.ini (Cumulus MX)]]), that format will not be used in any files in the [[Data folder|'''data''' sub-folder]], but you can see your preferred format in the settings pages, in the extreme record editing pages, and by default as an output from many (not all) web tags.  For any web tags that do permit use of output date modification format parameters, you can can combine any month specifier, with any day of month specifier, in that order, to get an output where the month appears first (see example in table below).  

!style="width:150px" | [[File:Badge v1.png]]Delphi Specifier for Cumulus 1.9.x

| G   (as single character format)

| Displays the date using the format given by the Short Date format, followed by the time using the format given by the Long Time format. The time is not displayed in Cumulus 1 if the date-time value indicates midnight precisely.

| '22/03/2019 09:47:25' produced by [[File:Badge v1.png]]<#time format=c>[[File:Badge vMx.png]]<#time format=G>

| ddddd (5 characters long)

| ddddd (5 characters long)

| 'ddddd' will output the date using the format given by the Short Date format.

[[File:Badge vMx.png]]'d' (when on its own, without space or '%' prefix) may or may not work, it displays inconsistent behaviour as its effect depends on the tag name (sorry, there is no definitive list from the MX author specifying effect by individual tag name) with which it is used (you will need to experiment for yourself and compare with the two examples).

| * Short date format e.g. '22/03/2019' (British Locale) produced by <#metdate format=ddddd>

|D (as single character format)

 

|e.g. '22 March 2020' (British Locale)

[[File:Badge vMx.png]] Note this is different output to '''format=%M''' or ''format=" M"'' (see [[#Month formats]]). Not applicable to USA locales.

| e.g. 22 July (English Locale)

| e.g. July 4 (USA format)

|TT

|T  (as single character format)

|Displays the time using the '''Long Time format'''.

 

|'09:47:56'  (might not use colon in your locale) produced by

==== Literals in scripts====

If you are considering use of literals (such as a space) within a output format modifier in a script, then don't. Instead include whatever precedes the literal in a tag specification, then concatenate on the literal, and finally concatenate another tag specification for whatever is to follow the literal.  An example to make this clearer is <code>$MXDateTime = '<#date format=yyyy-MM-dd>' . 'T' . '<#time format=hh:mm:ss>';</code>, which is written in PHP Hypertext Pre-processor format, the literal 'T' has been inserted by using two separate web tags surrounding the literal.  The same approach applies if you wanted to replace that "T" with a space.  (The explanation is that Cumulus (1 and MX) requires single quotes round a literal, but the script language requires any string to be enclosed in quotes, and double quotes are required by Cumulus round any complex specifier including any that include a space or other literal).