:MDEIndices -> :MDEIndex

Author: ubaldot

autoload/mde_indices.vim

@@ -3,26 +3,58 @@ vim9script
 import autoload "./mde_links.vim" as links
 import autoload "./mde_utils.vim" as utils
 
+var indices: any
 var indices_id = -1
 
 def IndicesCallback(id: number, idx: number)
   if idx > 0
 
-    if typename(g:markdown_extras_indices) == "list<string>"
-      var selection = getbufline(winbufnr(id), idx)[0]
-      exe $'edit {selection}'
-    elseif typename(g:markdown_extras_indices) == "dict<string>"
-      var selection = getbufline(winbufnr(id), idx)[0]
-      exe $'edit {g:markdown_extras_indices[selection]}'
+    var selection = ''
+    if typename(indices) == "list<string>"
+      selection = getbufline(winbufnr(id), idx)[0]
+    elseif typename(indices) == "list<list<string>>"
+      selection = getbufline(winbufnr(id), idx)[0]
+      var indices_names = indices->mapnew((_, val) => val[0])
+      var ii = index(indices_names, selection)
+      selection = indices[ii][1]
+    elseif typename(indices) == "dict<string>"
+      var selection_key = getbufline(winbufnr(id), idx)[0]
+      selection = indices[selection_key]
     endif
+
+    if !empty(selection)
+      if links.IsURL(selection) && selection =~ '^file://'
+        exe $'edit {fnameescape(links.URLToPath(selection))}'
+      elseif links.IsURL(selection)
+        exe $'Open {selection}'
+      else
+        exe $'edit {fnameescape(selection)}'
+      endif
+    endif
+
     indices_id = -1
   endif
 enddef
 
-export def ShowIndices()
-  if exists('g:markdown_extras_indices') != 0 && !empty('g:markdown_extras_indices')
+export def ShowIndices(passed_indices: string='')
+  var indices_found = false
+  echom typename(passed_indices)
+
+  if !empty(passed_indices)
+    # TODO: remove the eval() with something better
+    indices = eval(passed_indices)
+    indices_found = true
+  elseif exists('g:markdown_extras_indices') != 0
+      && !empty('g:markdown_extras_indices')
+    indices = g:markdown_extras_indices
+    indices_found = true
+  else
+    utils.Echoerr("Cannot find indices" )
+  endif
+
+  if indices_found
     const popup_width = (&columns * 2) / 3
-    const popup_height = min([len(g:markdown_extras_indices), &lines / 2])
+    const popup_height = min([len(indices), &lines / 2])
     var opts = {
         pos: 'center',
         border: [1, 1, 1, 1],
@@ -38,14 +70,18 @@ export def ShowIndices()
         wrap: 0,
         drag: 0,
       }
-    if typename(g:markdown_extras_indices) == "list<string>"
-      indices_id = popup_create(g:markdown_extras_indices, opts)
-      links.ShowPromptPopup(indices_id, g:markdown_extras_indices, " indices: ")
-    elseif typename(g:markdown_extras_indices) == "dict<string>"
-      indices_id = popup_create(keys(g:markdown_extras_indices), opts)
-      links.ShowPromptPopup(indices_id, keys(g:markdown_extras_indices), " indices: ")
+    if typename(indices) == "list<string>"
+      indices_id = popup_create(indices, opts)
+      links.ShowPromptPopup(indices_id, indices, " indices: ")
+    elseif typename(indices) == "list<list<string>>"
+      var indices_names = indices->mapnew((_, val) => val[0])
+      indices_id = popup_create(indices_names, opts)
+      links.ShowPromptPopup(indices_id, indices_names, " indices: ")
+    elseif typename(indices) == "dict<string>"
+      indices_id = popup_create(keys(indices), opts)
+      links.ShowPromptPopup(indices_id, keys(indices), " indices: ")
+    else
+      utils.Echoerr($"Wrong argument type to ':MDEIndex' ({typename(indices)})")
     endif
-  else
-    utils.Echoerr("'g:markdown_extras_indices' not set" )
   endif
 enddef

doc/markdown_extras.txt

@@ -162,11 +162,8 @@ You could for example set the following:
 INDICES
 
 As the plugin can be used for note-taking, it may be desirable to access
-different indices in an ergonomic way. This can be achieved with the
-|g:markdown_extras_indices| list in combination with the |:MDEIndices|
-command. Note that `g:markdown_extras_indices` is nothing, but a list (or a dict)
-of files. If it is a dict, then the keys is what is displayed in the popup
-menu and the values are the corresponding links.
+different indices in an ergonomic way. This can be achieved with the |:MDEIndex|
+command.
 
 ==============================================================================
 CONFIGURATION       *markdown-extras-configuration* *g:markdown_extras_config*
@@ -223,8 +220,11 @@ filling it with he various keys.
 
 
 						*g:markdown_extras_indices*
