v2024.01.24

2022.01.24

A minor documentation release.

New

• Docs: describe undocumented key mappings by @qadzek in #1389
• README.md: Tidy, remove pointers to defunct Matrix channel and Google Group, add wikis.world Mastodon account.

New Contributors

• @qadzek made their first contribution in #1389

Full Changelog: v2024.01.22...v2024.01.24

v2024.01.22

2024.01.22

This is something of a catchup release, bundling in changes since April (!) of last year, mostly bugfixes.

New

• Issue #1279: Fix/Improvement: When re-wrap a long line in a definition by gq it should insert :: at the new line
• Issue #1211: Support angle bracket escaped markdown urls
• Make auto_tags preserve existing tag section structure
• Issue #1315: GTD-style token highlighting
• Issue #1279: gqq autowrap leading :: definition as &l:comments
• Issue #1332: message URLs on Mac
• Util: add vimwiki#vars#set_syntaxlocal function for consistency

Fixed:

• Issue #1365: Fix: count ignored when looking up diary frequency Issue
• Issue #1323: Folding code blocks using markdown syntax folds the entire rest of the file
• Issue #1365: Jumping to nested anchor with markdown
• Issue #1297: Handle multibyte chars properly in table separators
• Issue #1311: Newlines in HTML conversion of codeblocks
• Issue #1326: Duplicate tag generation
• Issue #1324: File name prompt fixes
• Fix vimwiki#diary#calendar_sign when g:vimwiki_list is not set
• Use fnameescape() instead of escape() in edit_file()
• Admit trailing spaces for YAML delimiters
• Minor documentation fixes and CI improvements

v2023.04.04_1

v2023.04.04_1

Updates g:vimwiki_version for latest release.

v2023.04.04

2023.04.04

New:

• Issue #1261: Feature: Support for <mark> in Markdown highlighting with yellow background and back foreground
• Issue #1274: Feature: Continue blockquote when <CR> is pressed in insert mode; also add the blockquote_markers variable

Fixed:

• Issue #1267: Improve performance on link creation by speeding up is_diary_file()
• Issue #1229: Bug: VimwikiGoto without argument creates empty page
• Issue #1316: Permit tags in heading and improve VimwikiSearchTags and VimwikiRebuildTags
• Issue #1270: VimwikiAddHeaderLevel map (3=) was broken by a previous refactoring commit

v2022.03.15

Add more test, modify typeface regexes and add yaml metadata blcok feature

New:

• Issue #150 Fix Math border cases according to https://pandoc.org/MANUAL.html#math
• Issue #1287 Highlight YAML header with |yaml_metadata_block| configuration variable holding region delimiters

v2022.12.02

VimWiki 2022.12.02

This is the first release since v2.5, on 2020-05-26. It accumulates a fairly large set of fixes and some improvements.

With this release, we're more or less switching to a rolling release model. dev is now the permanent main branch, with master kept as a mirror of that in order to avoid breaking existing checkouts of the plugin. Future releases should be more frequent and much, much smaller in scope.

There are likely breaking changes here, although hopefully not too many.

New

• Policy: #1235: Move to calendar versioning and rolling release cadence
• Feature: #238: Reuse existing tabs with tab drop
• Issue #621: Feature request: Highlight code listings in HTML
• Issue #290: Calendar plugin, do not sign if no wiki
• Issue #281: Permit \| in tables
• PR #1128: VimwikiGoto: Support wiki pages with spaces
• Feature: Add option to use link Description in default syntax if caption is present.
• PR #1106: Fix trailing closing brace and comma typo
• Feature: VimwikiColorize maps in visual and normal mode <leader>wc
• Feature: PR #686: add a flag lists_return to disable mappings to <CR> and <S-CR> in insert mode
• Feature: enable re-mapping insert mode table mappings
• Feature: configure expression for Todo words
• Feature: #954 #1041: Add option vimwiki-option-listsyms_propagate to disable todo propagation to parents/children
• Issue #1009: foldmethod syntax works for markdown (g:vimwiki_folding) Also the VimwikiHeader1Folding (1..60 regions support end-of-file /\%$ as end marker
• Issue #990: Feature request: highlight multiline selection Add :VimwikiColorize with only support to clorize the current line
• PR #919: Fix duplicate helptag
• Feature: PR #988: Command VimwikiVar to list, get and set variables
• Feature: #837 extract web page <title> from URL under cursor and create a nice wiki link
• Feature: #922 #928: g:vimwiki_tag_format to change the tag format
• Feature: Support Emoji (Conceal and Complete)
• Issue #209: Feature: Markdown: Support SetExt Heading
• Issue #847 #640: Feature: Markdown anchor normalize and unormalize: better follow_link and VimwikiTOC
• Commit 5408d74: Syntax: Html support nested, concealable tag and faster start syntax region for typeface
• Issue #926: Feature: VimwikiRenameFile 1/ to other dir 2/ take argument (completable)
• Test: travis run vint in an parallel jobs => faster
• Issue #915: Feature: blockquote (> ) better joining (J) and wrap
• Issue #913: Allow VimwikiGoto completion after <CR>
• PR #967: Add multiline comment support via %%+ and +%%
• PR #946: Add option g:vimwiki_commentstring to customize commentstring
• Issue #940: Render table header inside thead element and rest under tbody element if table header specified in wiki
• PR #811: Feature: Added handling of absolute path to vimwiki (with //)
• PR #906: Add VimwikiRemoveDone to remove all todo items that are done
• PR #907: Cycle bullets
• PR #901: adds multiparagraph blockquotes using email style syntax
• PR #934: RSS feed generation for diary with :VimwikiRss.
• Feature: Add option vimwiki-option-template_date_format to configure alternative date string format
• Feature: Add VimwikiPasteLink to paste an absolute wiki link to the current file
• Feature: Add VimwikiBaddLink to add links to the buffer list, without loading, if they weren't listed yet

