jenkinsci/calendar-view-plugin

View on GitHub
src/main/webapp/help/date-and-time-formats.html

Summary

Maintainability
Test Coverage
<!--
The MIT License

Copyright (c) 2018 Sven Schoenung

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-->

When this option is checked you can customize the date and time display of four different areas in the calendar view:

<table style="margin:10px 0px">
<tr>
<td><b>View title:</b></td>
<td>The currently selected date displayed at the very top of each of the month/week/day views.</td>
</tr>
<tr>
<td><b>Day column title:</b></td>
<td>The date displayed at the top of each column that contains the events of a particular day or week day.</td>
</tr>
<tr>
<td><b>Events:</b></td>
<td>The start time for the calendar events that represent past and future builds.</td>
</tr>
<tr>
<td><b>Slots:</b></td>
<td>The times displayed on the time axis on the left in the week and day views.</td>
</tr>
<tr>
<td><b>Popups:</b></td>
<td>The dates and times of past builds shown in the popup that opens when hovering over a calendar event.</td>
</tr>
</table>

The date formats can be specified using standard <a href="http://momentjs.com/docs/#/displaying/format/">Moment.js format strings</a>:

<table style="margin:10px 0px">
    <tr>
        <th></th>
        <th style="text-align:left">Token</th>
        <th style="text-align:left">Output</th>
    </tr>
    <tr>
        <td><b>Month</b></td>
        <td>M</td>
        <td>1 2 ... 11 12</td>
    </tr>
    <tr>
        <td></td>
        <td>Mo</td>
        <td>1st 2nd ... 11th 12th</td>
    </tr>
    <tr>
        <td></td>
        <td>MM</td>
        <td>01 02 ... 11 12</td>
    </tr>
    <tr>
        <td></td>
        <td>MMM</td>
        <td>Jan Feb ... Nov Dec</td>
    </tr>
    <tr>
        <td></td>
        <td>MMMM</td>
        <td>January February ... November December</td>
    </tr>
    <tr>
        <td><b>Quarter</b></td>
        <td>Q</td>
        <td>1 2 3 4</td>
    </tr>
    <tr>
        <td></td>
        <td>Qo</td>
        <td>1st 2nd 3rd 4th</td>
    </tr>
    <tr>
        <td><b>Day of Month</b></td>
        <td>D</td>
        <td>1 2 ... 30 31</td>
    </tr>
    <tr>
        <td></td>
        <td>Do</td>
        <td>1st 2nd ... 30th 31st</td>
    </tr>
    <tr>
        <td></td>
        <td>DD</td>
        <td>01 02 ... 30 31</td>
    </tr>
    <tr>
        <td><b>Day of Year</b></td>
        <td>DDD</td>
        <td>1 2 ... 364 365</td>
    </tr>
    <tr>
        <td></td>
        <td>DDDo</td>
        <td>1st 2nd ... 364th 365th</td>
    </tr>
    <tr>
        <td></td>
        <td>DDDD</td>
        <td>001 002 ... 364 365</td>
    </tr>
    <tr>
        <td><b>Day of Week</b></td>
        <td>d</td>
        <td>0 1 ... 5 6</td>
    </tr>
    <tr>
        <td></td>
        <td>do</td>
        <td>0th 1st ... 5th 6th</td>
    </tr>
    <tr>
        <td></td>
        <td>dd</td>
        <td>Su Mo ... Fr Sa</td>
    </tr>
    <tr>
        <td></td>
        <td>ddd</td>
        <td>Sun Mon ... Fri Sat</td>
    </tr>
    <tr>
        <td></td>
        <td>dddd</td>
        <td>Sunday Monday ... Friday Saturday</td>
    </tr>
    <tr>
        <td><b>Day of Week (Locale)</b></td>
        <td>e</td>
        <td>0 1 ... 5 6</td>
    </tr>
    <tr>
        <td><b>Day of Week (ISO)</b></td>
        <td>E</td>
        <td>1 2 ... 6 7</td>
    </tr>
    <tr>
        <td><b>Week of Year</b></td>
        <td>w</td>
        <td>1 2 ... 52 53</td>
    </tr>
    <tr>
        <td></td>
        <td>wo</td>
        <td>1st 2nd ... 52nd 53rd</td>
    </tr>
    <tr>
        <td></td>
        <td>ww</td>
        <td>01 02 ... 52 53</td>
    </tr>
    <tr>
        <td><b>Week of Year (ISO)</b></td>
        <td>W</td>
        <td>1 2 ... 52 53</td>
    </tr>
    <tr>
        <td></td>
        <td>Wo</td>
        <td>1st 2nd ... 52nd 53rd</td>
    </tr>
    <tr>
        <td></td>
        <td>WW</td>
        <td>01 02 ... 52 53</td>
    </tr>
    <tr>
        <td><b>Year</b></td>
        <td>YY</td>
        <td>70 71 ... 29 30</td>
    </tr>
    <tr>
        <td></td>
        <td>YYYY</td>
        <td>1970 1971 ... 2029 2030</td>
    </tr>
    <tr>
        <td></td>
        <td>Y</td>
        <td>1970 1971 ... 9999 +10000 +10001
            <br>
            <b>Note:</b> This complies with the ISO 8601 standard for dates past the year 9999
        </td>
    </tr>
    <tr>
        <td><b>Week Year</b></td>
        <td>gg</td>
        <td>70 71 ... 29 30</td>
    </tr>
    <tr>
        <td></td>
        <td>gggg</td>
        <td>1970 1971 ... 2029 2030</td>
    </tr>
    <tr>
        <td><b>Week Year (ISO)</b></td>
        <td>GG</td>
        <td>70 71 ... 29 30</td>
    </tr>
    <tr>
        <td></td>
        <td>GGGG</td>
        <td>1970 1971 ... 2029 2030</td>
    </tr>
    <tr>
        <td><b>AM/PM</b></td>
        <td>A</td>
        <td>AM PM</td>
    </tr>
    <tr>
        <td></td>
        <td>a</td>
        <td>am pm</td>
    </tr>
    <tr>
        <td><b>Hour</b></td>
        <td>H</td>
        <td>0 1 ... 22 23</td>
    </tr>
    <tr>
        <td></td>
        <td>HH</td>
        <td>00 01 ... 22 23</td>
    </tr>
    <tr>
        <td></td>
        <td>h</td>
        <td>1 2 ... 11 12</td>
    </tr>
    <tr>
        <td></td>
        <td>hh</td>
        <td>01 02 ... 11 12</td>
    </tr>
    <tr>
        <td></td>
        <td>k</td>
        <td>1 2 ... 23 24</td>
    </tr>
    <tr>
        <td></td>
        <td>kk</td>
        <td>01 02 ... 23 24</td>
    </tr>
    <tr>
        <td><b>Minute</b></td>
        <td>m</td>
        <td>0 1 ... 58 59</td>
    </tr>
    <tr>
        <td></td>
        <td>mm</td>
        <td>00 01 ... 58 59</td>
    </tr>
    <tr>
        <td><b>Second</b></td>
        <td>s</td>
        <td>0 1 ... 58 59</td>
    </tr>
    <tr>
        <td></td>
        <td>ss</td>
        <td>00 01 ... 58 59</td>
    </tr>
    <tr>
        <td><b>Fractional Second</b></td>
        <td>S</td>
        <td>0 1 ... 8 9</td>
    </tr>
    <tr>
        <td></td>
        <td>SS</td>
        <td>00 01 ... 98 99</td>
    </tr>
    <tr>
        <td></td>
        <td>SSS</td>
        <td>000 001 ... 998 999</td>
    </tr>
    <tr>
        <td></td>
        <td>SSSS ... SSSSSSSSS</td>
        <td>000[0..] 001[0..] ... 998[0..] 999[0..]</td>
    </tr>
    <tr>
        <td><b>Time Zone</b></td>
        <td>z or zz</td>
        <td>
            EST CST ... MST PST
            <br>
            <b>Note:</b> as of <b>1.6.0</b>, the z/zz format tokens have been deprecated from plain moment objects. <a href="https://github.com/moment/moment/issues/162">Read more about it here.</a>
            However, they <em>do</em> work if you are using a specific time zone with the moment-timezone addon.
        </td>
    </tr>
    <tr>
        <td></td>
        <td>Z</td>
        <td>-07:00 -06:00 ... +06:00 +07:00</td>
    </tr>
    <tr>
        <td></td>
        <td>ZZ</td>
        <td>
            -0700 -0600 ... +0600 +0700
        </td>
    </tr>
    <tr>
        <td><b>Unix Timestamp</b></td>
        <td>X</td>
        <td>1360013296</td>
    </tr>
    <tr>
        <td><b>Unix Millisecond Timestamp</b></td>
        <td>x</td>
        <td>1360013296123</td>
    </tr>
</table>