Fixed references to jrnl_conf

docs/advanced.rst

@@ -6,12 +6,19 @@ Advanced Usage
 Configuration File
 -------------------
 
-You can configure the way jrnl behaves in a configuration file. By default, this is ``~/.jrnl_conf``. If you have the ``XDG_CONFIG_HOME`` variable set, the configuration file will be saved under ``$XDG_CONFIG_HOME/jrnl``. The configuration file is a simple JSON file with the following options.
+You can configure the way jrnl behaves in a configuration file. By default, this is ``~/.jrnl_config``. If you have the ``XDG_CONFIG_HOME`` variable set, the configuration file will be saved under ``$XDG_CONFIG_HOME/jrnl``.
+
+.. note::
+
+    On Windows, The configuration file is typically found at ``C:\Users\[Your Username]\.jrnl_config``.
+
+
+The configuration file is a simple JSON file with the following options and can be edited with any plain text editor.
 
 - ``journals``
       paths to your journal files
 - ``editor``
-    if set, executes this command to launch an external editor for writing your entries, e.g. ``vim`` or ``subl -w`` (note the ``-w`` flag to make sure *jrnl* waits for Sublime Text to close the file before writing into the journal. If you're using MacVim, that would be ``mvim -f``).
+    if set, executes this command to launch an external editor for writing your entries, e.g. ``vim``. Some editors require special options to work properly, see :doc:`FAQ <recipes>` for details.
 - ``encrypt``
     if ``true``, encrypts your journal using AES.
 - ``tagsymbols``
@@ -44,7 +51,7 @@ You can configure the way jrnl behaves in a configuration file. By default, this
 DayOne Integration
 ------------------
 
-Using your DayOne journal instead of a flat text file is dead simple -- instead of pointing to a text file, change your ``.jrnl_conf`` to point to your DayOne journal. This is a folder ending with ``.dayone``, and it's located at
+Using your DayOne journal instead of a flat text file is dead simple -- instead of pointing to a text file, change your ``.jrnl_config`` to point to your DayOne journal. This is a folder ending with ``.dayone``, and it's located at
 
 * ``~/Library/Application Support/Day One/`` by default
 * ``~/Dropbox/Apps/Day One/`` if you're syncing with Dropbox and
@@ -77,7 +84,7 @@ The ``default`` journal gets created the first time you start _jrnl_. Now you ca
 
 will both use ``~/work.txt``, while ``jrnl -n 3`` will display the last three entries from ``~/journal.txt`` (and so does ``jrnl default -n 3``).
 
-You can also override the default options for each individual journal. If you ``.jrnl_conf`` looks like this:
+You can also override the default options for each individual journal. If you ``.jrnl_config`` looks like this:
 
 .. code-block:: javascript
 
@@ -93,7 +100,7 @@ You can also override the default options for each individual journal. If you ``
         "food": "~/my_recipes.txt",
     }
 
-Your ``default`` and your ``food`` journals won't be encrypted, however your ``work`` journal will! You can override all options that are present at the top level of ``.jrnl_conf``, just make sure that at the very least you specify a ``"journal": ...`` key that points to the journal file of that journal.
+Your ``default`` and your ``food`` journals won't be encrypted, however your ``work`` journal will! You can override all options that are present at the top level of ``.jrnl_config``, just make sure that at the very least you specify a ``"journal": ...`` key that points to the journal file of that journal.
 
 .. note::
 

docs/recipes.rst

@@ -24,11 +24,36 @@ You can do things like ::
 
 To get a short summary of the 10 most recent, favourited entries before January 1, 2013 that are tagged with ``@fixed``.
 
+External editors
+----------------
 
-Using iA Writer to write entries
+To use external editors for writing and editing journal entries,  set them up in your ``.jrnl_config`` (see :doc:`advanced usage <advanced>` for details). Generally, after writing an entry, you will have to save and close the file to save the changes to jrnl.
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-On OS X, you can use the fabulous `iA Writer <http://www.iawriter.com/mac>`_ to write entries. Configure your ``.jrnl_conf`` like this:
+Sublime Text
+~~~~~~~~~~~~
+
+To use Sublime Text, install the command line tools for Sublime Text and configure your ``.jrnl_config`` like this:
+
+.. code-block:: javascript
+
+    "editor": "subl -w"
+
+Note the ``-w`` flag to make sure jrnl waits for Sublime Text to close the file before writing into the journal.
+
+
+MacVim
+~~~~~~
+
+Similar to Sublime Text, MacVim must be started with a flag that tells the the process to wait until the file is closed before passing control back to journal. In the case of MacVim, this is ``-f``:
+
+.. code-block:: javascript
+
+    "editor": "mvim -f"
+
+iA Writer
+~~~~~~~~~
+
+On OS X, you can use the fabulous `iA Writer <http://www.iawriter.com/mac>`_ to write entries. Configure your ``.jrnl_config`` like this:
 
 .. code-block:: javascript
 
@@ -37,27 +62,13 @@ On OS X, you can use the fabulous `iA Writer <http://www.iawriter.com/mac>`_ to
 What does this do? ``open -b ...`` opens a file using the application identified by the bundle identifier (a unique string for every app out there). ``-Wn`` tells the application to wait until it's closed before passing back control, and to use a new instance of the application.
 
 
-Using Notepad++ to write entries on Windows
+Notepad++ on Windows
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. note::
+To set `Notepad++ <http://notepad-plus-plus.org/>`_ as your editor, edit the jrnl config file (``.jrnl_config``) like this:
-
-    The configuration file is typically found at ``C:\Users\[Your Username]\.jrnl_conf``. This is just a text file and so can be edited in a text editor (but don't use Notepad, it will mess with the line endings).
-
-To set `Notepad++ <http://notepad-plus-plus.org/>`_ as your editor, edit the jrnl config file (``.jrnl_conf``) like this:
 
 .. code-block:: javascript
 
-    {
-      ...
       "editor": "C:\\Program Files (x86)\\Notepad++\\notepad++.exe -multiInst",
-    }
 
-The double backslashes are needed so jrnl can read the file path correctly. The ``-multiInst`` option will cause jrnl to open its own Notepad++ window. When you're done editing an entry in Notepad++, save the file and close the Notepad++ window for jrnl to know you're done editing and record your changes.
+The double backslashes are needed so jrnl can read the file path correctly. The ``-multiInst`` option will cause jrnl to open its own Notepad++ window.
-
-
-Known Issues
-------------
-
-- The Windows shell prior to Windows 7 has issues with unicode encoding. If you want to use non-ascii characters, change the codepage with ``chcp 1252`` before using `jrnl` (Thanks to Yves Pouplard for solving this!)
-- _jrnl_ relies on the `PyCrypto` package to encrypt journals, which has some known problems with installing on Windows and within virtual environments.