From ac0d01b7247aa3ab2731a29820156ab4fd9773f6 Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Sun, 7 Jun 2020 13:02:58 +0100 Subject: [PATCH] Doc: Fixes #3330: Fixed various links in doc --- ReactNativeClient/lib/models/Resource.js | 2 +- Tools/build-website.js | 5 +- docs/conflict/index.html | 392 +++++++++++++++++++++++ docs/index.html | 2 +- 4 files changed, 397 insertions(+), 4 deletions(-) create mode 100644 docs/conflict/index.html diff --git a/ReactNativeClient/lib/models/Resource.js b/ReactNativeClient/lib/models/Resource.js index daf625c60..a4cbba357 100644 --- a/ReactNativeClient/lib/models/Resource.js +++ b/ReactNativeClient/lib/models/Resource.js @@ -369,7 +369,7 @@ class Resource extends BaseItem { await Note.save({ title: _('Attachment conflict: "%s"', resource.title), - body: _('There was a [conflict](%s) on the attachment below.\n\n%s', 'https://joplinapp.org/conflict', Resource.markdownTag(conflictResource)), + body: _('There was a [conflict](%s) on the attachment below.\n\n%s', 'https://joplinapp.org/conflict/', Resource.markdownTag(conflictResource)), is_conflict: 1, }, { changeSource: ItemChange.SOURCE_SYNC }); } diff --git a/Tools/build-website.js b/Tools/build-website.js index 72b013d39..c56b2ea51 100644 --- a/Tools/build-website.js +++ b/Tools/build-website.js @@ -505,8 +505,8 @@ function tocMd() { } function replaceGitHubByJoplinAppLinks(md) { - let output = md.replace(/https:\/\/github.com\/laurent22\/joplin\/blob\/master\/readme\/(.*)\/index\.md(#[^\s)]+|)/g, 'https://joplinapp.org/$1'); - output = output.replace(/https:\/\/github.com\/laurent22\/joplin\/blob\/master\/readme\/(.*)\.md(#[^\s)]+|)/g, 'https://joplinapp.org/$1/$2'); + let output = md.replace(/https:\/\/github.com\/laurent22\/joplin\/blob\/master\/readme\/(.*?)\/index\.md(#[^\s)]+|)/g, 'https://joplinapp.org/$1'); + output = output.replace(/https:\/\/github.com\/laurent22\/joplin\/blob\/master\/readme\/(.*?)\.md(#[^\s)]+|)/g, 'https://joplinapp.org/$1/$2'); return output; } @@ -587,6 +587,7 @@ async function main() { ['readme/api.md', 'docs/api/index.html', { title: 'REST API' }], ['readme/prereleases.md', 'docs/prereleases/index.html', { title: 'Pre-releases' }], ['readme/markdown.md', 'docs/markdown/index.html', { title: 'Markdown Guide' }], + ['readme/conflict.md', 'docs/conflict/index.html', { title: 'What is a conflict?' }], ['readme/nextcloud_app.md', 'docs/nextcloud_app/index.html', { title: 'Joplin Web API for Nextcloud' }], ['readme/gsoc2020/index.md', 'docs/gsoc2020/index.html', { title: 'Google Summer of Code' }], diff --git a/docs/conflict/index.html b/docs/conflict/index.html new file mode 100644 index 000000000..09470266b --- /dev/null +++ b/docs/conflict/index.html @@ -0,0 +1,392 @@ + + + + + + + What is a conflict? | Joplin + + + + + + + + + + + + + +
+ +
+ +

Joplin

 +

An open source note taking and to-do application with synchronisation capabilities

+
+ +
+
+ +
+ + +
+
+
+ +
+ +

What is a conflict?🔗

+

A conflict happens when one note or one attachment is modified in two different places, and then synchronised. In that case, it not possible to determine which version of the note or attachment you want to keep, and thus a conflict is generated.

+

What happens in case of a conflict?🔗

+

When Joplin detects a conflict, the local note is copied to the Conflict notebook so as to avoid any data loss. Then the remote note is downloaded. You can then inspect the notes in the Conflict notebook, compare it with your other version, and copy any change that might have been overwritten.

+

How to avoid conflicts?🔗

+

Conflicts are always annoying to deal with so it is best to avoid them as much as possible.

+

For this, the best way is to synchronise as often as possible, so that you are always working with the latest versions of your notes.

+

Joplin attempts to do this by uploading your latest changes within a few seconds. However, downloading changes is done at fixed intervals, every few minutes (as defined in the Config screen) and this is where conflicts may happen. It can also happen if one of your device did not have an internet connection for some times, and then synchronises. A bad internet connection can also hinder synchronisation because it will interrupt the process, which may have to restarted from the beginning to ensure consistency.

+

So if you have not opened your application in a while, manually sync it and wait for it to complete, that way you are sure that whatever change you make will be on the latest version of the note.

+ +
+ + Improve this doc + +
+ + +
+Copyright (c) 2016-2020 Laurent Cozic +
+ + diff --git a/docs/index.html b/docs/index.html index 1b642d4b3..925d816a3 100644 --- a/docs/index.html +++ b/docs/index.html @@ -494,7 +494,7 @@ https://github.com/laurent22/joplin/blob/master/README.md

Importing from Markdown files🔗

Joplin can import notes from plain Markdown file. You can either import a complete directory of Markdown files or individual files.

In the desktop application, open File > Import > MD and select your Markdown file or directory.

-

In the terminal application, in command-line mode, type import --format md /path/to/file/ or import --format md /path/to/directory/.

+

In the terminal application, in command-line mode, type import --format md /path/to/file.md or import --format md /path/to/directory/.

Importing from other applications🔗

In general the way to import notes from any application into Joplin is to convert the notes to ENEX files (Evernote format) and to import these ENEX files into Joplin using the method above. Most note-taking applications support ENEX files so it should be relatively straightforward. For help about specific applications, see below: