Skip to content

Troubleshooting section in Vim docs (:help orgmode.txt) are not parsing as links due to missing space #1158

Description

@rmunn

Describe the bug

The Troubleshooting section of the :help orgmode.txt table of contents currently looks like this:

2. Troubleshooting                                   |orgmode-troubleshooting|
  - Indentation is not working|orgmode-troubleshooting-indentation-is-not-working|
  - I get treesitter/query.lua errors when opening agenda/capture prompt or org files|orgmode-troubleshooting-i-get-treesitter/query.lua-errors-when-opening-agenda/capture-prompt-or-org-files|
  - I get .../orgmode/parser/org.so is not a valid Win32 application on Windows|orgmode-troubleshooting-i-get-.../orgmode/parser/org.so-is-not-a-valid-win32-application-on-windows|
  - Dates are not in English|orgmode-troubleshooting-dates-are-not-in-english|
  - Chinese characters are not displayed correctly in agenda|orgmode-troubleshooting-chinese-characters-are-not-displayed-correctly-in-agenda|
  - Links are not concealed  |orgmode-troubleshooting-links-are-not-concealed|
  - Jumping to file path is not working for paths with forward slash|orgmode-troubleshooting-jumping-to-file-path-is-not-working-for-paths-with-forward-slash|

Notice how "Links are not concealed" is the only bullet point with a space between it and the tag. Positioning the cursor on |orgmode-troubleshooting-links-are-not-concealed| and pressing Ctrl+] works properly, as does :help orgmode-troubleshooting-links-are-not-concealed. But all the other tags, which don't have a space before the initial | character, do not show up as jumpable links in NeoVim's :help orgmode.txt, and :help (subject) doesn't work either.

checkhealth

==============================================================================
orgmode: ✅

Orgmode ~

  • ✅ OK Treesitter grammar installed (version 2.0.4)
  • ✅ OK Setup called
  • ✅ OK org_agenda_files configured
  • ✅ OK org_default_notes_file configured

Steps to reproduce

  1. Install orgmode plugin
  2. Run :help orgmode.txt
  3. Try to click on, or position cursor on and press Ctrl+T, one of the links that don't have a space before the |

Expected behavior

The script that turns docs/troubleshoot.org into the NeoVim help files needs to be adjusted to always put at least one space between the bulleted list and the |-delimited tag in the table of contents, even if that would push the total line length past 78 characters. Then NeoVim's help system will parse those tags properly as jumpable/clickable links.

Emacs functionality

No response

Minimal init.lua

local tmp_dir = vim.env.TMPDIR or vim.env.TMP or vim.env.TEMP or '/tmp'
local nvim_root = tmp_dir .. '/nvim_orgmode'
local lazy_root = nvim_root .. '/lazy'
local lazypath = lazy_root .. '/lazy.nvim'

for _, name in ipairs({ 'config', 'data', 'state', 'cache' }) do
  vim.env[('XDG_%s_HOME'):format(name:upper())] = nvim_root .. '/' .. name
end

-- Install lazy.nvim if not already installed
if not vim.uv.fs_stat(lazypath) then
  vim.fn.system({
    'git',
    'clone',
    '--filter=blob:none',
    'https://github.com/folke/lazy.nvim.git',
    '--branch=stable', -- latest stable release
    lazypath,
  })
end
vim.opt.rtp:prepend(lazypath)

require('lazy').setup({
  {
    'nvim-orgmode/orgmode',
    event = 'VeryLazy',
    ft = { 'org' },
    config = function()
      require('orgmode').setup()
    end,
  },
}, {
  root = lazy_root,
  lockfile = nvim_root .. '/lazy.json',
  install = {
    missing = false,
  },
})

require('lazy').sync({
  wait = true,
  show = false,
})

Screenshots and recordings

No response

nvim-orgmode version

5f7fbf7

OS / Distro

Arch Linux

Neovim version/commit

NVIM v0.12.2

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions