Added descriptions to settings

src/common/translation/english-translation-set.ts

@@ -68,6 +68,7 @@ export const englishTranslationSet: TranslationSet = {
     colorPicker: "Color picker",
 
     applicationSearchSettings: "Application Search",
+    applicationSearchSettingsDescription: `This plugin is searching for applications on your computer. You can specify the folders where your applications are installed and which file extension should be used to recognize an application.`,
     applicationSearchSettingsApplicationFolders: "Application folders",
     applicationSearchSettingsApplicationFolder: "Application folder",
     applicationSearchSettingsFolderPath: "Folder path",
@@ -82,13 +83,15 @@ export const englishTranslationSet: TranslationSet = {
     applicationSearchSettingsFolderValidationError: `An error occured while trying to validate "{{value}}"`,
 
     searchEngineSettings: "Search engine",
+    searchEngineSettingsDescription: `The search engine is used for preindexed items like applications, shortcuts and operating system settings/commands.`,
     searchEngineSettingsFuzzyness: "Fuzzyness",
     searchEngineSettingsFuzzynessDescription: "0 = strict, 1 = fuzzy",
     searchEngineSettingsStrict: "Strict",
     searchEngineSettingsFuzzy: "Fuzzy",
     searchEngineSettingsMaxSearchResults: "Max search results",
 
     shortcutSettings: "Shorcuts",
+    shortcutSettingsDescription: `This plugin enables you to quickly open files or websites by setting up your own shortcuts.`,
     shortcutSettingsShortcut: "Shortcuts",
     shortcutSettingsTableType: "Type",
     shortcutSettingsTableName: "Name",
@@ -110,24 +113,28 @@ export const englishTranslationSet: TranslationSet = {
     shortcutSettingsTypeFilePath: "File path",
 
     translationSettingsTranslation: "Translation",
+    translationSettingsDescription: `This plugin enables you to quickly translate words or short sentences. It uses an unofficial API (https://github.com/imankulov/linguee-api) for Linguee (https://linguee.de) and may be unstable.`,
     translationSettingsDebounceDelay: "Debounce delay (in milliseconds)",
     translationSettingsMinSearchTermLength: "Min search term length",
     translationSettingsPrefix: "Prefix",
     translationSettingsSourceLanguage: "Source language",
     translationSettingsTargetLanguage: "Target language",
 
     everythingSearch: "Everything search",
+    everythingSearchSettingDescription: `This plugin enables you to use Everything search to find files and folders on your local file system. You have to install "Everything" and the "Everything Command-line Interface" from https://www.voidtools.com/downloads/. After installing both you have to specify the file path to 'es.exe' below.`,
     everythingSearchPathToBinary: `Path to "es.exe"`,
     everythingSearchPrefix: "Prefix",
     everythingSearchMaxSearchResults: "Max search results",
     everythingSearchPathToBinaryFilterName: "Executable files",
 
     mdfindSearch: "mdfind search",
+    mdfindSettingsDescription: "This plugin enables you to use the native macOS search to find files and folders on your local file system.",
     mdfindSearchDebounceDelay: "Debounce delay (in milliseconds)",
     mdfindSearchPrefix: "Prefix",
     mdfindSearchMaxSearchResults: "Max search results",
 
     websearch: "Web search",
+    websearchSettingDescription: `This plugin enables you to quickly search the internet with your favorite web search engine by setting up your own web search engines.`,
     websearchEngines: "Web search engines",
     websearchEditingModalTitleAdd: "Add web search engine",
     websearchEditingModalTitleEdit: "Edit web search engine",
@@ -142,12 +149,14 @@ export const englishTranslationSet: TranslationSet = {
     websearchDescription: `Search on {{websearch_engine}} for "{{search_term}}"`,
 
     fileBrowser: "File Browser",
+    fileBrowserSettingsDescription: `This plugin enables you to browse through your local file system. To start you have to enter a valid absolute filepath.`,
     fileBrowserSettingsMaxSearchResults: "Max search results",
     fileBrowserOptionsShowHiddenFiles: "Show hidden files",
     fileBrowserOptionsBlackList: "Blacklist",
     fileBrowserOptionsBlackListPlaceholder: "File or folder name",
 
     operatingSystemCommands: "Operating system commands",
+    operatingSystemCommandsSettingsDescription: `Operating system commands are simple commands to control your operating system e.g. to shutdown or restart your computer.`,
 
     macOsShutdown: "Shut Down",
     macOsShutdownDescription: "Shut down computer",

src/common/translation/german-translation-set.ts

@@ -68,6 +68,7 @@ export const germanTranslationSet: TranslationSet = {
     colorPicker: "Farbwähler",
 
     applicationSearchSettings: "Programmsuche",
+    applicationSearchSettingsDescription: `Dieses Plugin sucht nach Programmen auf deinem Computer. Du kannst Ordner definieren, wo nach Applikationen gesucht werden soll und anhand welcher Dateiendung ein Programm erkennt werden soll.`,
     applicationSearchSettingsApplicationFolders: "Programmverzeichnisse",
     applicationSearchSettingsApplicationFolder: "Programmverzeichnis",
     applicationSearchSettingsFolderPath: "Ordnerpfad",
@@ -82,13 +83,15 @@ export const germanTranslationSet: TranslationSet = {
     applicationSearchSettingsFolderValidationError: `Während der Validierung von "{{value}}" ist ein Fehler aufgetreten`,
 
     searchEngineSettings: "Suchmaschine",
+    searchEngineSettingsDescription: `Die Suchmaschine wird für vorindexierte Inhalte benutzt, z.B. Programme, Shortcuts und Betriebssystembefehle und -einstellungen.`,
     searchEngineSettingsFuzzyness: "Fuzzyness",
     searchEngineSettingsFuzzynessDescription: "0 = strikt, 1 = fuzzy",
     searchEngineSettingsStrict: "Strikt",
     searchEngineSettingsFuzzy: "Fuzzy",
     searchEngineSettingsMaxSearchResults: "Maximale Suchergebnisse",
 
     shortcutSettings: "Shorcuts",
+    shortcutSettingsDescription: `Dieses Plugin erlaubt es dir Dateien und Webseiten schnell zu öffnen indem du eigene Shorctus erstellst.`,
     shortcutSettingsShortcut: "Shortcuts",
     shortcutSettingsTableType: "Typ",
     shortcutSettingsTableName: "Name",
@@ -110,24 +113,28 @@ export const germanTranslationSet: TranslationSet = {
     shortcutSettingsTypeFilePath: "Dateipfad",
 
     translationSettingsTranslation: "Übersetzung",
+    translationSettingsDescription: `Dieses Plugin erlaubt es dir schnell Wörter und kurze Sätze zu übersetzen. Es benutzt eine inoffizielle API (https://github.com/imankulov/linguee-api) für Linguee (https://github.com/imankulov/linguee-api) und kann daher instabil sein.`,
     translationSettingsDebounceDelay: "Debounce Verzögerung (in Millisekunden)",
     translationSettingsMinSearchTermLength: "Minimum Suchbegrifflänge",
     translationSettingsPrefix: "Präfix",
     translationSettingsSourceLanguage: "Quellsprache",
     translationSettingsTargetLanguage: "Zielsprache",
 
     everythingSearch: "Everything Suche",
+    everythingSearchSettingDescription: `Dieses Plugin erlaubt es dir lokale Dateien und Ordner mit Everthing search zu finden. Du musst "Everything" und "Everything Command-line Interface" von https://www.voidtools.com/downloads/ installieren. Nachdem beides installiert ist musst du den Dateipfad zu 'es.exe' unten angeben.`,
     everythingSearchPathToBinary: `Dateipfad zu "es.exe"`,
     everythingSearchPrefix: "Präfix",
     everythingSearchMaxSearchResults: "Maximale Suchergebnisse",
     everythingSearchPathToBinaryFilterName: "Ausführbare Dateien",
 
     mdfindSearch: "mdfind Suche",
+    mdfindSettingsDescription: "Dieses Plugin erlaubt es dir mithilfe der nativen macOS-Suche Dateien und Ordner in deinem lokalen Dateisystem zu finden.",
     mdfindSearchDebounceDelay: "Debounce Verzögerung (in Millisekunden)",
     mdfindSearchPrefix: "Präfix",
     mdfindSearchMaxSearchResults: "Maximale Suchergebnisse",
 
     websearch: "Websuche",
+    websearchSettingDescription: `Dieses Plugin erlaubt es dir schnell das Internet mit deiner Lieblings-Websuchmaschine zu durchsuchen, indem du deine eigenen Websuchamschinen erstellst.`,
     websearchEngines: "Websuchmaschinen",
     websearchEditingModalTitleAdd: "Websuchmaschine hinzufügen",
     websearchEditingModalTitleEdit: "Websuchmaschine bearbeiten",
@@ -142,12 +149,14 @@ export const germanTranslationSet: TranslationSet = {
     websearchDescription: `Suche auf {{websearch_engine}} nach "{{search_term}}"`,
 
     fileBrowser: "Dateibrowser",
+    fileBrowserSettingsDescription: `Dieses Plugin erlaubt es dir dein lokales Dateisystem zu durchsuchen. Um zu starten musst du einen validen absoluten Dateipfad angeben.`,
     fileBrowserSettingsMaxSearchResults: "Maximale Suchergebnisse",
     fileBrowserOptionsShowHiddenFiles: "Versteckte Dateien anzeigen",
     fileBrowserOptionsBlackList: "Blacklist",
     fileBrowserOptionsBlackListPlaceholder: "Datei- oder Ordnername",
 
     operatingSystemCommands: "Betriebssystembefehle",
+    operatingSystemCommandsSettingsDescription: `Betriebssystembefehle sind simple Befehle um das Betriebssystem zu steuern, z.B. Herunterfahren, Neustart.`,
 
     macOsShutdown: "Ausschalten",
     macOsShutdownDescription: "Computer ausschalten",

src/common/translation/translation-set.ts

@@ -65,6 +65,7 @@ export interface TranslationSet {
     colorPicker: string;
 
     applicationSearchSettings: string;
+    applicationSearchSettingsDescription: string;
     applicationSearchSettingsApplicationFolders: string;
     applicationSearchSettingsApplicationFolder: string;
     applicationSearchSettingsFolderPath: string;
@@ -79,13 +80,15 @@ export interface TranslationSet {
     applicationSearchSettingsFolderValidationError: string;
 
     searchEngineSettings: string;
+    searchEngineSettingsDescription: string;
     searchEngineSettingsFuzzyness: string;
     searchEngineSettingsFuzzynessDescription: string;
     searchEngineSettingsStrict: string;
     searchEngineSettingsFuzzy: string;
     searchEngineSettingsMaxSearchResults: string;
 
     shortcutSettings: string;
+    shortcutSettingsDescription: string;
     shortcutSettingsShortcut: string;
     shortcutSettingsTableType: string;
     shortcutSettingsTableName: string;
@@ -107,24 +110,28 @@ export interface TranslationSet {
     shortcutSettingsTypeFilePath: string;
 
     translationSettingsTranslation: string;
+    translationSettingsDescription: string;
     translationSettingsDebounceDelay: string;
     translationSettingsMinSearchTermLength: string;
     translationSettingsPrefix: string;
     translationSettingsSourceLanguage: string;
     translationSettingsTargetLanguage: string;
 
     everythingSearch: string;
+    everythingSearchSettingDescription: string;
     everythingSearchPathToBinary: string;
     everythingSearchPrefix: string;
     everythingSearchMaxSearchResults: string;
     everythingSearchPathToBinaryFilterName: string;
 
     mdfindSearch: string;
+    mdfindSettingsDescription: string;
     mdfindSearchDebounceDelay: string;
     mdfindSearchPrefix: string;
     mdfindSearchMaxSearchResults: string;
 
     websearch: string;
+    websearchSettingDescription: string;
     websearchEngines: string;
     websearchEditingModalTitleAdd: string;
     websearchEditingModalTitleEdit: string;
@@ -139,12 +146,14 @@ export interface TranslationSet {
     websearchDescription: string;
 
     fileBrowser: string;
+    fileBrowserSettingsDescription: string;
     fileBrowserSettingsMaxSearchResults: string;
     fileBrowserOptionsShowHiddenFiles: string;
     fileBrowserOptionsBlackList: string;
     fileBrowserOptionsBlackListPlaceholder: string;
 
     operatingSystemCommands: string;
+    operatingSystemCommandsSettingsDescription: string;
 
     macOsShutdown: string;
     macOsShutdownDescription: string;

src/renderer/settings/application-search-options-component.ts

@@ -110,6 +110,7 @@ export const applicationSearchSettingsComponent = Vue.extend({
                     </button>
                 </div>
             </div>
+            <p class="settings__setting-description" v-html="translations.applicationSearchSettingsDescription"></p>
             <div class="settings__setting-content">
                 <div v-if="!config.applicationSearchOptions.enabled" class="settings__setting-disabled-overlay"></div>
                 <div class="settings__setting-content-item box">

src/renderer/settings/everything-settings-component.ts

@@ -86,6 +86,7 @@ export const everythingSettingsComponent = Vue.extend({
                     </button>
                 </div>
             </div>
+            <p class="settings__setting-description" v-html="translations.everythingSearchSettingDescription"></p>
             <div class="settings__setting-content">
                 <div v-if="!config.everythingSearchOptions.enabled" class="settings__setting-disabled-overlay"></div>
                 <div class="settings__setting-content-item box">

src/renderer/settings/filebrowser-settings-component.ts

@@ -68,6 +68,7 @@ export const fileBrowserSettingsComponent = Vue.extend({
                 </button>
             </div>
         </div>
+        <p class="settings__setting-description" v-html="translations.fileBrowserSettingsDescription"></p>
         <div class="settings__setting-content">
             <div v-if="!config.fileBrowserOptions.isEnabled" class="settings__setting-disabled-overlay"></div>
             <div class="box">

src/renderer/settings/mdfind-settings-component.ts

@@ -54,6 +54,7 @@ export const mdfindSettingsComponent = Vue.extend({
                     </button>
                 </div>
             </div>
+            <p class="settings__setting-description" v-html="translations.mdfindSettingsDescription"></p>
             <div class="settings__setting-content" >
                 <div v-if="!config.mdfindOptions.enabled" class="settings__setting-disabled-overlay"></div>
                 <div class="box">

src/renderer/settings/operating-system-commands-settings-component.ts

@@ -55,6 +55,7 @@ export const operatingSystemCommandsSettingsComponent = Vue.extend({
                 </button>
             </div>
         </div>
+        <p class="settings__setting-description" v-html="translations.operatingSystemCommandsSettingsDescription"></p>
     </div>
     `,
 });

src/renderer/settings/search-engine-settings-component.ts

@@ -43,6 +43,7 @@ export const searchEngineSettingsComponent = Vue.extend({
                 <span class="icon"><i class="fas fa-undo-alt"></i></span>
             </button>
         </div>
+        <p class="settings__setting-description" v-html="translations.searchEngineSettingsDescription"></p>
         <div class="settings__setting-content">
             <div class="box">
                 <div class="settings__options-container">

src/renderer/settings/shortcut-settings-component.ts

@@ -118,6 +118,7 @@ export const shortcutSettingsComponent = Vue.extend({
                     </button>
                 </div>
             </div>
+            <p class="settings__setting-description" v-html="translations.shortcutSettingsDescription"></p>
             <div class="settings__setting-content">
                 <div v-if="!config.shortcutOptions.isEnabled" class="settings__setting-disabled-overlay"></div>
                 <div class="settings__setting-content-item box">

src/renderer/settings/translation-settings-component.ts

@@ -56,6 +56,7 @@ export const translationSettingsComponent = Vue.extend({
                     </button>
                 </div>
             </div>
+            <p class="settings__setting-description" v-html="translations.translationSettingsDescription"></p>
             <div class="settings__setting-content">
                 <div v-if="!config.translationOptions.enabled" class="settings__setting-disabled-overlay"></div>
                 <div class="box">

src/renderer/settings/websearch-settings-component.ts

@@ -94,6 +94,7 @@ export const webSearchSettingsComponent = Vue.extend({
                 </button>
             </div>
         </div>
+        <p class="settings__setting-description" v-html="translations.websearchSettingDescription"></p>
         <div class="settings__setting-content">
             <div v-if="!config.websearchOptions.isEnabled" class="settings__setting-disabled-overlay"></div>
             <div class="settings__setting-content-item box">

styles/settings.css

@@ -33,6 +33,10 @@ html {
     align-items: center;
 }
 
+.settings__setting-description {
+    margin-bottom: 1.5rem;
+}
+
 .settings__setting-content {
     position: relative;
 }