idnits 2.17.1 draft-ietf-acap-book-06.txt: 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 94: '... (that is, bookmark folders) SHOULD be...' RFC 2119 keyword, line 105: '...ks dataset entry MUST have an "entry" ...' RFC 2119 keyword, line 106: '... attributes are OPTIONAL....' RFC 2119 keyword, line 113: '...string. Clients MUST conform to the s...' RFC 2119 keyword, line 114: '... 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 (February 2003) is 7742 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 307 looks like a reference -- Missing reference section? 'ACAP' on line 299 looks like a reference -- Missing reference section? 'KEYWORDS' on line 303 looks like a reference -- Missing reference section? 'ABNF' on line 295 looks like a reference -- Missing reference section? 'UTF8' on line 311 looks like a reference Summary: 8 errors (**), 0 flaws (~~), 2 warnings (==), 7 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Internet Draft R. Gellens 3 Document: draft-ietf-acap-book-06.txt QUALCOMM 4 Expires: August 2003 February 2003 6 ACAP Bookmarks Dataset Class 8 Status of this Memo: 10 This document is an Internet-Draft and is in full conformance with 11 all provisions of Section 10 of RFC2026. 13 Internet-Drafts are working documents of the Internet Engineering 14 Task Force (IETF), its areas, and its working groups. Note that 15 other groups may also distribute working documents as 16 Internet-Drafts. 18 Internet-Drafts are draft documents valid for a maximum of six 19 months and may be updated, replaced, or obsoleted by other documents 20 at any time. It is inappropriate to use Internet- Drafts as 21 reference material or to cite them other than as "work in progress." 23 The list of current Internet-Drafts can be accessed at 24 26 The list of Internet-Draft Shadow Directories can be accessed at 27 . 29 Copyright Notice 31 Copyright (C) The Internet Society 2003. All Rights Reserved. 33 Abstract 35 Storing URLs [URL] for later access has become common in Internet 36 applications (for example, web browsers, FTP clients); these saved 37 URLs have become known as bookmarks. It would be desirable to 38 access one's bookmarks from multiple clients and multiple machines. 40 The Application Configuration Access Protocol [ACAP] provides an 41 ideal mechanism for storage of bookmarks, providing for ease of 42 coordination and synchronization of bookmarks between diverse 43 applications and systems, as well as for hierarchy, inheritance, and 44 sharing between users. 46 This specification defines a standard ACAP dataset class for 47 bookmarks. 49 Table of Contents 51 1. Conventions Used in this Document . . . . . . . . . . . . . . 3 52 2. Comments . . . . . . . . . . . . . . . . . . . . . . . . . . 3 53 3. ACAP Bookmarks Dataset Class . . . . . . . . . . . . . . . . 3 54 3.1. ACAP Bookmarks Dataset Class Prefix . . . . . . . . . . 3 55 3.2. ACAP Bookmarks Dataset Hierarchy . . . . . . . . . . . . 3 56 4. Recommended ACAP Bookmarks Dataset Attributes . . . . . . . 4 57 4.1. Basic Attributes . . . . . . . . . . . . . . . . . . . . 4 58 4.2. Specific Attributes . . . . . . . . . . . . . . . . . . 5 59 5. Common ABNF . . . . . . . . . . . . . . . . . . . . . . . . . 6 60 6. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 7 61 7. Normative References . . . . . . . . . . . . . . . . . . . . 8 62 8. Security Considerations . . . . . . . . . . . . . . . . . . 8 63 9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 8 64 10. Author's Address . . . . . . . . . . . . . . . . . . . . . 9 65 Intellectual Property Statement . . . . . . . . . . . . . . . . 9 66 Full Copyright Statement . . . . . . . . . . . . . . . . . . . 9 68 1. Conventions Used in this Document 70 The key words "MUST", "MUST NOT", "SHOULD", "SHOULD NOT", and "MAY" 71 in this document are to be interpreted as defined in "Key words for 72 use in RFCs to Indicate Requirement Levels" [KEYWORDS]. 74 2. Comments 76 Public comments can be sent to the IETF ACAP mailing list, 77 . To subscribe, send a message to 78 with the word SUBSCRIBE as the 79 body. Private comments should be sent to the author. 81 3. ACAP Bookmarks Dataset Class 83 The ACAP Bookmarks dataset class defines a set of attributes for 84 each bookmark, and provides for bookmark inheritance and hierarchy. 86 3.1. ACAP Bookmarks Dataset Class Prefix 88 Datasets whose names begin with "/bookmarks" are assumed to contain 89 bookmark entries as defined in this specification. 91 3.2. ACAP Bookmarks Dataset Hierarchy 93 Each user may have a hierarchical set of bookmarks. Nested or 94 hierarchical bookmarks (that is, bookmark folders) SHOULD be 95 represented using the ACAP Hierarchy. Any entry in a bookmarks 96 dataset can be a hierarchy node by setting the "subdataset" 97 attribute. 99 Inheritance is likely to be useful both for inheriting sets of site 100 or group default bookmarks as well as for inheriting user-specific 101 bookmarks when using different machines. 103 4. Recommended ACAP Bookmarks Dataset Attributes 105 A Bookmarks dataset entry MUST have an "entry" attribute. All other 106 attributes are OPTIONAL. 108 Attributes are specified using Augmented Backus-Naur Form [ABNF], 109 including the Core Rules. All attributes are single-valued and 110 textual (do not contain binary data) unless otherwise stated. 112 The ABNF defines the content of the attribute values prior to their 113 encoding as an ACAP string. Clients MUST conform to the syntax when 114 generating these attributes, but MUST NOT assume that the attribute 115 values will conform to this syntax on access. Servers MUST NOT 116 enforce the syntax. 118 4.1. Basic Attributes 120 These attributes are defined in ACAP [ACAP] and have meaning in all 121 dataset classes. The section describes how they are used in a 122 bookmarks dataset. 124 entry 125 The "entry" attribute is used to uniquely identify the bookmark. 126 The name MUST be unique, but is not expected to be descriptive, 127 and generally is not suitable for display to users. It is 128 client-defined. 130 The "entry" attribute is also used for ordering. When selecting 131 the "entry" attribute for a new bookmark, in addition to 132 uniqueness, the client selects a string which causes the new 133 entry to appear in the desired order, when sorted using the 134 "i;ascii-casemap" comparator [ACAP]. For example, to insert an 135 entry between "a1" and "a2", "a1a" could be used. 137 subdataset 138 The "subdataset" attribute indicates that there is a subdataset 139 of this entry. The value of this attribute specifies the actual 140 location of the subdataset, per [ACAP] section 3.1.1. For the 141 bookmarks dataset, a value of "." is most commonly used for a 142 user's own entries, indicating that the subdataset exists 143 directly beneath this one. However, especially when inheriting 144 bookmarks from group or site collections, the value of this 145 attribute may point to a dataset on the same or a different ACAP 146 server. 148 4.2. Specific Attributes 150 These attributes are specific to the Bookmarks dataset class. 152 bookmarks.Date.Added 153 This contains the date and time of the original creation of this 154 entry. The value is expressed in UTC with a timezone offset, 155 indicating the user's local time. 157 book-date = datetime ;specified in Common ABNF 159 bookmarks.Description 160 This contains the user-assigned description of the entry, as a 161 series of CRLF-separated lines. 163 book-description = *line ;specified in Common ABNF 165 bookmarks.Last.Modified 166 This contains the date and time of the most recent modification 167 of the entry. Modification includes any user-initiated action 168 (such as editing the description) but not automatic actions 169 (such as updating the "Last.Visited" attribute). The value is 170 expressed in UTC, with a timezone offset indicating the user's 171 local time. 173 book-modtime = datetime ;specified in Common ABNF 175 bookmarks.Last.Visited 176 This contains the date and time of the most recent access of the 177 location represented by the entry's URL. The value is expressed 178 in UTC, with a timezone offset indicating the user's local time. 180 book-visit = datetime ;specified in Common ABNF 182 bookmarks.Name 183 This specifies a descriptive name for the entry. It does not 184 need to be unique. 186 book-name = 1*(VCHAR / SP) 188 bookmarks.Type 189 This contains a token describing the type of the entry. The 190 Separator type indicates the entry is separator for display 191 purposes. The Folder type is used for a container or folder 192 (used with ACAP subdatasets). The Alias type is used for an 193 alias entry, in which case the URL is an ACAP URL to an entry in 194 an ACAP Bookmarks dataset. The Link type is used to refer to 195 any type of object, for example, a web page or a file. The 196 Frameset type is used to contain the state of a web page with 197 frames. In this case the URL of the main page is contained in 198 the 'bookmarks.URL' attribute, and the URLs for other frames are 199 contained in subdataset entries. 201 book-type = "separator" / "link" / "alias" / "folder" 202 "frameset" 204 bookmarks.URL 205 This contains the URL of the object referred to by this entry. 206 For Link type entries, this can be any type of URL. For Alias 207 type entries, this is an ACAP URL. ACAP URLs are specified in 208 [ACAP]. 210 book-url = url ;defined in [URL] 212 5. Common ABNF 214 The following [ABNF] rules are used above. 216 datetime = year month day hour minute second timezone 217 ;UTC and offset to local time 219 day = 2DIGIT 221 hour = 2DIGIT 223 line = *(VCHAR / SP) CRLF 225 minute = 2DIGIT 227 month = 2DIGIT 229 second = 2DIGIT 230 timezone = ("+" / "-") 4DIGIT 232 year = 4DIGIT 234 6. Examples 236 /~/bookmarks/ 238 entry a23gzk 239 bookmarks.Date.Added 19840101000001+0800 240 bookmarks.Description Where I get my worms 241 bookmarks.Last.Modified 19971114071202+0800 242 bookmarks.Last.Visited 19980311173545+0800 243 bookmarks.Name Fred's Bait and Tackle 244 bookmarks.Type link 245 bookmarks.URL http://www.fredsbaitandtackle.fog/ 247 entry b1799 248 bookmarks.type separator 250 entry xyzzy 251 bookmarks.Date.Added 19770612140004+0500 252 bookmarks.Description This really cool site I stumbled 253 on when looking for something 254 else. It has detailed and easy 255 to follow instructions on how to 256 crush beer cans 257 bookmarks.Last.Modified 19971231235902+0800 258 bookmarks.Last.Visited 19980311173510+0800 259 bookmarks.Name Yip Yap's Helpful HowTo Page 260 bookmarks.Type link 261 bookmarks.URL http://stud.cheesy.edu/~jru/ 263 entry zz99 264 subdataset . 265 bookmarks.Name Contemporaneous Contemplations 266 bookmarks.Type folder 268 /~/bookmarks/zz99/ 270 entry a1a1 271 bookmarks.Date.Added 19990401000002+0800 272 bookmarks.Description I laughed so hard beer came out my 273 nose and my then my roommate saw 274 and started laughing and choking 275 bookmarks.Last.Modified 19990401000002+0800 276 bookmarks.Last.Visited 19990401000001+0800 277 bookmarks.Name Why Beer is Better than ... 279 bookmarks.Type link 280 bookmarks.URL http://trash.example.org/~b1ff/ 281 beer.html 283 entry b2b2 284 bookmarks.Date.Added 19990401010003+0800 285 bookmarks.Description Commencement address delivered by 286 Clinton and Vonnegut to Vassar 287 bookmarks.Last.Modified 19990401010003+0800 288 bookmarks.Last.Visited 19990401010000+0800 289 bookmarks.Name Clinton and Vonnegut at Vassar 290 bookmarks.Type link 291 bookmarks.URL http://april.fools.oaf/vassar-mit 293 7. Normative References 295 [ABNF] Crocker, Overell, "Augmented BNF for Syntax Specifications: 296 ABNF", RFC 2234, Internet Mail Consortium, Demon Internet Ltd., 297 November 1997. 299 [ACAP] Newman, Myers, "ACAP -- Application Configuration Access 300 Protocol", RFC 2244, Innosoft, Netscape, November 1997. 301 303 [KEYWORDS] Bradner, "Key words for use in RFCs to Indicate 304 Requirement Levels", RFC 2119, Harvard University, March 1997. 305 307 [URL] Berners-Lee, Masinter, McCahill, "Uniform Resource Locators 308 (URL)", RFC 1738, CERN, Xerox Corporation, University of Minnesota, 309 December 1994. 311 [UTF8] Yergeau, F. "UTF-8, a transformation format of ISO 10646", 312 RFC 2279, Alis Technologies, January 1998. 313 315 8. Security Considerations 317 As with ACAP datasets in general, it is important that access 318 controls are set correctly on Bookmarks datasets. Attributes may 319 contain personal information which should not be disclosed except by 320 explicit owner request. 322 9. Acknowledgments 323 Many thanks to the participants of the IETF ACAP working group for 324 their help, comments, and suggestions. 326 10. Author's Address 328 Randall Gellens +1 858 651 5115 329 QUALCOMM Incorporated randy@qualcomm.com 330 5775 Morehouse Drive 331 San Diego, CA 92121-2779 332 U.S.A. 334 Intellectual Property Statement 336 The IETF takes no position regarding the validity or scope of any 337 intellectual property or other rights that might be claimed to 338 pertain to the implementation or use of the technology described in 339 this document or the extent to which any license under such rights 340 might or might not be available; neither does it represent that it 341 has made any effort to identify any such rights. Information on the 342 IETF's procedures with respect to rights in standards-track and 343 standards-related documentation can be found in BCP-11. Copies of 344 claims of rights made available for publication and any assurances 345 of licenses to be made available, or the result of an attempt made 346 to obtain a general license or permission for the use of such 347 proprietary rights by implementors or users of this specification 348 can be obtained from the IETF Secretariat. 350 The IETF invites any interested party to bring to its attention any 351 copyrights, patents or patent applications, or other proprietary 352 rights which may cover technology that may be required to practice 353 this standard. Please address the information to the IETF Executive 354 Director. 356 Full Copyright Statement 358 Copyright (C) The Internet Society 2003. All Rights Reserved. 360 This document and translations of it may be copied and furnished to 361 others, and derivative works that comment on or otherwise explain it 362 or assist in its implementation may be prepared, copied, published 363 and distributed, in whole or in part, without restriction of any 364 kind, provided that the above copyright notice and this paragraph 365 are included on all such copies and derivative works. However, this 366 document itself may not be modified in any way, such as by removing 367 the copyright notice or references to the Internet Society or other 368 Internet organizations, except as needed for the purpose of 369 developing Internet standards in which case the procedures for 370 copyrights defined in the Internet Standards process must be 371 followed, or as required to translate it into languages other than 372 English. 374 The limited permissions granted above are perpetual and will not be 375 revoked by the Internet Society or its successors or assigns. 377 This document and the information contained herein is provided on an 378 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 379 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 380 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 381 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 382 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.