Repository files navigation

Server-side infrastructure for tridoc: easy document management for individuals and small teams.

• Setup
• Tag System
  • Simple Tags
  • Parameterizable & Parameterized Tags
• Comments
• API

This will setup tridoc on port 8000 and fuseki avaliable on port 8001.Make sure you havedocker-compose installed.

ReplaceYOUR PASSWORD HERE in the first command with your choice of password.

Unix/Linux/wsl:

export TRIDOC_PWD="YOUR PASSWORD HERE"docker-compose builddocker-compose up

On windows, relpace the first line with:

$env:TRIDOC_PWD="YOUR PASSWORD HERE"

For more Setup options see theDEV-README.md

There are two types of tags: simple tags and parameterizable tags. Parameterizable tags need a parameter to become a parameterized tag wich can be added to a document.

Simple tags can be created byPOST to/tag. You need to send an JSON object like this:

{"label":"Inbox"}

Note:label must be unique.

The label must not contain any of the following: whitespace,/,\,#,",',,,;,:,?;
The label must not equal. (single dot) or.. (double dot).

Tags can be added to a document byPOST to/doc/{id}/tag. You need to send an JSON object like the one above.

Tags must be created before adding them to a document.

Parameterizable tags can be created byPOST to/tag too. You need to send an JSON object like this:

{"label":"Amount","parameter": {"type":"http://www.w3.org/2001/XMLSchema#decimal"    }}

Again,label must be unique.
parameter.type can either behttp://www.w3.org/2001/XMLSchema#decimal orhttp://www.w3.org/2001/XMLSchema#date .

Parameterizable tags can only be added to a document with a value assigned. ByPOSTing a JSON object like the following to/doc/{id}/tag, a parameterized tag is created and added to the document.

{"label":"Amount","parameter": {"type":"http://www.w3.org/2001/XMLSchema#decimal","value":"12.50"    }}

A parameterizable tag with thislabel andparameter.type has to be created before.

Tags can be added to a document byPOST to/doc/{id}/comment

You can either send an JSON document like the following

{"text":"This is a comment"}

When getting a comment, a JSON array with objects of the following structure is provided:

{"text":"This is a comment","created":"2020-03-12T10:07:20.493Z"}

¹ : ?text
² : ?limit and ?offset

³ : ?tag and ?nottag
Since 1.4.4, filtering for Tag Ranges is possible with the following syntax:…={label};{min};{max}.min ormax may be ommitted for unbounded search. Trailing semocolons may be omitted.Example:

…?tag=foo;;30&tag=bar;2020-01-01;2020-12-31

gives all that have tag foo with a value <= 30, and bar values within 2020.

Be aware that this may need replacing of the caracter; by%3B.

⁴ : ?accept
⁵ : ?date followed by an ISO 8601 date string including time and timezone, seconds optional, sets creation date

Deleting / editing comments might be supported in the future