rtm 0.2 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. data/README +17 -11
  2. metadata +20 -13
data/README CHANGED
@@ -1,4 +1,4 @@
1
- === Ruby Topic Maps (RTM)
1
+ ==== Ruby Topic Maps (RTM)
2
2
  RTM is a Topic Maps engine written in Ruby. See http://rtm.topicmapslab.de/ for instructions.
3
3
  Several backends and extensions are available as separate gems.
4
4
 
@@ -6,6 +6,14 @@ Several backends and extensions are available as separate gems.
6
6
  From a developer's perspective, RTM is a schema-less database management system.
7
7
  The Topic Maps standard (described below) on which RTM is based provides a way of creating a self-describing schema just by using it.
8
8
 
9
+ ==== Quickstart
10
+ require 'rtm'
11
+ connection = RTM.connect # uses the default Ontopia in-memory backend
12
+ topic_map = connection.create "http://example.org/my_topic_map/"
13
+ some_topic = topicmap.get!("identifier_of_the_topic")
14
+ some_topic["-"] = "default name for the topic"
15
+ topic_map.to_xtm("my_xtm_file.xtm")
16
+
9
17
  ==== Topic Maps
10
18
  Topic Maps is an international industry standard (ISO13250) for interchangeably representing information
11
19
  about the structure of information resources used to define topics, and the relationships between topics.
@@ -18,16 +26,14 @@ In addition, information objects can have properties, as well as values for thos
18
26
  The Topic Maps Data Model which is used in this implementation can be found on http://www.isotopicmaps.org/sam/sam-model/.
19
27
 
20
28
  ==== Backends
21
- [rtm-ontopia] JRuby only, recommended,
22
- uses Ontopia: http://code.google.com/p/ontopia/
23
- [rtm-tinytim] JRuby only,
24
- uses TinyTiM: http://tinytim.sourceforge.net/
25
- [rtm-activerecord] uses a custom ActiveRecord schema
29
+ * rtm-ontopia: JRuby only, recommended, uses Ontopia: http://code.google.com/p/ontopia/
30
+ * rtm-tinytim: JRuby only, uses TinyTiM: http://tinytim.sourceforge.net/
31
+ * rtm-activerecord: uses a custom ActiveRecord schema
26
32
 
27
33
  ==== Extensions
28
- [rtm-tmql] Adds support for the Topic Maps Query Language (TMQL), http://isotopicmaps.org/tmql/
29
- [rtm-tmcl] Adds support for the Topic Maps Constraint Language (TMCL), http://isotopicmaps.org/tmcl/
34
+ * rtm-tmql: Adds support for the Topic Maps Query Language (TMQL), http://isotopicmaps.org/tmql/
35
+ * rtm-tmcl: Adds support for the Topic Maps Constraint Language (TMCL), http://isotopicmaps.org/tmcl/
30
36
 
31
- ====
32
- [Copyright] Copyright 2009 Topic Maps Lab, University of Leipzig.
33
- [License] Apache License, Version 2.0
37
+ ==== License
38
+ Copyright 2009 Topic Maps Lab, University of Leipzig.
39
+ Apache License, Version 2.0
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rtm
3
3
  version: !ruby/object:Gem::Version
4
- version: "0.2"
4
+ version: 0.2.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Benjamin Bock
@@ -16,8 +16,8 @@ date: 2010-02-21 00:00:00 +01:00
16
16
  default_executable:
17
17
  dependencies: []
18
18
 
19
- description: |-
20
- === Ruby Topic Maps (RTM)
19
+ description: |
20
+ ==== Ruby Topic Maps (RTM)
21
21
  RTM is a Topic Maps engine written in Ruby. See http://rtm.topicmapslab.de/ for instructions.
22
22
  Several backends and extensions are available as separate gems.
23
23
 
@@ -25,6 +25,14 @@ description: |-
25
25
  From a developer's perspective, RTM is a schema-less database management system.
26
26
  The Topic Maps standard (described below) on which RTM is based provides a way of creating a self-describing schema just by using it.
27
27
 
28
+ ==== Quickstart
29
+ require 'rtm'
30
+ connection = RTM.connect # uses the default Ontopia in-memory backend
31
+ topic_map = connection.create "http://example.org/my_topic_map/"
32
+ some_topic = topicmap.get!("identifier_of_the_topic")
33
+ some_topic["-"] = "default name for the topic"
34
+ topic_map.to_xtm("my_xtm_file.xtm")
35
+
28
36
  ==== Topic Maps
29
37
  Topic Maps is an international industry standard (ISO13250) for interchangeably representing information
30
38
  about the structure of information resources used to define topics, and the relationships between topics.
@@ -37,19 +45,18 @@ description: |-
37
45
  The Topic Maps Data Model which is used in this implementation can be found on http://www.isotopicmaps.org/sam/sam-model/.
38
46
 
39
47
  ==== Backends
40
- [rtm-ontopia] JRuby only, recommended,
41
- uses Ontopia: http://code.google.com/p/ontopia/
42
- [rtm-tinytim] JRuby only,
43
- uses TinyTiM: http://tinytim.sourceforge.net/
44
- [rtm-activerecord] uses a custom ActiveRecord schema
48
+ * rtm-ontopia: JRuby only, recommended, uses Ontopia: http://code.google.com/p/ontopia/
49
+ * rtm-tinytim: JRuby only, uses TinyTiM: http://tinytim.sourceforge.net/
50
+ * rtm-activerecord: uses a custom ActiveRecord schema
45
51
 
46
52
  ==== Extensions
47
- [rtm-tmql] Adds support for the Topic Maps Query Language (TMQL), http://isotopicmaps.org/tmql/
48
- [rtm-tmcl] Adds support for the Topic Maps Constraint Language (TMCL), http://isotopicmaps.org/tmcl/
53
+ * rtm-tmql: Adds support for the Topic Maps Query Language (TMQL), http://isotopicmaps.org/tmql/
54
+ * rtm-tmcl: Adds support for the Topic Maps Constraint Language (TMCL), http://isotopicmaps.org/tmcl/
49
55
 
50
- ====
51
- [Copyright] Copyright 2009 Topic Maps Lab, University of Leipzig.
52
- [License] Apache License, Version 2.0
56
+ ==== License
57
+ Copyright 2009 Topic Maps Lab, University of Leipzig.
58
+ Apache License, Version 2.0
59
+
53
60
  email: rtm+rtm-gem-20100221@topicmapslab.de
54
61
  executables: []
55
62