Skip to content

dapete42/vcat

Repository files navigation

Maven CodeQL CodeFactor codecov

vcat

This repository contains the Java code for the vCat 'visual' category renderer, which uses Graphviz (http://graphviz.org/) to render the category structure of MediaWiki wikis (in particular those run by the Wikimedia Foundation) as graphical trees.

It replaces a similar tool written in PHP, Catgraph.

Projects

It consists of five Maven submodules:

  • vcat-core: The core library to evaluate parameters, get the necessary category information from the wiki and render it into an image.
  • vcat-caffeine: An addition which allows the use of Caffeine to store the API and metadata caches.
  • vcat-toolforge-webapp: A version of vCat which uses the meta_p.wiki table to look up wikis, and Caffeine for caching, as used on Wikimedia Toolforge. Builds an executable JAR file based on Quarkus (https://quarkus.io/).
  • vcat-webapp-simple: A simpler version of vCat for local testing.

Copyright notice

Copyright 2013-2023 Peter Schlömer

Licensed under the Apache License, Version 2.0 (the "License"); you may not use the files in this project except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.