/extra/html/elements/elements-docs.factor

http://github.com/abeaumont/factor · Factor · 27 lines · 25 code · 2 blank · 0 comment · 0 complexity · 0fe6bd760028e009f8f1eec7d60277d9 MD5 · raw file

  1. USING: help.markup help.syntax io present html ;
  2. IN: html.elements
  3. ARTICLE: "html.elements" "HTML elements"
  4. "The " { $vocab-link "html.elements" } " vocabulary provides words for writing HTML tags to the " { $link output-stream } " with a familiar look and feel in the code."
  5. $nl
  6. "HTML tags can be used in a number of different ways. The simplest is a tag with no attributes:"
  7. { $code "<p> \"someoutput\" write </p>" }
  8. "In the above, " { $link <p> } " will output the opening tag with no attributes. and " { $link </p> } " will output the closing tag."
  9. { $code "<p \"red\" =class p> \"someoutput\" write </p>" }
  10. "This time the opening tag does not have the '>'. Any attribute words used between the calls to " { $link <p } " and " { $link p> } " will write an attribute whose value is the top of the stack. Attribute values can be any object supported by the " { $link present } " word."
  11. $nl
  12. "Values for attributes can be used directly without any stack operations. Assuming we have a string on the stack, all three of the below will output a link:"
  13. { $code "<a =href a> \"Click me\" write </a>" }
  14. { $code "<a \"http://\" prepend =href a> \"click\" write </a>" }
  15. { $code "<a [ \"http://\" % % ] \"\" make =href a> \"click\" write </a>" }
  16. "Tags that have no “closing” equivalent have a trailing " { $snippet "tag/>" } " form:"
  17. { $code "<input \"text\" =type \"name\" =name 20 =size input/>" }
  18. "For the full list of HTML tags and attributes, consult the word list for the " { $vocab-link "html.elements" } " vocabulary. In addition to HTML tag and attribute words, a few utilities are provided."
  19. $nl
  20. "Writing unescaped HTML to " { $vocab-link "html.streams" } ":"
  21. { $subsections
  22. write-html
  23. print-html
  24. } ;
  25. ABOUT: "html.elements"