vimwiki/vimwiki

Feature: Open folds when navigating

Open

#140 opened on May 28, 2015

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Vim Script (9,400 stars) (647 forks)batch import
enhancementgood first issuework-around-exists

Description

I'm an avid user of folds, and I think the vimwiki folding is working well. However, navigating in the wiki by use of <cr> (and similar) with folding enabled often leads to closed folds. I therefore often do something like zv to open the folds after I've navigated with <cr>.

I propose to either add a call to zv in the <cr> mapping, or to add a hook or in some way allow the user to add actions to be performed after a wiki link has been opened. The latter seems the best solution to me, as it gives more control, but the former is also OK. I think it makes sense that navigation in the wiki always opens the folds at the link targets.

Contributor guide

Tech stack
None
Domain
developer experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Vim scriptVimwiki codebase understanding
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue requests adding an automatic fold opening mechanism when navigating with <cr> in vimwiki. The simplest approach is to modify the <cr> mapping in the plugin to include a call to `zv` after opening a link. This can be found in the vimwiki source, likely in the file that defines the `<Plug>VimwikiFollowLink` mapping. Alternatively, implementing a user configurable hook would be more flexible but requires more design. Check the current mapping in `autoload/vimwiki/base.vim` or similar. No linked PRs or comments suggesting a solution.