Half-way Summary (Was: Re: Draft progression)

[Martijn Koster <[e-mail]>]

Hi all,

with so many proposals and counterproposals flying around I thought
I'd summarise agreed proposed changes to the current draft, and
outstanding issues. I'm not trying to steal the show here, I'm
just trying to get things clear in my head.

I have appended diffs against the last patches Alan provided. If any of
the changes are incorrect, please let's resolve those first.

As always I hope this can be frozen in one form or another RSN,
and I suggest Alan identifies that point.

Outstanding issues:

p1. Where to list complete empty templates.
   - I vote for a companion RFC, to be published separately, not referenced
     from within this draft.

p2. Multiple records in Single Record files
   - Removing the "single record" distinction is required in one case:
     when two "packages" are described in separate files, and one/both of 
     them have >1 related record (ie software, docs and mailing list devoted
     to one software package).
   - It would require a rewrite of the paragraphss; the only difference
     the two scheme would be the different file-naming conventions.

   I think this is worthile, as I've never sees the sense behind a
   single-record file. Then again, I don't really care.   

p3. mailto:

   I don't see the point, Markus half likes it. It breaks existing index
   files. Alan, what do you think?

p4. variant URI
   - there is a problem here: Think about

      Format-v0:		Application/PostScript
      URI-v0:			ftp://ftp.fungus.newu.edu/pub/...
      Language-v0:		English
      Size-v0:			18 pages
      Format-v1:		text/plain; charset=US-ASCII
      URI-v1:			ftp://ftp.fungus.newu.edu/pub/...
      Size-v1:			13 pages
      Language-v1:		Russian

    One cannot express multiple URI's for one language version of a document.
    (because you can't have variant variant (sic) fields).
    Given that multiple values for the same field can be given; why not
    just rely on that to indicate alternatives?

    I'm not really bothered about this, I don't think URN/C resolution should
    be part of the IAFA templates...

p5. - Allowing HTML etc in descriptions

   I'm against, for reasons explained before.


Opinions?

-- Martijn
__________
Internet: [e-mail]
X-400: C=GB; A= ; P=Nexor; O=Nexor; S=koster; I=M
X-500: c=GB@o=NEXOR Ltd@cn=Martijn Koster
WWW: http://web.nexor.co.uk/mak/mak.html

*** draft-ietf-iiir-publishing-02.txt	Fri Aug 26 09:20:25 1994
--- draft-ietf-iiir-publishing-04.txt	Tue Aug 30 18:19:21 1994
***************
*** 99,105 ****
  Archives (IAFA) working group of the IETF. Special thanks are due to
  George Brett, Jill Foster, Jim Fullton, Joan Gargano, Rebecca Guenther,
  John Kunze, Clifford Lynch, Pete Percival, Paul Peters, Cecilia Preston,
! Peggy Seiden, Craig Summerhill, Chris Weider and Janet Vratney, Markus
  Stumpf and Martijn Koster.
  
  PREFACE
--- 99,105 ----
  Archives (IAFA) working group of the IETF. Special thanks are due to
  George Brett, Jill Foster, Jim Fullton, Joan Gargano, Rebecca Guenther,
  John Kunze, Clifford Lynch, Pete Percival, Paul Peters, Cecilia Preston,
! Peggy Seiden, Craig Summerhill, Chris Weider, Janet Vratney, Markus
  Stumpf and Martijn Koster.
  
  PREFACE
***************
*** 146,152 ****
  contacts, local time zone and other site-specific details may be given.
  
  Section 3 contains a set of encoding procedures for the information
! outlined in Section 2. These procedures allow the you, the AFA
  administrator, to take into account site-specific issues such as whether
  your particular operating system offers the capability of creating and
  using subdirectories, any limitations on filename length or the inability
--- 146,152 ----
  contacts, local time zone and other site-specific details may be given.
  
  Section 3 contains a set of encoding procedures for the information
! outlined in Section 2. These procedures allow you, the AFA
  administrator, to take into account site-specific issues such as whether
  your particular operating system offers the capability of creating and
  using subdirectories, any limitations on filename length or the inability
***************
*** 211,217 ****
     1.3 DIRECTORY SERVICES AND UNIFORM RESOURCE IDENTIFIERS
  
     Work is currently underway for the construction of what are known as
!    "Uniform Resource Identifiers". These will be structured strings
     whose purpose is to uniquely identify any resource on the Internet to
     determine access and identification information for that resource.
     This not only includes documents, software packages etc., but also
--- 211,217 ----
     1.3 DIRECTORY SERVICES AND UNIFORM RESOURCE IDENTIFIERS
  
     Work is currently underway for the construction of what are known as
!    "Uniform Resource Identifiers" (URI). These will be structured strings
     whose purpose is to uniquely identify any resource on the Internet to
     determine access and identification information for that resource.
     This not only includes documents, software packages etc., but also
***************
*** 280,291 ****
     2.1 HANDLES
  
     Handles for individuals or organizations, if used, are defined to be a
!    printable string unqiue within the context of the service providing the
     information. These are to be used as a shorthand method of referring
     to the complete organization or individual record and should be used
     preference to the complete entry. Indexing tools which gather template
     information should be aware that once removed from a particular
!    context, handles may no longer be unique and use technique to ensure
     unquieness in the expanded context.
  
     2.2 CLUSTERS: COMMON DATA ELEMENTS
--- 280,291 ----
     2.1 HANDLES
  
     Handles for individuals or organizations, if used, are defined to be a
!    printable string unique within the context of the service providing the
     information. These are to be used as a shorthand method of referring
     to the complete organization or individual record and should be used
     preference to the complete entry. Indexing tools which gather template
     information should be aware that once removed from a particular
!    context, handles may no longer be unique and use techniques to ensure
     unquieness in the expanded context.
  
     2.2 CLUSTERS: COMMON DATA ELEMENTS
***************
*** 315,321 ****
          - Name of individual.
  
  	- Name of organization to which individual belongs or under who's
!           authority this information is being made .
  
  	- Type of organization to which this individual belongs
  	  (University, commercial organization etc.)  
--- 315,321 ----
          - Name of individual.
  
  	- Name of organization to which individual belongs or under who's
!           authority this information is being made.
  
  	- Type of organization to which this individual belongs
  	  (University, commercial organization etc.)  
***************
*** 375,384 ****
  	The following is a list of generic data element subcomponents
  	used when referring to particular resources.
  
!         - A complete title for the resource.
  
-         - Short title. 
- 
          - City of resource.
  
          - State (or Province) of resource.
--- 375,382 ----
  	The following is a list of generic data element subcomponents
  	used when referring to particular resources.
  
!         - A title for the resource.
  
          - City of resource.
  
          - State (or Province) of resource.
***************
*** 510,516 ****
  	  with corresponding contact information.
       
  
! 	This description would then indicate whether the the parent
  	organization offers such services as:
  
          o on-line library catalogues.
--- 508,514 ----
  	  with corresponding contact information.
       
  
! 	This description would then indicate whether the parent
  	organization offers such services as:
  
          o on-line library catalogues.
***************
*** 527,535 ****
  
          - Title of service.
  
!         - Short title of service.
! 
! 	- URI of service
  
  	- Contact information for service administration.
  
--- 525,531 ----
  
          - Title of service.
  
! 	- URI of service.
  
  	- Contact information for service administration.
  
***************
*** 690,695 ****
--- 686,696 ----
     Data element names without associated field values are legal in
     templates. 
  
+    Data elements may occur in any order.
+ 
+    Multiple values for the same data element are allowed, and taken to
+    indicate equally appropriate alternatives.
+ 
     3.2 VARIANT FIELDS
  
     In section 1.3.1 we describe some information as being "variant" in
***************
*** 824,830 ****
  
        Thus
  
!       12:00 GMT / 05:45 GMT
  
        is a valid time range. Multiple time ranges are separated by
        whitespace.
--- 825,831 ----
  
        Thus
  
!          12:00 GMT / 05:45 GMT
  
        is a valid time range. Multiple time ranges are separated by
        whitespace.
***************
*** 839,853 ****
        leading '+' and country and routing codes without separators.  The
        number should be given assuming someone calling internationally
        (without local access codes). The number given in the local
!       convention may optionally be specified.
  
        For example,
  
!       Telephone: [phone]  (1-514-875-8611)
  
        or
  
!       Telephone: [phone]
   
     10) Latitude and longitude are specified in that order as
  
