Changeset 15153 in project


Ignore:
Timestamp:
07/04/09 17:35:36 (11 years ago)
Author:
sjamaan
Message:

Describe header-param(s), remove the silly get-quality procedure

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/intarweb

    r15090 r15153  
    210210if there is no value for that header.
    211211
    212 These are just shortcuts, the underlying procedures to query the raw
    213 contents of a header are these:
     212* <procedure>(header-params NAME HEADERS) => ALIST</procedure>
     213
     214This will return all the params for a given header, assuming there is
     215only one header.  An empty list is returned if the header does not exist.
     216
     217* <procedure>(header-param NAME PARAM HEADERS [DEFAULT]) => value</procedure>
     218
     219This will return a specific parameter for the header, or the
     220{{DEFAULT}} is the parameter isn't present or the header does not
     221exist.  This also assumes there's only one header.
     222
     223The procedures mentioned above are just shortcuts, the underlying
     224procedures to query the raw contents of a header are these:
    214225
    215226* <procedure>(header-contents NAME HEADERS) => VECTOR</procedure>
     
    226237for that mime-type.  All parameter names are downcased symbols, just
    227238like header names.
    228 
    229 There are special-purpose procedures for obtaining information about
    230 specific header parameters when the spec defines certain behaviour for
    231 them, as well:
    232 
    233 * <procedure>(get-quality PARAM VECTOR [DEFAULT]) =>
    234 value</procedure>
    235 
    236 This obtains the value of the {{q}} parameter for the given header
    237 value, if any, or {{1}} if there is none defined.
    238239
    239240==== Header types
Note: See TracChangeset for help on using the changeset viewer.