Compare commits

...

3 commits

Author SHA1 Message Date
David Ingerslev
91aa682979 0.2.1 2025-04-02 09:40:24 +01:00
David Ingerslev
9aade20454 Added note about recurring meetings/appointments 2025-04-02 09:40:09 +01:00
David Ingerslev
16bb41eba6 Added documentation for new helper field 2025-04-02 09:35:19 +01:00
5 changed files with 29 additions and 8 deletions

View file

@ -12,7 +12,14 @@ By processing .msg files, the plugin does not depend on having to run code withi
Outlook or on Microsoft 365 administrators authorising an app to connect to the
Microsoft Graph API.
It relies on the wonderful [msgreader](https://github.com/HiraokaHyperTools/msgreader),
Note about recurring meetings or appointments: Microsoft Outlook does not include
any fields that indicate which of the recurring appointments has been dragged-and-dropped,
so it is not possible to differentiate between them. This means that the start date/time
of the first appointment in the recurring series will be used by default. You may wish
to change the filename template to include the current date/time instead (or as well)
using the helper field [helper_currentDT](#helper_currentDT).
The plugin relies on the wonderful [msgreader](https://github.com/HiraokaHyperTools/msgreader),
[mustache.js](https://github.com/janl/mustache.js), and
[mustache-validator](https://github.com/eliasm307/mustache-validator) libraries.
@ -69,8 +76,8 @@ Note - the invalid characters are: `/` `*` `"` `\` `<` `>` `:` `|` `?`
The default template can be customised, or you can write a new
template using mustache syntax (see [the manual](https://mustache.github.io/mustache.5.html)).
All .msg [fields](https://hiraokahypertools.github.io/msgreader/typedoc/interfaces/MsgReader.FieldsData.html)
can be used in a template, and there are also some additional helper functions you can
use to format fields.
can be used in a template, and there are also some additional helper fields and
functions you can use to format fields.
### Default template
The default template for notes is:
@ -89,6 +96,19 @@ meeting-invite: {{body}}
---
```
### Helper fields for templates
There is currently only one helper field available:
#### helper_currentDT
The date and time at which the meeting was dragged-and-dropped onto the icon,
in ISO format (like *2025-04-02T09:31:12+01:00*).
You will probably want to use the [helper_dateFormat](#helper_dateFormat) function
to format it:
```
{{#helper_dateFormat}}{{helper_currentDT}}|YYYY-MM-DD HH.mm.ss{{/helper_dateFormat}}
```
### Helper functions for templates
To use a helper function in a template, include a section for the function, e.g.:
```

View file

@ -1,7 +1,7 @@
{
"id": "outlook-meeting-notes",
"name": "Outlook Meeting Notes",
"version": "0.2.0",
"version": "0.2.1",
"minAppVersion": "1.8.9",
"description": "Creates meeting notes for Outlook appointments and meetings.",
"author": "David Ingerslev",

4
package-lock.json generated
View file

@ -1,12 +1,12 @@
{
"name": "outlook-meeting-notes",
"version": "0.2.0",
"version": "0.2.1",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "outlook-meeting-notes",
"version": "0.2.0",
"version": "0.2.1",
"license": "MIT",
"dependencies": {
"@kenjiuno/msgreader": "^1.22.0",

View file

@ -1,6 +1,6 @@
{
"name": "outlook-meeting-notes",
"version": "0.2.0",
"version": "0.2.1",
"description": "Creates meeting notes for Outlook appointments and meetings.",
"main": "main.js",
"scripts": {

View file

@ -5,5 +5,6 @@
"0.1.4": "1.8.9",
"0.1.5": "1.8.9",
"0.1.6": "1.8.9",
"0.2.0": "1.8.9"
"0.2.0": "1.8.9",
"0.2.1": "1.8.9"
}