extra/morse/morse-docs.factor

   1 ! Copyright (C) 2007 Alex Chapman
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax ;
   4 IN: morse
   5
   6 HELP: ch>morse
   7 { $values
   8     { "ch" "A character that has a morse code translation" } { "morse" "A string consisting of zero or more dots and dashes" } }
   9 { $description "If the given character has a morse code translation, then return that translation, otherwise return a ? character." } ;
  10
  11 HELP: morse>ch
  12 { $values
  13     { "str" "A string of dots and dashes that represents a single character in morse code" } { "ch" "The translated character" } }
  14 { $description "If the given string represents a morse code character, then return that character, otherwise return a space character." } ;
  15
  16 HELP: >morse
  17 { $values
  18     { "str" "A string of ASCII characters which can be translated into morse code" } { "newstr" "A string in morse code" } }
  19 { $description "Translates ASCII text into morse code, represented by a series of dots, dashes, and slashes." }
  20 { $see-also morse> ch>morse } ;
  21
  22 HELP: morse>
  23 { $values { "morse" "A string of morse code, in which the character '.' represents dots, '-' dashes, ' ' spaces between letters, and ' / ' spaces between words." } { "plain" "The ASCII translation of the given string" } }
  24 { $description "Translates morse code into ASCII text" }
  25 { $see-also >morse morse>ch } ;
  26
  27 HELP: play-as-morse*
  28 { $values { "str" "A string of ascii characters which can be translated into morse code" } { "unit-length" "The length of a dot" } }
  29 { $description "Plays a string as morse code" } ;
  30
  31 HELP: play-as-morse
  32 { $values { "str" "A string of ascii characters which can be translated into morse code" } }
  33 { $description "Plays a string as morse code" } ;