Documentation update (released version v1.5.14) #4306

Daeraxa · 2021-01-05T13:26:45Z

Originally just related to questions and summary in this thread: https://discourse.joplinapp.org/t/how-to-save-pdf-to-joplin/13507/30?u=daeraxa but went through and checked a number of other docs that seemed like they could use an update either because of new features in the application or based on questions/issues raised in the forums.

I've done my best to test any new links etc. but please let me know if you find anything that needs to be fixed or if any other changes need to be made because it doesn't fit a given standard or some other kind of technical issue regarding publishing the docs to the website etc.

Altered readme.md:

Some generic punctuation and grammar chages
Some changes to generic terminology not reflected in application (e.g. Config screen -> Options screen)
Added (x86) after Linux in ## Desktop applications (as it does not currently work natively on ARM)
Added items to 'features' section
Added HTML import info to 'Importing > Importing from Evernote'
Added additional detail to 'Importing > Importing from Markdown files'
Added details of other export format options to 'Exporting'
Updated 'Synchronisation' with WebDAV + extra info about sync intervals + background syncing on content change
Moved details of terminal/cron sync from 'Dropbox' to main 'Synchronisation' heading as instructions are not Dropbox specific
Moved 'WebDAV synchronisation' directly below Nextcloud due to it referencing the instructions directly
Updated 'WebDAV synchronisation' to select sync target 6 rather than copy target 5 from Nextcloud setup
Changed link to Note attachments readme to /readne/note_hisotory.md file (new)
Added reference to inline display of items in 'Attachments'
Added file path for 'Note templates' section for those who might not be familiar with the config directory
Added 'plugins' section with short guide on how to install, turn off/on plugins, where they can be found and potential danger of installing them. As this is still beta functionality I understand if this section should not exist until it is out of beta.
- Further changes made on revision to alter "Tools > Options" to be more generic in some places (Settings) and more specific in others to make sure both Win/Linux + macOS is referenced.
- Software links were for 1.5.11 (desktop) and 1.4.11 (android apk), these have been updated to 1.5.14 and 1.5.1 respectively

Created /readme/note_history.md

Currently links to a Patreon blog post. Took the file from https://github.com/laurent22/joplin/blob/dev/readme/blog/20190523-231026.md and slightly altered it. Images still point to original .png files in /blog/images. Makes sense to have it as its own section, particularly if additional features are planned (e.g recycle bin)
- Updated for same reason as readme to remove platform specific references to menus

Updated readme/nextcloud_app.md

Added Link to new Joplin server announcement

Updated readme/plugins.md

Fleshed out advice to bring it inline with current plugin functionality
Added section on where to find plugins (currently - should be updated when proper repo is created)
Added simple instructions on how to install/manage/uninstall plugins
Added development section with a link to Joplin API overview page
- Updated for same reason as readme to remove platform specific references to menus

Updated readme/terminal.md

Updated sections (synchronisation, WebDAV synchronsiation, Dropbox synchronisation and OneDrive synchronisation) to align with the sync information in the readme.md
Updated languages, removed completion % in favour of a link to the main readme language section
Updated copyright to 2021
- Further changes made on revision to remove list and simply link to readme.md

Updated readme/rich_text_editor.md

Added limitation regarding HTML formatting tags being lost when edited in rich text editor

Updated readme/faq.md

Added section for known problematic WebDAV hosts

Updated readme//welcome/3_synchronising_your_notes.md

Changed link for sync info from export section to synchronisation section

tessus · 2021-01-05T17:08:45Z

I like the changes so far. I'm going to read all of it this evening.

tessus

Sorry that it took a bit longer. I've added my comments inline.

README.md

readme/terminal.md

tessus · 2021-01-07T00:37:55Z

readme/terminal.md

