basis/xml/entities/entities-docs.factor

   1 ! Copyright (C) 2005, 2009 Daniel Ehrenberg
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax assocs ;
   4 IN: xml.entities
   5
   6 ABOUT: "xml.entities"
   7
   8 ARTICLE: "xml.entities" "XML entities"
   9     "When XML is parsed, entities like &foo; are replaced with the characters they represent. A few entities like &amp; and &lt; are defined by default, but more are available, and the set of entities can be customized. Below are some words involved in XML entities, defined in the vocabulary 'entities':"
  10     { $subsection entities }
  11     { $subsection with-entities }
  12 "For entities used in HTML/XHTML, see " { $vocab-link "xml.entities.html" } ;
  13
  14 HELP: entities
  15 { $values { "value" assoc } }
  16 { $description "A hash table from default XML entity names (like " { $snippet "&amp;" } " and " { $snippet "&lt;" } ") to the characters they represent. This is automatically included when parsing any XML document." }
  17 { $see-also with-entities } ;
  18
  19 HELP: with-entities
  20 { $values { "entities" "a hash table of strings to strings" } { "quot" "a quotation ( -- )" } }
  21 { $description "Calls the quotation using the given table of entity values (symbolizing, eg, that " { $snippet "&foo;" } " represents " { $snippet "\"a\"" } ") on top of the default XML entities" } ;
  22