extra/id3/id3-docs.factor

   1 ! Copyright (C) 2008 Tim Wawrzynczak
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax sequences kernel accessors ;
   4 IN: id3
   5
   6 HELP: file-id3-tags
   7 { $values
   8     { "path" "a path string" }
   9     { "object/f" "a tuple storing ID3 metadata or f" } }
  10     { $description "Return a tuple containing the ID3 information parsed out of the MP3 file, or " { $link f } " if no metadata is present.  Currently, the parser supports the following tags: "
  11       $nl { $link title>> }
  12       $nl { $link artist>> }
  13       $nl { $link album>> }
  14       $nl { $link year>> }
  15       $nl { $link genre>> }
  16       $nl { $link comment>> } } ;
  17
  18 ARTICLE: "id3" "ID3 tags"
  19 "The " { $vocab-link "id3" } " vocabulary contains words for parsing " { $emphasis "ID3" } " tags, which are textual fields storing an MP3's title, artist, and other metadata." $nl
  20 "Parsing ID3 tags from an MP3 file:"
  21 { $subsection file-id3-tags } ;
  22
  23 ABOUT: "id3"