+ Possible values: ar (Arabic), eu (Basque),
+ bs_BA (Bosnian), bg_BG (Bulgarian),
+ ca (Catalan), hr_HR (Croatian),
+ cs_CZ (Czech), da_DK (Dansk),
+ de_DE (Deutsch), et_EE (Eesti Keel),
+ en_GB (English (UK)), en_US (English (US)),
+ es_ES (Español), eo (Esperanto),
+ fi_FI (Finnish), fr_FR (Français),
+ gl_ES (Galician), id_ID (Indonesian),
+ it_IT (Italiano), nl_BE (Nederlands),
+ nl_NL (Nederlands), nb_NO (Norwegian),
+ fa (Persian), pl_PL (Polski),
+ pt_PT (Português),
+ pt_BR (Português (Brasil)), ro (Română),
+ sl_SI (Slovenian), sv (Svenska), 
+ th_TH (Thai), vi (Tiếng Việt),
+ tr_TR (Türkçe), el_GR (Ελληνικά),
+ ru_RU (Русский), sr_RS (српски језик),
+ zh_CN (中文 (简体)), zh_TW (中文 (繁體)),
+ ja_JP (日本語), ko (한국말).


It could very well be that these are generated.

Not sure. If not, I'm ok with removing the percentages here, since we already have them in the README.

@laurent22 what do you think?

I added a bunch into here that were present in the README but not the old file (e.g. vi and id_ID) so if it is auto generated then there is something not syncing up unless they only show above a certain % completion?

I don't think it is auto-synced, because every time I generate the translations, only the README is updated. So I think this is a good change. There's no reason to have the percentages in the terminal.md file as well.

I just wanted to confirm with Laurent.

Yes, we shouldn't update this part manually as this whole section is updated with the content of joplin help all. So most likely the languages are out-dated but also other commands. So everything should be updated in one go (either in this pull request or later on).

tessus · 2021-01-07T00:39:27Z

README.md

@@ -308,15 +319,15 @@ Joplin uses and renders a Github-flavoured Markdown with a few variations and ad

 # Custom CSS

-Rendered markdown can be customized by placing a userstyle file in the profile directory `~/.config/joplin-desktop/userstyle.css` (This path might be different on your device - check at the top of the Config screen for the exact path). This file supports standard CSS syntax. Joplin ***must*** be restarted for the new css to be applied, please ensure that Joplin is not closing to the tray, but is actually exiting. Note that this file is used for both displaying the notes and printing the notes. Be aware how the CSS may look printed (for example, printing white text over a black background is usually not wanted).
+Rendered markdown can be customized by placing a userstyle file in the profile directory `~/.config/joplin-desktop/userstyle.css` (This path might be different on your device - check at the top of the Options screen (Tools > Options)) for the exact path). This file supports standard CSS syntax. Joplin ***must*** be restarted for the new css to be applied, please ensure that Joplin is not closing to the tray, but is actually exiting. Note that this file is used for both displaying the notes and printing the notes. Be aware how the CSS may look printed (for example, printing white text over a black background is usually not wanted).


Please revert this. On macOS there is no Tools > Options.

I wasn't aware there was a toolbar difference between macOS and Windows/Linux. I might have to dig out an ancient Mac mini that is lying around somewhere and come back to this after using the Mac version to be more familiar with the differences.

On Linux/Windows you go to Tools > Options and on macOS to Joplin > Preferences....

This is the reason why we used a rather general term and wording. Maybe we should use the term settings and explain what the term means (the first time it occurs in the README).

Not sure what the best way is to handle this. I'm open to suggestions.

Yes @tessus is correct, we use relatively generic terms because some parts of the doc apply to macOS or Windows, or sometimes even mobile/desktop/cli.

README.md

tessus · 2021-01-07T00:46:20Z

README.md


 The whole UI can be customized by placing a custom editor style file in the profile directory `~/.config/joplin-desktop/userchrome.css`.

 Important: userstyle.css and userchrome.css are provided for your convenience, but they are advanced settings, and styles you define may break from one version to the next. If you want to use them, please know that it might require regular development work from you to keep them working. The Joplin team cannot make a commitment to keep the application HTML structure stable.

 # Note templates

-In the **desktop app**, templates can be used to create new notes or to insert into existing ones by creating a `templates` folder in Joplin's config folder and placing Markdown template files into it. For example creating the file `hours.md` in the `templates` directory with the contents:
+In the **desktop app**, templates can be used to create new notes or to insert into existing ones by creating a `templates` folder in Joplin's profile directory `~/.config/joplin-desktop/templates` (This path might be different on your device - check at the top of the Options screen (Tools > Options)) and placing your Markdown template files into it. For example creating the file `hours.md` in the `templates` directory with the contents:


