idnits 2.17.1 draft-ietf-acap-book-03.txt: ** The Abstract section seems to be numbered Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** Looks like you're using RFC 2026 boilerplate. This must be updated to follow RFC 3978/3979, as updated by RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- ** The document seems to lack a 1id_guidelines paragraph about 6 months document validity -- however, there's a paragraph with a matching beginning. Boilerplate error? ** The document seems to lack a 1id_guidelines paragraph about the list of current Internet-Drafts -- however, there's a paragraph with a matching beginning. Boilerplate error? ** The document seems to lack a 1id_guidelines paragraph about the list of Shadow Directories -- however, there's a paragraph with a matching beginning. Boilerplate error? == No 'Intended status' indicated for this document; assuming Proposed Standard Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack an Introduction section. ** The document seems to lack an IANA Considerations section. (See Section 2.2 of https://www.ietf.org/id-info/checklist for how to handle the case when there are no actions for IANA.) ** The abstract seems to contain references ([ACAP], [URL]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. ** The document seems to lack a both a reference to RFC 2119 and the recommended RFC 2119 boilerplate, even if it appears to use RFC 2119 keywords -- however, there's a paragraph with a matching beginning. Boilerplate error? RFC 2119 keyword, line 97: '... (that is, bookmark folders) SHOULD be...' RFC 2119 keyword, line 108: '...ks dataset entry MUST have an "entry" ...' RFC 2119 keyword, line 109: '... attributes are OPTIONAL....' RFC 2119 keyword, line 116: '...string. Clients MUST conform to the s...' RFC 2119 keyword, line 117: '... attributes, but MUST NOT assume that ...' (2 more instances...) Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (25 February 2000) is 8820 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) -- Missing reference section? 'URL' on line 303 looks like a reference -- Missing reference section? 'ACAP' on line 295 looks like a reference -- Missing reference section? 'KEYWORDS' on line 299 looks like a reference -- Missing reference section? 'ABNF' on line 291 looks like a reference -- Missing reference section? 'UTF8' on line 307 looks like a reference Summary: 9 errors (**), 0 flaws (~~), 2 warnings (==), 7 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Internet Draft R. Gellens 2 Document: draft-ietf-acap-book-03.txt QUALCOMM 3 Expires: 25 August 2000 25 February 2000 5 ACAP Bookmarks Dataset Class 7 Status of this Memo: 9 This document is an Internet-Draft and is in full conformance with 10 all provisions of Section 10 of RFC2026. 12 Internet-Drafts are working documents of the Internet Engineering 13 Task Force (IETF), its areas, and its working groups. Note that 14 other groups may also distribute working documents as 15 Internet-Drafts. 17 Internet-Drafts are draft documents valid for a maximum of six 18 months and may be updated, replaced, or obsoleted by other documents 19 at any time. It is inappropriate to use Internet- Drafts as 20 reference material or to cite them other than as "work in progress." 22 The list of current Internet-Drafts can be accessed at 23 25 The list of Internet-Draft Shadow Directories can be accessed at 26 . 28 A version of this draft document is intended for submission to the 29 RFC editor as a Proposed Standard for the Internet Community. 30 Discussion and suggestions for improvement are requested. 32 Copyright Notice 34 Copyright (C) The Internet Society 2000. All Rights Reserved. 36 Table of Contents 38 1. Abstract . . . . . . . . . . . . . . . . . . . . . . . . . . 2 39 2. Conventions Used in this Document . . . . . . . . . . . . . . 2 40 3. Comments . . . . . . . . . . . . . . . . . . . . . . . . . . 2 41 4. ACAP Bookmarks Dataset Class . . . . . . . . . . . . . . . . 2 42 4.1. ACAP Bookmarks Dataset Class Prefix . . . . . . . . . . 3 43 4.2. ACAP Bookmarks Dataset Hierarchy . . . . . . . . . . . . 3 44 5. Recommended ACAP Bookmarks Dataset Attributes . . . . . . . 3 45 5.1. Basic Attributes . . . . . . . . . . . . . . . . . . . . 3 46 5.2. Specific Attributes . . . . . . . . . . . . . . . . . . 4 47 6. Common ABNF . . . . . . . . . . . . . . . . . . . . . . . . . 5 48 7. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 5 49 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 7 50 9. Security Considerations . . . . . . . . . . . . . . . . . . 7 51 10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 7 52 11. Author's Address . . . . . . . . . . . . . . . . . . . . . . 7 53 12. Full Copyright Statement . . . . . . . . . . . . . . . . . . 8 55 1. Abstract 57 Storing URLs [URL] for later access has become common in Internet 58 applications (for example, web browsers, FTP clients); these saved 59 URLs have become known as bookmarks. It would be desirable to 60 access one's bookmarks from multiple clients and multiple machines. 62 The Application Configuration Access Protocol [ACAP] provides an 63 ideal mechanism for storage of bookmarks, providing for ease of 64 coordination and synchronization of bookmarks between diverse 65 applications and systems, as well as for hierarchy, inheritance, and 66 sharing between users. 68 This specification defines a standard ACAP dataset class for 69 bookmarks. 71 2. Conventions Used in this Document 73 The key words "MUST", "MUST NOT", "SHOULD", "SHOULD NOT", and "MAY" 74 in this document are to be interpreted as defined in "Key words for 75 use in RFCs to Indicate Requirement Levels" [KEYWORDS]. 77 3. Comments 79 Public comments can be sent to the IETF ACAP mailing list, 80 . To subscribe, send a message to 81 with the word SUBSCRIBE as the 82 body. Private comments should be sent to the author. 84 4. ACAP Bookmarks Dataset Class 86 The ACAP Bookmarks dataset class defines a set of attributes for 87 each bookmark, and provides for bookmark inheritance and hierarchy. 89 4.1. ACAP Bookmarks Dataset Class Prefix 91 Datasets whose names begin with "/bookmarks" are assumed to contain 92 bookmark entries as defined in this specification. 94 4.2. ACAP Bookmarks Dataset Hierarchy 96 Each user may have a hierarchical set of bookmarks. Nested or 97 hierarchical bookmarks (that is, bookmark folders) SHOULD be 98 represented using the ACAP Hierarchy. Any entry in a bookmarks 99 dataset can be a hierarchy node by setting the "subdataset" 100 attribute. 102 Inheritance is likely to be useful both for inheriting sets of site 103 or group default bookmarks as well as for inheriting user-specific 104 bookmarks when using different machines. 106 5. Recommended ACAP Bookmarks Dataset Attributes 108 A Bookmarks dataset entry MUST have an "entry" attribute. All other 109 attributes are OPTIONAL. 111 Attributes are specified using Augmented Backus-Naur Form [ABNF], 112 including the Core Rules. All attributes are single-valued and 113 textual (do not contain binary data) unless otherwise stated. 115 The ABNF defines the content of the attribute values prior to their 116 encoding as an ACAP string. Clients MUST conform to the syntax when 117 generating these attributes, but MUST NOT assume that the attribute 118 values will conform to this syntax on access. Servers MUST NOT 119 enforce the syntax. 121 5.1. Basic Attributes 123 These attributes are defined in ACAP [ACAP] and have meaning in all 124 dataset classes. The section describes how they are used in a 125 bookmarks dataset. 127 entry 128 The "entry" attribute is used to uniquely identify the bookmark. 129 The name MUST be unique, but is not expected to be descriptive, 130 and generally is not suitable for display to users. It is 131 client-defined. 133 The "entry" attribute is also used for ordering. When selecting 134 the "entry" attribute for a new bookmark, in addition to 135 uniqueness, the client selects a string which causes the new 136 entry to appear in the desired order, when sorted using the 137 "i;ascii-casemap" comparator [ACAP]. For example, to insert an 138 entry between "a1" and "a2", "a1a" could be used. 140 subdataset 141 The "subdataset" attribute indicates that there is a subdataset 142 of this entry. The value of this attribute specifies the actual 143 location of the subdataset, per [ACAP] section 3.1.1. For the 144 bookmarks dataset, a value of "." is most commonly used for a 145 user's own entries, indicating that the subdataset exists 146 directly beneath this one. However, especially when inheriting 147 bookmarks from group or site collections, the value of this 148 attribute may point to a dataset on the same or a different ACAP 149 server. 151 5.2. Specific Attributes 153 These attributes are specific to the Bookmarks dataset class. 155 bookmarks.Date.Added 156 This contains the date and time of the original creation of this 157 entry. The value is expressed in UTC with a timezone offset, 158 indicating the user's local time. 160 book-date = datetime ;specified in Common ABNF 162 bookmarks.Description 163 This contains the user-assigned description of the entry, as a 164 series of CRLF-separated lines. 166 book-description = *line ;specified in Common ABNF 168 bookmarks.Last.Modified 169 This contains the date and time of the most recent modification 170 of the entry. Modification includes any user-initiated action 171 (such as editing the description) but not automatic actions 172 (such as updating the "Last.Visited" attribute). The value is 173 expressed in UTC, with a timezone offset indicating the user's 174 local time. 176 book-modtime = datetime ;specified in Common ABNF 178 bookmarks.Last.Visited 179 This contains the date and time of the most recent access of the 180 location represented by the entry's URL. The value is expressed 181 in UTC, with a timezone offset indicating the user's local time. 183 book-visit = datetime ;specified in Common ABNF 184 bookmarks.Name 185 This specifies a descriptive name for the entry. It does not 186 need to be unique. 188 book-name = 1*(VCHAR / SP) 190 bookmarks.Type 191 This contains a token describing the type of the entry. The 192 Separator type indicates the entry is separator for display 193 purposes. The Folder type is used for a container or folder 194 (used with ACAP subdatasets). The Alias type is used for an 195 alias entry, in which case the URL is an ACAP URL to an entry in 196 an ACAP Bookmarks dataset. The Link type is used to refer to 197 any type of object, for example, a web page or a file. 199 book-type = "separator" / "link" / "alias" / "folder" 201 bookmarks.URL 202 This contains the URL of the object referred to by this entry. 203 For Link type entries, this can be any type of URL. For Alias 204 type entries, this is an ACAP URL. ACAP URLs are specified in 205 [ACAP]. 207 book-url = url ;defined in [URL] 209 6. Common ABNF 211 The following [ABNF] rules are used above. 213 datetime = year month day hour minute second timezone 214 ;UTC and offset to local time 216 day = 2DIGIT 218 hour = 2DIGIT 220 line = *(VCHAR / SP) CRLF 222 minute = 2DIGIT 224 month = 2DIGIT 226 second = 2DIGIT 228 timezone = ("+" / "-") 4DIGIT 230 year = 4DIGIT 231 7. Examples 233 /~/bookmarks/ 235 entry a23gzk 236 bookmarks.Date.Added 19840101000001+0800 237 bookmarks.Description Where I get my worms 238 bookmarks.Last.Modified 19971114071202+0800 239 bookmarks.Last.Visited 19980311173545+0800 240 bookmarks.Name Fred's Bait and Tackle 241 bookmarks.Type link 242 bookmarks.URL http://www.fredsbaitandtackle.fog/ 244 entry b1799 245 bookmarks.type separator 247 entry xyzzy 248 bookmarks.Date.Added 19770612140004+0500 249 bookmarks.Description This really cool site I stumbled 250 on when looking for something 251 else. It has detailed and easy 252 to follow instructions on how to 253 crush beer cans 254 bookmarks.Last.Modified 19971231235902+0800 255 bookmarks.Last.Visited 19980311173510+0800 256 bookmarks.Name Yip Yap's Helpful HowTo Page 257 bookmarks.Type link 258 bookmarks.URL http://stud.cheesy.edu/~jru/ 260 entry zz99 261 subdataset . 262 bookmarks.Name Contemporaneous Contemplations 263 bookmarks.Type folder 265 /~/bookmarks/zz99/ 267 entry a1a1 268 bookmarks.Date.Added 19990401000002+0800 269 bookmarks.Description I laughed so hard beer came out my 270 nose and my then my roommate saw 271 and started laughing and choking 272 bookmarks.Last.Modified 19990401000002+0800 273 bookmarks.Last.Visited 19990401000001+0800 274 bookmarks.Name Why Beer is Better than ... 275 bookmarks.Type link 276 bookmarks.URL http://trash.example.org/~b1ff/ 277 beer.html 279 entry b2b2 280 bookmarks.Date.Added 19990401010003+0800 281 bookmarks.Description Commencment address delivered by 282 Clinton and Vonnegut to Vassar 283 bookmarks.Last.Modified 19990401010003+0800 284 bookmarks.Last.Visited 19990401010000+0800 285 bookmarks.Name Clinton and Vonnegut at Vassar 286 bookmarks.Type link 287 bookmarks.URL http://april.fools.oaf/vassar-mit 289 8. References 291 [ABNF] Crocker, Overell, "Augmented BNF for Syntax Specifications: 292 ABNF", RFC 2234, Internet Mail Consortium, Demon Internet Ltd., 293 November 1997. 295 [ACAP] Newman, Myers, "ACAP -- Application Configuration Access 296 Protocol", RFC 2244, Innosoft, Netscape, November 1997. 297 299 [KEYWORDS] Bradner, "Key words for use in RFCs to Indicate 300 Requirement Levels", RFC 2119, Harvard University, March 1997. 301 303 [URL] Berners-Lee, Masinter, McCahill, "Uniform Resource Locators 304 (URL)", RFC 1738, CERN, Xerox Corporation, University of Minnesota, 305 December 1994. 307 [UTF8] Yergeau, F. "UTF-8, a transformation format of ISO 10646", 308 RFC 2279, Alis Technologies, January 1998. 309 311 9. Security Considerations 313 As with ACAP datasets in general, it is important that access 314 controls are set correctly on Bookmarks datasets. Attributes may 315 contain personal information which should not be disclosed except by 316 explicit owner request. 318 10. Acknowledgments 320 Many thanks to the participants of the IETF ACAP working group for 321 their help, comments, and suggestions. 323 11. Author's Address 325 Randall Gellens +1 858 651 5115 326 QUALCOMM Incorporated randy@qualcomm.com 327 5775 Morehouse Drive 328 San Diego, CA 92121-2779 329 U.S.A. 331 12. Full Copyright Statement 333 Copyright (C) The Internet Society 2000. All Rights Reserved. 335 This document and translations of it may be copied and furnished to 336 others, and derivative works that comment on or otherwise explain it 337 or assist in its implementation may be prepared, copied, published 338 and distributed, in whole or in part, without restriction of any 339 kind, provided that the above copyright notice and this paragraph 340 are included on all such copies and derivative works. However, this 341 document itself may not be modified in any way, such as by removing 342 the copyright notice or references to the Internet Society or other 343 Internet organizations, except as needed for the purpose of 344 developing Internet standards in which case the procedures for 345 copyrights defined in the Internet Standards process must be 346 followed, or as required to translate it into languages other than 347 English. 349 The limited permissions granted above are perpetual and will not be 350 revoked by the Internet Society or its successors or assigns. 352 This document and the information contained herein is provided on an 353 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 354 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 355 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 356 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 357 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.