Update version number to 2.4.1

I cut the screen shots to only show features of vimwiki.

CONTRIBUTING.md

@@ -6,13 +6,21 @@ https://github.com/vimwiki/vimwiki/tree/dev to see if your problem is already fi
 Issues can be filed at https://github.com/vimwiki/vimwiki/issues/ .
 
 # Creating a pull request
+
 If you want to provide a pull request on GitHub, please start from the `dev` branch, not from the
 `master` branch. (Caution, GitHub shows `master` as the default branch from which to start a PR.)
 
+Make sure to update `doc/vimwiki.txt` with the following information:
+
+1. Update the changelog to include information on the new feature the PR introduces or the bug it
+   is fixing.
+2. Add a help section to describe any new features or options.
+2. If you are a first time contributor add your name to the list of contributors.
 
 # More info and advice for (aspiring) core developers
+
 - Before implementing a non-trivial feature, think twice what it means for the user. We should
-  always try to keep backward compatiblility. If you are not sure, discuss it on GitHub.
+  always try to keep backward compatibility. If you are not sure, discuss it on GitHub.
 - Also, when thinking about adding a new feature, it should be something which fits into the
   overall design of Vimwiki and which a significant portion of the users may like. Keep in mind
   that everybody has their own way to use Vimwiki.
@@ -21,6 +29,7 @@ If you want to provide a pull request on GitHub, please start from the `dev` bra
   setups. Take a little time to think about under which circumstances your changes could break.
 
 ## Git branching model
+
 - there are two branches with eternal lifetime:
     - `dev`: This is where the main development happens. Tasks which are done in one or only a few
       commits go here directly. Always try to keep this branch in a working state, that is, if the
@@ -51,5 +60,4 @@ If you want to provide a pull request on GitHub, please start from the `dev` bra
     forget this plan.
 11. Tell the world.
 
-
 %% vim:tw=99

README.md

@@ -1,90 +1,180 @@
-A Personal Wiki For Vim
+# VimWiki: A Personal Wiki For Vim
-==============================================================================
 
 [中文](README-cn.md)
 
