Git Product home page Git Product logo

owldocgen's Introduction

OwlDocGen

(c) 2021 Radek Burget ([email protected])

OwlDocGen generates ontology documentation from OWL ontology definitions. Compared to similar well-known tools such as LODE or pyLODE, it focuses on generating documentation for multiple interlinked ontologies. See the FitLayout ontology documentation for an example.

Installation

OwlDocGen is distributed as platform-independent runnable jar archive:

  • Download the runnable archive OwlDocGen.jar from Releases
  • Run the following command in the command prompt (depending on your operating system):
    java -jar OwlDocGen.jar

You should see a list of available parametres.

Usage

RDF4J Class Builder takes an OWL definition file in any format (RDF/XML, Turtle, ...) as the input. Multiple input files may be specified that are joined together before processing. The following documents are generated:

  • A separate document for every ontology found in the input files
  • An index page containing a list of all discovered ontologies.

The following command line parameters may be used:

OwlDocGen [-hV] [-f=<format>] [-o=<path>] [-t=title] [-p=<prefix::iri>[,<prefix::iri>...]]... <filename>...
      <filename>...       Input OWL files
  -f, --format=<format>   Output format: html, md
  -h, --help              Show this help message and exit.
  -o, --ouptut-folder=<path>
                          Ouput folder path
  -p, --prefix=<prefix::iri>[,<prefix::iri>...]
                          Additional prefix definition(s)
  -t, --title=title       Index page title
  -V, --version           Print version information and exit.

Example usage:

java -jar OwlDocGen.jar -o "ontology/doc" -t "FitLayout Ontologies" \
    fitlayout.owl render.owl segmentation.owl

Building

OwlDocGen may be build from the sources by maven. After cloning the source repository, use mvn package for building and packaging all the components.

owldocgen's People

Contributors

radkovo avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

owldocgen's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.