Vim for Writers

Revision as of 08:07, 11 November 2018 by NewMexicoKid (talk | contribs) (→‎Tips from Pingouin)

Vim workflow.png

Introduction

vim is a very powerful modal text editor with a large system of plugins. You may have heard of the infamous vim vs. emacs wars that have existed from the time of usenet and persist till today. vim does have a learning curve but it is very worthwhile to learn because your fingers never leave the keyboard as you are writing and editing. ViM = Vi Improved; it is a superset of the original vi editor.

This series of articles introduces vim.

Quick Vim Cheatsheet(s)

A great example vimrc (WurdBender)

WurdBender writes: I noticed most of the Vim community seems to prefer the Solarized theme, but I really can't stand it myself. I've been using Tomorrow Night from the repository you linked, except I run in 256 color mode (set t_Co=256) to subdue the colors a bit. I'm still trying out fonts. At the moment I'm liking Input Mono.

Below is what my setup looks like with some code to show off the colors. I wasn't sure I'd get much use out of the Airline bar, but it comes in handy. I've also created a repository for my .vimrc on GitHub, which I'm told is a good idea in case you need to quickly set up Vim on a new system. It's there if anybody wants to see it, though it's maybe a bit cluttered and noobish.

A derivative vimrc (NewMexicoKid)

NewMexicoKid writes: I made a (slightly modified) vimrc based on WurdBender's. I turned off numbers (too technical for NaNo), added autoindent and shift width/expand tab (which I find more useful for doing sub-bullets in markdown).

A more-efficient wordcount algorithm for writers (vithic)

  • From vithic
  • To NewMexicoKid
  • Sent at October 21, 2018 16:28
  • Subject Vim.

I just noticed that my Vim configuration is based yours that is referenced at http://www.naperwrimo.org/wiki/index.php?title=Vim_for_Writers. :)