Changed

• PR #1047: Allow to replace default mapping of VimwikiToggleListItem
• VimwikiCheckLinks work on current wiki or on range
• PR #1057: Change how resolve subdir work Change how shell escaping work when using CustomWiki2HTML
• PR #1132: Spaces in link descriptions are no longer replaced with links_space_char

Removed

According to changelog entries, nothing was removed this release. It's fairly unlikely, however, that at least some breaking changes didn't creep in. Please report anything that seems to have gone missing.

Fixed

• PR #1240 / issue #1241: Vimwiki2HTMLBrowse now works with Markdown
• Issue #950: Correctly follow links containing .
• PR #1245 / issue #1244: Fix VimwikiBacklinks handling of bracketed links
• Issue #1193: Fix wildcard expansion in find_autoload_file
• PR #1108: Fix resolution of leading-slash page links, add link tests
• Allow title values with quotes
• Enable strikethrough for Neovim
• Issue #1029: Fix: error loading plugin when lang uses comma instead of dot as decimal separator
• Issue #886: :VimwikiGenerateLinks not working on Windows
• Issue #55: Newlines in blockquotes are not honored
• Issue #55: BlockQuote restarts list numbering
• Issue #979: Fix: Accessing other filetypes within vimwiki
• Issue #886: VimwikiGenerateLinks crash with single quote in filename
• Issue #910: Fix: VimwikiTOC removes next non-empty line
• Issue #182: VimwikiTOC support headers with link
• Issue #813: iMap <Cr> interfere with completion (pum)
• Issue #709: Support inline code spans inside emphasis Refactoring code, del, eq, sup, sub as regions
• Issue #847 #640: Refactor: Syntax highlighting typeface: match -> region
• Issue #891: Fix: Table Pressing <Enter> autosets tw to 0
• Issue #894: Make all appropriate settings wikilocal (many commits)
• PR #902: Doc: Darken logo text
• PR #895: Fix: File extension for markdown -> syntax wide __FileExtention__ keyword appears
• PR #963: Doc: Replace VimwikiListChangeLevel references in doc with VimwikiListChangeLvl as defined by command
• PR #900: conceallevel is now setted locally for vimwiki buffers
• Issue #942: Fixing wrong html link conversion in windows
• PR #919: Fix duplicate helptag
• PR #959: Fix :VimwikiNextTask
• PR #986: Fix typo in help file
• PR #1030: Allow overwriting insert mode mappings
• PR #1057: Fix renaming, updating link, and exporting HTML subdir wrong
• Fix resolve subdir return wrong path in Windows
• Issue #794: Fix: Generated tag links are build wrong
• Issue #763: Links opening in qutebrowser multiple times on Linux

Release 2.5

New:

• PR #787: :VimwikiRenameFile works for all directories: even
  wiki_root/diary/2019-12-11.md if current file is wiki_root/dir1/file.md.
• Issue #764: fenced code blocks are properly supported for markdown
  syntax i.e. more than 3 backticks, adds tilde support.
• PR #785: :VimwikiGoto completion works with part of filename and
  nested directories
• Add test framework (vader, vint, vim-testbed)
• Issue #769: Set default values for g:vimwiki_ext2syntax.
• PR #735: Make list-toggling work properly even when code blocks are
  embedded within the list in Markdown mode.
• PR #711: Allow forcing VimwikiAll2HTML with !
• PR #702: Make remapping documentation more accessible to newer vim users
• PR #673: Add :VimwikiGoto key mapping.
• PR #689: Allow vimwiki-option-diary_rel_path to be an empty string.
• PR #683: Improve layout and format of key binding documentation in
  README and include note about key bindings that may not work.