--- 840,854 ----
        leading '+' and country and routing codes without separators.  The
        number should be given assuming someone calling internationally
        (without local access codes). The number given in the local
!       convention may optionally be specified in bracktes.
  
        For example,
  
!          Telephone: [phone]  (1-514-875-8611)
  
        or
  
!          Telephone: [phone]
   
     10) Latitude and longitude are specified in that order as
  
***************
*** 916,928 ****
  	  blank lines (lines which contain zero or more whitespace
  	  characters and the NEWLINE character). The start of each field
  	  is marked by a special fieldname on a new line in the leftmost
! 	  (first) column followed by a colon (:). All data element names
! 	  must start in the first column.
  
!       (2) Field data must be separated from fieldname by whitespace. Any
! 	  field may continue on the next line by whitespace in the first
! 	  column of that line. Multi-line fields are delimited by the
! 	  first line which does not have whitespace in the first column.
  
        (3) Fields in the same record must not contain any blank lines
  	  between them.
--- 917,930 ----
  	  blank lines (lines which contain zero or more whitespace
  	  characters and the NEWLINE character). The start of each field
  	  is marked by a special fieldname on a new line in the leftmost
! 	  (first) column followed by a colon (:) and optional whitespace.
!           All data element names must start in the first column.
  
!       (2) Field data must be separated from fieldname by a colon and
!           optional whitespace. Any field may continue on the next line by
!           whitespace in the first column of that line. Multi-line
!           fields are delimited by the first line which does not have
!           whitespace in the first column, or is blank.
  
        (3) Fields in the same record must not contain any blank lines
  	  between them.
***************
*** 948,958 ****
        (2) No indexing file under this scheme may contain more than one
  	  record (as defined above).
  
!       (3) Field data must be separated from fieldname by whitespace. Any
! 	  field may be continued on the next line by whitespace in the
! 	  first column of that line. Multi-line fields are delimited by
! 	  the first line which does not have whitespace in the first
! 	  column.
  
        (4) Fields must not contain any blank lines between them.
  
--- 950,960 ----
        (2) No indexing file under this scheme may contain more than one
  	  record (as defined above).
  
!       (3) Field data must be separated from fieldname by a colon and 
!           optional whitespace. Any field may be continued on the next
!           line by whitespace in the first column of that line. Multi-line
!           fields are delimited by the first line which does not have 
!           whitespace in the first column, or is blank.
  
        (4) Fields must not contain any blank lines between them.
  
***************
*** 960,967 ****
     3.5 ENCODING
  
     Indexing files should be made world readable. It is assumed that size
!    and modification times can be obtained through the existing FTP
!    mechanism and are operating system specific.
  
     The advantages to this system are that this information need only be
     constructed once with infrequent periodic updates as changes occur.
--- 962,969 ----
     3.5 ENCODING
  
     Indexing files should be made world readable. It is assumed that size
!    and modification times can be obtained through existing access
!    mechanisms and are operating system specific.
  
     The advantages to this system are that this information need only be
     constructed once with infrequent periodic updates as changes occur.
***************
*** 1076,1083 ****
  
          Title                   A complete title for the resource.
  
-         Short-Title             Summary title. 
- 
          City                    City of resource.
  
          State                   State (Province, etc.) of resource.
--- 1078,1083 ----
***************
*** 1090,1097 ****
                                  record that would facilitate users' finding
                                  this resource.
  
!         URI                     Uniform Resource Identifier.
! 
  
  
     3.7 TEMPLATE DEFINITIONS
--- 1090,1099 ----
                                  record that would facilitate users' finding
                                  this resource.
  
