Find file
Fetching contributors…
Cannot retrieve contributors at this time
124 lines (91 sloc) 4.75 KB
This is a mirror of http://www.vim.org/scripts/script.php?script_id=3582
# simplenote.vim
A vim plugin to interact with the [simplenote][1] API. You can create an
account [here](https://simple-note.appspot.com/create) if you don't already
have one.
Now you can take simple notes directly from your favourite editor.
## Installation
Just copy `simplenote.vim` into your plugin folder. But you really want to use
[pathogen][5] for your plugin management.
Your credentials have to be stored in your `vimrc`:
let g:SimplenoteUsername = "your simplenote username"
let g:SimplenotePassword = "your simplenote password"
If you don't want to have the credentials in your `vimrc` (if you manage it
with git for example), you can just set the variables in a different file (like
`~/.simplenoterc`) and source it with `source ~/.simplenoterc` in your `vimrc`.
By default all notes are treated as plain text. If you usually write all of
your notes in some other format (like markdown or restructured text) you can
set `g:SimplenoteFiletype` to the preferred vim filetype.
## Usage
The plugin provides several commands to interact with your Simplenote account.
In order to retrieve a list of your notes execute
:Simplenote -l X
:Simplenote -l todo,shopping
Where X is the number of notes to retrieve; omit X to retrieve all. This opens
a new scratch buffer with a line-wise listing of your notes. With `let
g:SimplenoteListHeight=X` set, the scratch buffer will come up X lines tall.
Alternatively when `let g:SimplenoteVertical=1` is set, it is opened as a
vertical rather than horizontal split window. You can also pass a comma
separated list of tags. This will only list notes which have at least one of
those tags. You can then navigate through the with the arrow keys and enter a
note on hitting `Return`. Now that you see the content of the note, you can
interact with this specific note:
:Simplenote -u
updates the content of the current note with the content of the current buffer.
The buffer write command `:w` is also mapped to update the current note.
If you want to delete the note, execute
:Simplenote -d
This moves the current note to the trash. If you want to completely delete a
note, use
:Simplenote -D
as it will directly delete the note and not only move it to the trash.
There also exists a command to create new notes.
:Simplenote -n
creates a new note with the contents of the current buffer. Once the note is
created, `:Simplenote -u` updates the newly created note, also with the
contents of the current buffer.
Tagging notes is also supported. If you enter
:Simplenote -t
on a buffer containing a valid note, you get an input dialog, prefilled with
existing comma-separated tags for the note, which you can then edit. Tags have
to be comma separated and hitting `Enter` will then update the note with the
new tag list.
There is also an option to open notes directly from a given key:
:Simplenote -o <notekey>
While this is not very useful in everyday usage, it can be used very
effectively to create shortcuts to notes you use often. Example:
" add :Todo command
command Todo Simplenote -o <yourtodonotekey>
Now you can jump to your todo note directly with `:Todo` in vim.
## Note sorting
simplenote.vim supports simple note ordering. Per default the sort order is
pinned notes first followed by modified date from newest to oldest. The order
can be changed by setting the `g:SimplenoteSortOrder` variable. It should be
set to a comma separated list of values which represents the sort order.
Allowed values are `pinned` (pinned before unpinned), `tags` (notes with tags
before untagged ones), `modifydate` and `createdate` (both newer before older).
## Dependencies
Version 2 of the SimpleNote API relies heavily on JSON. As JSON and VimL don't
really play nice together, basic parts of this plugin are implemented in
python. Therefore your vim has to be compiled with python support in order to
use this plugin.
## Usage behind proxy
Since the plugin uses Python's urllib2 for making HTTP requests, you just have to
add these lines (with the correct values) to your `.vimrc`:
let $HTTP_PROXY = 'http://<proxyuser&gt;:<proxypassword>@<proxyurl>:<proxyport>'
let $HTTPS_PROXY = 'http://<proxyuser&gt;:<proxypassword>@<proxyurl>:<proxyport>'
## Development
- [Bugs and issue tracker](https://github.com/mrtazz/simplenote.vim/issues)
## Contribute
- Fork the project
- Branch off develop
- Make your additions/fixes/improvements
- Send a pull request
## Thanks
[mattn][2], [Tim Pope][3] and [Scrooloose][4] who write awesome vim plugins
which I took as a basis to learn how to write vim plugins.
[1]: http://simplenoteapp.com/
[2]: http://github.com/mattn
[3]: http://github.com/tpope
[4]: http://github.com/scrooloose
[5]: http://github.com/tpope/vim-pathogen