idnits 2.17.1 draft-ietf-acap-book-02.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: ---------------------------------------------------------------------------- ** Missing expiration date. The document expiration date should appear on the first and last page. ** 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 96: '... (that is, bookmark folders) SHOULD be...' RFC 2119 keyword, line 107: '...ks dataset entry MUST have an "entry" ...' RFC 2119 keyword, line 108: '... attributes are OPTIONAL....' RFC 2119 keyword, line 115: '...string. Clients MUST conform to the s...' RFC 2119 keyword, line 116: '... 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 June 1999) is 9072 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 302 looks like a reference -- Missing reference section? 'ACAP' on line 294 looks like a reference -- Missing reference section? 'KEYWORDS' on line 298 looks like a reference -- Missing reference section? 'ABNF' on line 290 looks like a reference -- Missing reference section? 'UTF8' on line 306 looks like a reference Summary: 10 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-02.txt QUALCOMM 3 Expires: 25 December 1999 25 June 1999 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 1999. 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. Author's Address . . . . . . . . . . . . . . . . . . . . . . 7 52 11. Full Copyright Statement . . . . . . . . . . . . . . . . . . 8 54 1. Abstract 56 Storing URLs [URL] for later access has become common in Internet 57 applications (for example, web browsers, FTP clients); these saved 58 URLs have become known as bookmarks. It would be desirable to 59 access one's bookmarks from multiple clients and multiple machines. 61 The Application Configuration Access Protocol [ACAP] provides an 62 ideal mechanism for storage of bookmarks, providing for ease of 63 coordination and synchronization of bookmarks between diverse 64 applications and systems, as well as for hierarchy, inheritance, and 65 sharing between users. 67 This specification defines a standard ACAP dataset class for 68 bookmarks. 70 2. Conventions Used in this Document 72 The key words "MUST", "MUST NOT", "SHOULD", "SHOULD NOT", and "MAY" 73 in this document are to be interpreted as defined in "Key words for 74 use in RFCs to Indicate Requirement Levels" [KEYWORDS]. 76 3. Comments 78 Public comments can be sent to the IETF ACAP mailing list, 79 . To subscribe, send a message to 80 with the word SUBSCRIBE as the 81 body. Private comments should be sent to the author. 83 4. ACAP Bookmarks Dataset Class 85 The ACAP Bookmarks dataset class defines a set of attributes for 86 each bookmark, and provides for bookmark inheritance and hierarchy. 88 4.1. ACAP Bookmarks Dataset Class Prefix 90 Datasets whose names begin with "/bookmarks" are assumed to contain 91 bookmark entries as defined in this specification. 93 4.2. ACAP Bookmarks Dataset Hierarchy 95 Each user may have a hierarchical set of bookmarks. Nested or 96 hierarchical bookmarks (that is, bookmark folders) SHOULD be 97 represented using the ACAP Hierarchy. Any entry in a bookmarks 98 dataset can be a hierarchy node by setting the "subdataset" 99 attribute. 101 Inheritance is likely to be useful both for inheriting sets of site 102 or group default bookmarks as well as for inheriting user-specific 103 bookmarks when using different machines. 105 5. Recommended ACAP Bookmarks Dataset Attributes 107 A Bookmarks dataset entry MUST have an "entry" attribute. All other 108 attributes are OPTIONAL. 110 Attributes are specified using Augmented Backus-Naur Form [ABNF], 111 including the Core Rules. All attributes are single-valued and 112 textual (do not contain binary data) unless otherwise stated. 114 The ABNF defines the content of the attribute values prior to their 115 encoding as an ACAP string. Clients MUST conform to the syntax when 116 generating these attributes, but MUST NOT assume that the attribute 117 values will conform to this syntax on access. Servers MUST NOT 118 enforce the syntax. 120 5.1. Basic Attributes 122 These attributes are defined in ACAP [ACAP] and have meaning in all 123 dataset classes. The section describes how they are used in a 124 bookmarks dataset. 126 entry 127 The "entry" attribute is used to uniquely identify the bookmark. 128 The name MUST be unique, but is not expected to be descriptive, 129 and generally is not suitable for display to users. It is 130 client-defined. 132 The "entry" attribute is also used for ordering. When selecting 133 the "entry" attribute for a new bookmark, in addition to 134 uniqueness, the client selects a string which causes the new 135 entry to appear in the desired order, when sorted using the 136 "i;ascii-casemap" comparator [ACAP]. For example, to insert an 137 entry between "a1" and "a2", "a1a" could be used. 139 subdataset 140 The "subdataset" attribute indicates that there is a subdataset 141 of this entry. The value of this attribute specifies the actual 142 location of the subdataset, per [ACAP] section 3.1.1. For the 143 bookmarks dataset, a value of "." is most commonly used for a 144 user's own entries, indicating that the subdataset exists 145 directly beneath this one. However, especially when inheriting 146 bookmarks from group or site collections, the value of this 147 attribute may point to a dataset on the same or a different ACAP 148 server. 150 5.2. Specific Attributes 152 These attributes are specific to the Bookmarks dataset class. 154 bookmarks.Date.Added 155 This contains the date and time of the original creation of this 156 entry. The value is expressed in UTC with a timezone offset, 157 indicating the user's local time. 159 book-date = datetime ;specified in Common ABNF 161 bookmarks.Description 162 This contains the user-assigned description of the entry, as a 163 series of CRLF-separated lines. 165 book-description = *line ;specified in Common ABNF 167 bookmarks.Last.Modified 168 This contains the date and time of the most recent modification 169 of the entry. Modification includes any user-initiated action 170 (such as editing the description) but not automatic actions 171 (such as updating the "Last.Visited" attribute). The value is 172 expressed in UTC, with a timezone offset indicating the user's 173 local time. 175 book-modtime = datetime ;specified in Common ABNF 177 bookmarks.Last.Visited 178 This contains the date and time of the most recent access of the 179 location represented by the entry's URL. The value is expressed 180 in UTC, with a timezone offset indicating the user's local time. 182 book-visit = datetime ;specified in Common ABNF 183 bookmarks.Name 184 This specifies a descriptive name for the entry. It does not 185 need to be unique. 187 book-name = 1*(VCHAR / SP) 189 bookmarks.Type 190 This contains a token describing the type of the entry. The 191 Separator type indicates the entry is separator for display 192 purposes. The Folder type is used for a container or folder 193 (used with ACAP subdatasets). The Alias type is used for an 194 alias entry, in which case the URL is an ACAP URL to an entry in 195 an ACAP Bookmarks dataset. The Link type is used to refer to 196 any type of object, for example, a web page or a file. 198 book-type = "separator" / "link" / "alias" / "folder" 200 bookmarks.URL 201 This contains the URL of the object referred to by this entry. 202 For Link type entries, this can be any type of URL. For Alias 203 type entries, this is an ACAP URL. ACAP URLs are specified in 204 [ACAP]. 206 book-url = url ;defined in [URL] 208 6. Common ABNF 210 The following [ABNF] rules are used above. 212 datetime = year month day hour minute second timezone 213 ;UTC and offset to local time 215 day = 2DIGIT 217 hour = 2DIGIT 219 line = *(VCHAR / SP) CRLF 221 minute = 2DIGIT 223 month = 2DIGIT 225 second = 2DIGIT 227 timezone = ("+" / "-") 4DIGIT 229 year = 4DIGIT 230 7. Examples 232 /~/bookmarks/ 234 entry a23gzk 235 bookmarks.Date.Added 19840101000001+0800 236 bookmarks.Description Where I get my worms 237 bookmarks.Last.Modified 19971114071202+0800 238 bookmarks.Last.Visited 19980311173545+0800 239 bookmarks.Name Fred's Bait and Tackle 240 bookmarks.Type link 241 bookmarks.URL http://www.fredsbaitandtackle.fog/ 243 entry b1799 244 bookmarks.type separator 246 entry xyzzy 247 bookmarks.Date.Added 19770612140004+0500 248 bookmarks.Description This really cool site I stumbled 249 on when looking for something 250 else. It has detailed and easy 251 to follow instructions on how to 252 crush beer cans 253 bookmarks.Last.Modified 19971231235902+0800 254 bookmarks.Last.Visited 19980311173510+0800 255 bookmarks.Name Yip Yap's Helpful HowTo Page 256 bookmarks.Type link 257 bookmarks.URL http://stud.cheesy.edu/~jru/ 259 entry zz99 260 subdataset . 261 bookmarks.Name Contemporaneous Contemplations 262 bookmarks.Type folder 264 /~/bookmarks/zz99/ 266 entry a1a1 267 bookmarks.Date.Added 19990401000002+0800 268 bookmarks.Description I laughed so hard beer came out my 269 nose and my then my roommate saw 270 and started laughing and choking 271 bookmarks.Last.Modified 19990401000002+0800 272 bookmarks.Last.Visited 19990401000001+0800 273 bookmarks.Name Why Beer is Better than ... 274 bookmarks.Type link 275 bookmarks.URL http://trash.example.org/~b1ff/ 276 beer.html 278 entry b2b2 279 bookmarks.Date.Added 19990401010003+0800 280 bookmarks.Description Commencment address delivered by 281 Clinton and Vonnegut to Vassar 282 bookmarks.Last.Modified 19990401010003+0800 283 bookmarks.Last.Visited 19990401010000+0800 284 bookmarks.Name Clinton and Vonnegut at Vassar 285 bookmarks.Type link 286 bookmarks.URL http://april.fools.oaf/vassar-mit 288 8. References 290 [ABNF] Crocker, Overell, "Augmented BNF for Syntax Specifications: 291 ABNF", RFC 2234, Internet Mail Consortium, Demon Internet Ltd., 292 November 1997. 294 [ACAP] Newman, Myers, "ACAP -- Application Configuration Access 295 Protocol", RFC 2244, Innosoft, Netscape, November 1997. 296 298 [KEYWORDS] Bradner, "Key words for use in RFCs to Indicate 299 Requirement Levels", RFC 2119, Harvard University, March 1997. 300 302 [URL] Berners-Lee, Masinter, McCahill, "Uniform Resource Locators 303 (URL)", RFC 1738, CERN, Xerox Corporation, University of Minnesota, 304 December 1994. 306 [UTF8] Yergeau, F. "UTF-8, a transformation format of ISO 10646", 307 RFC 2279, Alis Technologies, January 1998. 308 310 9. Security Considerations 312 As with ACAP datasets in general, it is important that access 313 controls are set correctly on Bookmarks datasets. Attributes may 314 contain personal information which should not be disclosed except by 315 explicit owner request. 317 10. Author's Address 319 Randall Gellens +1 619 651 5115 320 QUALCOMM Incorporated randy@qualcomm.com 321 6455 Lusk Blvd. 322 San Diego, CA 92121-2779 323 U.S.A. 325 11. Full Copyright Statement 327 Copyright (C) The Internet Society 1999. All Rights Reserved. 329 This document and translations of it may be copied and furnished to 330 others, and derivative works that comment on or otherwise explain it 331 or assist in its implementation may be prepared, copied, published 332 and distributed, in whole or in part, without restriction of any 333 kind, provided that the above copyright notice and this paragraph 334 are included on all such copies and derivative works. However, this 335 document itself may not be modified in any way, such as by removing 336 the copyright notice or references to the Internet Society or other 337 Internet organizations, except as needed for the purpose of 338 developing Internet standards in which case the procedures for 339 copyrights defined in the Internet Standards process must be 340 followed, or as required to translate it into languages other than 341 English. 343 The limited permissions granted above are perpetual and will not be 344 revoked by the Internet Society or its successors or assigns. 346 This document and the information contained herein is provided on an 347 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 348 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 349 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 350 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 351 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.