Version 1.2.1 - fixes to refresh in rich editor

Author: djsudduth

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## v1.2.1 (2025-01-10)
+
+- Added setting to stop the deletion of refresh metadata if extracted note is edited in the rich text editor
+- Added warning that any edits to an extracted paragraph with refresh will be overwritten
+
+## v1.2.0 (2025-01-08)
+
+- Fixed refresh metadata bugs
+
 ## v1.1.9 (2025-01-06)
 
 - 1.1.6/1.1.9 no code change - just republish to production

README.md

@@ -12,7 +12,7 @@ Bullet and sub-bullet lists are treated as single paragraphs in Joplin. Settings
 
 Any Joplin tags in the source notes will be combined as Joplin tags in the extracted note. Selected notes are not changed at all.
 
-**Extracted notes can be refreshed from the source notes** if the setting to add extraction metadata is on. This will allow an extracted note to update if any of the source notes change. (NOTE: only one extracted note can be refrehed at a time).
+**Extracted notes can be refreshed from the source notes** if the setting to add extraction metadata is on. This will allow an extracted note to update if any of the source notes change. (NOTE: only one extracted note can be refrehed at a time. Also, if you use the rich text editor, you **must have the rich text metadata selection in settings turned on** so that the data isn't deleted if editing the extracted note).
 
 ## Installation
 
@@ -59,6 +59,7 @@ Go to `Tools > Options > Paragraph Extractor`
 - `Remove extracted paragraph keyword and add end tag`: Any tagged/hashtagged keyword will be removed from the paragraph and an endtag will be added in the new extraction note. Removal assumes the keyword has a hashtag prefix character - otherwise the setting is ignored. The end tag is always appended when this is selected. Default `false`
 - `Append extracted note refresh metadata`: When paragraphs are extracted from one or many notes, the details of the plugin's settings and source note list will be appended as metadata in the form of a comment. This can be used to refresh an extracted note if the source note or notes change. Default `false`
 - `Append extracted note refresh metadata`: When paragraphs are extracted from one or many notes, the details of the plugin's settings and source note list will be appended as metadata in the form of a comment (unless the rich text compatibility option is selected which will make the metadata visible). This can be used to refresh an extracted note if the source note or notes change. Default `false`
+- `Enable rich text editor compatibility for refresh metadata`: If the rich text editor is used with note refresh - this must be enabled so that the appended refresh metadata isn't deleted when a refreshed note is edited within the rich editor. This does not need to be enabled if using only the markdown editor. Default `true`
 - `Title of the combined note`: New title of the combined note. Default `Extracted paragraphs`.
 - `Custom note title`: New note title with possible variables `{{FIRSTTITLE}}`, `{{LASTTITLE}}`, `{{ALLTITLE}}` and `{{DATE}}`.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "joplin-plugin-paragraph-extractor",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "scripts": {
     "prepare": "npm run dist && husky install",
     "dist": "webpack --env joplin-plugin-config=buildMain && webpack --env joplin-plugin-config=buildExtraScripts && webpack --env joplin-plugin-config=createArchive",

src/extractParagraphs.ts

@@ -169,6 +169,12 @@ namespace extractParagraphs {
           });
 
         if (rnote.body.includes("-- pex|")) {
+          const refreshWarning = await dialogs.showMessageBox(
+            "Refreshing extracted notes will overwrite any changes. Do you wish to continue?"
+          );
+          if (refreshWarning > 0) {
+            return;
+          }
           footer = rnote.body.split("-- pex|");
           const chunks = footer[1].split("|");
           for (const chunk of chunks) {
@@ -221,6 +227,7 @@ namespace extractParagraphs {
       let extractAtBulletLevel = await joplin.settings.value(
         "extractAtBulletLevel"
       );
+      let richtextMetaData = await joplin.settings.value("richtextMetaData");
       let ignoreCase = await joplin.settings.value("ignoreCase");
       let includeHeaders = await joplin.settings.value("includeHeaders");
       let refreshMetaData = await joplin.settings.value("refreshMetaData");
@@ -244,6 +251,7 @@ namespace extractParagraphs {
         refreshMetaData = pexSettings[6] === "0" ? false : true;
         tagPrefix = pexSettings[7];
         tagName = pexSettings[8];
+        richtextMetaData = pexSettings[9] === "0" ? false : true;
       }
 
       // collect note data
@@ -540,6 +548,9 @@ namespace extractParagraphs {
         const pexDate = now.getTime();
 
         let pexHeader = "> <!-- pex";
+        if (richtextMetaData) {
+          pexHeader = "> < -- pex";
+        }
         newNoteBody.push(
           pexHeader +
             "|s:" +
@@ -560,6 +571,8 @@ namespace extractParagraphs {
             tagPrefix +
             "," +
             tagName +
+            "," +
+            Number(richtextMetaData).toString() +
             "|n:" +
             nIDs.slice(0, -1) +
             "|d:" +

src/locales/de_DE.json

@@ -3,6 +3,8 @@
   "settings.replaceKeywordwithTagDescription": "Entfernt mit Tags versehene Schlüsselwörter (wird ignoriert, wenn kein Tag-Präfix vorhanden ist) aus dem extrahierten Absatz und fügt sie als Hashtag am Ende der kombinierten Notiz hinzu.",
   "settings.refreshMetaData": "Extrahierte Notizaktualisierungsmetadaten anhängen",
   "settings.refreshMetaDataDescription": "Extrahierte Notizeinstellungen und Notizliste zum Aktualisieren am Ende der Notiz hinzufügen",
+  "settings.richtextMetaData": "Aktivieren Sie die Rich-Text-Editor-Kompatibilität zum Aktualisieren von Metadaten",
+  "settings.richtextMetaDataDescription": "Verhindern Sie, dass Aktualisierungsmetadaten automatisch vom Rich-Text-Editor gelöscht werden",
   "settings.extractAtBulletLevel": "Extrahieren Sie Inhalte auf der Ebene der Aufzählungslistenelemente",
   "settings.extractAtBulletLevelDescription": "Extrahiert nur die Aufzählungszeile mit dem Schlüsselwort und nicht die vollständige Aufzählungsliste des Absatzes.",
   "settings.ignoreCase": "Ignorieren Sie die Groß-/Kleinschreibung des Schlüsselworts",

src/locales/en_US.json

@@ -3,6 +3,8 @@
   "settings.replaceKeywordwithTagDescription": "Removes keywords with tagged prefix (ignored if no prefix character) from the extracted paragraph and adds it as a hashtag at the combined note end.",
   "settings.refreshMetaData": "Append extracted note refresh metadata",
   "settings.refreshMetaDataDescription": "Add extracted note settings and note list to the end of the note for refresh",
+  "settings.richtextMetaData": "Enable rich text editor compatibility for refresh metadata",
+  "settings.richtextMetaDataDescription": "Stop refresh metadata from being automatically deleted by the rich text editor",
   "settings.extractAtBulletLevel": "Extract content at the bulleted list item level",
   "settings.extractAtBulletLevelDescription": "Extracts only the bulleted line with the keyword rather than the full paragraph bulleted list.",
   "settings.ignoreCase": "Ignore the keyword case",

src/manifest.json

@@ -2,7 +2,7 @@
   "manifest_version": 1,
   "id": "io.github.djsudduth.paragraph-extractor",
   "app_min_version": "1.8.1",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "name": "Paragraph Extractor",
   "description": "Extract specific paragraphs out of Joplin notes using keywords, hashtags or custom tags",
   "author": "djsudduth",

src/settings.ts

@@ -91,6 +91,15 @@ export namespace settings {
         description: i18n.__("settings.refreshMetaDataDescription"),
       },
 
+      richtextMetaData: {
+        value: true,
+        type: SettingItemType.Bool,
+        section: "extractParagraphSection",
+        public: true,
+        label: i18n.__("settings.richtextMetaData"),
+        description: i18n.__("settings.richtextMetaDataDescription"),
+      },
+
       combinedNoteTitle: {
         value: "default",
         type: SettingItemType.String,