-g:markdown_extras_indices list<string> or dict<string>.
+g:markdown_extras_indices list<string>, list<list<string>> or dict<string>.
 			  If list<string>, contain the path of indices files.
+			  If list<string<string>> the first element of each
+			  item of the list is the alias, whereas the second
+			  is the link.
 			  If dict<string>, the values are the actual links
 			  whereas the keys are aliases. In the popup menu only
 			  the alias are displayed.
@@ -250,9 +250,27 @@ COMMANDS                                         *markdown-extras-commands*
                                                         *:MDEConvertLinks*
 :MDEConvertLinks    Convert inline links into reference-style links.
 
-                                                            *:MDEIndices*
-:MDEIndices         Open a popup with all the filenames included in
-                    |g:markdown_extras_indices|.
+                                                            *:MDEIndex*
+:MDEIndex [{args}]  Open a popup with all the URLs specified in {args}.
+		    The type of {args} can be list<string>, list<list<string>>
+		    or dict<string>. If no argument is passed, then
+		    |g:markdown_extras_indices| is considered.
+		    Example:
+		    >
+	    :MDEIndex  # Uses g:markdown_extras_indices
+	    :MDEIndex ['path1', 'path2', 'path3]
+	    :MDEIndex {foo: 'path1', bar: 'path2', baz: 'path3}
+	    :MDEIndex [['foo', 'path1'], ['bar', 'path2'], ['baz', 'path3]]
+<
+		    Or you can use in a script, like for example:
+		    >
+		      const my_index = {
+			foo: '/Users/ubaldot/home/Documents/foo.vim',
+			bar: 'https://example.com',
+			banana: '/mnt/c/files/bar.md'
+		      }
+		      execute $"MDEIndex {my_index}"
+<
 
                                                             *:MDEMake*
 :MDEMake            Invoke |:make| and |:Open| the rendered file. It requires

doc/tags

@@ -1,5 +1,5 @@
 :MDEConvertLinks	markdown_extras.txt	/*:MDEConvertLinks*
-:MDEIndices	markdown_extras.txt	/*:MDEIndices*
+:MDEIndex	markdown_extras.txt	/*:MDEIndex*
 :MDEMake	markdown_extras.txt	/*:MDEMake*
 g:markdown_extras_config	markdown_extras.txt	/*g:markdown_extras_config*
 g:markdown_extras_indices	markdown_extras.txt	/*g:markdown_extras_indices*

ftplugin/markdown.vim

@@ -22,7 +22,6 @@ endfor
 
 # Convert links inline links [mylink](blabla) to referenced links [mylink][3]
 command! -buffer -nargs=0 MDEConvertLinks links.ConvertLinks()
-command! -buffer -nargs=0 MDEIndices indices.ShowIndices()
 
 # Jump back to the previous file
 nnoremap <buffer> <backspace> <ScriptCmd>funcs.GoToPrevVisitedBuffer()<cr>

plugin/markdown_extras.vim

@@ -6,6 +6,7 @@ vim9script noclear
 
 import autoload './../autoload/mde_utils.vim' as utils
 import autoload './../autoload/mde_funcs.vim' as funcs
+import autoload './../autoload/mde_indices.vim' as indices
 
 if has('win32') && !has("patch-9.1.1270")
   # Needs Vim version 9.0 and above
@@ -23,10 +24,8 @@ endif
 var release_notes =<< FOO
 ## vim-markdown-extras: release notes
 
-Links must have a valid URL format to keep consistency with
-the markdown requirements.
-
-Hence, the following link:
+1. Links must have a valid URL format to keep consistency with
+the markdown requirements. Hence, the following link:
 
 [1]: C:\User\John\My Documents\foo bar.txt
 
@@ -40,6 +39,11 @@ Please, update the links in your markdown files.
 You can ask any LLM to convert the links for you.
 Typically, they are quite accurate.
 
+2. `:MDEIndices` has been renamed to `:MDEIndex` and can take an argument, for
+example you can call as `:MDEIndices ['apple', 'banana', 'strawberry']`.
+Furthermore, such a command is no longer valid only for markdown files but
+it become global.
+
 Press <Esc> to close this popup.
 FOO
 
@@ -56,8 +60,6 @@ def ShowReleaseNotes()
   win_execute(popup_id, 'set conceallevel=2')
 enddef
 
-command! -nargs=0 MDEReleaseNotes ShowReleaseNotes()
-
 augroup MARKDOWN_EXTRAS_VISITED_BUFFERS
     autocmd!
     autocmd BufEnter *  {
@@ -120,4 +122,7 @@ if use_pandoc && !executable('pandoc')
   endif
 endif
 
-g:markdown_extras_loaded = true
+command! -nargs=0 MDEReleaseNotes ShowReleaseNotes()
+command! -nargs=? MDEIndex indices.ShowIndices(<f-args>)
+
+g:markdown_extras_loaded = false