Changeset 8699 in project


Ignore:
Timestamp:
02/23/08 18:18:29 (12 years ago)
Author:
gabalz
Message:

More formatting to srfi-38 egg wiki documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/srfi-38

    r8698 r8699  
    77=== Description
    88
    9 A Chicken version of the reference implementation for SRFI-38, a facility
     9A Chicken version of the reference implementation for
     10[[http://srfi.schemers.org/srfi-38/srfi-38.html|SRFI-38]], a facility
    1011for reading and writing objects with shared structure.
    1112
     
    2021=== Documentation
    2122
    22 See SRFI-38 document.
     23See [[http://srfi.schemers.org/srfi-38/srfi-38.html|SRFI-38 document]].
    2324
    24 This implementation extends write-with-shared-structure to accept optional
    25 flags (following the optional port argument).
     25This implementation extends '''write-with-shared-structure''' to accept
     26optional flags (following the optional port argument).
    2627
    27 Passing the keyword #:ignore-strings will treat strings as normal
     28Passing the keyword '''#:ignore-strings''' will treat strings as normal
    2829(nonshared) objects.
    2930
    30 The keyword #:interesting-procedures is followed by a list of three
     31The keyword '''#:interesting-procedures''' is followed by a list of three
    3132procedures:
    3233
     
    3738  association-list -> association-list)
    3839
    39 The interesting? procedure returns #t when the object can be processed, #f
    40 otherwise.
     40The '''interesting?''' procedure returns '''#t''' when the object can
     41be processed, '''#f''' otherwise.
    4142
    4243All optional "interesting objects" are written as
    43 #<KIND-SYMBOL[OBJECT]...>. It is the job of write-interesting to display
    44 the KIND-SYMBOL and write any elements, using the first procedure,
    45 separated by #\space. Writing the elements of the object as a list or
    46 vector is advised.
     44#<KIND-SYMBOL[OBJECT]...>. It is the job of '''write-interesting''' to display
     45the '''KIND-SYMBOL''' and write any elements, using the first procedure,
     46separated by '''#\space'''. Writing the elements of the '''object''' as a list
     47or vector is advised.
    4748
    48 The scan procedure must call the first procedure for every element of the
    49 object. The returned association-list is used for the next invocation.
    50 Returns the modified association-list.
     49The '''scan''' procedure must call the first procedure for every element of the
     50'''object'''. The returned '''association-list''' is used for the next
     51invocation. Returns the modified '''association-list'''.
    5152
    52 This implementation extends read-with-shared-structure to accept optional
     53This implementation extends '''read-with-shared-structure''' to accept optional
    5354flags (following the optional port argument).
    5455
    55 The keyword #:interesting-procedures is followed by a list of three
     56The keyword '''#:interesting-procedures''' is followed by a list of three
    5657procedures:
    5758
     
    6162  unspecified)
    6263
    63 The interesting? procedure returns #t when the object can be processed, #f
    64 otherwise.
     64The '''interesting?''' procedure returns '''#t''' when the object can be
     65processed, '''#f''' otherwise.
    6566
    66 The read-interesting procedure must use the first procedure to read any
    67 elements of the object. The symbol is the KIND-SYMBOL. The procedure
    68 should return #f for an unsuccessful operation, otherwise the reified
    69 object. The procedure must not consume the trailing #\> but must exit
    70 positioned at the trailing #\>. The input-port is positioned just after
    71 the KIND-SYMBOL upon invocation.
     67The '''read-interesting''' procedure must use the first procedure to read any
     68elements of the '''object'''. The '''symbol''' is the '''KIND-SYMBOL'''. The
     69procedure should return '''#f''' for an unsuccessful operation, otherwise the reified
     70object. The procedure must not consume the trailing '''#\>''' but must exit
     71positioned at the trailing '''#\>'''. The '''input-port''' is positioned just
     72after the '''KIND-SYMBOL''' upon invocation.
    7273
    73 The scan procedure must call the second procedure for every element of the
    74 object when the element is a procedure, otherwise it must call the first
     74The '''scan''' procedure must call the second procedure for every element of the
     75'''object''' when the element is a procedure, otherwise it must call the first
    7576procedure with the element.
    7677
Note: See TracChangeset for help on using the changeset viewer.