aboutsummaryrefslogtreecommitdiff

Federated Wiki - Causal Loop Diagram Plugin

This plugin, type: causal loop, extends the markup of the federated wiki.

It allows for the rendering of interactive causal loop diagrams using a very simple syntax.

The Syntax

Each line is a connection.

  • Something +> Other, a positive link. This means if the node changes, it changes in the same direction.
  • Something -> Other, a negative link. This means if the node changes, it changes in the opposite direction.
  • Something +> Other [0.5], This link has a multiplier of 0.5. This means that when Something goes up 1, Other goes up 0.5. You can also apply this to negative links.

Development workflow

This project has a Makefile that encapsulates some of the common development tasks.

To help with development, you can to run the plugin in a local instance of wiki. You need to set the path of that using the WIKIDIR environment variable.

The Makefile assumes the wiki is in ../../vendor/wiki.

# If your wiki directory is elsehwere.
WIKIDIR=$HOME/workspace/wiki make link

The source needs to be built before it can be used. make build builds it.

Linking the project.

make link will create a link from this project to the local fedwiki instance, so it can load the latest version of your code.

Running the local Wiki.

make will run the wiki. make watch will rebuild the client on any change.

Code quality.

  • Run tests with make test
  • Format the code with make format
  • Lint the code with make lint