summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs: Switch shebang to bash since popd and pushd are bashismsJeremy Bicha2023-05-103-3/+3
| | | | | | popd and pushed are not implemented in all shells https://rgeissert.blogspot.com/2013/02/a-bashism-week-pushing-and-poping.html
* docs: Document FTS feature as a wholeCarlos Garnacho2023-04-041-0/+66
| | | | | Docs about FTS are somewhat thin and scattered. Add a doc blurb about FTS explaining how things are put together.
* docs: Document CLI tools in the reference documentationCarlos Garnacho2023-03-264-7/+180
| | | | | | | | | | | Duplicate/adapt the script existing at docs/website/build.py in order to build HTML/markdown output for our command line tools. Since we use the xmlto CLI tool and asciibook->docbook->html conversions to get style-free HTML documents, and it was not previously a build dependency, make this an optional runtime dependency while we cannot bump dependencies.
* docs: Improve NIE ontology introductionCarlos Garnacho2023-03-268-25/+295
| | | | | | Explain more in depth the relation between dataobject/informationelement, taking inspiration from the original Nepomuk documentation in wording and illustrations.
* docs: Make flag icons themeableCarlos Garnacho2023-03-268-161/+36
| | | | | | Instead of including them as images, inline and theme them like we do with other SVGs, this makes them look better on dark themes, other than being a non-descript grey.
* docs: Allow adding an extra substitution pathCarlos Garnacho2023-03-261-1/+6
| | | | | | | | | Since we have files in the sources dir and generated files in the build dir, we may want to generate documentation that inline files from both locations. Allow adding an additional lookup path for the file, so both can be tried.
* docs: Allow consecutive substitution sectionsCarlos Garnacho2023-03-261-1/+1
| | | | | | Our helper script to substitute and inline doc sections and images may choke if multiple {{ }} blocks are found in the same line. Make it handle this situation in the regexp used.
* docs: Nudge the style of ontology class hierarchies in dark themesCarlos Garnacho2023-03-261-0/+4
|
* docs: Add missing imageCarlos Garnacho2023-03-262-0/+142
| | | | It was left unpushed in my tree, and silently not included.
* docs: Fixes for dark theme variantsCarlos Garnacho2023-03-199-2/+20
| | | | | | Make the background of some images transparent, and add some CSS to ensure nodes, edges and arrows get proper colors on both light and dark themes.
* docs: Refurbish overviewCarlos Garnacho2023-03-193-37/+84
| | | | | Explain somewhat better what tracker is, does, and what possible advantages there could be in using it.
* manpages: Do not recommend broken API commandsCarlos Garnacho2023-03-191-1/+3
| | | | | | | | | | The flatpak CLI parsing for additional policies changes at some point so that it is not possible to specify multiple values in a single call. Doing that results in the ';' being escaped, and the full string to be interpreted as a single value. In order to add multiple values, --add-policy can be called multiple times, recommend that in our manpage for the task.
* docs: Separate sandboxing documentation to its own docCarlos Garnacho2023-03-197-25/+386
| | | | Explain this a bit better, add some diagrams, etc.
* Merge branch 'sam/website-irc' into 'master'Carlos Garnacho2023-03-051-2/+1
|\ | | | | | | | | website: Update IRC details See merge request https://gitlab.gnome.org/GNOME/tracker/-/merge_requests/578
| * website: Update IRC detailsSam Thursfield2023-02-171-2/+1
| |
* | docs: Drop "This is preview documentation..." on website docsCarlos Garnacho2023-02-271-41/+0
| | | | | | | | | | | | The version is already expressed in gi-docgen output, plus it's now appended in the completely wrong place... making the website output look ugly.
* | docs: Drop docbook XML documentation generationCarlos Garnacho2023-02-275-1086/+3
| | | | | | | | | | | | This is bitrotting already, and we will not want to go back to that. Presumably noone else would, so we can simply drop this.
* | docs: Also fix index.json search terms for web UICarlos Garnacho2023-02-273-6/+93
| | | | | | | | | | | | Same rationale than devhelp, we want to add ontology-related search terms there. Generate the JSON files separately, in order to merge them at the same last stage.
* | docs: Embed SVG images in SPARQL tutorialCarlos Garnacho2023-02-2711-19/+288
| | | | | | | | | | | | 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.
* | docs: Make tutorial a generated docCarlos Garnacho2023-02-272-26/+36
| | | | | | | | | | In order to move to embedded SVGs for images, we have to be able to embed them first.
* | docs: Link to TrackerNotifier from ontology docsCarlos Garnacho2023-02-271-1/+1
| | | | | | | | In the annotations about nrl:notify properties.
* | docs: Style ontology property tables a bitCarlos Garnacho2023-02-271-1/+8
| | | | | | | | | | Add some separation between columns, and a hover effect on rows, to increase legibility.
* | docs: Fix "Notes" images to display in the same lineCarlos Garnacho2023-02-271-0/+1
| | | | | | | | Otherwise, they show in multiple lines.
* | docs: Generate also diagrams for RDF class relationshipCarlos Garnacho2023-02-272-0/+137
| | | | | | | | | | | | Highlight how do the various ontology classes relate to other classes. Just like with the class diagrams, make things links so the documentation can be navigated.
* | docs: Replace ontology class hierarchy ascii art with SVGsCarlos Garnacho2023-02-276-20/+163
| | | | | | | | | | More in line with gi-docgen, generate SVGs for our class hierarchies, and embed them in the docs.
* | docs: Do not print pre-defined instances of base resourcesCarlos Garnacho2023-02-271-0/+6
| | | | | | | | | | | | It is not much useful to e.g. list every defined resource in the rdfs:Resource documentation. Avoid these kinda obvious pre-defined instances.
* | docs: Make better use of the sidebar in ontology documentationCarlos Garnacho2023-02-271-68/+19
| | | | | | | | | | Avoid too much nesting of sections, so the navigation sidebar is able to show the classes and additional properties.
* | docs: Make the examples document go through file embeddingCarlos Garnacho2023-02-272-45/+50
| | | | | | | | | | This document has some embedded code examples, these should be embedded into the final markdown document.
* | docs: Add back helper to embed files into markdown documentationCarlos Garnacho2023-02-273-21/+65
| | | | | | | | | | Rescue this nasty little hack from commit c5414ed4da15, and make it go through the generated documentation files at the moment.
* | docs: Update additional reference documentationCarlos Garnacho2023-02-2718-661/+609
| | | | | | | | | | | | | | | | | | Update it to the gi-docgen syntax, fix links, flesh out docs some more, and make documents generally make a better use of the navigation sidebar. The several subsections describing ontologies have been merge into a single document.
* | docs: Fix image references in ontology doc toolCarlos Garnacho2023-02-271-1/+1
| | | | | | | | Fix the images for our small property annotations.
* | docs: Fix image references in tutorialCarlos Garnacho2023-02-271-4/+4
| |
* | docs: Migrate documentation to gi-docgenCarlos Garnacho2023-02-2717-266/+185
|/ | | | | | | | | | | | Move away from hotdoc, and port the documentation infrastructure to use gi-docgen. We still do fixup devhelp2 files in order to include ontology items as search terms, and we still do prefer to ship the pre-generated documentation in the tarball, in order to avoid a host of dependencies like graphviz for the people building from tarballs. It is not the first time that porting to gi-docgen was attempted, this is partially based on work by Daniele Nicolodi <daniele@grinta.net>.
* docs: Add mention about entailment regimesCarlos Garnacho2023-01-291-0/+32
| | | | | | | | These rules pretty much define the triples that can be extrapolated from a simpler data set. We have some strong reliance on RDFS entailment, so document to what extent. Closes: https://gitlab.gnome.org/GNOME/tracker-miners/-/issues/255
* cli: Add --output-format argument to "tracker3 export"Carlos Garnacho2023-01-101-8/+5
| | | | | And kinda deprecate the --show-graphs option that did output TriG. We now are able to output TTL, TriG, and JSON-LD.
* core/docs: Fix various "variable may be uninitialized" warningsSam Thursfield2022-10-031-1/+1
| | | | | | None of the situations here look like potential bugs, just cases where the compiler can't verify that the variable will be initialized before it's used.
* docs: Avoid warnings doubly parsing base ontologyCarlos Garnacho2022-08-304-17/+35
| | | | | | | | | Separate ontology parsing so that we can provide separate locations for .ontology and .description files, so that we can avoid doubly parsing the base ontology just for the sake of parsing the description files. This avoids redefinition warnings by the ontology docgen tool while generating the docs for the base ontology.
* docs: Use correct integer type for iteratorCarlos Garnacho2022-08-301-1/+1
| | | | Fixes a compiler warning.
* build: Cleanse of Vala dependenciesCarlos Garnacho2022-07-171-1/+1
| | | | | | Drop all the places left where we do specify things for Vala, and rename the targets that had that name because of vala code presence.
* libtracker-sparql: Port remote TrackerSparqlConnection to new http helpersCarlos Garnacho2022-04-241-1/+1
| | | | | | | | | Remove the direct soup dependency by using TrackerHttpClient, that deals with soup itself. This also means the remote connection objects can move to the main library code, instead of being built as standalone modules. In consequence, the older remote modules are no longer built, and their loading infrastructure removed.
* manpages: Stress further the usage of --loopback in tracker3-endpointCarlos Garnacho2022-04-031-0/+3
|
* docs: Add "security" section under "implementation details"Carlos Garnacho2022-04-033-0/+202
| | | | | | | Paraphrase and complete some of the security considerations brought up at the various SPARQL reference documents. Fixes: https://gitlab.gnome.org/GNOME/tracker/-/issues/349
* docs: Add Javascript examplesCarlos Garnacho2022-04-035-4/+127
|
* docs: Add python examplesCarlos Garnacho2022-04-035-4/+136
|
* libtracker-sparql: Mark parameter as nullableCarlos Garnacho2022-04-031-4/+4
| | | | This is missing in introspection annotations.
* docs: Remove hack to embed filesCarlos Garnacho2022-04-033-56/+21
| | | | | This is something hotdoc can do for us, there is no need for an script here.
* website: Add FAQ about versions supported by TrackerCarlos Garnacho2022-02-231-0/+30
| | | | | Rationalize why we only support the last stable, and everything else is deemed to crash and burn.
* website: Mention "tracker3 status" as first stop in debuggingCarlos Garnacho2022-02-231-2/+4
| | | | | | Besides current status, that tells about missing files and whatnot, seems a good idea to advise that before telling to follow/restart/debug daemons.
* manpages: Fix generation of manpages with asciidoc 10Jan Alexander Steffens (heftig)2022-02-157-27/+20
| | | | | | | We should use asciidoc's `a2x` driver instead of running xsltproc ourselves. asciidoc 10 ships its stylesheets in a private directory. Fixes: https://gitlab.gnome.org/GNOME/tracker/-/issues/347
* docs: Document how the annotated types in cursors affect limitsCarlos Garnacho2022-02-041-1/+6
| | | | | | | SELECTs may have 2000 columns, which we effectively halve with SPARQL queries doubling the number of columns. Still, 1000 is an acceptable default limit, and the change is unlikely to have side effects, so document this new behavior.
View Lorry Controller Status