extra/id3/id3-docs.factor

   1 ! Coyright (C) 2007 Adam Wendt
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.syntax help.markup ;
   4 IN: id3
   5
   6 ARTICLE: "id3-tags" "ID3 Tags"
   7 "The " { $vocab-link "id3" } " vocabulary is used to read ID3 tags from MP3 audio streams."
   8 { $subsection id3v2 }
   9 { $subsection read-tag }
  10 { $subsection id3v2? }
  11 { $subsection read-id3v2 } ;
  12
  13 ABOUT: "id3-tags"
  14
  15 HELP: id3v2
  16 { $values { "filename" "a pathname string" } { "tag/f" "a tag or f" } }
  17 { $description "Outputs a " { $link tag } " or " { $link f } " if file does not start with an ID3 tag." } ;
  18
  19 HELP: read-tag
  20 { $values { "stream" "a stream" } { "tag/f" "a tag or f" } }
  21 { $description "Outputs a " { $link tag } " or " { $link f } " if stream does not start with an ID3 tag." } ;
  22
  23 HELP: id3v2?
  24 { $values { "?" "a boolean" } }
  25 { $description "Tests if the current input stream begins with an ID3 tag." } ;
  26
  27 HELP: read-id3v2
  28 { $values { "tag/f" "a tag or f" } }
  29 { $description "Outputs a " { $link tag } " or " { $link f } " if the current input stream does not start with an ID3 tag." } ;