• PR #681: Prevent sticky type checking errors for old vim versions.
• PR #686: New option g:vimwiki_key_mappings that allow key mappings to
  be enabled/disabled by groups. Key mappings are also no longer
  overwritten if they are already defined.
• PR #675: Add option vimwiki-option-name to assign a per wiki name.
• PR #661: Add option g:vimwiki_auto_header to automatically generate
  a level 1 header for new wiki pages.
• PR #665: Integration with vimwiki_markdown gem
  https://github.com/patrickdavey/vimwiki_markdown
  This provides the vimwiki-option-html_filename_parameterization
  which alters the filenames vimiwiki checks against when running the
  html conversion. It also disables the deleting of html files which
  no longer match against a wiki file.
• PR #663: New option g:vimwiki_conceal_onechar_markers to control
  whether to show or hide single-character format markers.
• PR #636: Wiki local option vimwiki-option-exclude_files which is
  a list of patterns to exclude when checking or generating links.
• PR #644: Key mapping gnt to jump to the next open task.
• PR #643: Option g:vimwiki_toc_link_format to change how links are
  formatted in the TOC.
• PR #641: Option g:vimwiki_conceal_code_blocks to conceal preformatted
  text markers.
• PR #634: New options g:vimwiki_links_header and
  g:vimwiki_tags_header to customize the title string of generated
  sections. New option g:vimwiki_links_header_level and
  g:vimwiki_tags_header_level which allow the header level (1-6) of the
  generated links to be set. New option g:vimwiki_markdown_header_style
  which specifies the nuber of newlines after the created header for
  generated sections.
• PR #635: Wiki local options vimwiki-option-auto_generate_links and
  vimwiki-option-auto_generate_tags.
• Wiki local option vimwiki-option-links_space_char to replace spaces
  with a different character when creating a link.
• Allow increase/decrease header level to take a count.
• PR #637: Option g:vimwiki_table_reduce_last_col to not autoformat last
  column of a table.
• PR #629: New option g:vimwiki_toc_header_level to set the desired
  header level for the TOC.
• PR #616: Hex color codes are colored in HTML output.
• PR #573: Add HTML template variable %wiki_path% which outputs the path
  of the current file being converted to HTML.
• PR #529: Option g:vimwiki_markdown_link_ext to include the extension
  .md in generated links.
• PR #528: Add option g:vimwiki_create_link to prevent link creation
  with <CR>.
• PR #498: Option vimwiki-option-diary_caption_level which adds captions
  to the diary index based on headers.
• PR #377: Add horizontal alignment to tables.
• PR #202: Don't override or display errors for existing keymappings.
• PR #47: Optimize table formatting for large tables.
• PR #857: Make default template responsive
• PR #879: Generate links when diary & wiki dir are the same

Changed:

• Issue #796: Rename :VimwikiGenerateTags to :VimwikiGenerateTagLinks
• Issue #638: Rename :VimwikiDeleteLink to :VimwikiDeleteFile
• Issue #638: Rename :VimwikiRenameLink to :VimwikiRenameFile
• For all three above the old commands still works but is deprecated and
  will be removed in later versions.
• Set default vimwiki-option-list_margin = 0 for markdown syntax.
• Modify horizontal rule (thematic-breaks) syntax for markdown.

Removed:

• PR #698: Remove awa check triggering silent file edits.
• Options g:vimwiki_use_mouse and g:vimwiki_table_mappings. These are
  still present in the code for backwards compatibility but have been
  removed from the documentation and will be fully removed at a later
  point.

Fixed:

• Issue #90: :VimwikiRenameFile doesn't update links in diary.
• Issue #790: Allow tags before a header with markdown syntax.
• Issue #779: Vimwiki tags file meets ctags standard.
• Issue #781: Compatablity fixes for older versions of Vim.
• Issue #691: Allow :VimwikiGoBackLink to go back multiple times.
• Update MathJax CDN loading instructions.
• Issue #212: Don't treat comment characters within code blocks as
  headers.
• Issue #420: Add error handling to :VimwikiSearch
• PR #744: Fix typo in vimwiki_list_manipulation
• Issue #715: s:clean_url is compatible with vim pre 7.4.1546 (sticky type
  checking)
• Issue #729: Normalize links uses relative paths in diary pages for
  Markdown syntax. This previously only worked for the default syntax.
• Disable spell check in code and math inline/blocks.
• Properly handle markdown image links ![]()
• Issue #415: Expand iabbrev entries on <CR>.
• Issue #619: allow escaped characters in markdown links.
• Issue #240: Fix regex pattern for markdown []() links
• Issue #685: Error message for invalid user options fixed.
• Issue #481: Allow surrounding URLs with '<' '>'
• Issue #237: :VimwikiRenameFile now works for Markdown syntax
• Issue #612: GVim menu displayed duplicate names.
• Issue #456: Omnicompletion of wikilinks under Windows. Note: this should
  be considered a temporary fix until #478 is closed.
