Add support for custom format (#21)

* Add support for custom format

* Settings description update

* Remove toggling custom format

* Only pass required settings to ZoterotItem

* Add month and monthlocal option

* Add custom date format

* Date formatting with dayjs

---------

Co-authored-by: louisld <[email protected]>

Author: louisld

CHANGELOG.md

@@ -0,0 +1,4 @@
+# 2.1.0
+
+- Added support for custom format link.
+- Removed `author` filter on item to include other type of creator.

README.md

@@ -19,3 +19,36 @@ Conntect Zotero with Joplin to reference sources in notes and open them via `zot
 1. Open a note and enter `z@`
 2. Search for your reference
 3. Select it
+
+### Custom text for links
+
+Custom formattting of the text can be enabled from plugin settings.
+
+#### Example
+
+| Location   | Display |
+|---|---|
+| Settings | `[<authorfirst>, <year>, *<title>*](<zoterolink>)<externallink>`  |
+| Markdown | `[Jannes Magnusson, 2024, *jannessm/joplin-zotero-link*](zotero://select/library/items/Q5U7SN82)[&#x1F517;](https://github.com/jannessm/joplin-zotero-link)`|
+| Editor | [Jannes Magnusson, 2024, *jannessm/joplin-zotero-link*](zotero://select/library/items/Q5U7SN82)[&#x1F517;](https://github.com/jannessm/joplin-zotero-link) |
+
+#### Available parameters
+| Key        | Description          |
+|----------------|----------------------|
+| `<key>`        | Zotero key           |
+| `<zoterolink>` | Local zotero link `zotero://select/library/items/<key>` |
+| `<authors>`     |    All authors                  |
+|  `<authorfirst>`               |        First author |
+|   `<title>`   |   Title |
+|  `<date>` | Date in local format         |
+|  `<date:YYYY-MM-DDTHH:mm:ss>` | Date formating using [dayjs](https://day.js.org/) |
+|   `<year>`   |  Year    |
+|   `<month>`  | Month in `en-US` format |
+|   `<monthlocal>`  | Month in local format |
+|   `<publication>`  |   Publication journal   |
+|   `<publicationshort>` |  Short version of publication journal  |
+|  `<doi>`        |   DOI    |
+|  `<doiurl>`  |    DOI url `https://doi.org/<doi>`   |
+|  `<url>` | External url    |
+|  `<externallink>`   |  Give external link with icon 🔗 `[&#x1F517;](<url>)` |
+|  `<externaldoi>`   |  Give external DOI link with icon 🔗 `[&#x1F517;](<doilink>)` |

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "joplin-plugin-zotero-link",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "scripts": {
     "dist": "webpack --env joplin-plugin-config=buildMain && webpack --env joplin-plugin-config=buildExtraScripts && webpack --env joplin-plugin-config=createArchive",
     "prepare": "npm run dist",
@@ -31,6 +31,7 @@
     "@codemirror/autocomplete": "^6.18.1",
     "@codemirror/language": "^6.10.3",
     "@codemirror/view": "^6.34.1",
-    "@types/codemirror": "^5.60.15"
+    "@types/codemirror": "^5.60.15",
+    "dayjs": "^1.11.13"
   }
 }

package.json

@@ -22,10 +22,12 @@ joplin.plugins.register({
 		await joplin.contentScripts.onMessage(scriptId, async (msg) => {
 
 			if (msg === 'getSettings') {
-                const settingValue = await joplin.settings.value(SETTING.Port);
+				const port = await joplin.settings.value(SETTING.Port);
+				const cf = await joplin.settings.value(SETTING.CustomFormat);
                 return {
-                    port: settingValue,
-                };
+					port: port,
+					customFormat: cf
+				};
 			} else {
 				await dialogs.setHtml(error, `
 					<h1>${msg.title}</h1>