Skip to content

Commit 37da2d6

Browse files
committed
Auto-update README.md from README.org
1 parent a685723 commit 37da2d6

File tree

3 files changed

+52
-52
lines changed

3 files changed

+52
-52
lines changed

README.md

+28-28
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,22 @@ ELOT takes inspiration from this paradigm and uses the excellent Emacs Orgmode p
2121
Ontological constructs are generated from narrative sections and Manchester Notation (OMN) fragments. Diagrams are generated from Turtle examples or SPARQL queries by using the rdfpuml tool.
2222
The tool then extracts ontological definitions (OMN or Turtle) and documentation (HTML or PDF).
2323

24-
- [Prerequisites in brief](#orge7ac34a)
25-
- [Installation](#org5c6fc2e)
26-
- [Get Emacs](#org6ae6f73)
27-
- [Install ELOT in Emacs](#orgb5fd97b)
28-
- [Install ELOT auxiliaries](#orgeaf56eb)
29-
- [NEW: Convert existing OWL files to ELOT format](#orgaf72598)
30-
- [Quick start using ELOT](#org0d2c385)
31-
- [Adding an ontology](#orgd19697d)
32-
- [Adding classes and relations](#orgf6781d9)
33-
- [Adding annotations](#orgf45be48)
34-
- [Querying the ontology](#org829ab56)
35-
- [Making a diagram](#orgb399a63)
36-
- [Display labels instead of identifiers](#orgc4b91b8)
37-
38-
39-
<a id="orge7ac34a"></a>
24+
- [Prerequisites in brief](#org9010ab3)
25+
- [Installation](#org7aa9b2c)
26+
- [Get Emacs](#org19dfc60)
27+
- [Install ELOT in Emacs](#orge214a8a)
28+
- [Install ELOT auxiliaries](#orgc6cbbc3)
29+
- [NEW: Convert existing OWL files to ELOT format](#orgdadb10d)
30+
- [Quick start using ELOT](#orgf04456a)
31+
- [Adding an ontology](#orga1f38d7)
32+
- [Adding classes and relations](#org6850bf6)
33+
- [Adding annotations](#org877cdfc)
34+
- [Querying the ontology](#org32b4d8b)
35+
- [Making a diagram](#org26ad75a)
36+
- [Display labels instead of identifiers](#org99a791c)
37+
38+
39+
<a id="org9010ab3"></a>
4040

4141
## Prerequisites in brief
4242

@@ -52,12 +52,12 @@ If you are new to Emacs, the book [Mastering Emacs](https://www.masteringemacs.o
5252
recommended.
5353

5454

55-
<a id="org5c6fc2e"></a>
55+
<a id="org7aa9b2c"></a>
5656

5757
## Installation
5858

5959

60-
<a id="org6ae6f73"></a>
60+
<a id="org19dfc60"></a>
6161

6262
### Get Emacs
6363

@@ -75,7 +75,7 @@ for Linux).
7575
For MacOS users: See the [GNU Emacs downloads](https://www.gnu.org/software/emacs/download.html) page under "macOS".
7676

7777

78-
<a id="orgb5fd97b"></a>
78+
<a id="orge214a8a"></a>
7979

8080
### Install ELOT in Emacs
8181

@@ -105,7 +105,7 @@ The following steps will get you started editing OWL ontologies.
105105
`~/elisp/elot/elot-package/` to your `load-path`.
106106

107107

108-
<a id="orgeaf56eb"></a>
108+
<a id="orgc6cbbc3"></a>
109109

110110
### Install ELOT auxiliaries
111111

@@ -145,7 +145,7 @@ Get the tools:
145145
`elot-exporter.jar` in your `bin` folder.
146146

147147

148-
<a id="orgaf72598"></a>
148+
<a id="orgdadb10d"></a>
149149

150150
### NEW: Convert existing OWL files to ELOT format
151151

@@ -156,12 +156,12 @@ easy to work on existing ontologies in your favourite editor.
156156
The `jar` file can be downloaded from [ELOT releases](https://github.com/johanwk/elot/releases).
157157

158158

159-
<a id="org0d2c385"></a>
159+
<a id="orgf04456a"></a>
160160

161161
## Quick start using ELOT
162162

163163

164-
<a id="orgd19697d"></a>
164+
<a id="orga1f38d7"></a>
165165

166166
### Adding an ontology
167167

@@ -215,7 +215,7 @@ Now create an OWL file from your new document.
215215
![img](./documentation/images/firefox-skeleton1.png)
216216

217217

218-
<a id="orgf6781d9"></a>
218+
<a id="org6850bf6"></a>
219219

220220
### Adding classes and relations
221221

@@ -233,7 +233,7 @@ Now create an OWL file from your new document.
233233
![img](documentation/images/elot-animal1.png)
234234

235235

236-
<a id="orgf45be48"></a>
236+
<a id="org877cdfc"></a>
237237

238238
### Adding annotations
239239

@@ -244,7 +244,7 @@ In this screenshot, two annotations are added to the "transitive" characteristic
244244
![img](documentation/images/elot-annotate-axiom1.png)
245245

246246

247-
<a id="org829ab56"></a>
247+
<a id="org32b4d8b"></a>
248248

249249
### Querying the ontology
250250

@@ -257,7 +257,7 @@ In this screenshot, two annotations are added to the "transitive" characteristic
257257
![img](documentation/images/elot-query1.png)
258258

259259

260-
<a id="orgb399a63"></a>
260+
<a id="org26ad75a"></a>
261261

262262
### Making a diagram
263263

@@ -281,7 +281,7 @@ In this screenshot, two annotations are added to the "transitive" characteristic
281281
![img](documentation/images/firefox-diagram1.png)
282282

283283

284-
<a id="orgc4b91b8"></a>
284+
<a id="org99a791c"></a>
285285

286286
### Display labels instead of identifiers
287287

documentation/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11

22
# Table of Contents
33

4-
1. [More documentation is needed](#orgc80debe)
5-
2. [Introductory presentation, 2024](#orgee7a57e)
6-
3. [Installation](#orgddc47ac)
4+
1. [More documentation is needed](#org0547cf4)
5+
2. [Introductory presentation, 2024](#org3823370)
6+
3. [Installation](#orgbd1d69b)
77

88

99

10-
<a id="orgc80debe"></a>
10+
<a id="org0547cf4"></a>
1111

1212
# More documentation is needed
1313

@@ -23,7 +23,7 @@
2323
- integrating templates for generated ontology content
2424

2525

26-
<a id="orgee7a57e"></a>
26+
<a id="org3823370"></a>
2727

2828
# Introductory presentation, 2024
2929

@@ -33,7 +33,7 @@ This presentation can be a good starting point for a quick look at main features
3333
- [Presentation slides in HTML format](20240525T181908--elot-presented-to-iof-tob__elot_emacs_iof.html) *to view the presentation, download a copy and open in a web browser*.
3434

3535

36-
<a id="orgddc47ac"></a>
36+
<a id="orgbd1d69b"></a>
3737

3838
# Installation
3939

examples/README.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11

22
# Table of Contents
33

4-
1. [Examples made with `elot-exporter` jar](#orgdb92963)
5-
1. [Cell Ontology](#orgea92b8b)
6-
2. [Units of Measure](#org248c1a4)
7-
3. [UBERON](#org406838d)
8-
4. [CIM Equipment](#org892f5fe)
9-
5. [BFO-2020](#orgcc5cdcd)
10-
2. [Other examples](#org1a02afb)
11-
1. [Maintenance](#orgf28fa39)
12-
2. [Pizza](#org9c19603)
4+
1. [Examples made with `elot-exporter` jar](#org826dc23)
5+
1. [Cell Ontology](#orgdff8d3d)
6+
2. [Units of Measure](#orgcdbb6d0)
7+
3. [UBERON](#orgb20fd1e)
8+
4. [CIM Equipment](#org4ca9ca6)
9+
5. [BFO-2020](#org8064127)
10+
2. [Other examples](#org7cd8fcd)
11+
1. [Maintenance](#org17407e3)
12+
2. [Pizza](#org5f6375a)
1313

1414

1515

16-
<a id="orgdb92963"></a>
16+
<a id="org826dc23"></a>
1717

1818
# Examples made with `elot-exporter` jar
1919

@@ -22,7 +22,7 @@ These examples are generated with the `elot-exporter` (see <https://github.com/j
2222
java -jar elot-exporter-0.3-SNAPSHOT.jar ontology.ttl > ontology.org
2323

2424

25-
<a id="orgea92b8b"></a>
25+
<a id="orgdff8d3d"></a>
2626

2727
## Cell Ontology
2828

@@ -32,7 +32,7 @@ CL-basic from <http://purl.obolibrary.org/obo/cl/cl-basic.owl>.
3232
This is part of the Cell Ontology, see <https://www.ebi.ac.uk/ols4/ontologies/cl> and <http://purl.obolibrary.org/obo/cl.owl>.
3333

3434

35-
<a id="org248c1a4"></a>
35+
<a id="orgcdbb6d0"></a>
3636

3737
## Units of Measure
3838

@@ -41,7 +41,7 @@ This is part of the Cell Ontology, see <https://www.ebi.ac.uk/ols4/ontologies/cl
4141
Ontology of Units of Measure from <http://www.ontology-of-units-of-measure.org/page/om-2>
4242

4343

44-
<a id="org406838d"></a>
44+
<a id="orgb20fd1e"></a>
4545

4646
## UBERON
4747

@@ -55,7 +55,7 @@ Warning:
5555
- But still, Emacs may hang for a very long time before responding (eg 10 minutes). So it's perhaps better to use `find-file-literally` to avoid that.
5656

5757

58-
<a id="org892f5fe"></a>
58+
<a id="org4ca9ca6"></a>
5959

6060
## CIM Equipment
6161

@@ -64,7 +64,7 @@ Warning:
6464
Electrical CIM: equipment ontology from [61970-600-2\_Equipment-AP-Voc-RDFS2020\_v3-0-0.ttl](https://github.com/Sveino/Inst4CIM-KG/blob/develop/rdfs-improved/CGMES/ttl/61970-600-2_Equipment-AP-Voc-RDFS2020_v3-0-0.ttl)
6565

6666

67-
<a id="orgcc5cdcd"></a>
67+
<a id="org8064127"></a>
6868

6969
## BFO-2020
7070

@@ -74,15 +74,15 @@ Basic Formal Ontology (BFO-2020) from <https://github.com/BFO-ontology/BFO-2020/
7474
An "About" section has been added after conversion.
7575

7676

77-
<a id="org1a02afb"></a>
77+
<a id="org7cd8fcd"></a>
7878

7979
# Other examples
8080

8181
These examples were made before the `elot-exporter` was available. They
8282
will eventually be updated, once the exporter is more complete.
8383

8484

85-
<a id="orgf28fa39"></a>
85+
<a id="org17407e3"></a>
8686

8787
## Maintenance
8888

@@ -100,7 +100,7 @@ which is much better than
100100
> - **SubClassOf:** obo:BFO\_0000062 some (iof-maint:FailureEvent or iof-maint:FailureProcess)
101101
102102

103-
<a id="org9c19603"></a>
103+
<a id="org5f6375a"></a>
104104

105105
## Pizza
106106

0 commit comments

Comments
 (0)