Giter VIP home page Giter VIP logo

node-psi-server's Introduction

node-psi-server README

This document provides a short description of node-psi-server. node-psi-server is a Topic Maps application.

Dependencies

Make sure that you've installed these two applications on your machine:

The following external libraries have been included in the node-psi-server package:

  • tmjs - an Open Source Topic Maps engine.
  • Mu - an asynchroneous template engine based on mustache.js.
  • opts.js - a command line options parser.

Examples

You can use the Opera topic map from the examples catalog for testing. To see which PSIs are included, run the following command:

node server.js --list examples/opera.jtm psi.ontopia.net

To start the web server run

node server.js --config ./config-sample.jtm examples/opera.jtm psi.ontopia.net

  • config-sample.jtm is the configuration file,
  • examples/opera.jtm is the topic map that you want to serve PSIs for
  • psi.ontopia.net is the server name

Now you should be able to open e.g. http://localhost:8000/person or "http://localhost:8000/city/380-firenze" in your web browser.

Limitations

Besides all bugs, node-psi-server has two main limitations:

  1. No support of PSIs with anchor.
  2. Only topic maps in JTM format are supported.

Detailed explanations:

'#' in PSIs is not supported. This is because the anchor part is not sent to the server. If you e.g. enter

http://psi.example.com/foo#bar

the requested URL on the server is

http://psi.example.com/foo

The is could be solved by creating a special index for all PSIs containing a # symbol, but currently this feature is not implemented.

Due to a limitation in tmjs, only JTM topic maps can be imported. However, you can use mappify.org to convert any topic map to JTM. Maiana and Ontopia also support export of topic maps in JTM.

node-psi-server's People

Contributors

jansc avatar

Watchers

Marcelle von Wendland avatar James Cloos avatar

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.