flibbles / tw5-xml

XML tools for Tiddlywiki5: import/xport, rendering, parsing wth XPath and CSS Selectors
BSD 3-Clause "New" or "Revised" License
10 stars 1 forks source link
css-selector tiddlywiki-plugin tiddlywiki5 xml xml-tiddlers xpath

XML for Tiddlywiki

This plugin provides several tools which allow for working with XML tiddlers.

For a demonstration, and for documentation, see the tiddlywiki demo site.

How to install

Visit the demo site. It will have a simple drag-and-drop installation icon.

For Node.js

The following is an abridged version of the instructions found here.

First, check out the source code using git. Then copy the contents of the plugins directory into a "flibbles" directory in a path where you'd like it to be available. Then add that path to the TIDDLYWIKI_PLUGIN_PATH environment variable.

For instance, copy the contents of the plugin directory to "~/.tiddlywiki/flibbles" directory. Then run echo "TIDDLYWIKI_PLUGIN_PATH=~/.tiddlywiki" >> .profile

If you've installed it correctly, the path to the plugin.info file should look something like:

~/.tiddlywiki/flibbles/xml/plugin.info

Afterward, add the plugin inside your projects' tiddlywiki.info file. The plugins section will look something like:

{
   ...
   "plugins": [
      ...
      "flibbles/xml"
   ],
   ...
}

Alternatively, you can also copy the plugins directly into your projects' root directory. Though this makes the install local only to those specific projects.

Note: If you're performing Node.js server operations using tw5-xml, you may need to install some dependencies first. See the documentation for more details.

How to test

Make sure you have tiddlywiki available on your PATH. Then from the project root directory, type:

tiddlywiki --build test