Same here. On macOS this is in the menu Joplin > Preferences....

Maybe just mention that the info is in the General tab of the config/settings/preferences/options screen.

laurent22 · 2021-01-07T16:53:27Z

Thanks for the update @Daeraxa, that looks very good. I'll go through the files once you've made the changes suggested by @tessus, as I think there's no much else to change.

tessus · 2021-01-09T00:01:25Z

Whatever you just did makes the PR unreadable. I won't be able to reviewe it like this.

Daeraxa · 2021-01-09T00:01:28Z

Oh dear, I fixed the issues but my inexperience with git is clearly showing (see horrible mess of commits from recent days...). Is it best to just rebase my dev branch and make the changes in a new branch off that? Do I need to close this PR and open a new one to do it?

tessus · 2021-01-09T00:07:39Z

No idea, how to fix this now. There are a few possibilities, but I'm not quite sure what the simplest would be.

You don't have to rebase dev, you just have to pull the latest changes from the remote. Then you can create a new branch off dev and cherry pick your original commits from this branch. I think that's the best option. Please note the the order when cherry-picking is usually important. It should be done chronologically.

Update: What exactly did you do? Maybe there's away to revert this.

Daeraxa · 2021-01-09T00:15:59Z

Update: What exactly did you do? Maybe there's away to revert this.

Honestly not entirely sure. At some point my dev branch got out of sync so I did rebase it to make it completely inline with the main dev branch (no commits ahead or behind). I then branched that out to one called 'docs2' and made the rest of my changes without reverting one or two changes made by other PRs to documentation.
I think my mistake was merging the 'old' docs branch (in the PR) with the 'new' docs2 branch as the first one was out of sync and the 'new' one pushed all the changes made in dev to that older branch. Is there a way to change the branch it is coming from in the PR?

