iVim icon indicating copy to clipboard operation
iVim copied to clipboard

Add support for VimWiki

Open pyager opened this issue 7 years ago • 5 comments

Please add support for VimWiki.

pyager avatar Apr 16 '18 16:04 pyager

What do you mean? Have you tried it? Are there problems? Or is it just that you don't know how to install a plugin in iVim?

sedm0784 avatar Apr 17 '18 11:04 sedm0784

Hi, @pyager , if you are talking about a vim plugin, you can try to install it and report some problems you might encounter.

Normally, iVim supports plugins that don't require external shell commands, and its default $HOME (what the "~" stands for) is the "Documents" directory.

terrychou avatar Apr 18 '18 01:04 terrychou

Yes, I am talking about a plugin. I didn’t see any documentation on use/implementation of plugins, and assumed that they needed to be bundled with the app, based upon Apple’s sandboxing. Since you indicate it is possible, can you point to an outline of how to install a plugin? I assume that it is not as easy on a desktop system (I use Pathogen for my desktop vim).

pyager avatar Apr 18 '18 16:04 pyager

Usually, you can find the installation instructions on the plugin's project site.

When it comes to iVim, the main issue would be the filesystem operations (e.g. copying the necessary files to the specific locations).

a. to copy files to iVim, I would use the Files.app (:h ios-file-system).

b. one problem with the Files.app is that items beginning with dots are hidden in it. In this case, you can utilize the netrw plugin (installed by default) to do the rest deployment after you have copied the plugin into the sandbox of iVim. (:h ios-file-system)

c. as mentioned above, the default $HOME directory is the "Documents" directory.

d. be warned that, due to iOS's limitation, plugins that require external shell commands would not work in iVim.

e. according to other users, Pathogen also works well in iVim.

Please report here if you encounter any problems during the installation, we will see what we can do.

terrychou avatar Apr 19 '18 02:04 terrychou

It may be less tedious to install plugins in iVim if you use a Vimball.

I was glad to avoid moving each individual file into place. I was glad to avoid temporarily giving the ".vim" directory a name with a different first character, just so the Files app would list it.

On any machine with enough tools and filesystem access, you can package the plugin files as a Vimball. Details are in :h vimball, which comes with iVim along with the "vimball" plugin.

I don't know where to find a briefer summary of that process. I'll summarize it here.

On your packaging machine, you'll start by installing the plugin in the first directory in runtimepath. Commonly that is .vim (in Windows, vimfile), but you can put something else temporarily at the front of your runtimepath.

You'll use :[range]MkVimball[!] filename [path] to create the Vimball file. As far as I am aware, it will have ".vba" or ".vmb" appended to the filename that you specified.

Then you just need to move the Vimball somewhere like your iCloud Files, so that you can see the Vimball with iVim's :idoc command. You'll open the Vimball in iVim and hit :UseVimball (equivalently, :so %) to install the plugin.

minopret avatar Jul 02 '18 13:07 minopret