Changeset 15861 in project


Ignore:
Timestamp:
09/13/09 16:47:46 (10 years ago)
Author:
sjamaan
Message:

Document extra procedures dealing with the estraier draft format

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/estraier-client

    r15859 r15861  
    396396Rotate the master's log.
    397397
     398=== Other procedures
     399
     400These procedures are not likely to be very useful, but they are
     401provided for completeness.
     402
     403==== read-draft
     404
     405<procedure>(read-attributes inport)</procedure>
     406
     407Read a document in
     408[[http://hyperestraier.sourceforge.net/uguide-en.html#formats|"draft format"]]
     409from the input-port {{inport}}.
     410Returns two values: the document contents (a list of strings
     411representing the lines in the docuemnt) and the document's attributes
     412(an alist).
     413
     414==== read-attributes
     415
     416<procedure>(read-attributes inport)</procedure>
     417
     418Like {{read-attributes}}, except this only reads the attributes and
     419returns only one value: an alist with the attributes.
     420
     421==== write-draft
     422
     423<procedure>(write-draft outport contents attributes)</procedure>
     424
     425Write out a document in "draft" format to the specified output port
     426{{outport}}.  {{attributes}} is an alist with the attributes of the
     427document, {{contents}} is a list of strings with the lines in the
     428document.
     429
     430==== write-attributes
     431
     432<procedure>(write-attributes outport attributes)</procedure>
     433
     434Like {{write-draft}}, except this only writes the attributes part
     435(the "header", in a way) of the draft.
    398436
    399437=== Changelog
Note: See TracChangeset for help on using the changeset viewer.