Edit: Just checked the comparison for a PR from my 'docs2' branch (https://github.com/laurent22/joplin/compare/dev...Daeraxa:docs2?expand=1) which looks correct. - Is there a simple way to 'replace' this branch in its entirety with that one without breaking the PR?

tessus · 2021-01-09T00:44:31Z

Is there a simple way to 'replace' this branch in its entirety with that one without breaking the PR?

Not sure how gh handles that. You could try to rename your old branch, rename the new one to match the old name, and then force-push to your fork. Whatever you do, make backups or create temp branches before you do git actions where you are not sure of the outcome. You can also play and manipulate the reflog, but that's rather an advanced topic.

Daeraxa · 2021-01-09T00:52:27Z

I think I fixed it, thank you. I've also updated the original comment with some additional changes - anything as a second level list item is new.

laurent22 · 2021-01-09T01:33:19Z

readme/faq.md

@@ -104,6 +104,10 @@ For example:

 In this case, [make sure you enter the correct WebDAV URL](https://github.com/laurent22/joplin/issues/309).

+### Known problematic/unsupported WebDAV hosts


As this is a faq, please rename to "Why is my WebDAV host not working?". Then below: "The following WebDAV hosts are not supported:"

This is an h3 header underneath the existing '## WebDAV synchronisation is not working' h2 header but I can make both of those changes

Ok so I think you can just name it "Unsupported WebDAV hosts" then and leave the rest as it is.

laurent22 · 2021-01-09T01:35:36Z

README.md

-Windows (32 and 64-bit) | <a href='https://github.com/laurent22/joplin/releases/download/v1.5.11/Joplin-Setup-1.5.11.exe'><img alt='Get it on Windows' width="134px" src='https://joplinapp.org/images/BadgeWindows.png'/></a>
-macOS | <a href='https://github.com/laurent22/joplin/releases/download/v1.5.11/Joplin-1.5.11.dmg'><img alt='Get it on macOS' width="134px" src='https://joplinapp.org/images/BadgeMacOS.png'/></a>
-Linux | <a href='https://github.com/laurent22/joplin/releases/download/v1.5.11/Joplin-1.5.11.AppImage'><img alt='Get it on Linux' width="134px" src='https://joplinapp.org/images/BadgeLinux.png'/></a>
+Windows (32 and 64-bit) | <a href='https://github.com/laurent22/joplin/releases/download/v1.5.14/Joplin-Setup-1.5.14.exe'><img alt='Get it on Windows' width="134px" src='https://joplinapp.org/images/BadgeWindows.png'/></a>
+macOS | <a href='https://github.com/laurent22/joplin/releases/download/v1.5.14/Joplin-1.5.14.dmg'><img alt='Get it on macOS' width="134px" src='https://joplinapp.org/images/BadgeMacOS.png'/></a>
+Linux (x86) | <a href='https://github.com/laurent22/joplin/releases/download/v1.5.14/Joplin-1.5.14.AppImage'><img alt='Get it on Linux' width="134px" src='https://joplinapp.org/images/BadgeLinux.png'/></a>

-**On Windows**, you may also use the <a href='https://github.com/laurent22/joplin/releases/download/v1.5.11/JoplinPortable.exe'>Portable version</a>. The [portable application](https://en.wikipedia.org/wiki/Portable_application) allows installing the software on a portable device such as a USB key. Simply copy the file JoplinPortable.exe in any directory on that USB key ; the application will then create a directory called "JoplinProfile" next to the executable file.
+**On Windows**, you may also use the <a href='https://github.com/laurent22/joplin/releases/download/v1.5.14/JoplinPortable.exe'>Portable version</a>. The [portable application](https://en.wikipedia.org/wiki/Portable_application) allows installing the software on a portable device such as a USB key. Simply copy the file JoplinPortable.exe in any directory on that USB key ; the application will then create a directory called "JoplinProfile" next to the executable file.


Please don't change the version number. Also please remove the (x86) as it's more or less implied since it's the only version.

Is this not an issue? If you click the Android play store link it takes you to the v.1.5.1 updated version but the apk link takes to you an older 1.4.11. Similarly on the desktop links it takes you to the download of the older 1.5.11 version then if you select 'check for updates' you are immediately prompted for 1.5.14 download.
I included x86 because I noticed there have been a number of requests and comments that people have been unable to make it work on Raspberry Pi, Pinebooks etc. but can remove it if required.

Version numbers are updated automatically. Yes please remove the x86 mention, I'm trying to keep this download table simple.

What is updating them automatically, has this broken? As I mentioned, if you look at the readme (+ joplinapp website), the manual download links all reference an old version where the versions downloaded from repositories (linux command line, play store, app store) all link to the newer version.

No, someone has to run a sscript in the pacakages/tools dir. However, we only run this, when there's an official release for desktop.

Then has this not been done? I'll revert the changes now I know that it is auto, my assumption was that it wasn't because of the mismatch of versions between repos and links. 1.5.14 and 1.5.1 are the latest "proper" released versions are they not? As mentioned this is not what the current document links to (for desktop from the joplinapp website). I only noticed this because I downloaded it for my old mac mini I dug out from somewhere and noticed it installed a version I was not expecting.

Apparently we forgot. So after we merge the PR, we update it. That is what Laurent was saying, also in rwference to the terminal.md file, when it comes to the text for the joplin command (options and arguments).

Right, I get you. The terminal.md ones aren't automatic at the moment though are they, so those would have to be done (as Laurent said) in a future PR - I very much doubt I can fathom out how to do it within this one.

They might be. I don't know. I would have to read the scripts in tools. But yeah, this is certainly not part of this PR.

laurent22 · 2021-01-09T01:35:54Z

README.md

 ---|---|---
-Android | <a href='https://play.google.com/store/apps/details?id=net.cozic.joplin&utm_source=GitHub&utm_campaign=README&pcampaignid=MKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'><img alt='Get it on Google Play' height="40px" src='https://joplinapp.org/images/BadgeAndroid.png'/></a> | or download the APK file: [64-bit](https://github.com/laurent22/joplin-android/releases/download/android-v1.4.11/joplin-v1.4.11.apk) [32-bit](https://github.com/laurent22/joplin-android/releases/download/android-v1.4.11/joplin-v1.4.11-32bit.apk)
+Android | <a href='https://play.google.com/store/apps/details?id=net.cozic.joplin&utm_source=GitHub&utm_campaign=README&pcampaignid=MKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'><img alt='Get it on Google Play' height="40px" src='https://joplinapp.org/images/BadgeAndroid.png'/></a> | or download the APK file: [64-bit](https://github.com/laurent22/joplin-android/releases/download/android-v1.5.1/joplin-v1.5.1.apk) [32-bit](https://github.com/laurent22/joplin-android/releases/download/android-v1.5.1/joplin-v1.5.1-32bit.apk)
 iOS | <a href='https://itunes.apple.com/us/app/joplin/id1315599797'><img alt='Get it on the App Store' height="40px" src='https://joplinapp.org/images/BadgeIOS.png'/></a> | -


Version number should not be changed.

laurent22 · 2021-01-09T01:37:41Z

README.md

+- Colour, font sizes and faces - Evernote text is stored as HTML and this is converted to Markdown during the import process. For notes that are mostly plain text or with basic formatting (bold, italic, bullet points, links, etc.) this is a lossless conversion, and the note, once rendered back to HTML should be very similar. Tables are also imported and converted to Markdown tables. For very complex notes, some formatting data might be lost - in particular colours, font sizes and font faces will not be imported. The text itself however is always imported in full regardless of formatting. If it is essential that this extra data is preserved then Joplin also allows import of ENEX files as HTML. While this does preserve additional formatting such as font colours and sizes, it will not be converted to Markdown; as such it can still be edited using the Rich Text editor but the Markdown editor will only display the unformatted HTML.



A bit too much details and too specific to desktop app. Please only keep the part "If it is essential that this extra data is preserved then Joplin also allows import of ENEX files as HTML."

laurent22 · 2021-01-09T01:40:49Z

README.md

+Synchronisation options can be set via the Settings menu (*Windows/Linux*: Tools > Options > Plugins; *macOS*: Joplin > Preferences). For information regarding the configuration required for a specific target see the relevant section below.
+
+If the **terminal client** has been installed, it is possible to also synchronise outside of the user interface by typing `joplin sync` from the terminal. This can be used to setup a cron script to synchronise at a regular interval. For example, this would do it every 30 minutes:


Hmm, I don't know if we want these details here. This section is an overview of the synchronisation feature, and I don't think we've ever had someone asking where the sync options are, so it might be intuitive enough that we don't need to document it.

This was only put in as admittedly a very awkward way to highlight where the options section is in that section rather than repeating it more than once further down but I'll remove it (i.e. the cron script etc. is applicable to all of the below sections not just the Dropbox section it was originally in)

laurent22 · 2021-01-09T01:49:15Z

README.md

@@ -277,7 +291,7 @@ Resources that are not attached to any note will be automatically deleted in acc

 ## Downloading attachments

-The way the attachments are downloaded during synchronisation can be customised in the Configuration screen, under "Attachment download behaviour". The default option ("Always") is to download all the attachments, all the time, so that the data is available even when the device is offline. There is also the option to download the attachments manually (option "Manual"), by clicking on it, or automatically (Option "Auto"), in which case the attachments are downloaded only when a note is opened. These options should help saving disk space and network bandwidth, especially on mobile.
+The way the attachments are downloaded during synchronisation can be customised in the Settings screen, under "Attachment download behaviour". The default option ("Always") is to download all the attachments, all the time, so that the data is available even when the device is offline. There is also the option to download the attachments manually (option "Manual"), by clicking on it, or automatically (Option "Auto"), in which case the attachments are downloaded only when a note is opened. These options should help saving disk space and network bandwidth, especially on mobile.


Again it's not clear why "Settings", which is not used in any of the apps, is a better term than Configuration (which, granted, is only used in the CLI app, but at least it was consistent across the doc).

So this was part of the wider comment about 'Tools > Options' vs 'Joplin > Preferences' in Win/Linux vs macOS. Essentially there are 3 sets of names for accessing the config. I just went with the suggestion that had already been made on the previous review but happy to change to something if you want a standard name somewhere as the documentation has references to a number of different terms (settings, configuration, config, options).

laurent22 · 2021-01-09T01:50:23Z

README.md


 The whole UI can be customized by placing a custom editor style file in the profile directory `~/.config/joplin-desktop/userchrome.css`.

 Important: userstyle.css and userchrome.css are provided for your convenience, but they are advanced settings, and styles you define may break from one version to the next. If you want to use them, please know that it might require regular development work from you to keep them working. The Joplin team cannot make a commitment to keep the application HTML structure stable.

 # Note templates

-In the **desktop app**, templates can be used to create new notes or to insert into existing ones by creating a `templates` folder in Joplin's config folder and placing Markdown template files into it. For example creating the file `hours.md` in the `templates` directory with the contents:
+In the **desktop app**, templates can be used to create new notes or to insert into existing ones by creating a `templates` folder in Joplin's profile directory `~/.config/joplin-desktop/templates` (This path might be different on your device - check at the top of the `General` page of the Settings menu and placing your Markdown template files into it. For example creating the file `hours.md` in the `templates` directory with the contents:


No need for this extra info because the menu item opens the correct directory automatically.

That is a good point, I forgot about the menu item.

laurent22 · 2021-01-09T01:52:51Z

README.md

@@ -338,6 +352,14 @@ The currently supported template variables are:
 | `{{bowm}}` | Date of the beginning of the week (when week starts on Monday) based on the settings format | |
 | `{{bows}}` | Date of the beginning of the week (when week starts on Sunday) based on the settings format | |

+# Plugins
+
+The **desktop app** has the ability to extend beyond its standard functionality by the way of plugins. These plugins adhere to the Joplin plugin API and can be installed & configured within the application via the Settings menu (*Windows/Linux*: Tools > Options > Plugins; *macOS*: Joplin > Preferences). This menu allows the manual installation of the plugin using the single 'Joplin Plugin Archive' (*.jpl) file. Once the application is reloaded the plugins will appear within the plugins menu where they can be toggled on/off or removed entirely.


Again I'm not so keen about repeating how to open the config screen. I would just keep it concise and write "open the Plugins section in the Configuration screen". When you write very detailed paths like this, it's just more stuff that needs to be maintained whenever we change something in the app. So it's ok to give general instructions rather than precise menu items and buttons to be clicked.

laurent22 · 2021-01-09T01:59:44Z

README.md

+
+The **desktop app** has the ability to extend beyond its standard functionality by the way of plugins. These plugins adhere to the Joplin plugin API and can be installed & configured within the application via the Settings menu (*Windows/Linux*: Tools > Options > Plugins; *macOS*: Joplin > Preferences). This menu allows the manual installation of the plugin using the single 'Joplin Plugin Archive' (*.jpl) file. Once the application is reloaded the plugins will appear within the plugins menu where they can be toggled on/off or removed entirely.
+
+Plugins are currently maintained by the community in the [Joplin Discourse 'plugins' category](https://discourse.joplinapp.org/c/plugins/18). These plugins should not be considered 'official' and care should be taken to understand any potential risks that come from installation.


Please remove this part: "These plugins should not be considered 'official' and care should be taken to understand any potential risks that come from installation."

That's true of nearly everything in this project. We don't vet Electron, or React Native or any of the hundreds of packages that make the applications, and it wouldn't make sense to add this warning everywhere for everything. We take necessary precautions when building the plugin repository and info about this is in the forum. Perhaps that could be made into a separate more official document.

Fair enough, I put it in as your original proposal for the plugins repo had a requirement for 'vetting' the plugins which is absent in the current forum category. I'll remove it.

laurent22 · 2021-01-09T02:01:33Z

readme/plugins.md

+
+## Plugin Repository
+
+Plugins are currently maintained by the community in the [Joplin Discourse 'plugins' category](https://discourse.joplinapp.org/c/plugins/18). These plugins are not officially tested or vetted and care should be taken to understand any potential risks that come from installation.


Again please remove the warning. When it comes to security we need to be precise - what are the risks, what precautions do we take, etc. Vague statements like this aren't a good idea.

Daeraxa · 2021-01-10T00:18:24Z

Updates made based on comments.

laurent22 · 2021-01-20T11:58:48Z

Looks good now, many thanks for the update @Daeraxa!

tessus added the documentation Documentation, web site, README label Jan 5, 2021

tessus reviewed Jan 7, 2021

View reviewed changes

Daeraxa added 4 commits January 8, 2021 22:55

Documentation update

683c53f

Docsupdate links testing

39c6634

Docsupdate final test

7c197ad

Updated from review notes

2fa9988

Daeraxa force-pushed the docsupdate-1514 branch from 239e690 to 2fa9988 Compare January 9, 2021 00:51

Daeraxa changed the title ~~Documentation update proposal (released version v1.5.14)~~ Documentation update (released version v1.5.14) Jan 9, 2021

laurent22 reviewed Jan 9, 2021

View reviewed changes

Daeraxa added 3 commits January 9, 2021 03:08

Update from review

e9a5c60

Removal of updates to readme.md

e7c5d39

Merge branch 'dev' into docsupdate-1514

8d9459f

Merge branch 'dev' into docsupdate-1514

51ee9e3

laurent22 merged commit 197e43d into laurent22:dev Jan 20, 2021

Daeraxa mentioned this pull request Jan 22, 2021

joplinapp.org Desktop App download links point to old release binaries #4404

Closed

		@@ -104,6 +104,10 @@ For example:

		In this case, [make sure you enter the correct WebDAV URL](https://github.com/laurent22/joplin/issues/309).

		### Known problematic/unsupported WebDAV hosts

		- Colour, font sizes and faces - Evernote text is stored as HTML and this is converted to Markdown during the import process. For notes that are mostly plain text or with basic formatting (bold, italic, bullet points, links, etc.) this is a lossless conversion, and the note, once rendered back to HTML should be very similar. Tables are also imported and converted to Markdown tables. For very complex notes, some formatting data might be lost - in particular colours, font sizes and font faces will not be imported. The text itself however is always imported in full regardless of formatting. If it is essential that this extra data is preserved then Joplin also allows import of ENEX files as HTML. While this does preserve additional formatting such as font colours and sizes, it will not be converted to Markdown; as such it can still be edited using the Rich Text editor but the Markdown editor will only display the unformatted HTML.

		Synchronisation options can be set via the Settings menu (Windows/Linux: Tools > Options > Plugins; macOS: Joplin > Preferences). For information regarding the configuration required for a specific target see the relevant section below.

		If the terminal client has been installed, it is possible to also synchronise outside of the user interface by typing `joplin sync` from the terminal. This can be used to setup a cron script to synchronise at a regular interval. For example, this would do it every 30 minutes:


		The desktop app has the ability to extend beyond its standard functionality by the way of plugins. These plugins adhere to the Joplin plugin API and can be installed & configured within the application via the Settings menu (Windows/Linux: Tools > Options > Plugins; macOS: Joplin > Preferences). This menu allows the manual installation of the plugin using the single 'Joplin Plugin Archive' (*.jpl) file. Once the application is reloaded the plugins will appear within the plugins menu where they can be toggled on/off or removed entirely.

		Plugins are currently maintained by the community in the [Joplin Discourse 'plugins' category](https://discourse.joplinapp.org/c/plugins/18). These plugins should not be considered 'official' and care should be taken to understand any potential risks that come from installation.


		## Plugin Repository

		Plugins are currently maintained by the community in the [Joplin Discourse 'plugins' category](https://discourse.joplinapp.org/c/plugins/18). These plugins are not officially tested or vetted and care should be taken to understand any potential risks that come from installation.

Documentation update (released version v1.5.14) #4306

Documentation update (released version v1.5.14) #4306

Conversation

Daeraxa commented Jan 5, 2021 • edited Loading

tessus commented Jan 5, 2021

tessus left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

laurent22 commented Jan 7, 2021

tessus commented Jan 9, 2021

Daeraxa commented Jan 9, 2021

tessus commented Jan 9, 2021 • edited Loading

Daeraxa commented Jan 9, 2021 • edited Loading

tessus commented Jan 9, 2021

Daeraxa commented Jan 9, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Daeraxa Jan 9, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Daeraxa Jan 9, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Daeraxa commented Jan 10, 2021

laurent22 commented Jan 20, 2021

Daeraxa commented Jan 5, 2021 •

edited

Loading

tessus commented Jan 9, 2021 •

edited

Loading

Daeraxa commented Jan 9, 2021 •

edited

Loading

Daeraxa commented Jan 9, 2021 •

edited

Loading

Daeraxa Jan 9, 2021 •

edited

Loading

Daeraxa Jan 9, 2021 •

edited

Loading