From 892d1141e47a785709ced1b941bda7426271008e Mon Sep 17 00:00:00 2001 From: Carlos Garnacho Date: Sun, 26 Feb 2023 19:34:45 +0100 Subject: docs: Embed SVG images in SPARQL tutorial Use embedded SVG for the few diagrams we have at the tutorial, like everywhere else in docs now. This should also work with dark modes and whatnot. --- .../libtracker-sparql/images/triple-graph-1.dot | 8 +- .../libtracker-sparql/images/triple-graph-1.png | Bin 7440 -> 0 bytes .../libtracker-sparql/images/triple-graph-1.svg | 31 ++++ .../libtracker-sparql/images/triple-graph-2.dot | 8 +- .../libtracker-sparql/images/triple-graph-2.png | Bin 91597 -> 0 bytes .../libtracker-sparql/images/triple-graph-2.svg | 161 +++++++++++++++++++++ .../libtracker-sparql/images/triple-graph-3.dot | 9 +- .../libtracker-sparql/images/triple-graph-3.png | Bin 24991 -> 0 bytes .../libtracker-sparql/images/triple-graph-3.svg | 70 +++++++++ .../libtracker-sparql/tracker-sparql.toml.in | 3 - docs/reference/libtracker-sparql/tutorial.md.in | 17 ++- 11 files changed, 288 insertions(+), 19 deletions(-) delete mode 100644 docs/reference/libtracker-sparql/images/triple-graph-1.png create mode 100644 docs/reference/libtracker-sparql/images/triple-graph-1.svg delete mode 100644 docs/reference/libtracker-sparql/images/triple-graph-2.png create mode 100644 docs/reference/libtracker-sparql/images/triple-graph-2.svg delete mode 100644 docs/reference/libtracker-sparql/images/triple-graph-3.png create mode 100644 docs/reference/libtracker-sparql/images/triple-graph-3.svg (limited to 'docs/reference') diff --git a/docs/reference/libtracker-sparql/images/triple-graph-1.dot b/docs/reference/libtracker-sparql/images/triple-graph-1.dot index 319417d5c..7625533fc 100644 --- a/docs/reference/libtracker-sparql/images/triple-graph-1.dot +++ b/docs/reference/libtracker-sparql/images/triple-graph-1.dot @@ -1,9 +1,9 @@ digraph G { rankdir=LR; - graph [bgcolor="#00000000"]; - node [fontname="Cantarell", style="filled", shape="ellipse", color="#000000", fillcolor="#d8e5e5"]; Subject; - node [shape="rectangle", color="#000000", fillcolor="#add8e6"]; Object; - edge [fontname="Cantarell"]; + bgcolor=transparent; + node [shape="box", border=0, fontname="sans-serif"]; Object; + node [shape="box", style="rounded", border=0, fontname="sans-serif"]; Subject; + edge [fontname="sans-serif", fontsize=10]; Subject -> Object [label=Predicate]; } diff --git a/docs/reference/libtracker-sparql/images/triple-graph-1.png b/docs/reference/libtracker-sparql/images/triple-graph-1.png deleted file mode 100644 index 2cf93dbe8..000000000 Binary files a/docs/reference/libtracker-sparql/images/triple-graph-1.png and /dev/null differ diff --git a/docs/reference/libtracker-sparql/images/triple-graph-1.svg b/docs/reference/libtracker-sparql/images/triple-graph-1.svg new file mode 100644 index 000000000..3dd8b9991 --- /dev/null +++ b/docs/reference/libtracker-sparql/images/triple-graph-1.svg @@ -0,0 +1,31 @@ + + + + + + +G + + +Object + +Object + + + +Subject + +Subject + + + +Subject->Object + + +Predicate + + + diff --git a/docs/reference/libtracker-sparql/images/triple-graph-2.dot b/docs/reference/libtracker-sparql/images/triple-graph-2.dot index 1187da0ec..70c981866 100644 --- a/docs/reference/libtracker-sparql/images/triple-graph-2.dot +++ b/docs/reference/libtracker-sparql/images/triple-graph-2.dot @@ -1,9 +1,9 @@ digraph G { rankdir=LR; - graph [bgcolor="#00000000"]; - node [fontname="Cantarell", style="filled", shape="ellipse", color="#000000", fillcolor="#d8e5e5"]; "http://example.com/Song", "nfo:FileDataObject", "nmm:MusicPiece", "http://example.com/Album", "http://example.com/Jason", "http://example.com/Marty", "http://example.com/Band"; - node [shape="rectangle", color="#000000", fillcolor="#add8e6"]; Images, "Go Off!", "Marty Friedman", "Jason Becker", "Cacophony"; - edge [fontname="Cantarell"]; + bgcolor=transparent; + node [shape="box", border=0, fontname="sans-serif"]; Images, "Go Off!", "Marty Friedman", "Jason Becker", "Cacophony"; + node [shape="box", style="rounded", border=0, fontname="sans-serif"]; "http://example.com/Song", "nfo:FileDataObject", "nmm:MusicPiece", "http://example.com/Album", "http://example.com/Jason", "http://example.com/Marty", "http://example.com/Band"; + edge [fontname="sans-serif", fontsize=10]; "http://example.com/Song" -> "nfo:FileDataObject" [label="rdf:type"]; "http://example.com/Song" -> "nmm:MusicPiece" [label="rdf:type"]; diff --git a/docs/reference/libtracker-sparql/images/triple-graph-2.png b/docs/reference/libtracker-sparql/images/triple-graph-2.png deleted file mode 100644 index d80ce6d90..000000000 Binary files a/docs/reference/libtracker-sparql/images/triple-graph-2.png and /dev/null differ diff --git a/docs/reference/libtracker-sparql/images/triple-graph-2.svg b/docs/reference/libtracker-sparql/images/triple-graph-2.svg new file mode 100644 index 000000000..94bfb3aff --- /dev/null +++ b/docs/reference/libtracker-sparql/images/triple-graph-2.svg @@ -0,0 +1,161 @@ + + + + + + +G + + +Images + +Images + + + +Go Off! + +Go Off! + + + +Marty Friedman + +Marty Friedman + + + +Jason Becker + +Jason Becker + + + +Cacophony + +Cacophony + + + +http://example.com/Song + +http://example.com/Song + + + +http://example.com/Song->Images + + +nie:title + + + +nfo:FileDataObject + +nfo:FileDataObject + + + +http://example.com/Song->nfo:FileDataObject + + +rdf:type + + + +nmm:MusicPiece + +nmm:MusicPiece + + + +http://example.com/Song->nmm:MusicPiece + + +rdf:type + + + +http://example.com/Album + +http://example.com/Album + + + +http://example.com/Song->http://example.com/Album + + +nmm:musicAlbum + + + +http://example.com/Jason + +http://example.com/Jason + + + +http://example.com/Song->http://example.com/Jason + + +nmm:albumArtist + + + +http://example.com/Marty + +http://example.com/Marty + + + +http://example.com/Song->http://example.com/Marty + + +nmm:albumArtist + + + +http://example.com/Band + +http://example.com/Band + + + +http://example.com/Song->http://example.com/Band + + +nmm:performer + + + +http://example.com/Album->Go Off! + + +nie:title + + + +http://example.com/Jason->Jason Becker + + +nmm:artistName + + + +http://example.com/Marty->Marty Friedman + + +nmm:artistName + + + +http://example.com/Band->Cacophony + + +nmm:artistName + + + diff --git a/docs/reference/libtracker-sparql/images/triple-graph-3.dot b/docs/reference/libtracker-sparql/images/triple-graph-3.dot index 55ce34e70..9ad595bce 100644 --- a/docs/reference/libtracker-sparql/images/triple-graph-3.dot +++ b/docs/reference/libtracker-sparql/images/triple-graph-3.dot @@ -1,9 +1,10 @@ digraph G { rankdir=LR; - graph [bgcolor="#00000000"]; - node [fontname="Cantarell", style="filled", shape="ellipse", color="#000000", fillcolor="#d8e5e5"]; "nmm:MusicPiece"; - node [style="filled,dotted", color="#000000", fillcolor="#ffffff"]; song, songTitle, album, albumTitle; - edge [fontname="Cantarell"]; + bgcolor=transparent; + + node [shape="box", style="rounded", border=0, fontname="sans-serif"]; "nmm:MusicPiece"; + node [shape="ellipse", style="dashed", border=1, fillcolor="#000000"]; song, songTitle, album, albumTitle; + edge [fontname="sans-serif", fontsize=10]; song -> "nmm:MusicPiece" [label="rdf:type"]; song -> songTitle [label="nie:title"]; diff --git a/docs/reference/libtracker-sparql/images/triple-graph-3.png b/docs/reference/libtracker-sparql/images/triple-graph-3.png deleted file mode 100644 index 965694481..000000000 Binary files a/docs/reference/libtracker-sparql/images/triple-graph-3.png and /dev/null differ diff --git a/docs/reference/libtracker-sparql/images/triple-graph-3.svg b/docs/reference/libtracker-sparql/images/triple-graph-3.svg new file mode 100644 index 000000000..6fb0dc667 --- /dev/null +++ b/docs/reference/libtracker-sparql/images/triple-graph-3.svg @@ -0,0 +1,70 @@ + + + + + + +G + + +nmm:MusicPiece + +nmm:MusicPiece + + + +song + +song + + + +song->nmm:MusicPiece + + +rdf:type + + + +songTitle + +songTitle + + + +song->songTitle + + +nie:title + + + +album + +album + + + +song->album + + +nmm:MusicAlbum + + + +albumTitle + +albumTitle + + + +album->albumTitle + + +nie:title + + + diff --git a/docs/reference/libtracker-sparql/tracker-sparql.toml.in b/docs/reference/libtracker-sparql/tracker-sparql.toml.in index 78d01838a..fef19fe55 100644 --- a/docs/reference/libtracker-sparql/tracker-sparql.toml.in +++ b/docs/reference/libtracker-sparql/tracker-sparql.toml.in @@ -41,9 +41,6 @@ content_images = [ "images/icon-multivalue.svg", "images/icon-notify.svg", "images/icon-superproperty.svg", - "images/triple-graph-1.png", - "images/triple-graph-2.png", - "images/triple-graph-3.png", ] urlmap_file = "urlmap.js" diff --git a/docs/reference/libtracker-sparql/tutorial.md.in b/docs/reference/libtracker-sparql/tutorial.md.in index 570046648..6a19663bf 100644 --- a/docs/reference/libtracker-sparql/tutorial.md.in +++ b/docs/reference/libtracker-sparql/tutorial.md.in @@ -36,7 +36,9 @@ triple of the form: Or expressed visually: -![Triple Graph](triple-graph-1.png) +
+{{ images/triple-graph-1.svg }} +
Subject and object are 2 graph vertices and the predicate is the edge, the accumulation of those triples form the full graph. For example, @@ -66,7 +68,9 @@ the following triples: Would visually generate the following graph: -![Triple Graph](triple-graph-2.png) +
+{{ images/triple-graph-2.svg }} +
The dot after each triple is not (just) there for legibility, but is part of the syntax. The RDF triples in full length are quite @@ -283,7 +287,10 @@ SELECT ?song ?songTitle ?albumTitle { ``` Stop a bit to think on the graph pattern expressed in the last query: -![Graph Pattern](triple-graph-3.png) + +
+{{ images/triple-graph-3.svg }} +
This pattern on one hand consists of specified data (eg. `?song` must be a `nmm:MusicPiece`, it must have a `nmm:musicAlbum` and a `nie:title`, @@ -548,7 +555,9 @@ sets of `subject predicate object`. A single predicate like that is the simplest property path there is, it relates subject and object directly via a labeled arrow. -![](triple-graph-1.png) +
+{{ images/triple-graph-1.svg }} +
Property paths make it possible to define more complex connections between subject and object (literally, paths of properties). The `/` -- cgit v1.2.1