Changeset 11806 in project


Ignore:
Timestamp:
08/30/08 14:01:42 (13 years ago)
Author:
sjamaan
Message:

Make uri-generic docs use the Chicken egg doc syntax extensions

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/uri-generic

    r11781 r11806  
    1616==== Constructors
    1717
    18 ; {{uri-reference:: STRING -> URI}}
     18<procedure>(uri-reference STRING) => URI</procedure>
     19
    1920A URI reference is either a URI or a relative reference (RFC 3986,
    2021Section 4.1).  If the given string's prefix does not match the syntax
     
    2425==== Predicates and Accessors
    2526
    26 ; {{uri?:: URI -> BOOL}}
    27 ; {{uri-authority:: URI -> URI-AUTH}}
    28 ; {{uri-scheme:: URI -> SYMBOL}}
    29 ; {{uri-path:: URI -> LIST}}
    30 ; {{uri-query:: URI -> LIST}}
    31 ; {{uri-fragment:: URI -> STRING}}
    32 ; {{uri-host:: URI -> STRING}}
    33 ; {{uri-port:: URI -> INTEGER}}
    34 ; {{uri-username:: URI -> STRING}}
    35 ; {{uri-password:: URI -> STRING}}
     27<procedure>(uri? URI) => BOOL</procedure>
     28<procedure>(uri-authority URI) => URI-AUTH</procedure>
     29<procedure>(uri-scheme URI) => SYMBOL</procedure>
     30<procedure>(uri-path URI) => LIST</procedure>
     31<procedure>(uri-query URI) => LIST</procedure>
     32<procedure>(uri-fragment) URI => STRING</procedure>
     33<procedure>(uri-host URI) => STRING</procedure>
     34<procedure>(uri-port URI) => INTEGER</procedure>
     35<procedure>(uri-username) URI => STRING</procedure>
     36<procedure>(uri-password) URI) => STRING</procedure>
    3637
    3738If a component is not defined in the given URI, then the corresponding
    38 accessor returns {{#F}}.
     39accessor returns {{#f}}.
    3940
    4041==== String and List Representations
    4142
    42 ; {{uri->string:: URI * USERINFO -> STRING}}: reconstructs the give URI into a string; uses a supplied function {{LAMBDA USERNAME PASSWORD -> STRING}} to map the userinfo part of the URI
    43 ; {{uri->list:: URI * USERINFO -> LIST}}: returns a list of the form {{(SCHEME SPECIFIC FRAGMENT)}}; {{SPECIFIC}} is of the form {{(AUTHORITY PATH QUERY)}}
     43<procedure>(uri->string URI USERINFO) => STRING</procedure>
     44
     45Reconstructs the give URI into a string; uses a supplied function {{LAMBDA USERNAME PASSWORD -> STRING}} to map the userinfo part of the URI
     46
     47<procedure>(uri->list URI USERINFO) => LIST</procedure>
     48
     49Returns a list of the form {{(SCHEME SPECIFIC FRAGMENT)}}; {{SPECIFIC}} is of the form {{(AUTHORITY PATH QUERY)}}.
    4450
    4551==== Reference Resolution
    4652
    47 ; {{absolute-uri:: URI -> URI}}: converts the given URI to absolute URI, in which no fragments are allowed (RFC 3986, Section 4.2)
    48 ; {{uri-relative-to:: URI * URI -> URI}}: constructs an absolute URI given a relative URI and a base URI (RFC 3986, Section 5.2.2)
    49 ; {{uri-relative-from:: URI * URI -> URI}}: constructs a new, possibly relative, URI which represents the location of the first URI with respect to the second URI
     53<procedure>(absolute-uri URI) => URI</procedure>
     54
     55Converts the given URI to absolute URI, in which no fragments are allowed (RFC 3986, Section 4.2)
     56
     57<procedure>(uri-relative-to URI URI) => URI</procedure>
     58
     59Constructs an absolute URI given a relative URI and a base URI (RFC 3986, Section 5.2.2)
     60
     61<procedure>(uri-relative-from URI URI) => URI</procedure>
     62
     63Constructs a new, possibly relative, URI which represents the location of the first URI with respect to the second URI.
    5064
    5165==== Normalization 
    5266
    53 ; {{uri-normalize-case}}: URI case normalization (RFC 3986 section 6.2.2.1)
    54 ; {{uri-normalize-path-segments}}: URI path segment normalization (RFC 3986 section 6.2.2.4)
     67<procedure>(uri-normalize-case URI) => URI</procedure>
     68
     69URI case normalization (RFC 3986 section 6.2.2.1)
     70
     71<procedure>(uri-normalize-path-segments URI) => URI</procedure>
     72
     73URI path segment normalization (RFC 3986 section 6.2.2.4)
    5574
    5675=== Requires
    5776
    58 ; [[syntax-case]]
    5977; [[matchable]]
    6078; [[defstruct]]
     
    6987=== License
    7088
    71 Based on the Haskell URI library by  Graham Klyne <gk@ninebynine.org>.
     89Based on the [[http://www.ninebynine.org/Software/ReadMe-URI-Haskell.txt|Haskell URI library]] by  Graham Klyne <gk@ninebynine.org>.
    7290
    7391Copyright 2008 Ivan Raikov.
Note: See TracChangeset for help on using the changeset viewer.