@@ -4,69 +4,119 @@ Style guide defining wording, spelling, and other details regarding how DSNP ter
4
4
For more information about DSNP, visit [ dsnp.org] ( https://www.dsnp.org/ )
5
5
or [ DSNP on GitHub] ( https://github.com/LibertyDSNP/spec )
6
6
7
- ## Announcement
8
- Uppercase A
7
+ ## General rules
8
+ * Announcements specific to DSNP have initial caps. (i.e., Broadcast Announcement)
9
+ * Announcement Types also have initial caps.
10
+ * General words that aren't specific to DSNP are lowercase (i.e., announcement, batch, content hash).
11
+ * Attribute is lowercase except when combined with an announcement or a specific DSNP set type. (i.e., Attribute Set Announcement)
12
+
13
+ ## announcement
14
+ Generally all lowercase
9
15
10
16
## Announcement Type
11
17
Uppercase A and T
12
18
13
- ## Batch
14
- Uppercase B
19
+ ## attribute
20
+ All lowercase
21
+
22
+ ## attribute sets
23
+ All lowercase
24
+
25
+ ## Attribute Set Announcement
26
+ Uppercase A, S and A
27
+
28
+ ## Attribute Set Type
29
+ Uppercase A, S and T
30
+
31
+ ## Attribute Set Value Document
32
+ Uppercase A, S, V and D
33
+
34
+ ## batch
35
+ All lowercase
15
36
16
37
## Batch Publication
17
38
Uppercase B and P
18
39
40
+ ## bloom filter
41
+ lowercase b and f
42
+
43
+ ## Broadcast Announcements
44
+ Uppercase B and A
45
+
19
46
## Code of Conduct
20
47
Uppercase C and C
21
48
22
49
## community
23
50
All lowercase
24
51
52
+ ## content announcement
53
+ All lowercase
54
+
55
+ ## Content Attribute Set
56
+
57
+ ## content hash
58
+ All lowercase
59
+
60
+ ## credential document
61
+ All lowercase
62
+
25
63
## Decentralized Social Networking Protocol (DSNP)
26
64
Spelled out fully first time it appears and then acronym thereafter. Avoid preceding with the word "the" and never follow with the word "protocol".
27
65
28
66
## development community
29
67
All lowercase
30
68
69
+ ## DSNP Announcements
70
+ Uppercase DSNP and A
71
+
31
72
## DSNP public social graph
32
73
All lowercase after acronym
33
74
34
75
## DSNP Batch Publications
35
76
Uppercase Acronym plus uppercase B and P
36
77
78
+ ## DSNP content
79
+ Uppercase acronym, lowercase c
80
+
37
81
## DSNP Content Hash
38
82
Uppercase Acronym plus uppercase C and H
39
83
84
+ ## DSNP Content URI
85
+ Uppercase D, C and URI
86
+
40
87
## DSNP graph
41
88
Only acronym is uppercase
42
89
43
90
## DSNP Identifiers
44
91
Uppercase Acronym plus uppercase I
45
92
46
- ## DSNP Identity
47
- Uppercase Acronym plus Uppercase I
93
+ ## DSNP identity
94
+ Uppercase Acronym lowercase i
48
95
49
96
## DSNP Id
50
- Short for DSNP Identity , Uppercase Acronym plus uppercase I
97
+ Short for DSNP identity , Uppercase Acronym lowercase when spelled out
51
98
52
99
## DSNP Protocol Scheme
53
100
Uppercase Acronym plus uppercase P and S
54
101
55
102
## DSNP Specification
56
103
Uppercase DSNP and S, avoid preceding with the word "the"
57
104
105
+ ## DSNP user
106
+ Uppercase DSNP and lowercase u
107
+
58
108
## DSNP User Id
59
109
Uppercase acronym, U and I, avoid preceding with the word "the"
60
110
61
111
## DSNP User URI
62
112
Uppercase Acronyms plus uppercase U
63
113
64
- ## End User
65
- Uppercase E and U
66
-
67
114
## Exclamation Marks
68
115
Should be avoided
69
116
117
+ ## External Content Attributes
118
+ Uppercase E, C and A
119
+
70
120
## Graph Change Announcements
71
121
Uppercase G, C and A.
72
122
Note: Graph Change Announcements and events have been migrated to use User Data Operations as of version 1.2.0.
@@ -78,9 +128,15 @@ Note: Graph Change Announcements and events have been migrated to use User Data
78
128
## InterPlanetary File System (IPFS)
79
129
Uppercase I, P, F and S. In the first instance, spell out followed by the acronym in parentheses. Use the acronym only thereafter.
80
130
131
+ ## issuer
132
+ All lower case
133
+
81
134
## MUST/MUST NOT
82
135
All Caps when defining rules for specification
83
136
137
+ ## on-demand credential
138
+ Hyphenated, all lower case
139
+
84
140
## Operation
85
141
Uppercase O when referring to spec-defined DSNP Operations
86
142
@@ -90,26 +146,65 @@ Always use
90
146
## Possessives
91
147
Making DSNP possessive should be avoided (e.g. DSNP’s)
92
148
149
+ ## Profile Announcement
150
+ Uppercase P and A
151
+
93
152
## Project Liberty
94
153
Uppercase P and L
95
154
155
+ ## public key
156
+ All lowercase
157
+
96
158
## public graph
97
159
All lowercase
98
160
161
+ ## Public Key Announcement
162
+ Uppercase P, K and A
163
+
99
164
## Reaction Announcement
100
165
Uppercase R and A
101
166
102
167
## Record
103
168
Uppercase R when referring to spec-defined DSNP State Change Records
104
169
170
+ ## Reply Announcements
171
+ Uppercase R and A
172
+
173
+ ## schema
174
+ All lowercase
175
+
105
176
## social network graph
106
177
All lowercase
107
178
108
179
## Team
109
180
Should not be used in context with DSNP
110
181
182
+ ## Tombstone Announcement
183
+ Uppercase T and A
184
+
185
+ ## User Attribute Set Announcement
186
+ Uppercase U, A, S and A
187
+
188
+ ## verifier
189
+ Lowercase v
190
+
191
+ ## Verifiable Credential Document
192
+ Uppercase V, C and D
193
+
194
+ ## Verifier Credential Schema Document
195
+ Uppercase V, C, S and D
196
+
111
197
## Update Announcement
112
198
Uppercase U and A
113
199
200
+ ## user
201
+ All lowercase
202
+
203
+ ## User Attribute Set
204
+ Uppercase U, A and S
205
+
206
+ ## verifier
207
+ All lowercase
208
+
114
209
## We/Us/Our
115
210
Should not be used in context with Frequency
0 commit comments