-![screenshot1](doc/screenshot_1.png)
+- [Intro](#intro)
-![screenshot2](doc/screenshot_2.png) *
+- [Installation](#installation)
+    - [Prerequisites](#prerequisites)
+    - [VIM Packages](#installation-using-vim-packages-since-vim-741528)
+    - [Pathogen](#installation-using-pathogen)
+    - [Vim-Plug](#installation-using-vim-plug)
+    - [Vundle](#installation-using-vundle)
+- [Basic Markup](#basic-markup)
+    - [Lists](#lists)
+- [Key Bindings](#key-bindings)
+- [Commands](#commands)
+- [Changing Wiki Syntax](#changing-wiki-syntax)
+- [Getting Help](#getting-help)
+- [Helping VimWiki](#helping-vimwiki)
+- [Wiki](https://github.com/vimwiki/vimwiki/wiki)
+- [License](#license)
 
-Intro
+## Intro
-------------------------------------------------------------------------------
 
-Vimwiki is a personal wiki for Vim -- a number of linked text files that have
+VimWiki is a personal wiki for Vim -- a number of linked text files that have
 their own syntax highlighting.
 
-With Vimwiki you can:
+With VimWiki you can:
 
- * organize notes and ideas
+ * Organize notes and ideas
- * manage todo-lists
+ * Manage to-do lists
- * write documentation
+ * Write documentation
- * maintain a diary
+ * Maintain a diary
- * export everything to HTML
+ * Export everything to HTML
 
-To do a quick start press `<Leader>ww` (this is usually `\ww`) to go to your index
+To do a quick start press `<Leader>ww` (this is usually `\ww`) to go to your
-wiki file.  By default it is located in `~/vimwiki/index.wiki`.
+index wiki file. By default it is located in `~/vimwiki/index.wiki`.
 
 Feed it with the following example:
 
-    = My knowledge base =
+```
-        * Tasks -- things to be done _yesterday_!!!
-        * Project Gutenberg -- good books are power.
-        * Scratchpad -- various temporary stuff.
 
-Place your cursor on `Tasks` and press Enter to create a link.  Once pressed,
+= My knowledge base =
-`Tasks` will become `[[Tasks]]` -- a Vimwiki link.  Press Enter again to
+    * Tasks -- things to be done _yesterday_!!!
-open it.  Edit the file, save it, and then press Backspace to jump back to your
+    * Project Gutenberg -- good books are power.
+    * Scratchpad -- various temporary stuff.
+
+```
+
+Place your cursor on `Tasks` and press Enter to create a link. Once pressed,
+`Tasks` will become `[[Tasks]]` -- a VimWiki link. Press Enter again to
+open it. Edit the file, save it, and then press Backspace to jump back to your
 index.
 
-A Vimwiki link can be constructed from more than one word.  Just visually
+A VimWiki link can be constructed from more than one word. Just visually
-select the words to be linked and press Enter.  Try it with `Project Gutenberg`.
+select the words to be linked and press Enter. Try it with `Project Gutenberg`.
 The result should look something like:
 
-    = My knowledge base =
+```
-        * [[Tasks]] -- things to be done _yesterday_!!!
+
-        * [[Project Gutenberg]] -- good books are power.
+= My knowledge base =
-        * Scratchpad -- various temporary stuff.
+    * [[Tasks]] -- things to be done _yesterday_!!!
+    * [[Project Gutenberg]] -- good books are power.
+    * Scratchpad -- various temporary stuff.
+
+```
+
+## Screenshots
+
+![Lists View](doc/lists.png)
+![Entries View](doc/entries.png)
+![Todos View](doc/todos.png)
+![Wiki View](doc/wiki.png)
+
+## Installation
+
+### Prerequisites
+
+Make sure you have these settings in your vimrc file:
+
+```vim
+
+set nocompatible
+filetype plugin on
+syntax on
+
+```
+
+Without them VimWiki will not work properly.
 
 
-Basic Markup
+#### Installation using [Vim packages](http://vimhelp.appspot.com/repeat.txt.html#packages) (since Vim 7.4.1528)
-------------------------------------------------------------------------------
 
-    = Header1 =
+```sh
-    == Header2 ==
+
-    === Header3 ===
+git clone https://github.com/vimwiki/vimwiki.git ~/.vim/pack/plugins/start/vimwiki
+
+```
+
+#### Installation using [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332)
+
+```sh
+
+cd ~/.vim
+mkdir bundle
+cd bundle
+git clone https://github.com/vimwiki/vimwiki.git
+
+```
+
+#### Installation using [Vim-Plug](https://github.com/junegunn/vim-plug)
+
+Add the following to the plugin-configuration in your vimrc:
+
+```vim
+
+Plug 'vimwiki/vimwiki'
+
+```
+
+Then run `:PlugInstall`.
+
+#### Installation using [Vundle](https://github.com/VundleVim/Vundle.vim)
+
+Add `Plugin 'vimwiki/vimwiki'` to your vimrc file and run
+
+```sh
+
+vim +PluginInstall +qall
+
+```
+
+Or download the [zip
+archive](https://github.com/vimwiki/vimwiki/archive/master.zip) and extract it
+in `~/.vim/bundle/`
+
+Then launch Vim, run `:Helptags` and then `:help vimwiki` to verify it was
+installed.
+
+## Basic Markup
+
+```
+= Header1 =
+== Header2 ==
+=== Header3 ===
 
 
-    *bold* -- bold text
+*bold* -- bold text
-    _italic_ -- italic text
+_italic_ -- italic text
 
-    [[wiki link]] -- wiki link
+[[wiki link]] -- wiki link
-    [[wiki link|description]] -- wiki link with description
+[[wiki link|description]] -- wiki link with description
+```
 
+### Lists:
 
-Lists:
+```
-
+* bullet list item 1
-    * bullet list item 1
+    - bullet list item 2
-        - bullet list item 2
+    - bullet list item 3
-        - bullet list item 3
+        * bullet list item 4
-            * bullet list item 4
+        * bullet list item 5
-            * bullet list item 5
+* bullet list item 6
-    * bullet list item 6
+* bullet list item 7
-    * bullet list item 7
+    - bullet list item 8
-        - bullet list item 8
+    - bullet list item 9
-        - bullet list item 9
-
-    1. numbered list item 1
-    2. numbered list item 2
-        a) numbered list item 3
-        b) numbered list item 4
 
+1. numbered list item 1
+2. numbered list item 2
+    a) numbered list item 3
+    b) numbered list item 4
+```
 
 For other syntax elements, see `:h vimwiki-syntax`
 
+## Key bindings
 
-Key bindings
+Normal mode:
-------------------------------------------------------------------------------
-
-normal mode:
 
  * `<Leader>ww` -- Open default wiki index file.
  * `<Leader>wt` -- Open default wiki index file in a new tab.
@@ -100,89 +190,61 @@ normal mode:
 
 For more keys, see `:h vimwiki-mappings`
 
+## Commands
 
-Commands
+ * `:VimWiki2HTML` -- Convert current wiki link to HTML
-------------------------------------------------------------------------------
+ * `:VimWikiAll2HTML` -- Convert all your wiki links to HTML
-
- * `:Vimwiki2HTML` -- Convert current wiki link to HTML
- * `:VimwikiAll2HTML` -- Convert all your wiki links to HTML
  * `:help vimwiki-commands` -- list all commands
  * `:help vimwiki` -- General vimwiki help docs
 
+## Changing Wiki Syntax
 
-Changing Wiki Syntax
+VimWiki currently ships with 3 syntaxes: VimWiki (default), Markdown
-------------------------------------------------------------------------------
+(markdown), and MediaWiki (media)
 
- Vimwiki currently ships with 3 syntaxes: Vimwiki (default), Markdown (markdown), and MediaWiki (media)
+If you would prefer to use either Markdown or MediaWiki syntaxes, set the
+following option in your .vimrc:
 
- If you would prefer to use either Markdown or MediaWiki syntaxes, set the following option in your .vimrc:
+```vim
- ```
-     let g:vimwiki_list = [{'path': '~/vimwiki/',
-                           \ 'syntax': 'markdown', 'ext': '.md'}]
- ```
 
+let g:vimwiki_list = [{'path': '~/vimwiki/',
+                      \ 'syntax': 'markdown', 'ext': '.md'}]
 
-Installation
+```
-==============================================================================
 
-Prerequisites
+## Getting help
-------------------------------------------------------------------------------
 
-Make sure you have these settings in your vimrc file:
+**Have a question?**  
+Visit the IRC channel [`#vimwiki`](https://webchat.freenode.net/?channels=#vimwiki) on Freenode ([webchat](https://webchat.freenode.net/?channels=#vimwiki), also synced to Matrix/Riot: `#freenode_#vimwiki:matrix.org`) or post to the [mailing list](https://groups.google.com/forum/#!forum/vimwiki).
 
-    set nocompatible
+## Helping VimWiki
-    filetype plugin on
-    syntax on
 
-Without them Vimwiki will not work properly.
+VimWiki has a lot of users but only very few recurring developers or people
+helping the community. Your help is therefore appreciated. Everyone can help!
+See [#625](https://github.com/vimwiki/vimwiki/issues/625) for information on
+how you can help.
 
+## License
 
-Installation using [Vim packages](http://vimhelp.appspot.com/repeat.txt.html#packages) (since Vim 7.4.1528)
+MIT License
-------------------------------------------------------------------------------
 
-    git clone https://github.com/vimwiki/vimwiki.git ~/.vim/pack/plugins/start/vimwiki
+Copyright (c) 2008-2010 Maxim Kim
+              2013-2017 Daniel Schemala
 
-Installation using [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332)
+Permission is hereby granted, free of charge, to any person obtaining a copy
-------------------------------------------------------------------------------
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-    cd ~/.vim
+The above copyright notice and this permission notice shall be included in all
-    mkdir bundle
+copies or substantial portions of the Software.
-    cd bundle
-    git clone https://github.com/vimwiki/vimwiki.git
 
-Installation using [Vim-Plug](https://github.com/junegunn/vim-plug)
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-------------------------------------------------------------------------------
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-Add the following to the plugin-configuration in your vimrc:
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-    Plug 'vimwiki/vimwiki'
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-
+SOFTWARE.
-Then run `:PlugInstall`.
-
-Installation using [Vundle](https://github.com/VundleVim/Vundle.vim)
-------------------------------------------------------------------------------
-
-Add `Plugin 'vimwiki/vimwiki'` to your vimrc file and run
-
-    vim +PluginInstall +qall
-
-Or download the [zip archive](https://github.com/vimwiki/vimwiki/archive/master.zip) and extract it in `~/.vim/bundle/`
-
-Then launch Vim, run `:Helptags` and then `:help vimwiki` to verify it was installed.
-
-
-Getting help
-==============================================================================
-
-Have a question? Visit the IRC channel `#vimwiki` on Freenode ([webchat](https://webchat.freenode.net/?channels=#vimwiki), also synced to Matrix/Riot: `#freenode_#vimwiki:matrix.org`) or post to the [mailing list](https://groups.google.com/forum/#!forum/vimwiki).
-
-Helping Vimwiki
-==============================================================================
-
-Vimwiki has a lot of users but only very few recurring developers or people helping the community. Your help is therefore appreciated. Everyone can help! See [#625](https://github.com/vimwiki/vimwiki/issues/625) for information on how you can help.
-
-
-
-----
-\* Screenshots made with the [solarized colorscheme](https://github.com/altercation/vim-colors-solarized)
-and [lightline](https://github.com/itchyny/lightline.vim)

doc/vimwiki.txt

@@ -9,7 +9,7 @@
               |___|  |___| |_|   |_||__| |__||___| |___| |_||___|            ~
 
 
-                               Version: 2.4
+                               Version: 2.4.1
 
 ==============================================================================
 CONTENTS                                                             *vimwiki*
@@ -2988,6 +2988,7 @@ Contributors and their Github usernames in roughly chronological order:
     - Stefan Huber (@shuber2)
     - Hugo Hörnquist (@HugoNikanor)
     - Rane Brown (@ranebrown)
+    - @monkinco
 
 
 ==============================================================================
@@ -3000,6 +3001,12 @@ http://code.google.com/p/vimwiki/issues/list. They may be accessible from
 https://github.com/vimwiki-backup/vimwiki/issues.
 
 
+2.4.1 (2019-02-20)~
+Fixed:
+    * Fix VimwikiShowVersion function.
+    * strikethrough `~` characters were not hidden within tables
+    * Update and format README.md and update screen shots
+
 2.4 (2019-03-24)~
 
 New:~

plugin/vimwiki.vim

@@ -10,7 +10,7 @@ endif
 let g:loaded_vimwiki = 1
 
 " Set to version number for release, otherwise -1 for dev-branch
-let s:plugin_vers = 2.4
+let s:plugin_vers = "2.4.1"
 
 " Get the directory the script is installed in
 let s:plugin_dir = expand('<sfile>:p:h:h')
@@ -195,15 +195,15 @@ endfunction
 
 function! s:get_version()
   if s:plugin_vers != -1
-    echo "Stable version: " . s:plugin_vers
+    echo "Stable version: " . string(s:plugin_vers)
   else
-    let a:plugin_rev    = system("git --git-dir " . s:plugin_dir . "/.git rev-parse --short HEAD")
+    let l:plugin_rev    = system("git --git-dir " . s:plugin_dir . "/.git rev-parse --short HEAD")
-    let a:plugin_branch = system("git --git-dir " . s:plugin_dir . "/.git rev-parse --abbrev-ref HEAD")
+    let l:plugin_branch = system("git --git-dir " . s:plugin_dir . "/.git rev-parse --abbrev-ref HEAD")
-    let a:plugin_date   = system("git --git-dir " . s:plugin_dir . "/.git show -s --format=%ci")
+    let l:plugin_date   = system("git --git-dir " . s:plugin_dir . "/.git show -s --format=%ci")
     if v:shell_error == 0
-      echo "Branch: " . a:plugin_branch
+      echo "Branch: " . l:plugin_branch
-      echo "Revision: " . a:plugin_rev
+      echo "Revision: " . l:plugin_rev
-      echo "Date: " . a:plugin_date
+      echo "Date: " . l:plugin_date
     else
       echo "Unknown version"
     endif

syntax/vimwiki.vim

@@ -297,7 +297,7 @@ execute 'syntax match VimwikiItalicBoldT /'.vimwiki#vars#get_syntaxlocal('rxItal
 execute 'syntax match VimwikiDelText /'.vimwiki#vars#get_syntaxlocal('rxDelText').
       \ '/ contains=VimwikiDelTextChar,@Spell'
 execute 'syntax match VimwikiDelTextT /'.vimwiki#vars#get_syntaxlocal('rxDelText').
-      \ '/ contained contains=VimwikiDelTextChar,@Spell'
+      \ '/ contained contains=VimwikiDelTextCharT,@Spell'
 
 execute 'syntax match VimwikiSuperScript /'.vimwiki#vars#get_syntaxlocal('rxSuperScript').
       \ '/ contains=VimwikiSuperScriptChar,@Spell'