I managed to decrease the word count overhead quite a bit somehow by copy/pasting a function from somewhere that made it only update it on every line break (at 20k words it's still painful when inserting a line break though).

Just replace your ~/.vim/plugged/vim-markdown-folding/after/ftplugin/markdown/folding.vim with this:

https://pastebin.com/A291j9Fc

Just to add some clarification - the original setup provides a line count that is mostly useless to authors. The suggested folding.vim file changes that into a word count and nothing else (at a slight resource expense, most likely - especially if folds grow into 1k+ words).

Tips from reddit

This reddit post and answer has some interesting starting points to explore: 

  Plug 'reedes/vim-pencil' " Super-powered writing things
  Plug 'tpope/vim-abolish' " Fancy abbreviation replacements
  Plug 'junegunn/limelight.vim' " Highlights only active paragraph
  Plug 'junegunn/goyo.vim' " Full screen writing mode
  Plug 'reedes/vim-lexical' " Better spellcheck mappings
  Plug 'reedes/vim-litecorrect' " Better autocorrections
  Plug 'reedes/vim-textobj-sentence' " Treat sentences as text objects
  Plug 'reedes/vim-wordy' " Weasel words and passive voice



  augroup pencil
   autocmd!
   autocmd filetype markdown,mkd call pencil#init()
       \ | call lexical#init()
       \ | call litecorrect#init()
       \ | setl spell spl=en_us fdl=4 noru nonu nornu
       \ | setl fdo+=search
  augroup END

 " Pencil / Writing Controls {{{
   let g:pencil#wrapModeDefault = 'soft'
   let g:pencil#textwidth = 74
   let g:pencil#joinspaces = 0
   let g:pencil#cursorwrap = 1
   let g:pencil#conceallevel = 3
   let g:pencil#concealcursor = 'c'
   let g:pencil#softDetectSample = 20
   let g:pencil#softDetectThreshold = 130
 " }}}

And finally: https://labs.tomasino.org/vim-in-context/

Tips from Pingouin

I have a dozen plugins in my .vimrc, but the only ones I couldn't live without for prose are Goyo (distraction-free), vim-peekaboo (show registers while yanking/pasting) and vim-Grammalecte (a french grammar/spelling checker). I've added a live word count to my status bar and a feature I haven't seen elsewhere but which I now find mandatory: something to hide what I'm writing but still provide me with some context.

It serves two purposes: to protect my kids or other prying eyes from reading my "rated" stuff, and to help me resist my inner editor (can't correct what I don't see!). I can still read some of it with a little effort if I typed it not too long ago, and see the overall structure so I don't get lost. It's a single key toggle, so I can quickly hide or reveal the whole window.

Another "can't live without it" setting is the one to return to last edit position when opening files.

I also have a shortcut to navigate to the previous or next scene/chapter/book:

map <leader>n /^[#*]<cr>:nohl<cr>

map <leader>p k?^[#*]<cr>:nohl<cr>


Edit: I can't embed an image… so go to https://imgur.com/a/H4oNuZD to see my "incognito/censored/kill-the-inner-editor" mode

Update: Well, it was coded within my .vimrc, but it's now a plugin: https://github.com/swordguin/vim-veil

Thanks for your interest! I hope it will be useful to you or to other people.

Here's the relevant section of my .vimrc for the word count: https://pastebin.com/t07PRJYC

Both work flawlessly even with a 200'000 words markdown novel (no lag at all)

vimrc generator

See this great vimrc generator to get a decent starter vimrc.

How to learn how to use vim

vimrc tips

HBBisenieks writes: Most of my vimrc is set for the benefit of my dayjob as a sysadmin, but one line I always make sure is in my vimrc is 

  set title

That way I rarely forget what file I'm editing.

ViM Folding

Here is a must-see video that makes vim folding look utterly simple.

Also see this plugin: vim-outliner

ViM plugins

There are several ViM plugin managers. One of them is: vundle, a vim bundle manager that lets you EASILY install other vim plugins/bundles.

Markdown

Markdown is a very simple mark-up language that encourages writers to focus on their content rather than on presentation. It can handle bolding, italics, bullet lists, section headings, hypertext links, etc. and you can use utilities like pandoc to transform your markdown text to many, many different formats, including:

ViM has plugins for better markdown syntax highlighting (vim-markdown) and vim-markdown-folding. With the latter, you can:

  • add the spacebar mapping to your .vimrc:
    nnoremap <Space> za

Some use gnu make to automatically generate everything from the markdown source.

Beautiful colors

Check out the beauty of vim-colors-solarized that "is a sixteen color palette (eight monotones, eight accent colors) designed for use with terminal and gui applications. It has several unique properties. I designed this colorscheme with both precise CIELAB lightness relationships and a refined set of hues based on fixed color wheel relationships. It has been tested extensively in real world use on color calibrated displays (as well as uncalibrated/intentionally miscalibrated displays) and in a variety of lighting conditions." (ethanschoonover.com)

Also see this quora question with plenty of answers that recommend different color schemes.

Another couple of references that show you color samples:

Notes for Planning

See the vim script called nvim to build piles of random little notes during novel planning.

Movement

Vim can be more or less as powerful as you want it. It's really worth the time spent learning how to jump around ( using '(' and ')' to jump to the start of the previous / next sentence in particular).

Help

  • You can get help on just about any vim feature by entering the command ':help SOMETHING', e.g. ':help spell'
  • This might be useful: Vim Commands Cheat Sheet

Autosave

  • 'set autowriteall' - autosave your current document whenever you change away from the current buffer. You can just do 'set autowrite', which will save in *most* situations (the main exemption being quitting).
  • There is also a vim plugin: https://github.com/907th/vim-auto-save. It apparently turns on auto save and saves every time a buffer is modified.

Spell Checking

  • it supports a personal word list (very useful for fantasy authors ;-) )
  • some useful keys for spellchecking:
    • ]s - forward to misspelled/rare/wrong cap word
    • [s - backwards ]
    • S - only stop at misspellings
    • [S - in other direction
    • zG - accept spelling for this session
    • zg - accept spelling and add to personal dictionary
    • zW - treat as misspelling for this session
    • zw - treat as misspelling and add to personal dictionary
    • z= - show spelling suggestions
    • :spellr - repeat last spell replacement for all words in window

Thesaurus

WriteRoom / DarkRoom simulator

There apparently are many writeroom/darkroom vim plugins and configurations for "distraction free writing". Of the three I tried, I think I like this plugin (vimroom) the best. For installation using vundle, see https://github.com/mikewest/vimroom (Bundle 'mikewest/vimroom'). A rival noted that on Windows, VimTweak yields transparent gvim windows.

Sessions

Sessions can be used to save window configurations

You can use vundle to load both of these and then :SaveSession to save the session. Put 

  let g:session_autosave = 'no'

at the end of your vimrc so you don't get prompted to save sessions when you close files. A session will preserve your layout and place in the file--very cool!

Wordcount

   """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
   " Here begins my automated wordcount addition.
   " This combines several ideas from:
   " http://stackoverflow.com/questions/114431/fast-word-count-function-in-vim
   """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
   let g:word_count="<unknown>"
   function WordCount()
       return g:word_count
   endfunction
   function UpdateWordCount()
       let lnum = 1
       let n = 0
       while lnum <= line('$')
           let n = n + len(split(getline(lnum)))
           let lnum = lnum + 1
       endwhile
       let g:word_count = n
   endfunction
   " Update the count when cursor is idle in command or insert mode.
   " Update when idle for 1000 msec (default is 4000 msec).
   set updatetime=1000
   augroup WordCounter
       au! CursorHold,CursorHoldI * call UpdateWordCount()
   augroup END
   " Set statusline, shown here a piece at a time
   highlight User1 ctermbg=green guibg=green ctermfg=black guifg=black
   set statusline=%1*            " Switch to User1 color highlight
   set statusline+=%<%F            " file name, cut if needed at start
   set statusline+=%M            " modified flag
   set statusline+=%y            " file type
   set statusline+=%=            " separator from left to right justified
   set statusline+=\ %{WordCount()}\ words,
   set statusline+=\ %l/%L\ lines,\ %P    " percentage through the file

Vim Wiki

The vim wiki plugin is surprisingly powerful. I've noticed quite a few people advocating the use of the zim desktop wiki tool (but, of course, it isn't edited in vim, even though there is a vim zim syntax support); I regularly use Mediawiki instances (and once played with tiddlywiki). The vim wiki plugin looks interesting; and, since I now use the vundle plugin manager, I may give it a try.

Some reviews I've seen for vim wiki:

Related Articles of Interest

  • Awesome vim plugins for writers - Posted 08 Feb 2017 by Zsolt Szakács
  • ViM Plugins For Writers - Reed Esau's growing list of ViM plugins for writers. Includes vim colors pencil (pretty theme for writers), vim thematic (theme manager), vim-pencil (handles wrap modes for writers)
  • an article of a guy who wants to devise a ruby gem for handling novel writing/formatting tasks (okay, not really a vim resource; but something that looked interesting to those of us writing text files)
  • blog article about writing novels in a text editor vs. a WYSIWYG word processor; some interesting comments, including a reference to flashbake, a set of scripts designed to make it easier for writers to use version control software
  • writing in vim -- this author shares his vimrc and some of his plugins; the thing of interest here is his use of a set thesaurus command. I found this intriguing and found this nifty thesaurus plugin for vim that looks very useful and usable.
  • Nine great plugins mentioned in this blog article, including:
    • Showmarks
      Marks are bookmarks within a Vim document. You can set a mark by pressing m followed by another letter that designates the mark. To jump to a mark, enter ' followed by the mark's letter.
      The great weakness of marks is that they are invisible. This limits the number you can use to however many you can remember, and you can easily accidentally overwrite an existing mark by creating another with the same name.
      Showmarks allows you to toggle the visibility of marks off and on – and that tiny functionality is enough to increase the usefulness of marks several times over.
    • Vim Signature
      vim-signature is a plugin to place, toggle and display marks. Apart from the above, you can also
      • Navigate forward/backward by position/alphabetical order
      • Displaying multiple marks (upto 2, limited by the signs feature)
      • Placing custom signs !@#$%^&*() as visual markers
    • Vim-abolish
      Vim-abolish is so elegant that you wonder why no one thought of it before, but it's hard to describe. It has aspects of a word processor's spell checker or autocorrect, but might best be described as a configurable search and replace tool. What makes Vim-abolish so powerful is that it allows you not only to search and replace one word or spelling for another, but also to include all instances of a word. Upper case, lower case, noun and adverb, past and present tense, participles – all can be added to the search and replaced with a few dozen characters.
      Admittedly, you might take a while to learn how to think in the terms necessary to set up a Vim-abolish command, and learning how to construct a command may take some time too. However, once you understand how Vim-abolish works, you will probably find it an invaluable proofreading tool.
  • Rachel Aaron advises tracking ones reading progress in this excellent blog article (on how to increase ones writing productivity).
  • One user uses ViM together with git (flashbake), vimroom, onlinethesaurus, vim-abolish, vim-repeat and vim-outline. Vimroom does not always work as well, and there's little support for it, but it's still usable with a bit of tinkering. Of all the plugins vim-outline is the most useful. She recommends it to everyone planning to use vim. It allows you to easily structure your text, and makes for easy folding/expanding.
  • vim-repeat looks interesting for better repetition with: .
  • Seth Brown wrote: The Text Triumvirate (zsh, vim and tmux) -- in this article, Seth mentions vim-powerline, a python-powered status line plugin. The author of that plugin then points to vim-airline as a lighter-weight but still featureful status line plugin.
  • one redditor has plans to write a book on Vim for Writers; there are some interesting chapter titles in this reddit.
  • Here is a nifty Google tech talk by vim creator Bram Moolenaar with useful tips for productive vim; and a blog post about how to use vim and ack for notetaking.

Annotations

Question: What's a good way to 'highlight' bits of text that you know you need to fact-check/add to/etc. so that it's easily seen upon a reread? I've just changed the text color in programs I've used previously...but how to best do that in vim?

One answer: I first thought about using vim tags -- I have never used them before, but I've heard of them and it sounds like they do some things that might be useful.

In Vim the quickfix commands are used more generally to find a list of positions in files. For example, |:vimgrep| finds pattern matches. You can use the positions in a script with the |getqflist()| function. Thus you can do a lot more than the edit/compile/fix cycle!

  • But this vim-notebook plugin sounds much more straightforward and easy-to-use right off the bat:

This plugin has been created to annotate and aggregate key aspects, such as source code, documentation, notes etc, relative to tasks to be done. Annotations with referenced resources are stored into text files called notebooks under the folder $HOME/.notebook.

A typical usage scenario is:

  1. create a new notebook called issue_missing_refresh_of referenced_line
  2. open the text file containing key information
  3. select text of interest
  4. annotate selecting proper category and description
  5. repeat annotation for other interesting text
  6. open the notebook to have an overview of interesting information
  7. go to an entry of interest
  8. jump to the referenced text file
  9. repeat the exploration with other entries

Traditionally, I've just made my notes directly in the text, marking it with NOTES ;-)

This year, though, writing in Markdown, I might take the HTML commenting approach (as suggested in this pandoc google group). On the other hand, the vim-notebook plugin sounds pretty cool--being able to annotate things in a separate file and yet jump to them at will... neat!

Why use ViM?

Question: Is there a portable OFFLINE text editor that could be run from a USB drive? If so, would such a thing be safe for use on public computers or able to be secured? It doesn't need to be anything fancy.

One Answer: A very good text editor with a PortableApps version, lots of available, easily-manageable plugins and extremely good ergonomics is ViM (vi improved).

I would encourage you to see this summary of this year's nano-technology thread on ViM (that focuses on how ViM can be used for writing).

Why should you give this modal ASCII editor a try?

Other references

What about Emacs?

brookter wrote:

If you like the general approach of Scrivener but want to stay in plain text with keybindings like they are meant to be used (ie Vim...), you may want to check this out: it's basically an attempt to reproduce some of Scrivener's features using Vim. https://vimvalley.com/replacing-scrivener-with-emacs-and-vim/ Actually, it uses Evil mode within Emacs — this is a VERY GOOD THING. Evil mode (Vim emulation) gives Emacs the one thing it lacks, a decent text editor. (Ahem.)

Retrieved from "https://naperwrimo.org/wiki/index.php?title=Vim_for_Writers&oldid=3062"