Skip to content
This repository was archived by the owner on Apr 13, 2022. It is now read-only.

Commit 37b709c

Browse files
authored
Clarity and motivation for preferences File
1 parent bea2322 commit 37b709c

File tree

1 file changed

+45
-10
lines changed

1 file changed

+45
-10
lines changed

solid-webid-profiles.md

Lines changed: 45 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -89,12 +89,18 @@ for the purposes of building distributed read-write-web applications.
8989
In addition, Solid recommends that WebID profiles include the following
9090
statements:
9191

92-
1. A profile SHOULD include a `foaf:name` (see the discussion
92+
1. A profile MUST include a `foaf:name` (see the discussion
9393
on [user names](#recommendation-for-user-names-in-profiles) below).
94-
2. A profile SHOULD include `cert:key` public key certificate information, for
94+
This does not have to be a real name, it can by any pseudnym, but
95+
a string proided for apps to use for representing the user, in chats, sharing etc etc.
96+
2. A profile SHOULD include a public `foaf:image` of either a mugshot of the person or a chosen avatar
97+
to make the display of the user's contributions identifyable.
98+
3. A profile MAY provide a `foaf:nick` nickname as a short string for use by user interfaces where
99+
space is limited.
100+
3. A profile SHOULD include `cert:key` public key certificate information, for
95101
use with WebID+TLS (which is currently the primary Solid authentication
96102
mechanism).
97-
3. A profile SHOULD point to the root storage location using `pim:storage`
103+
4. A profile SHOULD point to the root storage location using `pim:storage`
98104
(so that applications will know where to read and write their data).
99105

100106
```ttl
@@ -125,7 +131,7 @@ what to name the user, is to perform the following steps:
125131
1. An app SHOULD look in the user's WebID Profile for the `foaf:name` predicate,
126132
and use that as the name, if it's available.
127133
2. If an app does not find a name in the user profile, it MAY fall back to using
128-
the WebID URL as the username.
134+
the WebID URL, r a part ofo it, as the username.
129135

130136
## Public and Private Profiles
131137

@@ -148,13 +154,42 @@ across several RDF documents:
148154
The combination of the main WebID Profile document, and all of the *related*
149155
profile documents is referred to as the **Extended Profile**.
150156

151-
Solid apps that interact with the WebID profile MUST also load and parse *all*
152-
of the related RDF resources that are linked to from the main profile using
153-
the following predicates:
157+
Solid apps that interact anonymously with the WebID profile MUST also load and parse *all*
158+
of the related public RDF resources that are linked to from the main profile using any
159+
the following triples in the main profile document:
160+
161+
1. $webid `http://www.w3.org/2002/07/owl#sameAs` ?public
162+
2. $webid `http://www.w3.org/2000/01/rdf-schema#seeAlso` ?public
163+
164+
Solid apps that interact as the user in question, logged in with their cedentials,
165+
with their own WebID profile MUST also load and parse all
166+
of the related public public resources above and also will normally
167+
load the user's preferences file.
168+
169+
### Private preferences file
170+
171+
The private preferences file is part of the extended profile. It is found
172+
by following a triple in the main profile (the result of looking up the webid)
173+
174+
3. $webid `http://www.w3.org/ns/pim/space#preferencesFile` ?preferences
175+
176+
Where the subject is the user's original webid.
177+
178+
It is the first private file that the app discovers in thie process, and
179+
it is the place which either stores, or leads to, all of the
180+
data which is private to the user, including settings
181+
and preferences, language and display preferences, and so on
182+
and all the user's pesonal data, be it conntacts, pictures or health data.
183+
184+
The `solid:preferencesFile` link is unusual then in that it is a link
185+
from public data to private data. Otherwise, discovery happes in two
186+
parallelel but otherwise congruent ways, in a tree of public information starting from
187+
the extended profile, and a tree of private information starting from the
188+
private preferences file. Developers use urged to use common software for
189+
these cases, and also to make it extenssible in future for when
190+
the congruent trees may be rooted in files corresponding to groups and organizations
191+
of which the user is a member.
154192

155-
1. `http://www.w3.org/2002/07/owl#sameAs`
156-
2. `http://www.w3.org/2000/01/rdf-schema#seeAlso`
157-
3. `http://www.w3.org/ns/pim/space#preferencesFile`
158193

159194
## Public Key Certificates
160195

0 commit comments

Comments
 (0)