summaryrefslogtreecommitdiff
path: root/docs/reference
diff options
context:
space:
mode:
authorCarlos Garnacho <carlosg@gnome.org>2021-08-03 16:18:53 +0200
committerCarlos Garnacho <carlosg@gnome.org>2021-08-26 14:04:24 +0200
commita32f0dcca7ebf99f6771eb5bb8b8c7f56e6c705d (patch)
treebe45082d643ee1acc2d85ccb18f164be32605dbd /docs/reference
parentc3c873854067f6151d6c837626fb06412d7844c6 (diff)
downloadtracker-a32f0dcca7ebf99f6771eb5bb8b8c7f56e6c705d.tar.gz
docs: Set primary section on all markdown docs
Diffstat (limited to 'docs/reference')
-rw-r--r--docs/reference/libtracker-sparql/base-ontology.md4
-rw-r--r--docs/reference/libtracker-sparql/defining-ontologies.md4
-rw-r--r--docs/reference/libtracker-sparql/examples.md.in2
-rw-r--r--docs/reference/libtracker-sparql/gi-index.md2
-rw-r--r--docs/reference/libtracker-sparql/implementation.md2
-rw-r--r--docs/reference/libtracker-sparql/index.md2
-rw-r--r--docs/reference/libtracker-sparql/limits.md2
-rw-r--r--docs/reference/libtracker-sparql/ontologies.md2
-rw-r--r--docs/reference/libtracker-sparql/overview.md2
-rw-r--r--docs/reference/libtracker-sparql/performance.md2
-rw-r--r--docs/reference/libtracker-sparql/sparql-and-tracker.md2
-rw-r--r--docs/reference/libtracker-sparql/sparql-functions.md2
12 files changed, 26 insertions, 2 deletions
diff --git a/docs/reference/libtracker-sparql/base-ontology.md b/docs/reference/libtracker-sparql/base-ontology.md
index f2f4d8368..8eec6a707 100644
--- a/docs/reference/libtracker-sparql/base-ontology.md
+++ b/docs/reference/libtracker-sparql/base-ontology.md
@@ -1,8 +1,10 @@
---
-title: Base Ontology
+title: Base ontology
short-description: Base for defining ontologies
...
+# Base ontology
+
The base ontology is the seed for defining application-specific
ontologies. It defines the basic types and property/class
definitions themselves, so that classes and properties may be
diff --git a/docs/reference/libtracker-sparql/defining-ontologies.md b/docs/reference/libtracker-sparql/defining-ontologies.md
index 0208b1293..46b14428b 100644
--- a/docs/reference/libtracker-sparql/defining-ontologies.md
+++ b/docs/reference/libtracker-sparql/defining-ontologies.md
@@ -1,8 +1,10 @@
---
-title: Defining Ontologies
+title: Defining ontologies
short-description: Defining Ontologies
...
+# Defining ontologies
+
An ontology defines the entities that a Tracker endpoint can store, as
well as their properties and the relationships between different entities.
diff --git a/docs/reference/libtracker-sparql/examples.md.in b/docs/reference/libtracker-sparql/examples.md.in
index 14c6a94af..d903f20b3 100644
--- a/docs/reference/libtracker-sparql/examples.md.in
+++ b/docs/reference/libtracker-sparql/examples.md.in
@@ -3,6 +3,8 @@ title: Examples
short-description: Examples
...
+# Examples
+
This chapters shows some real examples of usage of the Tracker
SPARQL Library.
diff --git a/docs/reference/libtracker-sparql/gi-index.md b/docs/reference/libtracker-sparql/gi-index.md
index 37bdfa61e..8913fd4b8 100644
--- a/docs/reference/libtracker-sparql/gi-index.md
+++ b/docs/reference/libtracker-sparql/gi-index.md
@@ -1,3 +1,5 @@
---
title: API reference
...
+
+# API reference
diff --git a/docs/reference/libtracker-sparql/implementation.md b/docs/reference/libtracker-sparql/implementation.md
index 39718718e..998f66dc8 100644
--- a/docs/reference/libtracker-sparql/implementation.md
+++ b/docs/reference/libtracker-sparql/implementation.md
@@ -3,6 +3,8 @@ title: Implementation details
short-description: Tracker implementation specifics
...
+# Implementation details
+
This section highlights the chosen interpretations of the
SPARQL specification, and specifies how to get the best of
Tracker's implementation of the SPARQL standard.
diff --git a/docs/reference/libtracker-sparql/index.md b/docs/reference/libtracker-sparql/index.md
index d837bdc55..48feb76bd 100644
--- a/docs/reference/libtracker-sparql/index.md
+++ b/docs/reference/libtracker-sparql/index.md
@@ -1,3 +1,5 @@
+# Tracker library documentation
+
Tracker is a low-footprint, yet complete implementation of the SPARQL
standard. It allows you to create triplestores (either in disk or in
memory), connect to remote SPARQL endpoints (via DBus or HTTP), or
diff --git a/docs/reference/libtracker-sparql/limits.md b/docs/reference/libtracker-sparql/limits.md
index 94fb6ffcf..4bcb19677 100644
--- a/docs/reference/libtracker-sparql/limits.md
+++ b/docs/reference/libtracker-sparql/limits.md
@@ -3,6 +3,8 @@ title: Limits
short-description: Implementation limits
...
+# Limits
+
Tracker is implemented on top of SQLite, and all of its benefits and
[limits](https://www.sqlite.org/limits.html) apply. This
document will break down how those limits apply to Tracker. Depending on
diff --git a/docs/reference/libtracker-sparql/ontologies.md b/docs/reference/libtracker-sparql/ontologies.md
index 443ace6f1..884e7c481 100644
--- a/docs/reference/libtracker-sparql/ontologies.md
+++ b/docs/reference/libtracker-sparql/ontologies.md
@@ -3,6 +3,8 @@ title: Ontologies
short-description: Structure of the stored data
...
+# Ontologies
+
Ontologies define the structure of the data that the triplestore
can hold. It defines the possible resource classes,
the properties these classes may have, and the relation between
diff --git a/docs/reference/libtracker-sparql/overview.md b/docs/reference/libtracker-sparql/overview.md
index c350313ce..0ae0d342b 100644
--- a/docs/reference/libtracker-sparql/overview.md
+++ b/docs/reference/libtracker-sparql/overview.md
@@ -3,6 +3,8 @@ title: Overview
short-description: Library Overview
...
+# Overview
+
Tracker SPARQL allows creating and connecting to one or more
triplestore databases. It is used by the
[Tracker Miners filesystem indexer](https://gitlab.gnome.org/GNOME/tracker-miners/),
diff --git a/docs/reference/libtracker-sparql/performance.md b/docs/reference/libtracker-sparql/performance.md
index fcd8989ca..47510a65b 100644
--- a/docs/reference/libtracker-sparql/performance.md
+++ b/docs/reference/libtracker-sparql/performance.md
@@ -3,6 +3,8 @@ title: Performance dos and donts
short-description: Performance dos and donts
...
+# Performance advise
+
SPARQL is a very powerful query language. As it should be
suspected, this means there are areas where performance is
sacrificed for versatility.
diff --git a/docs/reference/libtracker-sparql/sparql-and-tracker.md b/docs/reference/libtracker-sparql/sparql-and-tracker.md
index 9c6e1e965..8a33a965b 100644
--- a/docs/reference/libtracker-sparql/sparql-and-tracker.md
+++ b/docs/reference/libtracker-sparql/sparql-and-tracker.md
@@ -3,6 +3,8 @@ title: SPARQL as understood by Tracker
short-description: SPARQL as understood by Tracker
...
+# SPARQL as understood by Tracker
+
This section describes the choices made by Tracker in its interpretation
of the SPARQL documents, as well as its extensions and divergences.
diff --git a/docs/reference/libtracker-sparql/sparql-functions.md b/docs/reference/libtracker-sparql/sparql-functions.md
index fe7769fc8..939cac37b 100644
--- a/docs/reference/libtracker-sparql/sparql-functions.md
+++ b/docs/reference/libtracker-sparql/sparql-functions.md
@@ -3,6 +3,8 @@ title: Builtin SPARQL functions
short-description: Builtin SPARQL functions
...
+# Builtin SPARQL functions
+
Besides the functions built in the SPARQL 1.1 syntax, type casts
and functional properties, Tracker supports a number of SPARQL
functions. Some of these functions have correspondences in XPath.