• Issue #654: Fix :VimwikiShowVersion command.
• PR #634: Removed extra newlines that were inserted before/after
  generated links.
• Issue #543: Allow commands related to opening index files or diary pages
  to take a count, modify keymapping behavior, and fix discrepancies in
  the documentation.
• Issue #539: The option g:vimwiki_url_maxsave now only affects raw
  URLs (wiki links are excluded).
• Issue #438: Fix creation of visually selected links on diary pages.
• Issue #404: Don't conceal strikethrough character in tables.
• Issue #318: Markdown syntax bold, italic, and italic/bold are now
  rendered correctly.
• Issue #835: Pressing enter on the dash of a markdown list causes an error.
• Issue #876: E684: list index out of range: 0, when creating a link containing a ..
• Issue #803: :VimwikiGenerateLinks for subdirectory only
• Issue #776: Command [count]o can't repeat in vimwiki

2.4.1

Minor bugfix release

Fixes:

• Fix VimwikiShowVersion function.
• strikethrough ~ characters were not hidden within tables
• Update and format README.md and update screen shots

2.4

New

• Add the option g:vimwiki_text_ignore_newline.
• g:vimwiki_listsyms can have fewer or more than 5 symbols.
• glx on a list item marks a checkbox as won't do, see :h vimwiki_glx.
• Add the option g:vimwiki_listsym_rejected to set the character used for won't-do list items.
• gln and glp change the "done" status of a checkbox, see vimwiki_gln.
• :VimwikiSplitLink and :VimwikiVSplitLink can now reuse an existing split window and not move the cursor.
• Add 'aH' and 'iH' text objects, see vimwiki-text-objects.
• Add the keys vimwiki_[[, vimwiki_]], vimwiki_[=, vimwiki_]= and vimwiki_]u for navigating between headers.
• Add the command :VimwikiMakeTomorrowDiaryNote.
• g:vimwiki_folding has a new option 'custom'.
• Add the ':quick' option for faster folding, see g:vimwiki_folding.
• Add the %date placeholder, see vimwiki-date.
• Add the option vimwiki-option-custom_wiki2html_args.
• Add support for HTML-style comments when using markdown syntax.
• Made headings link to themselves in HTML output.
• Add :VimwikiShowVersion to check the version

Removed

• Remove the undocumented and buggy command :VimwikiReadLocalOptions which allowed to store Vimwiki related settings in a local file.
• Remove the undocumented command :VimwikiPrintWikiState.
• For complicated reasons, Vimwiki doesn't clean up its settings anymore if you change the filetype of a wiki buffer.

Fixed

• Make vimwiki-option-automatic_nested_syntaxes work also for markdown.
• Issue #236: Highlight math blocks as TeX math, not TeX.
• Issue #264: Don't overwrite mappings to i_ from other plugins.
• Fix an error where sometimes didn't work under Windows.
• Issue #302: :VimwikiDiaryGenerateLinks had issues with markdown.
• Issue #445: Better handling of 'autowriteall' and 'hidden'.
• Improve 'ah' and 'ih' text objects, see vimwiki-text-objects.
• Allow opening of links using Powershell.
• Allow any visual mode to be used with vimwiki_+.
• Markdown syntax for vimwiki-toc is used, when appropriate.
• Wikis can now be in subfolders of other wikis.
• Issue #482: :VimwikiMakeDiaryNote now uses the diary of the current wiki.
• Opening the diary and wikis from the menu works correctly now.
• Issue #497: Make :VimwikiMakeDiaryNote work outside a wiki buffer.
• Use markdown syntax in the diary when appropriate.
• Improve handling of errors on opening files.
• Update links when renaming a page with :VimwikiRenameLink.
• Fix losing the highlighting in various situations.
• Improved link normalisation.
• Various other minor fixes.

2.3

New

• Add :VimwikiMakeYesterdayDiaryNote command
• Issue #128: add option vimwiki-option-automatic_nested_syntaxes
• Issue #192: Sort links in the list generated by :VimwikiGenerateTags

Fixed

• Issue #176: Fix issue when the wiki path contains spaces
• Also look for tags in wiki files in subdirectories
• Locate the .tags file correctly on Windows
• Issue #183: Fix HTML conversion of headers containing links
• Issue #64: create correct Markdown links when pressing CR on a word
• Issue #191: ignore headers inside preformatted text when creating the TOC
• Create the standard CSS file also if only one file is converted to HTML
• Fix #188: vimwiki_+ on a raw url surrounds it with brackets
• various minor fixes