From 480eb4574b3d1af4c4b5fbc0bc2c069b17be1dc5 Mon Sep 17 00:00:00 2001 From: Manuel Ebert Date: Fri, 3 Jan 2014 15:59:38 +0100 Subject: [PATCH] Move docs on Windows to FAQ --- docs/advanced.rst | 18 ------------------ docs/recipes.rst | 20 ++++++++++++++++++++ 2 files changed, 20 insertions(+), 18 deletions(-) diff --git a/docs/advanced.rst b/docs/advanced.rst index 6fcafee4..b7d098f1 100644 --- a/docs/advanced.rst +++ b/docs/advanced.rst @@ -99,24 +99,6 @@ Your ``default`` and your ``food`` journals won't be encrypted, however your ``w Changing ``encrypt`` to a different value will not encrypt or decrypt your journal file, it merely says whether or not your journal `is` encrypted. Hence manually changing this option will most likely result in your journal file being impossible to load. -Windows Usage -------------- - -A couple of tips to get jrnl working better on Windows: - -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). - -For editing entries, Notepad will technically work, but doesn't play nice with line endings. A good alternative is `Notepad++ `_. To set Notepad++ 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++ windows. 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. - Known Issues ~~~~~~~~~~~~ diff --git a/docs/recipes.rst b/docs/recipes.rst index 852b1219..0bfb92a5 100644 --- a/docs/recipes.rst +++ b/docs/recipes.rst @@ -36,6 +36,26 @@ On OS X, you can use the fabulous `iA Writer `_ 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 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. note:: + + 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++ `_ 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. + + Known Issues ------------