!         URI			Uniform Resource Identifier
! 	
!         Access-Method           Freetext description of access method
!                                 for which no URI syntax has been defined.
  
  
     3.7 TEMPLATE DEFINITIONS
***************
*** 1240,1245 ****
--- 1242,1249 ----
        Admin-(USER*):          Contact information of the individual or
  			      group responsible for administering this site.
  
+       Host-Name:              Primary Domain Name System host name.
+ 
        Host-Alias:             Preferred DNS-registered name for the AFA host as
  			      this logical archive. This name must be
  			      valid CNAME entry in the Domain Name System.
***************
*** 1284,1290 ****
                                logical AFA.
  
  
!       Notes for this record.
  
  
        <1> The period is measured in days. This value should be chosen to
--- 1288,1294 ----
                                logical AFA.
  
  
!       Notes for this template.
  
  
        <1> The period is measured in days. This value should be chosen to
***************
*** 1303,1314 ****
  			    contained in this archive is in the
  			    public domain
        Admin-Name:	    Ima Admin
!       Admin-Email:	    mailto:[e-mail]
        Admin-Work-Phone:     [phone]
        Admin-Work-Fax:	    [phone]
        Admin-Postal:	    555 Marsden Road, London, SE15 4EE
        Record-Last-Modified-Name: Yuri Tolstoy
!       Record-Last-Modified-Email: mailto:[e-mail]
        Record-Last-Modified-Date:	Mon, Jun 21 93 17:03:23 EDT
        Update-Frequency:     20
        Keywords:	    	    Militarism, Post Office, Conservatism
--- 1307,1318 ----
  			    contained in this archive is in the
  			    public domain
        Admin-Name:	    Ima Admin
!       Admin-Email:	    mailto:[e-mail]
        Admin-Work-Phone:     [phone]
        Admin-Work-Fax:	    [phone]
        Admin-Postal:	    555 Marsden Road, London, SE15 4EE
        Record-Last-Modified-Name: Yuri Tolstoy
!       Record-Last-Modified-Email: mailto:[e-mail]
        Record-Last-Modified-Date:	Mon, Jun 21 93 17:03:23 EDT
        Update-Frequency:     20
        Keywords:	    	    Militarism, Post Office, Conservatism
***************
*** 1346,1352 ****
  
        Record-Last-Verified-Date:      The date this record was last verified.
  
!       Reference-URI-v*:	      The starting point. This is the initial
  				      site the package can be found of.
  				      As there may be more than one file
  				      or directory belonging to this
--- 1350,1356 ----
  
        Record-Last-Verified-Date:      The date this record was last verified.
  
!       Reference-URI:                  The starting point. This is the initial
  				      site the package can be found of.
  				      As there may be more than one file
  				      or directory belonging to this
***************
*** 1353,1365 ****
  				      package this is a -v* type. Specified
                                        as an URI. (See Note <1>)
  
!       Source-URI-v*:	      The location the package is mirrored
                                        from. This may itself be a mirror
  				      site of Reference-URI or
                                        another Source-URI. Specified
  				      as an URI.
  
