vimoku 1.0.0

Python wrapper around Clingo/Answer Set Programming

vimoku

Edit pages of a dokuwiki instance with your favorite editor.

Use the RPC-XML interface of dokuwiki, accessed using dokuwikixmlrpc.

Installation

setup

Install vimoku.py somewhere, make it executable. You probably want to rename it just vimoku, or create aliases in your dot files.

Create a new repository with git init, and, in the git/config file, add the following section: You need to create the file $XDG_CONFIG_HOME/vimoku/vimoku.ini (Your $XDG_CONFIG_HOME is probably equal to ~/.config) as follow:

[DEFAULT]
url = https://yourwiki.url.net
user = john
password = yourpassword

The url is the url of your wiki. User and password are the login for the account you will use to publish your editions on the wiki. It therefore must be an existing dokuwiki user allowed to use RTC calls.

dependencies

Only one, really : dokuwikixmlrpc. There is no documentation, but the code is short and understandable. You probably look for the DokuWikiClient object.

pip install dokuwikixmlrpc should be enough, probably with --user. You could also copy paste in place of the imports the single source file of dokuwikixmlrpc in vimoku.py. Don't forget to remove the (call to) main function.

Tested with python 3.8. Should work with 3.6. Will not with 3.5 (sorry, f-strings are the best).

Usage

Edition

Use vimoku --help for help.

Basic usage:

vimoku pageid

You can edit multiple pages, using standard dokuwiki naming conventions for categories:

vimoku categ1:page1 page2 categ2:categ3:page3

And you may set a commit message (by default, it's undocumented remote modification):

vimoku page2 -m "guess from where i edit that page ??"

Your editor will fire a first time, letting you modify the pages you requested. It will fire a second time to let you modify, for each page, the commit message. And, if you opened other files, it will be fired a third time to ask you if they are wiki pages to retrieve and edit (see cycling).

Move and copy [NOT IMPLEMENTED]

Using flags --move-to and --copy-to, you can modify your wiki structure easily ! The only difference between the two is that moving deletes the page after copy. Note the existence of specific flags, such as --redirect and --fix-backlinks. See the below examples.

Change the name of a page, if the new name is not an existing page:

vimoku categ:pageid --move-to othercateg:newpageid

Change the name of a page, if the new name is not an existing page, with a redirection in the old page to the new one:

vimoku categ:pageid --move-to othercateg:newpageid --redirect

Move a category bar into another (note the : that indicate that the category, not the page, is to be considered):

vimoku bar: --move-to baz --redirect

Move all content of a category bar into baz, and put a redirection message in the moved pages:

vimoku bar:* --move-to baz --redirect

Vimoku will try to detect any possible fault with what you provided, then will ask you to review the move with your editor. There, you can go wild and erase entire pages by not paying attention to what you do.

Categories selection

The next example shows some advanced details regarding categories. Let's consider the wiki containing the following pages:

a
b
b:d:e
b:f
c
c:g

The following command:

vimoku a b: c --move-to h --redirect

Should move the pages to obtain:

b
c:g
h:a
h:b:d:e
h:b:f
h:c

If you also wanted to move b and c:g, you should indicate that you want to move b and c:, thus:

vimoku a b b: c c: --move-to h --redirect

tips

cycling

Once in your editor, if you create more files in the temporary directory containing the files you asked for edition, they will not be removed. Instead, you will be prompted (using your $EDITOR) about which files you want to edit properly.

The whole program will run again, this time retrieving the new files you asked for.

NB: if you wrote things in those manually opened files, you will loose your data. Even if the page doesn't exists on the wiki. Yes, that sucks. Help me.

editor options

Your vimoku.ini accept the following option: editor_option, which is formated with the variable cwd, the current working directory. Files to open are fed after those options. For instance, using vim, i ended up with the following value:

editor=/usr/bin/vim
editor_options=-c ":cd {cwd}" -p

This ensures that vim opens each file in its tab (-p), and uses the temporary directory containing all files as working dir so opening more files is easy (-c "…").

Work to be done

• fix the data loss problem when writing a new file and asking the program to upload it.
• what about using a watchdog to automatically download and lock the newly opened file ? Or provide a vim plugin ?
• use the --minor flag
• use tmpfile instead of flooding .config/vimoku
• is it possible to upload a media ?
• there is few TODOs in the code.
• find a way to implement deletion and renaming of dokuwiki pages in the CLI. Argparse subcommands ?