Skip to content

More info on template time formats #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

More info on template time formats #243

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
20ab7de
More info on template time formats
cartermak Aug 14, 2025
de0c409
Explicitly state the 'Text' mode format
cartermak Aug 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions docs/command-expansion/template-expansion/authoring-templates.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,17 @@ The actual compilation of templates is discussed in [Expanding Templates](../exp
We also introduce with Handlebars formatting the notion of helpers. Helper functions (discussed in the Handlebars documentation [here](https://handlebarsjs.com/guide/builtin-helpers.html)), allow a user to invoke a function with arguments and produce a result in the template.
Aerie defines 4 helpers for use in templates. User-defined helpers are not yet supported, so only these 4 are available at the moment.

Template helpers for times output according to the configured language. The time formats for the supported languages are:

| Language | Format |
| :------- | :------------------------------ |
| STOL | `YYYY-ddd/HH:MM:SS[.sss]` |
| SeqN | `YYYY-dddTHH:MM:SS[.sss[sss]]` |
| Text | `YYYY-MM-DDTHH:MM:SS[.ssssss]Z` |

### `add-time`

This helper allows a user to compute a new time string (that is either STOL or SeqN compatible) from an existing one, and a duration to be added to that time. For example:
This helper allows a user to compute a new time string from an existing one and a duration to be added to that time. For example:

**Input**

Expand Down Expand Up @@ -158,7 +166,7 @@ A2024-001T01:00:00

### `subtract-time`

This helper allows a user to compute a new time string (that is either STOL or SeqN compatible) from an existing one, and a duration to be subtracted from that time. For example:
This helper allows a user to compute a new time string from an existing one and a duration to be subtracted from that time. For example:

**Input**

Expand Down Expand Up @@ -191,7 +199,8 @@ A2023-365T23:00:00
```

### `format-as-date`
This helper allows a user to format a date-like string input in the date format defined in the target sequencing language. For example, if I want STOL-like dates (which use `/` instead of a `T`, and include the time zone abbreviation) but my input is:

This helper formats a time value such as activity start time into the correct format for the template's specified sequencing language. For example, given a template configured for STOL, the start time may be formatted as follows:

**Input**

Expand All @@ -202,16 +211,12 @@ This helper allows a user to format a date-like string input in the date format
}
```

then I can write my template as:

**Template**

```
CMD AT={{ format-as-date startTime }}
```

which provides me with:

**Result**

```
Expand Down