!       Destination-URI-v*:	      The location the package can be found
                                        locally. Specified as an URI.
  
        Timezone:                       The timezone this site is in. (see
--- 1357,1369 ----
  				      package this is a -v* type. Specified
                                        as an URI. (See Note <1>)
  
!       Source-URI:                     The location the package is mirrored
                                        from. This may itself be a mirror
  				      site of Reference-URI or
                                        another Source-URI. Specified
  				      as an URI.
  
!       Destination-URI:                The location the package can be found
                                        locally. Specified as an URI.
  
        Timezone:                       The timezone this site is in. (see
***************
*** 1388,1395 ****
  				      will be updated/fetched.
  
        Update-Exclude-Pattern:	      A regular expression. Files matching this
! 				      pattern on Source-URI will not
! 				      be updated/fetched.
  
        Update-Compression-Pattern:     A regular expression. Used for packing
                                        or re-packing files being updated/
--- 1392,1399 ----
  				      will be updated/fetched.
  
        Update-Exclude-Pattern:	      A regular expression. Files matching this
! 				      pattern on Source-URI will not be
! 				      updated/fetched.
  
        Update-Compression-Pattern:     A regular expression. Used for packing
                                        or re-packing files being updated/
***************
*** 1399,1404 ****
--- 1403,1409 ----
  				      for the automatic updates.
  
  
+       Notes for this template:
  
        <1> The -v* form is especially useful, if you mirror a package within a
  	  directory called "path", but you don't mirror the whole "path", but
***************
*** 1405,1411 ****
  	  only the "src" and "doc" subdirectories.
  
        <2> This may be any number or one or more of the (comma seperated) words
! 	  "Mon", "Tue", Wed", "Thu", "Fri", "Sat" or "Sun"
  
        <3> Valid keywords are:
              autodelete  - files will be automatically deleted, when they are
--- 1410,1416 ----
  	  only the "src" and "doc" subdirectories.
  
        <2> This may be any number or one or more of the (comma seperated) words
! 	  "Mon", "Tue", Wed", "Thu", "Fri", "Sat" or "Sun".
  
        <3> Valid keywords are:
              autodelete  - files will be automatically deleted, when they are
***************
*** 1431,1437 ****
        Example:
        --------
  
!       This is an example of a AFA-MIRROR file.
  
        Template-Type:			MIRROR
        Admin-Name:			John Long Silver
--- 1436,1442 ----
        Example:
        --------
  
!       This is an example of a MIRROR record.
  
        Template-Type:			MIRROR
        Admin-Name:			John Long Silver
***************
*** 1476,1482 ****
  
        To allow for the use of "handles" and so as not to require the
        repetition of the USER* information each time this cluster is
!       needed in other templates we define here a USER template in which
        the information can be stored in one place. Assuming the use of a
        unique handle, other records may then refer to this template to
        complete the require information. The definition is simply the data
--- 1481,1487 ----
  
        To allow for the use of "handles" and so as not to require the
        repetition of the USER* information each time this cluster is
!       needed in other templates, we define here a USER template in which
        the information can be stored in one place. Assuming the use of a
        unique handle, other records may then refer to this template to
        complete the require information. The definition is simply the data
***************
*** 1513,1519 ****
  
          Title:          Title of service.
  
! 	URI:		URI of service.
  
          Admin-(USER*):  Contact information of person or group
  			responsible for service administration
--- 1518,1524 ----
  
          Title:          Title of service.
  
! 	URI-v*:		URI of service.
  
          Admin-(USER*):  Contact information of person or group
  			responsible for service administration
***************
*** 1539,1545 ****
                          general access is not available.
  
  	Charging-Policy:
! 			Free text field describing any changing
  			mechanism in place. Additionally, fee structure
  			may be included in this field.
  
--- 1544,1550 ----
                          general access is not available.
  
  	Charging-Policy:
! 			Free text field describing any charging
  			mechanism in place. Additionally, fee structure
  			may be included in this field.
  
***************
*** 1570,1583 ****
                          verified.
  
  
- 
-       Notes on this file.
- 
-       <1> The Internet protocol used to communicate with this service.
-       	  For example, "telnet" or "SMTP" or "NNTP" etc. A more complete
- 	  explanation of specialized protocols (which may not be
- 	  generally known) should be supplied in the main description.
- 
        Example 1
        ---------
        The following is an example of an entry for a telnet service.
--- 1575,1580 ----
***************
*** 1629,1641 ****
        3.8.4 DOCUMENTS, DATASETS, MAILING LIST ARCHIVES, USENET ARCHIVES,
  	    SOFTWARE PACKAGES, IMAGES AND OTHER OBJECTS
  
!       This file contains records with the following fields.
  
-       For multi-record files each record is started and the previous
-       record is delimited by the "Template-Type" field which also
-       determines the type of object being indexed. Suggestions for these
-       types include:
- 
        Type of Object			Template-Type
        -------------- 	        	--------------
  
--- 1626,1634 ----
        3.8.4 DOCUMENTS, DATASETS, MAILING LIST ARCHIVES, USENET ARCHIVES,
  	    SOFTWARE PACKAGES, IMAGES AND OTHER OBJECTS
  
!       These templates all contain the same fields, but have different
!       "Template-Type" values. Suggestions for these types include:
  
        Type of Object			Template-Type
        -------------- 	        	--------------
  
***************
*** 1658,1669 ****
  
  	Category:		Type of object. See Note <1>
  
!         Title:                  Title of the object.
  
! 	Author-(USER*):   Description/contact information about the
  				authors/creators of the object.
  
! 	Admin-(USER*):    Description/contact information about the
  				administrators/maintainers of the object.
  
  	Record-Last-Modified-(USER*):
--- 1651,1664 ----
  
  	Category:		Type of object. See Note <1>
  
!         Title:                  Complete title of the object.
! 
!         Short-Title:            Summary title (if the Title is very long). 
  
! 	Author-(USER*):         Description/contact information about the
  				authors/creators of the object.
  
! 	Admin-(USER*):          Description/contact information about the
  				administrators/maintainers of the object.
  
  	Record-Last-Modified-(USER*):
***************
*** 1725,1731 ****
  
  	Size-v*:		Length of object in bytes (octets).
  
- 
  	Language-v*:		The name of the language in which the
  				object is written. For documents this
  				would be the natural language. For
--- 1720,1725 ----
***************
*** 1745,1751 ****
  	URI-v*:			Description of access to object. This is
  				not required if naming scheme 2 is used.
  	
- 
          Last-Revision-Date-v*:  Last date that the object was revised.
  
  
--- 1739,1744 ----
***************
*** 1776,1783 ****
        ---------
  	  
  
!       Example of AFA-OBJECT file for the DOCUMENT type. Note that this
!       example contains variant information.
  
        Template-Type:		DOCUMENT
        Title:			The Function of Homeoboxes in Yeast
--- 1769,1775 ----
        ---------
  	  
  
!       Example of DOCUMENT record.
  
        Template-Type:		DOCUMENT
        Title:			The Function of Homeoboxes in Yeast
***************
*** 1820,1829 ****
        Example 2
        ---------
  
!       This is an example of a software entry. Note the use of the
        software maintainer's "handle" instead of the explicit contact
!       information. This could be used if there was a well-known external
!       method of resolving this handle.
  
        Template-Type:	SOFTWARE
        Title:		Beethoven's Fifth Player 
--- 1812,1820 ----
        Example 2
        ---------
  
!       This is an example of a SOFTWARE record. Note the use of the
        software maintainer's "handle" instead of the explicit contact
!       information.
  
        Template-Type:	SOFTWARE
        Title:		Beethoven's Fifth Player 
***************
*** 1842,1848 ****
  			Copyright held by author
        Keywords:		Classical music, V-windows
        Format-v0:	LZ compressed
!       URI-v0:		gopher://power.org/1/pub/Vfifth.tar.Z
  
  
  4. CONCLUSION
--- 1833,1839 ----
  			Copyright held by author
        Keywords:		Classical music, V-windows
        Format-v0:	LZ compressed
!       URI-v0:		gopher://power.org/00/pub/Vfifth.tar.Z
  
  
  4. CONCLUSION
***************
*** 1869,1875 ****
  [2] "A Guide to Anonymous FTP Site Administration". Work in progress from
      the Internet Anonymous FTP Archive Working Group of the IETF.
  
! [3] Internet Draft "draft-ietf-uri-resource-names-00.txt" Work in
      Progress from the Uniform Resource Identifier Working Group of the
      IETF.
  
--- 1860,1866 ----
  [2] "A Guide to Anonymous FTP Site Administration". Work in progress from
      the Internet Anonymous FTP Archive Working Group of the IETF.
  
! [3] Internet Draft "draft-ietf-uri-resource-names-02.txt" Work in
      Progress from the Uniform Resource Identifier Working Group of the
      IETF.