idnits 2.17.1 draft-ietf-acap-book-01.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 Internet-Drafts being working documents. ** The document seems to lack a 1id_guidelines paragraph about 6 months document validity. ** The document seems to lack a 1id_guidelines paragraph about the list of current Internet-Drafts. ** The document seems to lack a 1id_guidelines paragraph about the list of Shadow Directories. == 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.) ** There is 1 instance of too long lines in the document, the longest one being 1 character in excess of 72. ** 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 90: '... (that is, bookmark folders) SHOULD be...' RFC 2119 keyword, line 101: '...ks dataset entry MUST have an "entry" ...' RFC 2119 keyword, line 102: '... attributes are OPTIONAL....' RFC 2119 keyword, line 109: '...string. Clients MUST conform to the s...' RFC 2119 keyword, line 110: '... 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 (18 December 1998) is 9261 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 249 looks like a reference -- Missing reference section? 'ACAP' on line 241 looks like a reference -- Missing reference section? 'KEYWORDS' on line 245 looks like a reference -- Missing reference section? 'ABNF' on line 237 looks like a reference -- Missing reference section? 'UTF8' on line 253 looks like a reference Summary: 12 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-01.txt QUALCOMM 3 Expires: 18 June 1999 18 December 1998 5 ACAP Bookmarks Dataset Class 7 Status of this Memo: 9 This document is an Internet Draft. Internet Drafts are working 10 documents of the Internet Engineering Task Force (IETF), its areas, 11 and its working groups. Note that other groups may also distribute 12 working documents as Internet Drafts. 14 Internet Drafts are draft documents valid for a maximum of six 15 months. Internet Drafts may be updated, replaced, or obsoleted by 16 other documents at any time. It is not appropriate to use Internet 17 Drafts as reference material or to cite them other than as a 18 "working draft" or "work in progress." 20 To learn the current status of any Internet Draft, please check the 21 "1id-abstracts.txt" listing contained in the Internet Drafts shadow 22 directories on ftp.is.co.za (Africa), nic.nordu.net (Europe), 23 munnari.oz.au (Pacific Rim), ftp.ietf.org (US East Coast), or 24 ftp.isi.edu (US West Coast). 26 A version of this draft document is intended for submission to the 27 RFC editor as a Proposed Standard for the Internet Community. 28 Discussion and suggestions for improvement are requested. 30 Public comments can be sent to the IETF ACAP mailing list, 31 . To subscribe, send a message 32 containing SUBSCRIBE to . 33 Private comments should be sent to the author. 35 Copyright Notice 37 Copyright (C) The Internet Society 1998. All Rights Reserved. 39 Table of Contents 41 1. Abstract . . . . . . . . . . . . . . . . . . . . . . . . . . 2 42 2. Conventions Used in this Document . . . . . . . . . . . . . . 2 43 3. ACAP Bookmarks Dataset Class . . . . . . . . . . . . . . . . 2 44 3.1. ACAP Bookmarks Dataset Class Prefix . . . . . . . . . . . 3 45 3.2. ACAP Bookmarks Dataset Hierarchy . . . . . . . . . . . . 3 46 4. Recommended ACAP Bookmarks Dataset Attributes . . . . . . . . 3 47 4.1. Basic Attributes . . . . . . . . . . . . . . . . . . . . 3 48 4.2. Specific Attributes . . . . . . . . . . . . . . . . . . . 5 49 5. Common ABNF . . . . . . . . . . . . . . . . . . . . . . . . 5 50 6. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 6 51 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 6 52 8. Security Considerations . . . . . . . . . . . . . . . . . . . 6 53 9. Author's Address . . . . . . . . . . . . . . . . . . . . . . 6 54 10. Full Copyright Statement . . . . . . . . . . . . . . . . . . -1 56 1. Abstract 58 Storing URLs [URL] for later access has become common in Internet 59 applications (for example, web browsers, FTP clients); these saved 60 URLs have become known as bookmarks. It would be desirable to 61 access one's bookmarks from multiple clients and multiple machines. 63 The Application Configuration Access Protocol [ACAP] provides an 64 ideal mechanism for storage of bookmarks, providing for ease of 65 coordination and synchronization of bookmarks between diverse 66 applications and systems, as well as for hierarchy, inheritance, and 67 sharing. 69 This specification defines a standard ACAP dataset class for 70 bookmarks. 72 2. Conventions Used in this Document 74 The key words "MUST", "MUST NOT", "SHOULD", "SHOULD NOT", and "MAY" 75 in this document are to be interpreted as defined in "Key words for 76 use in RFCs to Indicate Requirement Levels" [KEYWORDS]. 78 3. ACAP Bookmarks Dataset Class 80 The ACAP Bookmarks dataset class defines a set of attributes for 81 each bookmark, and provides for bookmark inheritance and hierarchy. 83 3.1. ACAP Bookmarks Dataset Class Prefix 84 Datasets whose names begin with "/bookmarks" are assumed to contain 85 bookmark entries as defined in this specification. 87 3.2. ACAP Bookmarks Dataset Hierarchy 89 Each user may have a hierarchical set of bookmarks. Nested or 90 hierarchical bookmarks (that is, bookmark folders) SHOULD be 91 represented using the ACAP Hierarchy. Any entry in a bookmarks 92 dataset can be a hierarchy node by setting the "subdataset" 93 attribute. 95 Inheritance is likely to be useful both for inheriting sets of site 96 or group default bookmarks as well as for inheriting user-specific 97 bookmarks when using different machines. 99 4. Recommended ACAP Bookmarks Dataset Attributes 101 A Bookmarks dataset entry MUST have an "entry" attribute. All other 102 attributes are OPTIONAL. 104 Attributes are specified using Augmented Backus-Naur Form [ABNF]. 105 All attributes are single-valued and textual unless otherwise 106 stated. 108 The ABNF defines the content of the attribute values prior to their 109 encoding as an ACAP string. Clients MUST conform to the syntax when 110 generating these attributes, but MUST NOT assume that the attribute 111 values will conform to this syntax on access. Servers MUST NOT 112 enforce the syntax. 114 4.1. Basic Attributes 116 These attributes are defined in ACAP [ACAP] and have meaning in all 117 dataset classes. The section describes how they are used in a 118 bookmarks dataset. 120 entry 121 The "entry" attribute is used to hold a unique name for the 122 bookmark. The name MUST be unique, but is not expected to be 123 descriptive, and may not be suitable for display to users. It 124 is client-defined. 126 subdataset 127 The "subdataset" attribute indicates there is another bookmark 128 dataset underneath this entry. 130 4.2. Specific Attributes 132 These attributes are specific to the Bookmarks dataset class. 134 bookmarks.Date.Added 135 This contains the date and time of the original creation of this 136 entry. The value is expressed in UTC with a timezone offset, 137 indicating the user's local time. 139 book-date = datetime ;specified in Common ABNF 141 bookmarks.Description 142 This contains the user-assigned description of the entry, as a 143 series of CRLF-separated lines. 145 book-description = *line ;specified in Common ABNF 147 bookmarks.Last.Modified 148 This contains the date and time of the most recent modification 149 of the entry. Modification includes any user-initiated action 150 (such as editing the description) but not automatic actions 151 (such as updating the "Last.Visited" attribute). The value is 152 expressed in UTC, with a timezone offset indicating the user's 153 local time. 155 book-modtime = datetime ;specified in Common ABNF 157 bookmarks.Last.Visited 158 This contains the date and time of the most recent access of the 159 location represented by the entry's URL. The value is expressed 160 in UTC, with a timezone offset indicating the user's local time. 162 book-visit = datetime ;specified in Common ABNF 164 bookmarks.Name 165 This specifies a descriptive name for the entry. It does not 166 need to be unique. 168 book-name = 1*(VCHAR / SP) 170 bookmarks.Type 171 This contains a token describing the type of the entry. The 172 Separator type indicates the entry is separator for display 173 purposes. The Folder type is used for a container or folder 174 (used with ACAP subdatasets). The Alias type is used for an 175 alias entry, in which case the URL is an ACAP URL to an entry in 176 an ACAP Bookmarks dataset. The Link type is used to refer to 177 any type of object, for example, a web page or a file. 179 book-type = "separator" / "link" / "alias" / "folder" 180 bookmarks.URL 181 This contains the URL of the object referred to by this entry. 182 For Link type entries, this can be any type of URL. For Alias 183 type entries, this is an ACAP URL. ACAP URLs are specified in 184 [ACAP]. 186 book-url = url ;defined in [URL] 188 5. Common ABNF 190 The following [ABNF] rules are used above. 192 datetime = year month day hour minute second timezone 193 ;UTC and offset to local time 195 day = 2DIGIT 197 hour = 2DIGIT 199 line = *(VCHAR / SP) CRLF 201 minute = 2DIGIT 203 month = 2DIGIT 205 second = 2DIGIT 207 timezone = ("+" / "-") 4DIGIT 209 year = 4DIGIT 211 6. Examples 213 entry a23gzk 214 bookmarks.Date.Added 19840101000001+0800 215 bookmarks.Description Where I get my worms 216 bookmarks.Last.Modified 19971114071202+0800 217 bookmarks.Last.Visited 19980311173545+0800 218 bookmarks.Name Fred's Bait and Tackle 219 bookmarks.Type link 220 bookmarks.URL http://www.fredsbaitandtackle.com/ 222 entry xyzzy 223 bookmarks.Date.Added 19770612140004+0500 224 bookmarks.Description This really cool site I stumbled 225 on when looking for something 226 else. It has detailed and easy 227 to follow instructions on how to 228 crush beer cans 229 bookmarks.Last.Modified 19971231235902+0800 230 bookmarks.Last.Visited 19980311173510+0800 231 bookmarks.Name Yip Yap's Helpful HowTo Page 232 bookmarks.Type link 233 bookmarks.URL http://stud.cheesy.edu/~jru/ 235 7. References 237 [ABNF] Crocker, Overell, "Augmented BNF for Syntax Specifications: 238 ABNF", RFC 2234, Internet Mail Consortium, Demon Internet Ltd., 239 November 1997. 241 [ACAP] Newman, Myers, "ACAP -- Application Configuration Access 242 Protocol", RFC 2244, Innosoft, Netscape, November 1997. 243 245 [KEYWORDS] Bradner, "Key words for use in RFCs to Indicate 246 Requirement Levels", RFC 2119, Harvard University, March 1997. 247 249 [URL] Berners-Lee, Masinter, McCahill, "Uniform Resource Locators 250 (URL)", RFC 1738, CERN, Xerox Corporation, University of Minnesota, 251 December 1994. 253 [UTF8] Yergeau, F. "UTF-8, a transformation format of ISO 10646", 254 RFC 2279, Alis Technologies, January 1998. 255 257 8. Security Considerations 259 As with ACAP datasets in general, it is important that access 260 controls are set correctly on Bookmarks datasets. Attributes may 261 contain personal information which should not be disclosed except by 262 explicit owner request. 264 9. Author's Address 266 Randall Gellens +1 619 651 5115 267 QUALCOMM Incorporated Randy@Qualcomm.Com 268 6455 Lusk Blvd. 269 San Diego, CA 92121-2779 270 U.S.A. 272 10. Full Copyright Statement 274 Copyright (C) The Internet Society 1998. All Rights Reserved. 276 This document and translations of it may be copied and furnished to 277 others, and derivative works that comment on or otherwise explain it 278 or assist in its implementation may be prepared, copied, published 279 and distributed, in whole or in part, without restriction of any 280 kind, provided that the above copyright notice and this paragraph 281 are included on all such copies and derivative works. However, this 282 document itself may not be modified in any way, such as by removing 283 the copyright notice or references to the Internet Society or other 284 Internet organizations, except as needed for the purpose of 285 developing Internet standards in which case the procedures for 286 copyrights defined in the Internet Standards process must be 287 followed, or as required to translate it into languages other than 288 English. 290 The limited permissions granted above are perpetual and will not be 291 revoked by the Internet Society or its successors or assigns. 293 This document and the information contained herein is provided on an 294 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 295 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 296 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 297 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 298 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.