{"id":15634692,"url":"https://github.com/blackwinter/ontopia-tldr","last_synced_at":"2025-10-09T08:14:46.701Z","repository":{"id":56886765,"uuid":"11763610","full_name":"blackwinter/ontopia-tldr","owner":"blackwinter","description":"Tolog Document Retrieval with Ontopia.","archived":false,"fork":false,"pushed_at":"2016-10-12T09:50:11.000Z","size":476,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-08-09T20:53:42.385Z","etag":null,"topics":["bibliographic-references","ontopia","ruby","rubynlp","topicmaps"],"latest_commit_sha":null,"homepage":"http://blackwinter.github.io/ontopia-tldr","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/blackwinter.png","metadata":{"files":{"readme":"README","changelog":"ChangeLog","contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-07-30T11:37:51.000Z","updated_at":"2023-09-08T16:41:06.000Z","dependencies_parsed_at":"2022-08-20T14:31:26.193Z","dependency_job_id":null,"html_url":"https://github.com/blackwinter/ontopia-tldr","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/blackwinter/ontopia-tldr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackwinter%2Fontopia-tldr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackwinter%2Fontopia-tldr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackwinter%2Fontopia-tldr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackwinter%2Fontopia-tldr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blackwinter","download_url":"https://codeload.github.com/blackwinter/ontopia-tldr/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackwinter%2Fontopia-tldr/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278873422,"owners_count":26060757,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bibliographic-references","ontopia","ruby","rubynlp","topicmaps"],"created_at":"2024-10-03T10:55:58.111Z","updated_at":"2025-10-09T08:14:46.675Z","avatar_url":"https://github.com/blackwinter.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"= ontopia-tldr - Tolog Document Retrieval with Ontopia\n\n== VERSION\n\nThis documentation refers to ontopia-tldr version 0.1.2\n\n\n== DESCRIPTION\n\nOntopia::TLDR is an attempt at bridging the gap between the worlds of formal\nknowledge representation (ontologies, topic maps, etc.) and bibliographic document\nretrieval (bibliographic databases). It allows for retrieving documents from\nbibliographic databases (currently, only Midos[http://progris.de] databases are\nsupported) by means of tolog[http://ontopia.net/omnigator/docs/query/tutorial.html],\nOntopia's[http://ontopia.net] topic map query language.\n\n=== Deployment\n\nOntopia::TLDR comes as a Sinatra application, so all the standard deployment\noptions apply (rackup, Passenger[https://www.phusionpassenger.com/], etc.).\nHowever, in order to allow for maximum flexibility, you need to supply your\nown \u003ctt\u003econfig.ru\u003c/tt\u003e file; e.g. (see Ontopia::TLDR for available options):\n\n  require 'ontopia/tldr'\n\n  run Ontopia::TLDR.set(\n    dbm_file: File.expand_path('../tldr.dbm', __FILE__),\n    xtm_file: File.expand_path('../tldr.xtm', __FILE__),\n\n    document_keys: %w[YOUR DOCUMENT KEYS],\n    topic_keys:    %w[YOUR TOPIC KEYS],\n\n    title: 'YOUR TITLE'\n  )\n\nAssuming the following directory layout:\n\n  /srv/tldr\n    |\n    +-- config.ru\n    |\n    +-- tldr.dbm\n    |\n    +-- tldr.xtm\n    |\n    `-- tmp/\n\nPlace your database and topic map files there and adjust their paths in the\n\u003ctt\u003econfig.ru\u003c/tt\u003e file. The \u003ctt\u003etmp/\u003c/tt\u003e directory is used by Passenger\nfor the \u003ctt\u003erestart.txt\u003c/tt\u003e file.\n\nTo deploy Ontopia::TLDR with Passenger on Apache, create a symlink in the\nDocumentRoot pointing to the app's \u003ctt\u003epublic/\u003c/tt\u003e directory (this example\nmakes use of current_gem[http://blackwinter.github.com/current_gem]; adjust\nthe paths according to your environment):\n\n  /var/www\n    |\n    `-- tldr -\u003e /usr/local/jruby/lib/ruby/gems/shared/current/ontopia-tldr/lib/ontopia/tldr/public\n\nThen put the following snippet in Apache's VirtualHost configuration:\n\n  \u003cVirtualHost *:80\u003e\n    ...\n\n    RackBaseURI /tldr\n    \u003cDirectory /var/www/tldr\u003e\n      Options -MultiViews\n      PassengerAppRoot /srv/tldr                # \u003c-- This (non-standard) line is important\n      PassengerRuby /usr/local/jruby/bin/jruby  # \u003c-- And this one sets the Ruby interpreter to JRuby\n    \u003c/Directory\u003e\n  \u003c/VirtualHost\u003e\n\n\n== SUPPORTED PLATFORMS\n\nOntopia::TLDR requires JRuby[http://jruby.org]. It has been tested with jruby\n1.7.4 (1.9.3p392) on OpenJDK 64-Bit Server VM 1.6.0_27-b27 [linux-amd64] and\njruby 9.0.0.0 (2.2.2) on OpenJDK 64-Bit Server VM 24.79-b02 1.7.0_79-b14\n[linux-amd64].\n\n\n== LINKS\n\nOntopia::       http://ontopia.net/\nDemo::          http://ixtrieve.fh-koeln.de/ghn\nDocumentation:: https://blackwinter.github.com/ontopia-tldr\nSource code::   https://github.com/blackwinter/ontopia-tldr\nRubyGem::       https://rubygems.org/gems/ontopia-tldr\n\n\n== AUTHORS\n\n* Jens Wille \u003cmailto:jens.wille@gmail.com\u003e\n\n\n== LICENSE AND COPYRIGHT\n\nCopyright (C) 2013-2015 Jens Wille\n\nontopia-tldr is free software: you can redistribute it and/or modify it\nunder the terms of the GNU Affero General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or (at your\noption) any later version.\n\nontopia-tldr is distributed in the hope that it will be useful, but\nWITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\nor FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public\nLicense for more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with ontopia-tldr. If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblackwinter%2Fontopia-tldr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblackwinter%2Fontopia-tldr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblackwinter%2Fontopia-tldr/lists"}