Skip to content

Commit

Permalink
docs for atag.text.import.xml
Browse files Browse the repository at this point in the history
  • Loading branch information
sarmbruster committed Apr 8, 2024
1 parent b13933f commit 2ba4b50
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ A collections of https://neo4j.com[neo4j] stored procedures to support the https

#### example

[source,cypher]
----
CALL atag.chains.characterChain('what a nice text') YIELD path RETURN path;
Expand All @@ -45,10 +46,12 @@ Uses regex `((?<=\W)|(?=\W))` for identifying tokens.

#### examples

[source,cypher]
----
CALL atag.chains.tokenChain('what a nice text') YIELD path RETURN path;
----

[source,cypher]
----
match (t:Text)
where t.text is not null
Expand All @@ -75,6 +78,7 @@ Interconnects the two chains appropriately.

#### example

[source,cypher]
----
CREATE (s:Text{text:'What a nice text'})
WITH s
Expand Down Expand Up @@ -103,12 +107,14 @@ NOTE: the regex parameter uses lookahead/lookbehind notation, see https://docs.o

#### example

[source,cypher]
----
CALL atag.chains.chain('what a nice text', '((?<=\\s)|(?=\\s))', 'Character', 'NEXT_CHARACTER', false) YIELD path RETURN path
----

#### create example

[source,cypher]
----
match (n) detach delete n;
create (t1:Text {text:'Müde macht uns die Arbeit, die wir liegen lassen, nicht die, die wir tun.', textEn:'It is the work we leave undone that makes us tired, not the work we do.', url:'https://klebeheld.de/wandtattoos/zitate/arbeit/wandtattoo-muede-macht-uns-die-arbeit-die-wir-liegen-lassen-nicht-die-die-wir-tun.-no.1-ebner-e/542'})
Expand Down Expand Up @@ -146,6 +152,7 @@ A function that loads the contents of a given URI into a string. This runs a HTT

#### example

[source,cypher]
----
RETURN atag.text.load('http://www.regesta-imperii.de/id/1316-05-14_1_0_8_0_0_1_a')
----
Expand All @@ -170,6 +177,7 @@ Generate annotation nodes out of HTML tags.

#### example

[source,cypher]
----
CREATE (r:Text {identifier:'[RI XIII] H. 15 n. 101', summary:'Kg. F. teilt Kammerer und Rat der Stadt Regensburg mit, daß er als Vormund des Königs (von Böhmen und Ungarn) Ladislaus (Postumus) einerseits sowie die Brüder Hans und Heinrich, Hzz. zu Lüben (<em>Löbin</em>)<sup>1</sup>, andererseits glauben, Ansprüche auf die Länder und Städte Liegnitz und Goldberg<sup>2</sup> zu haben. Deshalb habe er auf den <em>nechsten montag nach sant Veits schierstkunftigen</em> (Juni 21) einen Tag nach Breslau angesetzt und an mehrere Fürsten, Herren und Mannen geschrieben, diesen Tag zu besuchen<sup>3</sup>. <em>Als richter</em> in dieser Angelegenheit habe er den Bf. Peter (Nowag) von Breslau <em>geordnet</em><sup>4</sup>; er bittet sie, ebenfalls eine Botschaft zu schicken, um Reinprecht von Ebersdorf und anderen, die er dorthin senden werde, <em>rat und beystand ze tun</em>. Er (Kg. F.) habe auch den Breslauern befohlen, ihnen hierzu Sicherheit und Geleit zu erteilen<sup>5</sup>.'});
MATCH (t:Text {identifier:'[RI XIII] H. 15 n. 101'})
Expand All @@ -184,12 +192,24 @@ Generate annotations from a property containing a (TEI) XML document.
.Parameters atag.text.import.xml
|===
| name | type | description | default value

| startNode | node | start node containing html text |
| propertyKey | string | property name for html property | text
| xpath expression | string | xpath used as a filter | /TEI/text/body//node()
| label | string | label for new annotation nodes | Annotation
| plainTextProperty | string | property name for plain text | plainText
| relationshipType | string | relationship type between for annotation nodes | HAS_ANNOTATION

| | | |
| return value | node | new annotation nodes |
|===

#### example

[source,cypher]
----
CREATE (t:Text{id:1, text: atag.text.load("https://git.thm.de/aksz15/teixml2spo/-/raw/master/patzig.xml")})
WITH t
CALL atag.text.import.xml(t, 'text', '/TEI/text/body//node()', 'Annotation', 'plainText') YIELD node
RETURN node
----

0 comments on commit 2ba4b50

Please sign in to comment.