vitro/webapp/web/templates/freemarker/lib/lib-datetime.ftl

<#-- $This file is distributed under the terms of the license in /doc/license.txt$ -->

<#-- Macros and functions for datetime formatting. 

     Currently these do more than format the datetime string, they actually select the precision as well. This should change in a future
     implementation; see NIHVIVO-1567. We want the Java code to apply the precision to the datetime string to pass only the
     meaningful data to the templates. The templates can format as they like, so these functions/macros would do display formatting
     but not data extraction.
 -->

<#-- Macro yearInterval

     Display a year interval in a property statement
     
     Set endYearAsRange=false to display an end year without a start year without a preceding hyphen. The hyphen indicates that
     a range is expected but the start year is not provided (e.g., core:personInPosition); no hyphen indicates that
     a single date is typical (e.g., core:educationalTraining).
-->

<#macro yearInterval startDateTime endDateTime endYearAsRange=true>
    <#local yearInterval>
        <#if startDateTime?has_content>
            <#local startYear = xsdDateTimeToYear(startDateTime)>
        </#if>
        <#if endDateTime?has_content>
            <#local endYear = xsdDateTimeToYear(endDateTime)>
        </#if>
        <#if startYear?? && endYear??>
            ${startYear} - ${endYear}
        <#elseif startYear??>
            ${startYear} -
        <#elseif endYear ??>
            <#if endYearAsRange>- </#if>${endYear}
        </#if>
    </#local>
    
    <#if yearInterval?has_content>
        <span class="listDateTime">${yearInterval}</span>
    </#if>  
</#macro>

<#-- Function xsdDateTimeToYear 
     
     Display an XSD datetime string as a year.
     
     Example: 1983-12-07T17:15:28Z displays as 1983
-->

<#function xsdDateTimeToYear datetime>
    <#return datetime?date("yyyy")?string("yyyy") >
</#function>