Changeset 12988 in project


Ignore:
Timestamp:
01/11/09 23:39:13 (11 years ago)
Author:
sjamaan
Message:

Add a few descriptions about new procedures

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/uri-common

    r12976 r12988  
    1414* All components are to be fully URI-decoded (so no percent-encoded characters in it).
    1515* The query argument will be in
    16    [[http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1|application/x-www-form-urlencoded]] form.
     16   [[http://www.w3.org/TR/xforms/#structure-model-submission|application/x-www-form-urlencoded]] form.
    1717* The port is automatically determined if it is omitted and the URI scheme is known.
    1818
     
    2121==== Constructors
    2222
    23 <procedure>(uri-common arg) => uri-common</procedure>
     23<procedure>(uri-common-reference string) => uri-common</procedure>
     24<procedure>(absolute-uri-common string) => uri-common</procedure>
    2425
    25 Construct a new uri-common object. The {{ARG}} can be either an
    26 {{URI}} (an [[uri-generic]] object) or a string.
     26Construct a new uri-common object, analogous to uri-reference and
     27absolute-uri from [[uri-generic]].
     28
     29==== uri-generic and string representation
     30
     31<procedure>(uri-common->uri-generic uri-common) => uri-generic</procedure>
     32<procedure>(uri-generic->uri-common uri-common #!key (query-separator (form-urlencoded-separator))) => uri-common</procedure>
     33
     34To convert between uri-generic and uri-common objects, use these
     35procedures.  For information about the optional {{query-separator}} argument,
     36see the [[#query-encoding-and-decoding|query encoding/decoding section]].
     37
     38<procedure>(uri-common->string uri-common userinfo) => string</procedure>
     39
     40Reconstructs the given URI into a string; uses a supplied function
     41{{LAMBDA USERNAME PASSWORD -> STRING}} to map the userinfo part of the
     42URI
     43
    2744
    2845==== Predicates and Accessors
    2946
    3047* <procedure>(uri-common? uri-common) => bool</procedure>
    31 * <procedure>(uri-common-generic uri-common) => symbol</procedure>
    3248* <procedure>(uri-common-scheme uri-common) => symbol</procedure>
    3349* <procedure>(uri-common-path uri-common) => list</procedure>
     
    3854* <procedure>(uri-common-username uri-common) => string</procedure>
    3955* <procedure>(uri-common-password uri-common) => string</procedure>
     56* <procedure>(uri-common-query-separator uri-common) => string</procedure>
    4057
    4158If a component is not defined in the given URI-common, then the
     
    4663Update the specified keys in the URI-common object in a functional way
    4764(ie, it creates a new copy with the modifications).
     65
     66==== Reference Resolution
     67
     68<procedure>(uri-common-relative-to URI URI) => URI</procedure>
     69
     70Constructs an absolute URI given a relative URI and a base URI (RFC 3986, Section 5.2.2)
     71
     72<procedure>(uri-common-relative-from URI URI) => URI</procedure>
     73
     74Constructs a new, possibly relative, URI which represents the location
     75of the first URI with respect to the second URI.
    4876
    4977==== Query encoding and decoding
     
    6795
    6896The separator defaults to the ampersand character.
     97
     98==== Normalization 
     99
     100<procedure>(uri-common-normalize-case URI) => URI</procedure>
     101
     102URI case normalization (RFC 3986 section 6.2.2.1)
     103
     104<procedure>(uri-common-normalize-path-segments URI) => URI</procedure>
     105
     106URI path segment normalization (RFC 3986 section 6.2.2.3)
     107
    69108
    70109=== Requires
Note: See TracChangeset for help on using the changeset viewer.