Updated doc and help

CliClient/app/command-help.js

@@ -71,6 +71,8 @@ class Command extends BaseCommand {
 			this.stdout('');
 			this.stdout(commandNames.join(', '));
 			this.stdout('');
+			this.stdout(_('In any command, a note or notebook can be refered to by title or ID, or using the shortcuts `$n` or `$b` for, respectively, the currently selected note or notebook. `$c` can be used to refer to the currently selected item.'));
+			this.stdout('');
 			this.stdout(_('To move from one widget to another, press Tab or Shift+Tab.'));
 			this.stdout(_('Use the arrows and page up/down to scroll the lists and text areas (including this console).'));
 			this.stdout(_('To maximise/minimise the console, press "C".'));

README.md

@@ -2,7 +2,7 @@
 
 Joplin is a free, open source note taking and todo application, which can handle a large number of notes organised into notebooks. The notes are searchable, can be copied, tagged and modified with your own text editor.
 
-Notes exported from Evenotes via .enex files [can be imported](#importing-notes-from-evernote) into Joplin, including the formatted content (which is converted to markdown), resources (images, attachments, etc.) and complete metadata (geolocation, updated time, created time, etc.).
+Notes exported from Evernote via .enex files [can be imported](#importing-notes-from-evernote) into Joplin, including the formatted content (which is converted to markdown), resources (images, attachments, etc.) and complete metadata (geolocation, updated time, created time, etc.).
 
 The notes can be [synchronised](#synchronisation) with various targets including the file system (for example with a network directory) or with Microsoft OneDrive. When synchronising the notes, notebooks, tags and other metadata are saved to plain text files which can be easily inspected, backed up and moved around.
 
@@ -33,26 +33,28 @@ To start it, type `demo-joplin`.
 - Synchronises to a plain text format, which can be easily manipulated, backed up, or exported to a different format.
 - Plain text notes, which are rendered as markdown in the mobile application.
 - Tag support
-- File attachment support (likewise, all file attachements can be imported from Evernote but currently cannot be manually added to a note)
+- File attachment support (likewise, all file attachments can be imported from Evernote but currently cannot be manually added to a note)
 - Search functionality.
-- Geolocation support.
+- Geo-location support.
 - Supports multiple languages.
 
 # Usage
 
-To start the application type `joplin`. This will open the user interface, which has three main panes: Notebooks, Notes and the text of the current note. There are also additional panels that can be toggled on and off via shortcuts (see shortcuts below).
+To start the application type `joplin`. This will open the user interface, which has three main panes: Notebooks, Notes and the text of the current note. There are also additional panels that can be toggled on and off via [shortcuts](#available-shortcuts).
+
+<img src="https://github.com/laurent22/joplin/blob/master/docs/images/ScreenshotTerminalCaptions.png" height="400px">
 
 ## Input modes
 
-Joplin user interface is partly based on vim and offers two different modes to interact with the notes and notebooks:
+Joplin user interface is partly based on the text editor Vim and offers two different modes to interact with the notes and notebooks:
 
 ### Normal mode
 
-Allows moving from one pane to another using the `Tab` and `Shift-Tab` keys, and to select/view notes. Press `Enter` to edit a note. Various other [shortcuts](#available-shortcuts) are available.
+Allows moving from one pane to another using the `Tab` and `Shift-Tab` keys, and to select/view notes using the arrow keys. Text area can be scrolled using the arrow keys too. Press `Enter` to edit a note. Various other [shortcuts](#available-shortcuts) are available.
 
 ### Command-line mode
 
-Press `:` to enter command line mode. From there, the Joplin comands such as `mknote` or `search` are available. See the [full list of commands](#available-commands).
+Press `:` to enter command line mode. From there, the Joplin commands such as `mknote` or `search` are available. See the [full list of commands](#available-commands).
 
 It is possible to refer to a note or notebook by title or ID. However the simplest way is to refer to the currently selected item using one of these shortcuts:
 
@@ -84,7 +86,7 @@ Attach a local file to the currently selected note ($n):
 
 	ren $n /home/laurent/pictures/Vacation12.jpg
 
-The configuration can also be changed from command-line. For example, to change the current editor to Sublime Text:
+The configuration can also be changed from command-line mode. For example, to change the current editor to Sublime Text:
 
 	config editor "subl -w"
 
@@ -102,31 +104,37 @@ If the help is not fully visible, press `Tab` multiple times till the console is
 
 ## Editing a note
 
-To edit a note, select it and press `ENTER`. Or, in command-line, mode type `edit $n` to edit the currently selected note, or `edit "Note title"` to edit a particular note.
+To edit a note, select it and press `ENTER`. Or, in command-line mode, type `edit $n` to edit the currently selected note, or `edit "Note title"` to edit a particular note.
 
 # Importing notes from Evernote
 
-Joplin was designed as a replacement for Evernote and so can import complete Evernote notebooks, as well as notes, tags, resources (attached files) and note metadata (such as author, geo-location, etc.). In terms of data, the only two things that might slightly differ are:
+Joplin was designed as a replacement for Evernote and so can import complete Evernote notebooks, as well as notes, tags, resources (attached files) and note metadata (such as author, geo-location, etc.) via ENEX files. In terms of data, the only two things that might slightly differ are:
 
-- "Regocntion" data - Evernote images, in particular scanned (or photographied) documents have "recognition" data associated with them. It is the text that Evernote has been able to recognise in the document. This data is not preserved when the note are imported into Joplin. However, should it become supported in the search tool or other parts of Joplin, it should be possible to regenerate this recognition data since the actual image would still be available.
+- Recognition data - Evernote images, in particular scanned (or photographed) documents have [recognition data](https://en.wikipedia.org/wiki/Optical_character_recognition) associated with them. It is the text that Evernote has been able to recognise in the document. This data is not preserved when the note are imported into Joplin. However, should it become supported in the search tool or other parts of Joplin, it should be possible to regenerate this recognition data since the actual image would still be available.
 
-- Colour and 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 loss - in particular colours, font sizes and font faces will not be imported. The text itself however is always imported in full regardless of formatting.
+- 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 loss - in particular colours, font sizes and font faces will not be imported. The text itself however is always imported in full regardless of formatting.
 
-HOW TO IMPORT A NOTEBOOK - Tutorial that shows how to export from Evernote client, then command to import in Joplin
+To import Evernote data, follow these steps:
+
+* First, export your Evernote notebooks to ENEX files as described [here](https://help.evernote.com/hc/en-us/articles/209005557-How-to-back-up-export-and-restore-import-notes-and-notebooks).
+* In Joplin, in [command-line mode](#command-line-mode), type `import-enex /path/to/file.enex`. This will import the notes into a new notebook named after the filename.
+* Then repeat the process each notebook that needs to be imported.
 
 # Synchronization
 
-INFO ABOUT SYNC
+Joplin does synchronisation by creating simple text files that represent notes, notebooks, tags and resources. These files can then be synchronised with OneDrive or any other supported target (currently it can also synchronise with the local file system; and a Dropbox driver is also planned). When syncing, Joplin creates a sub-directory in OneDrive, in /Apps/Joplin and read/write the notes and notebooks from it. The application does not have access to anything outside this directory. To initiate the synchronisation process, type `:sync`. You will be asked to follow a link to authorise the application. After that, the application will synchronise in the background whenever it is running. It's possible to also synchronise outside of the user interface by typing `joplin sync`. This can be used to setup a cron script to synchronise at regular interval. For example, this would synchronise every 30 minutes:
+
+	*/30 * * * * /path/to/joplin sync
 
 # Android client
 
 An Android client is available and can synchronise with the terminal client via OneDrive:
 
-<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://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png'/></a>
+<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="60px" src='https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png'/></a>
 
 # URLs
 
-By pressing Ctrl+Click on a URL, most terminals will open that URL in the default browser. However, one issue especially with long URLs is that they can end up like this:
+By pressing Ctrl+Click on a URL, most terminals will open that URL in the default browser. However, one issue, especially with long URLs, is that they can end up like this:
 
 <img src="https://github.com/laurent22/joplin/blob/master/docs/images/UrlCut.png" width="240px">
 
@@ -136,24 +144,26 @@ As a solution Joplin tries to start a mini-server in the background and, if succ
 
 <img src="https://github.com/laurent22/joplin/blob/master/docs/images/UrlNoCut.png" width="240px">
 
-With this it means that not only the text will be more readable but links are also unlikely to be cut. Note that both resources (files that are attached to notes) and external links are handled in this way.
+Since this is still an actual URL, the terminal should still make it clickable. And with shorter URLs, the text is more readable and the links are unlikely to be cut. Note that both resources (files that are attached to notes) and external links are handled in this way.
 
 # Attachments / Resources
 
-In Markdown links to resources are respresented as a simple ID to the resource. In order to give access to these resources, they will be, like links, converted to local URL. Clicking this link will then open a browser, which will handle the file - i.e. display the image, open the PDF file, etc.
+In Markdown, links to resources are represented as a simple ID to the resource. In order to give access to these resources, they will be, like links, converted to local URLs. Clicking this link will then open a browser, which will handle the file - i.e. display the image, open the PDF file, etc.
 
 # Localisation
 
-The applications is currently available in English and French. If you would like to contribute a translation it is quite straightforward, please follow these steps:
+Joplin is currently available in English and French. If you would like to contribute a translation, it is quite straightforward, please follow these steps:
 
-- Download Poedit, the translation editor, and install it: https://poedit.net/
-- Download the file to be translated: https://raw.githubusercontent.com/laurent22/joplin/master/CliClient/locales/joplin.pot
+- [Download Poedit](https://poedit.net/), the translation editor, and install it.
+- [Download the file to be translated](https://raw.githubusercontent.com/laurent22/joplin/master/CliClient/locales/joplin.pot).
 - In Poedit, open this .pot file, go into the Catalog menu and click Configuration. Change "Country" and "Language" to your own country and language.
-- From then you can translate the file. Once it's done, please send the file to [this address](https://raw.githubusercontent.com/laurent22/joplin/master/Assets/Adresse.png).
+- From then you can translate the file. Once it's done, please send the file to [this address](https://raw.githubusercontent.com/laurent22/joplin/master/Assets/Adresse.png) or open a pull request.
+
+This translation will apply to both the terminal and the Android application.
 
 # Available shortcuts
 
-There are two types of shortcuts: those that manipulate the user interface directly, such as TAB to move from one widget to another, and those that are simply shortcuts to actual commands. In a way similar to Vim, these commands are generally a verb followed by an object. For example, typing `mn` ([m]ake [n]ote), is used to create a new note, it will switch the interface to command line mode and pre-fill it with `mknote ""` from where the title of the note can be entered.
+There are two types of shortcuts: those that manipulate the user interface directly, such as `TAB` to move from one widget to another, and those that are simply shortcuts to actual commands. In a way similar to Vim, these commands are generally a verb followed by an object. For example, typing `mn` ([m]ake [n]ote), is used to create a new note: it will switch the interface to command line mode and pre-fill it with `mknote ""` from where the title of the note can be entered. See below for the full list of shortcuts:
 
 	Tab       Give focus to next widget
 	Shift+Tab Give focus to previous widget