basis/quoted-printable/quoted-printable-docs.factor

   1 ! Copyright (C) 2009 Daniel Ehrenberg
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax strings byte-arrays io.encodings.string ;
   4 IN: quoted-printable
   5
   6 ABOUT: "quoted-printable"
   7
   8 ARTICLE: "quoted-printable" "Quoted printable encoding"
   9 "The " { $vocab-link "quoted-printable" } " vocabulary implements RFC 2045 part 6.7, providing words for reading and generating quotable printed text."
  10 { $subsections
  11     >quoted
  12     >quoted-lines
  13     quoted>
  14 } ;
  15
  16 HELP: >quoted
  17 { $values { "byte-array" byte-array } { "string" string } }
  18 { $description "Encodes a byte array as quoted printable, on a single line." }
  19 { $warning "To encode a string in quoted printable, first use the " { $link encode } " word." } ;
  20
  21 HELP: >quoted-lines
  22 { $values { "byte-array" byte-array } { "string" string } }
  23 { $description "Encodes a byte array as quoted printable, with soft line breaks inserted so the output lines are no longer than 76 characters." }
  24 { $warning "To encode a string in quoted printable, first use the " { $link encode } " word with a specific encoding." } ;
  25
  26 HELP: quoted>
  27 { $values { "string" string } { "byte-array" byte-array } }
  28 { $description "Decodes a quoted printable string into an array of the bytes represented." }
  29 { $warning "When decoding something in quoted printable form and using it as a string, be sure to use the " { $link decode } " word rather than simply converting the byte array to a string." } ;