Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update information on dokieli's data conventions and conformance to specifications #380

Merged
merged 2 commits into from
Mar 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion Documentation/conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,24 @@ To add material to the meeting (let's say `https://example.com/agenda-meeting.ht

## Dokieli Document

A 'Dokieli Document' is an HTML document with some linked-data annotations, but otherwise just HTML. So the 'Dokieli Document' tool does not store data in triples in RDF sources like most other tools do, but instead allows you to run an online HTML editor right on your pod. When you click 'Save' in the Dokieli editor, the HTML document is written to your pod using a http PUT request, and in that sense this editor makes use of the LDP (read-write web) functionalities of your pod. You can also use Dokieli as a third-party app, on https://dokie.li.
[dokieli](https://dokie.li/) is a clientside editor for decentralised article publishing, annotations, and social interactions. Source code is available from <https://github.com/linkeddata/dokieli>.

dokieli allows content creators to generate human- and machine-readable documents in HTML+RDFa, optionally embedding "data blocks" using the `<script type="">` mechanism to include content in Turtle, JSON-LD, and TriG. dokieli also employs mechanisms to use media types that are acceptable by a server (e.g., JSON-LD, Turtle, HTML+RDFa) when, for example, generating data for servers conforming to the [Solid Protocol](https://solidproject.org/ED/protocol), [Linked Data Platform](https://www.w3.org/TR/ldp/), [Linked Data Notifications](https://www.w3.org/TR/ldn/), [Web Annotation Protocol](https://www.w3.org/TR/annotation-protocol), or [ActivityPub](https://www.w3.org/TR/activitypub/).

The documents that are generated by dokieli are entirely *Linked Data* documents, in that all significant units of information are available in triple statements (as per data models it conforms to), in addition to being accessible by text-based web browsers or screen readers, especially in the case of HTML.

dokieli can parse, use, or generate RDF sources including (but not limited to):
* [WebID](https://www.w3.org/2005/Incubator/webid/spec/identity/) for personal/agent identities.
* [Web Access Control (WAC)](https://solidproject.org/TR/wac)/[Access Control Lists (ACL)](https://dbpedia.org/resource/Access_Control_List) to set permissions on Web resources.
* W3C [Web Annotation Model](https://www.w3.org/TR/annotation-model/), W3C [Web Annotation Vocabulary](https://www.w3.org/TR/annotation-vocab/), W3C [Embedding Web Annotations in HTML](https://www.w3.org/TR/annotation-html), and W3C [Selectors and States](https://www.w3.org/TR/selectors-states/) to model and identify annotations (e.g., replies, peer-reviews, liking, resharing, bookmarking)
* W3C [Activity Streams 2.0 vocabulary](https://www.w3.org/TR/activitystreams-vocabulary) for social activities.
* W3C [ODRL Information Model](https://www.w3.org/TR/odrl-model/) and W3C [ODRL Vocabulary & Expression](https://www.w3.org/TR/odrl-vocab/) to represent statements about the usage of content and services.
* [Memento](https://tools.ietf.org/html/rfc7089) for resource management, e.g., TimeMap.
* [Creative Commons](https://creativecommons.org/) to assign license to individual contributions and annotations.
* [Robust Links](http://robustlinks.mementoweb.org/) for hyperlinks (e.g., citations) and to show Link Decoration.
* [schema.org](http://schema.org/), [SPAR Ontologies](http://www.sparontologies.net/), [PROV-O](https://www.w3.org/TR/prov-o/), and various other vocabularies.

Dokieli can also be used from any spawned instance, e.g., https://dokie.li/ , https://csarven.ca/, or as a Web browser extension. See https://dokie.li/docs and https://github.com/linkeddata/dokieli/blob/main/README.md#specifications for further documentation on data conventions and lists of specifications (protocols and data models) that dokieli conforms to.

## Folder

Expand Down
Loading