Webtags/Parameters: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
1,570 bytes removed ,  13:36, 3 October 2022
m
Line 271: Line 271:
====Date formats====
====Date formats====


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.
The [[#Year formats|Year formats]], [[#Month formats|Month formats]], and [[#Day formats|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.
The [[#Locales|locale]] 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''') listed at the start.


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).  
If you are in the USA, Cumulus will only use your month first date internally for the start date (see [[Cumulus.ini]]), 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).  


<big>Please could an American contributor please check if the "M" modifier works for their locale as shown and update the table below if necessary, and edit this comment into a confirmation</big>.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | [[File:Badge v1.png]]Delphi Specifier for Cumulus 1.9.x
!style="width:150px" | Specifier
!style="width:150px" | [[File:Badge vMx.png]]Mono/.NET Specifier for Cumulus MX
!style="width:600px" | Displays
!style="width:600px" | Displays
!style="width:600px" | Example
!style="width:600px" | Example
|-
|-
| c
| G  (as single character format)
| 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.
| 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.  
| '22/03/2019 09:47:25' produced by [[File:Badge v1.png]]<#time format=c>[[File:Badge vMx.png]]<#time format=G>
| '22/03/2019 09:47:25' produced by <#time format=G>
|-
|-
| ddddd (5 characters long)
| ddddd (5 characters long)  
| ddddd (5 characters long)  
| 'ddddd' will output the date using the format given by the Short Date format.
| Displays 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).
Note: 'd' (when on its own, without '%' prefix) displays seemingly inconsistent behaviour as its effect depends on the tag name) with which it is used.
| * Short date format e.g. '22/03/2019' (British Locale) produced by <#metdate format=ddddd>
| Short date format e.g. '22/03/2019' (British Locale) produced by <#metdate format=ddddd>
* [[File:Badge vMx.png]] For some tag names can use "d":
** <#metdateyesterday format=d> e.g. '22/03/2019' (British Locale)
** <#yesterday=d> e.g. '22' returned
|-
|-
|dddddd (6 characters long)
|D  (as single character format)
|D  (as single character format)
|Displays the date using the format given by the Long Date format.   
|Displays the date using the format given by the Long Date format.   
[[File:Badge vMx.png]]The MX 'D' parameter '''cannot be combined''' with any other parameters.
|e.g. '22 March 2020' (British Locale)
|e.g. '22 March 2020' (British Locale)
|-
|-
|"D MMMM YYYY"
|D
|Long date format
|e.g.4 December 2009
|-
|"D MMMM"
|M
|M
|Day of month followed by Month name.   
|Day of month followed by Month name.   


[[File:Badge vMx.png]] Note this is different output to '''format=%M''' or ''format=" M"'' (see [[#Month formats]]). Not applicable to USA locales.
Note this is different output to '''format=%M''' (see [[#Month formats]]). Not applicable to USA locales.
| e.g. 22 July (English Locale)
| e.g. 22 July (English Locale)
|-
|-
|"MMMM D"
|"MMMM d" if M alone does not work
|"MMMM d" if M alone does not work
| USA format of month before day of month
| USA format of month before day of month
| e.g. July 4 (USA format)
| e.g. July 4 (USA format)
|-
|TT
|T  (as single character format)
|Displays the time using the '''Long Time format'''.
[[File:Badge vMx.png]] Note that this is a full time specifier and "T" is on its own as we are using a single character format.
|'09:47:56'  (might not use colon in your locale) produced by
* [[File:Badge v1.png]]<#LastDataReadT format=TT>
*[[File:Badge vMx.png]]<#LastDataReadT format=T>
|}
|}


Navigation menu