refactor: update settings (#1094)

Author: st3v3nmw

src/algorithms/base/isrs-algorithm.ts

@@ -4,6 +4,10 @@ import { OsrNoteGraph } from "src/algorithms/osr/osr-note-graph";
 import { DueDateHistogram } from "src/due-date-histogram";
 import { Note } from "src/note";
 
+export enum Algorithm {
+    SM_2_OSR = "SM-2-OSR",
+}
+
 export interface ISrsAlgorithm {
     noteOnLoadedNote(path: string, note: Note, noteEase: number): void;
     noteCalcNewSchedule(

src/data-stores/base/data-store.ts

@@ -2,6 +2,10 @@ import { RepItemScheduleInfo } from "src/algorithms/base/rep-item-schedule-info"
 import { RepItemStorageInfo } from "src/data-stores/base/rep-item-storage-info";
 import { Question } from "src/question";
 
+export enum DataStoreName {
+    NOTES = "NOTES",
+}
+
 export interface IDataStore {
     questionCreateSchedule(
         originalQuestionText: string,

src/data-stores/store-in-note/note.ts renamed to src/data-stores/notes/notes.ts

@@ -11,7 +11,7 @@ import { Question } from "src/question";
 import { SRSettings } from "src/settings";
 import { DateUtil, formatDate_YYYY_MM_DD, globalDateProvider } from "src/utils/dates";
 
-export class StoreInNote implements IDataStore {
+export class StoreInNotes implements IDataStore {
     private settings: SRSettings;
     app: App;
     easeByPath: NoteEaseList;

src/gui/tabs.tsx

@@ -16,8 +16,9 @@
  *
  * Contact the author (Jarkko Linnanvirta): https://github.com/Taitava/
  */
-
 import { setIcon } from "obsidian";
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import h from "vhtml";
 
 export interface Tab {
     title: string;
@@ -63,7 +64,9 @@ export function createTabs(
     const tab_buttons: TabButtons = {};
     const tab_structure: TabStructure = {
         header: tab_header,
-        active_tab_id: Object.keys(tabs)[0] as string, // Indicate that the first tab is active. This does not affect what tab is active in practise, it just reports the active tab.
+        // Indicate that the first tab is active.
+        // This does not affect what tab is active in practise, it just reports the active tab.
+        active_tab_id: Object.keys(tabs)[0] as string,
         buttons: tab_buttons,
         contentContainers: tab_content_containers,
         contentGeneratorPromises: {},
@@ -80,7 +83,9 @@ export function createTabs(
             },
         });
         button.onclick = function (event: MouseEvent) {
-            const tab_button = this as HTMLElement; // Use 'this' instead of event.target because this way we'll always get a button element, not an element inside the  button (i.e. an icon).
+            // Use 'this' instead of event.target because this way we'll always get a button element,
+            //  not an element inside the  button (i.e. an icon).
+            const tab_button = this as HTMLElement;
 
             // Hide all tab contents and get the max dimensions
             let max_width = 0;
@@ -95,15 +100,19 @@ export function createTabs(
                     "Container element is missing. Did not get a parent from tab header.",
                 );
             }
-            const tab_contents = container_element.findAll("div.sr-tab-content"); // Do not get all tab contents that exist, because there might be multiple tab systems open at the same time.
+
+            // Do not get all tab contents that exist,
+            //  because there might be multiple tab systems open at the same time.
+            const tab_contents = container_element.findAll("div.sr-tab-content");
             const is_main_settings_modal = container_element.hasClass("vertical-tab-content");
             for (const index in tab_contents) {
                 const tab_content = tab_contents[index];
 
                 // Get the maximum tab dimensions so that all tabs can have the same dimensions.
                 // But don't do it if this is the main settings modal
                 if (!is_main_settings_modal) {
-                    tab_content.addClass("sr-tab-active"); // Need to make the tab visible temporarily in order to get the dimensions.
+                    // Need to make the tab visible temporarily in order to get the dimensions.
+                    tab_content.addClass("sr-tab-active");
                     if (tab_content.offsetHeight > max_height) {
                         max_height = tab_content.offsetHeight;
                     }
@@ -117,7 +126,9 @@ export function createTabs(
             }
 
             // Remove active status from all buttons
-            const adjacent_tab_buttons = tab_header.findAll(".sr-tab-header-button"); // Do not get all tab buttons that exist, because there might be multiple tab systems open at the same time.
+            // Do not get all tab buttons that exist,
+            //  because there might be multiple tab systems open at the same time.
+            const adjacent_tab_buttons = tab_header.findAll(".sr-tab-header-button");
             for (const index in adjacent_tab_buttons) {
                 const tab_button = adjacent_tab_buttons[index];
                 tab_button.removeClass("sr-tab-active");
@@ -142,10 +153,12 @@ export function createTabs(
             tab_content.addClass("sr-tab-active");
 
             // Mark the clicked tab as active in TabStructure (just to report which tab is currently active)
-            tab_structure.active_tab_id = activate_tab_id.replace(/^sr-tab-/, ""); // Remove "sr-tab" prefix.
+            // Remove "sr-tab" prefix.
+            tab_structure.active_tab_id = activate_tab_id.replace(/^sr-tab-/, "");
 
             // Focus an element (if a focusable element is present)
-            tab_content.find(".sr-focus-element-on-tab-opening")?.focus(); // ? = If not found, do nothing.
+            // ? = If not found, do nothing.
+            tab_content.find(".sr-focus-element-on-tab-opening")?.focus();
 
             // Apply the max dimensions to this tab
             // But don't do it if this is the main settings modal
@@ -159,7 +172,7 @@ export function createTabs(
         };
         if (tab.icon) setIcon(button, tab.icon);
 
-        button.insertAdjacentText("beforeend", " " + tab.title);
+        button.insertAdjacentHTML("beforeend", <span style="padding-left: 5px;">{tab.title}</span>);
         tab_buttons[tab_id] = button;
 
         // Create content container

src/lang/locale/ar.ts

@@ -55,6 +55,7 @@ export default {
     GROUP_FLASHCARD_REVIEW: "Flashcard Review",
     GROUP_FLASHCARD_SEPARATORS: "Flashcard Separators",
     GROUP_DATA_STORAGE: "Storage of Scheduling Data",
+    GROUP_DATA_STORAGE_DESC: "Choose where to store the scheduling data",
     GROUP_FLASHCARDS_NOTES: "Flashcards & Notes",
     GROUP_CONTRIBUTING: "Contributing",
     CHECK_WIKI: '.<a href="${wiki_url}">wiki</a> لمزيد من المعلومات ، تحقق من',
@@ -63,11 +64,11 @@ export default {
     GITHUB_ISSUES:
         'Raise an issue <a href="${issues_url}">here</a> if you have a feature request or a bug report.',
     GITHUB_SOURCE_CODE:
-        'Project source code available on <a href="${github_project_url}">GitHub</a>',
+        'The project\'s source code is available on <a href="${github_project_url}">GitHub</a>.',
     CODE_CONTRIBUTION_INFO:
-        'Information on <a href="${code_contribution_url}">code contributions</a>',
+        '<a href="${code_contribution_url}">Here\'s</a> how to contribute code to the plugin.',
     TRANSLATION_CONTRIBUTION_INFO:
-        'Information on <a href="${translation_contribution_url}">translating the plugin</a> to your language',
+        '<a href="${translation_contribution_url}">Here\'s</a> how to translate the plugin to another language.',
     PROJECT_CONTRIBUTIONS:
         'Raise an issue <a href="${issues_url}">here</a> if you have a feature request or a bug report',
     FOLDERS_TO_IGNORE: "مجلدات لتجاهلها",
@@ -81,7 +82,7 @@ export default {
     FLASHCARD_EASY_DESC: '"تخصيص التسمية للزر "سهل',
     FLASHCARD_GOOD_DESC: '"تخصيص التسمية للزر "جيد',
     FLASHCARD_HARD_DESC: '"تخصيص التسمية للزر "صعب',
-    REVIEW_BUTTON_DELAY: "Button press delay (ms)",
+    REVIEW_BUTTON_DELAY: "Button Press Delay (ms)",
     REVIEW_BUTTON_DELAY_DESC: "Add a delay to the review buttons before they can be pressed again.",
     FLASHCARD_TAGS: "وُسوم البطاقات",
     FLASHCARD_TAGS_DESC: "#2أدخل الوُسوم مفصولة بمسافات أو أسطر جديدة ، أي بطاقات# رزمة3# رزمة",
@@ -137,7 +138,7 @@ export default {
     MAX_N_DAYS_REVIEW_QUEUE: "الحد الأقصى لعدد الأيام التي يجب عرضها على اللوحة اليمنى",
     MIN_ONE_DAY: "يجب أن يكون عدد الأيام 1 على الأقل",
     VALID_NUMBER_WARNING: "يرجى تقديم رقم صالح",
-    UI_PREFERENCES: "تفضيلات واجهة المستخدم",
+    UI: "User Interface",
     SHOW_STATUS_BAR: "Show status bar",
     SHOW_STATUS_BAR_DESC:
         "Turn this off to hide the flashcard's review status in Obsidian's status bar",
@@ -148,8 +149,8 @@ export default {
     INITIALLY_EXPAND_SUBDECKS_IN_TREE_DESC:
         " عطل هذا الخيار لطي الرُزم المتداخلة في نفس البطاقة , مفيد إذا كان لديك بطاقات تنتمي إلى العديد من الرُزم في نفس الملف",
     ALGORITHM: "خوارزمية",
-    CHECK_ALGORITHM_WIKI:
-        '<a href="${algo_url}">algorithm implementation</a> :لمزيد من المعلومات تحقق من',
+    CHECK_ALGORITHM_WIKI: '<a href="${algo_url}">algorithm details</a> :لمزيد من المعلومات تحقق من',
+    SM2_OSR_VARIANT: "OSR's variant of SM-2",
     BASE_EASE: "سهولة القاعدة",
     BASE_EASE_DESC: "الحد الأدنى = 130 ، ويفضل حوالي 250.",
     BASE_EASE_MIN_WARNING: "يجب أن تكون سهولة القاعدة 130 على الأقل.",
@@ -165,9 +166,12 @@ export default {
     MAX_LINK_CONTRIB: "أقصى مساهمة ارتباط",
     MAX_LINK_CONTRIB_DESC: "أقصى مساهمة للسهولة المرجحة للملاحظات المرتبطة بالسهولة الأولية.",
     LOGGING: "تسجيل",
-    DISPLAY_DEBUG_INFO: "عرض معلومات التصحيح على وحدة تحكم المطور",
-    DISPLAY_PARSER_DEBUG_INFO:
-        "Display debugging information for the parser on the developer console",
+    DISPLAY_SCHEDULING_DEBUG_INFO: "عرض معلومات التصحيح على وحدة تحكم المطور",
+    DISPLAY_PARSER_DEBUG_INFO: "Show the parser's debugging information on the developer console",
+    SCHEDULING: "Scheduling",
+    EXPERIMENTAL: "Experimental",
+    HELP: "Help",
+    STORE_IN_NOTES: "In the notes",
 
     // sidebar.ts
     NOTES_REVIEW_QUEUE: "ملاحظات قائمة المراجعة",

src/lang/locale/cz.ts

@@ -55,6 +55,7 @@ export default {
     GROUP_FLASHCARD_REVIEW: "Flashcard Review",
     GROUP_FLASHCARD_SEPARATORS: "Flashcard Separators",
     GROUP_DATA_STORAGE: "Storage of Scheduling Data",
+    GROUP_DATA_STORAGE_DESC: "Choose where to store the scheduling data",
     GROUP_FLASHCARDS_NOTES: "Flashcards & Notes",
     GROUP_CONTRIBUTING: "Contributing",
     CHECK_WIKI: 'Pro více informací jděte na <a href="${wiki_url}">wiki</a>.',
@@ -63,11 +64,11 @@ export default {
     GITHUB_ISSUES:
         'Raise an issue <a href="${issues_url}">here</a> if you have a feature request or a bug report.',
     GITHUB_SOURCE_CODE:
-        'Project source code available on <a href="${github_project_url}">GitHub</a>',
+        'The project\'s source code is available on <a href="${github_project_url}">GitHub</a>.',
     CODE_CONTRIBUTION_INFO:
-        'Information on <a href="${code_contribution_url}">code contributions</a>',
+        '<a href="${code_contribution_url}">Here\'s</a> how to contribute code to the plugin.',
     TRANSLATION_CONTRIBUTION_INFO:
-        'Information on <a href="${translation_contribution_url}">translating the plugin</a> to your language',
+        '<a href="${translation_contribution_url}">Here\'s</a> how to translate the plugin to another language.',
     PROJECT_CONTRIBUTIONS:
         'Raise an issue <a href="${issues_url}">here</a> if you have a feature request or a bug report',
     FOLDERS_TO_IGNORE: "Ignorované složky",
@@ -81,7 +82,7 @@ export default {
     FLASHCARD_EASY_DESC: 'Customize the label for the "Easy" Button',
     FLASHCARD_GOOD_DESC: 'Customize the label for the "Good" Button',
     FLASHCARD_HARD_DESC: 'Customize the label for the "Hard" Button',
-    REVIEW_BUTTON_DELAY: "Button press delay (ms)",
+    REVIEW_BUTTON_DELAY: "Button Press Delay (ms)",
     REVIEW_BUTTON_DELAY_DESC: "Add a delay to the review buttons before they can be pressed again.",
     FLASHCARD_TAGS: "Tag pro kartičky",
     FLASHCARD_TAGS_DESC:
@@ -141,7 +142,7 @@ export default {
     MAX_N_DAYS_REVIEW_QUEUE: "Maximální počet dní zobrazených v pravém panelu",
     MIN_ONE_DAY: "Počet dní musí být minimálně 1.",
     VALID_NUMBER_WARNING: "Prosím zadejte validní číslo.",
-    UI_PREFERENCES: "Předvolby uživatelského rozhraní",
+    UI: "Předvolby uživatelského rozhraní",
     SHOW_STATUS_BAR: "Show status bar",
     SHOW_STATUS_BAR_DESC:
         "Turn this off to hide the flashcard's review status in Obsidian's status bar",
@@ -153,6 +154,7 @@ export default {
         "Vypněte toto, chcete-li sbalit vnořené balíčky na stejné kartě. To je užitečné, pokud máte kartičky, které patří k mnoha balíčkům ve stejném souboru.",
     ALGORITHM: "Algoritmus",
     CHECK_ALGORITHM_WIKI: 'Pro více informací jděte na <a href="${algo_url}">popis algoritmu</a>.',
+    SM2_OSR_VARIANT: "OSR's variant of SM-2",
     BASE_EASE: "Základní složitost",
     BASE_EASE_DESC: "minimum = 130, nejlépe přibližně 250.",
     BASE_EASE_MIN_WARNING: "Základní složitost musí být minimálně 130.",
@@ -169,9 +171,12 @@ export default {
     MAX_LINK_CONTRIB_DESC:
         "Maximální příspěvek vážené složitosti prolinkovaných poznámek použitý pro určení počáteční složitosti.",
     LOGGING: "Zaznamenávám",
-    DISPLAY_DEBUG_INFO: "Zobrazit informace pro ladění na vývojářské konzoli",
-    DISPLAY_PARSER_DEBUG_INFO:
-        "Display debugging information for the parser on the developer console",
+    DISPLAY_SCHEDULING_DEBUG_INFO: "Zobrazit informace pro ladění na vývojářské konzoli",
+    DISPLAY_PARSER_DEBUG_INFO: "Show the parser's debugging information on the developer console",
+    SCHEDULING: "Scheduling",
+    EXPERIMENTAL: "Experimental",
+    HELP: "Help",
+    STORE_IN_NOTES: "In the notes",
 
     // sidebar.ts
     NOTES_REVIEW_QUEUE: "Fronta poznámek k revizi",

src/lang/locale/de.ts

@@ -61,6 +61,7 @@ export default {
     GROUP_FLASHCARD_REVIEW: "Flashcard Review",
     GROUP_FLASHCARD_SEPARATORS: "Flashcard Separators",
     GROUP_DATA_STORAGE: "Storage of Scheduling Data",
+    GROUP_DATA_STORAGE_DESC: "Choose where to store the scheduling data",
     GROUP_FLASHCARDS_NOTES: "Flashcards & Notes",
     GROUP_CONTRIBUTING: "Contributing",
     CHECK_WIKI: 'Weitere Informationen gibt es im <a href="${wiki_url}">Wiki</a> (english).',
@@ -69,11 +70,11 @@ export default {
     GITHUB_ISSUES:
         'Raise an issue <a href="${issues_url}">here</a> if you have a feature request or a bug report.',
     GITHUB_SOURCE_CODE:
-        'Project source code available on <a href="${github_project_url}">GitHub</a>',
+        'The project\'s source code is available on <a href="${github_project_url}">GitHub</a>.',
     CODE_CONTRIBUTION_INFO:
-        'Information on <a href="${code_contribution_url}">code contributions</a>',
+        '<a href="${code_contribution_url}">Here\'s</a> how to contribute code to the plugin.',
     TRANSLATION_CONTRIBUTION_INFO:
-        'Information on <a href="${translation_contribution_url}">translating the plugin</a> to your language',
+        '<a href="${translation_contribution_url}">Here\'s</a> how to translate the plugin to another language.',
     PROJECT_CONTRIBUTIONS:
         'Raise an issue <a href="${issues_url}">here</a> if you have a feature request or a bug report',
     FOLDERS_TO_IGNORE: "Ausgeschlossene Ordner",
@@ -157,7 +158,7 @@ export default {
         "Maximale Anzahl anstehender Notizen, die im rechten Fensterbereich angezeigt werden",
     MIN_ONE_DAY: "Anzahl der Tage muss mindestens 1 sein.",
     VALID_NUMBER_WARNING: "Bitte eine gültige Zahl eingeben.",
-    UI_PREFERENCES: "Einstellungen der Benutzeroberfläche",
+    UI: "User Interface",
     SHOW_STATUS_BAR: "Show status bar",
     SHOW_STATUS_BAR_DESC:
         "Turn this off to hide the flashcard's review status in Obsidian's status bar",
@@ -170,6 +171,7 @@ export default {
     ALGORITHM: "Algorithmus",
     CHECK_ALGORITHM_WIKI:
         'Weiterführende Informationen: <a href="${algo_url}">Implementierung des Algorithmus</a> (english).',
+    SM2_OSR_VARIANT: "OSR's variant of SM-2",
     BASE_EASE: "Basis der Schwierigkeit",
     BASE_EASE_DESC: "Minimum ist 130. Empfohlen wird ca. 250.",
     BASE_EASE_MIN_WARNING: "Basis der Schwierigkeit muss mindestens 130 sein.",
@@ -188,9 +190,13 @@ export default {
     MAX_LINK_CONTRIB_DESC:
         "Maximaler Einfluss der Einfachheiten verlinkter Notizen zur gewichteten initialen Einfachheit einer neuen Lernkarte.",
     LOGGING: "Protokollierung",
-    DISPLAY_DEBUG_INFO: "Informationen zum Debugging in der Entwicklerkonsole anzeigen",
+    DISPLAY_SCHEDULING_DEBUG_INFO: "Informationen zum Debugging in der Entwicklerkonsole anzeigen",
     DISPLAY_PARSER_DEBUG_INFO:
         "Informationen zum parser Debugging in der Entwicklerkonsole anzeigen",
+    SCHEDULING: "Scheduling",
+    EXPERIMENTAL: "Experimental",
+    HELP: "Help",
+    STORE_IN_NOTES: "In the notes",
 
     // sidebar.ts
     NOTES_REVIEW_QUEUE: "Anstehende Notizen zur Wiederholung",