extra/progress-bars/progress-bars-docs.factor

   1 ! Copyright (C) 2011 Doug Coleman.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax math strings ;
   4 IN: progress-bars
   5
   6 HELP: make-progress-bar
   7 { $values
   8     { "percent" "a real number between 0 and 1" } { "length" integer }
   9     { "string" string }
  10 }
  11 { $description "Makes a progress bar " { $snippet "percent" } " completed that is " { $snippet "length" } " characters long." } ;
  12
  13 ARTICLE: "progress-bars" "Progress bars"
  14 "The " { $vocab-link "progress-bars" } " vocabulary implements a simple progress bar string." $nl
  15 "To make a generic progress bar string:"
  16 { $subsections make-progress-bar }
  17 "The " { $vocab-link "progress-bars.models" } " vocabulary implements a word to display a progress bar that shows how much of a file has been read so far." ;
  18
  19 ABOUT: "progress-bars"