Skip to content

Commit

Permalink
Remove settings descriptions from README
Browse files Browse the repository at this point in the history
  • Loading branch information
@JackGruber
JackGruber committed Feb 18, 2024
1 parent 0c2efd8 commit e087ab9
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 42 deletions.
18 changes: 0 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,24 +59,6 @@ The backup started manually by `Create backup` respects all the settings except

Go to `Tools > Options > Backup`

| Option | Description | Default |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------- |
| `Backup path` | Where to save the backups to. <br>This path is exclusive for the Joplin backups, there should be no other data in it when you disable the `Create Subfolder` settings! | |
| `Keep x backups` | How many backups should be kept | `1` |
| `Backups interval in hours` | Create a backup every X hours | `24` |
| `Only on change` | Creates a backup at the specified backup interval only if there was a change to a `note`, `tag`, `resource` or `notebook` | `false` |
| `Password protected backups` | Protect the backups via encrypted Zip archive. | `false` |
| `Logfile` | Loglevel for backup.log | `error` |
| `Create zip archive` | Save backup data in a Zip archive | `No` |
| `Zip compression Level` | Compression level for zip archive archive | `Copy (no compression)` |
| `Temporary export path` | The data is first exported into this path before it is copied to the backup `Backup path`. | `` |
| `Backup set name` | Name of the backup set if multiple backups are to be keep. [Available moment tokens](https://momentjs.com/docs/#/displaying/format/), which can be used with `{<TOKEN>}` | `{YYYYMMDDHHmm}` |
| `Single JEX` | Create only one JEX file for all, this option is recommended to prevent the loss of internal note links or folder structure during a restore! | `true` |
| `Export format` | Selection of the export format of the notes. | `jex` |
| `Command on Backup finish` | Execute command when backup is finished. | |
| `Create Subfolder` | Create a sub folder `JoplinBackup` in the configured `Backup path`. Deactivate only if there is no other data in the `Backup path`! | `true` |
| `Backup plugins` | Backup the plugin folder from the Joplin profile with all installed plugin jpl files. | `true` |

## Keyboard Shortcuts

Under `Options > Keyboard Shortcuts` you can assign a keyboard shortcut for the following commands:
Expand Down
28 changes: 15 additions & 13 deletions src/locales/de_DE.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,27 +20,28 @@
},
"settings": {
"path": {
"label": "Sicherungs Pfad"
"label": "Sicherungs Pfad",
"description": "Speicherort für die Backups. "
},
"exportPath": {
"label": "Temporärer Export Pfad",
"description": "Temporärer Pfad für die Notizen währen des Exports, bevor diese in den Sicherungs Pfad verschoben werden"
"description": "Temporärer Pfad für den Datenexport aus Joplin, bevor die Daten in den %s verschoben werden"
},
"backupRetention": {
"label": "Behalte x Sicherungen",
"description": "Wenn mehr als eine Version konfiguriert ist, werden die Ordner im Sicherungspfad entsprechend der Einstellung `Sicherungsset Namen` erstellt"
"description": "Wie viele Sicherungen aufbewahrt werden sollen. Wenn mehr als eine Version konfiguriert ist, werden die Ordner im Sicherungspfad entsprechend der Einstellung 'Sicherungsset Namen' erstellt"
},
"backupInterval": {
"label": "Sicherungsinterval in Stunden",
"description": "0 = Automatisches Sicherung ist deaktivert"
},
"onlyOnChange": {
"label": "Nur bei änderung",
"description": "Erstellt eine Sicherung im angegebenen Sicherungsintervall nur dann, wenn es eine Änderung in den Notizen gab"
"description": "Erstellt eine Sicherung im angegebenen Sicherungsintervall nur dann, wenn es eine Änderung in den Notizen, Tags, Dateien oder Notizbücher gab"
},
"usePassword": {
"label": "Passwort geschütztes Sicherung",
"description": "Die Sicherung wird mittels verschlüsseltem ZIP Archive geschützt"
"description": "Die Sicherung wird mittels verschlüsseltem Archive geschützt"
},
"password": {
"label": "Passwort",
Expand All @@ -51,35 +52,36 @@
"description": "Wiederholen Sie das Passwort, um dieses zu bestätigen"
},
"fileLogLevel": {
"label": "Protokollierungsebene"
"label": "Protokollierungsebene",
"description": "Protokollierungsebene für die Backup Logdatei"
},
"createSubfolder": {
"label": "Erstellen eines Unterordners",
"description": "Erstellt einen Unterordner im konfigurierten `Sicherungs Pfad`. Nur deaktivieren, wenn sich keine weiteren Daten im `Sicherungs Pfad` befinden!"
"description": "Erstellt einen Unterordner im konfigurierten %s. Nur deaktivieren, wenn sich keine weiteren Daten im %s befinden!"
},
"zipArchive": {
"label": "Erstelle ein ZIP-Archive",
"description": "Wenn ein Passwortschutz für die Sicherung eingestellt ist, wird immer ein Zip-Archiv erstellt"
"label": "Erstelle ein Archive",
"description": "Backup Daten in einem Archiv speichern, wenn ein Passwortschutz für die Sicherung eingestellt ist wird immer ein Archiv erstellt"
},
"compressionLevel": {
"label": "ZIP Komprimierungsgrad",
"description": "Komprimierungsgrad für das ZIP-Archiv"
"description": "Komprimierungsgrad für das Archiv"
},
"backupSetName": {
"label": "Sicherungsset Namen",
"description": "Name des Sicherungssatzes, wenn mehrere Sicherungen aufbewahrt werden sollen"
"description": "Name des Sicherungssatzes, wenn mehrere Sicherungen aufbewahrt werden sollen. Moment Token (https://momentjs.com/docs/#/displaying/format/) können mittels {TOKEN} verwendet werden"
},
"backupPlugins": {
"label": "Plugins sichern",
"description": "Plugin jpl Dateien mit sichern (Es werden keine Plugin Einstellungen gesichert!)"
},
"exportFormat": {
"label": "Export Format",
"description": "Sicherungsformat für die Notizen"
"description": "Joplin Datenexportformat während der Sicherung"
},
"singleJex": {
"label": "Eine JEX Datei",
"description": "Erstellen nur eine JEX-Datei für alle Notizbücher (empfohlen, um den Verlust von internen Notizverknüpfungen und der Ordnerstruktur zu vermeiden)"
"description": "Erstellt nur eine JEX Datei (Empfohlen, um den Verlust interner Notizverknüpfungen oder der Ordnerstruktur bei einer Wiederherstellung zu vermeiden!)"
},
"execFinishCmd": {
"label": "Befehl nach der Sicherung",
Expand Down
22 changes: 12 additions & 10 deletions src/locales/en_US.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,24 @@
},
"settings": {
"path": {
"label": "Backup path"
"label": "Backup path",
"description": "Storage location for the backups. Dieser Pfad ist exklusiv für die Joplin Backups, es sollten sich keine anderen Daten darin befinden, wenn die Einstellungen für 'Unterordner erstellen' deaktiviert wird!"
},
"exportPath": {
"label": "Temporary export path",
"description": "Temporary path for note export from Joplin, before they are copyed to backup destination"
"description": "Temporary path for data export from Joplin, before the data is moved to the backup path"
},
"backupRetention": {
"label": "Keep x backups",
"description": "If more than one version is configured, folders are created in the Backup Path acording to backupSetName setting"
"description": "How many backups should be kept. If more than one version configured, folders are created in the Backup Path acording to 'Backup set name' setting"
},
"backupInterval": {
"label": "Backup interval in hours",
"description": "0 = disable automatic backup"
},
"onlyOnChange": {
"label": "Only on change",
"description": "Creates a backup at the specified backup interval only if there was a change"
"description": "Creates a backup at the specified backup interval only if there was a change to a `note`, `tag`, `resource` or `notebook`"
},
"usePassword": {
"label": "Password protected backups",
Expand All @@ -51,35 +52,36 @@
"description": "Repeat password to validate"
},
"fileLogLevel": {
"label": "Loglevel"
"label": "Loglevel",
"description": "Loglevel for the backup logfile"
},
"createSubfolder": {
"label": "Create Subfolder",
"description": "Create a subfolder in the the configured `Backup path`. Deactivate only if there is no other data in the `Backup path`!"
"description": "Create a subfolder in the the configured {{backupPath}}. Deactivate only if there is no other data in the {{backupPath}}!"
},
"zipArchive": {
"label": "Create archive",
"description": "If a password protected backups is set, an archive is always created"
"description": "Save backup data in a archive, if a password protected backups is set, an archive is always created"
},
"compressionLevel": {
"label": "Compression level",
"description": "Compression level for archive"
},
"backupSetName": {
"label": "Backup set name",
"description": "Name of the backup set if multiple backups are to be keep"
"description": "Name of the backup set if multiple backups are to be kept. Moment Token (https://momentjs.com/docs/#/displaying/format/) can be used with {TOKEN}"
},
"backupPlugins": {
"label": "Backup plugins",
"description": "Backup plugin jpl files (No plugin settings!)"
},
"exportFormat": {
"label": "Export format",
"description": "Backup format for the notes"
"description": "Joplin data export format during the backup"
},
"singleJex": {
"label": "Single JEX",
"description": "Create only one JEX file for all notebooks (Recommended to prevent the loss of internal note links and folder structure)"
"description": "Create only one JEX file (Recommended to prevent the loss of internal note links or folder structure during a restore!)"
},
"execFinishCmd": {
"label": "Command on Backup finish",
Expand Down
6 changes: 5 additions & 1 deletion src/settings.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ export namespace Settings {
section: "backupSection",
public: true,
label: i18n.__("settings.path.label"),
description: i18n.__("settings.path.description"),
};

let exportPathSettings = null;
Expand Down Expand Up @@ -119,6 +120,7 @@ export namespace Settings {
isEnum: true,
public: true,
label: i18n.__("settings.fileLogLevel.label"),
description: i18n.__("settings.fileLogLevel.description"),
options: {
false: "Off",
verbose: "Verbose",
Expand All @@ -134,7 +136,9 @@ export namespace Settings {
public: true,
advanced: true,
label: i18n.__("settings.createSubfolder.label"),
description: i18n.__("settings.createSubfolder.description"),
description: i18n.__("settings.createSubfolder.description", {
backupPath: i18n.__("settings.path.label"),
}),
},
zipArchive: {
value: "no",
Expand Down

0 comments on commit e087ab9

Please sign in to comment.