factor: trim using lists

[factor.git] / basis / xml / writer / writer-docs.factor

diff --git a/basis/xml/writer/writer-docs.factor b/basis/xml/writer/writer-docs.factor
index 38f97bd5f85493de0db284f8685e31394463e357..f15fdb1a6fae41f5bc9445f3a93ff75a43249900 100644 (file)
--- a/basis/xml/writer/writer-docs.factor
+++ b/basis/xml/writer/writer-docs.factor
@@ -1,58 +1,66 @@
 ! Copyright (C) 2005, 2009 Daniel Ehrenberg
 ! See http://factorcode.org/license.txt for BSD license.
-USING: help.syntax help.markup io strings xml.data multiline ;
+USING: help.markup help.syntax io strings xml.data ;
 IN: xml.writer
 
 ABOUT: "xml.writer"
 
 ARTICLE: "xml.writer" "Writing XML"
-    "These words are used to print XML preserving whitespace in text nodes"
-    { $subsection write-xml }
-    { $subsection xml>string }
-    "These words are used to prettyprint XML"
-    { $subsection pprint-xml>string }
-    { $subsection pprint-xml }
-    "Certain variables can be changed to mainpulate prettyprinting"
-    { $subsection sensitive-tags }
-    { $subsection indenter }
-    "All of these words operate on arbitrary pieces of XML: they can take, as in put, XML documents, comments, tags, strings (text nodes), XML chunks, etc." ;
+"These words are used to print XML preserving whitespace in text nodes"
+{ $subsections
+    write-xml
+    xml>string
+}
+"These words are used to prettyprint XML"
+{ $subsections
+    pprint-xml>string
+    pprint-xml
+}
+"Certain variables can be changed to manipulate prettyprinting"
+{ $subsections
+    sensitive-tags
+    indenter
+}
+"All of these words operate on arbitrary pieces of XML: they can take, as in put, XML documents, comments, tags, strings (text nodes), XML chunks, etc." ;
 
 HELP: xml>string
-{ $values { "xml" "an XML document" } { "string" "a string" } }
+{ $values { "xml" "an XML document" } { "string" string } }
 { $description "This converts an XML document " { $link xml } " into a string. It can also be used to convert any piece of XML to a string, eg an " { $link xml-chunk } " or " { $link comment } "." }
 { $notes "This does not preserve what type of quotes were used or what data was omitted from version declaration, as that information isn't present in the XML data representation. The whitespace in the text nodes of the original document is preserved." } ;
 
 HELP: pprint-xml>string
-{ $values { "xml" "an XML document" } { "string" "a string" } }
-{ $description "converts an XML document into a string in a prettyprinted form." }
+{ $values { "xml" "an XML document" } { "string" string } }
+{ $description "Converts an XML document into a string in a prettyprinted form." }
 { $notes "This does not preserve what type of quotes were used or what data was omitted from version declaration, as that information isn't present in the XML data representation. The whitespace in the text nodes of the original document is preserved." } ;
 
 HELP: write-xml
 { $values { "xml" "an XML document" } }
-{ $description "prints the contents of an XML document to " { $link output-stream } "." }
+{ $description "Prints the contents of an XML document to " { $link output-stream } "." }
 { $notes "This does not preserve what type of quotes were used or what data was omitted from version declaration, as that information isn't present in the XML data representation. The whitespace in the text nodes of the original document is preserved." } ;
 
 HELP: pprint-xml
 { $values { "xml" "an XML document" } }
-{ $description "prints the contents of an XML document to " { $link output-stream } " in a prettyprinted form." }
+{ $description "Prints the contents of an XML document to " { $link output-stream } " in a prettyprinted form." }
 { $notes "This does not preserve what type of quotes were used or what data was omitted from version declaration, as that information isn't present in the XML data representation. Whitespace is also not preserved." } ;
 
 { xml>string write-xml pprint-xml pprint-xml>string } related-words
 
 HELP: indenter
 { $var-description "Contains the string which is used for indenting in the XML prettyprinter. For example, to print an XML document using " { $snippet "%%%%" } " for indentation, you can use the following:" }
-{ $example {" USING: xml.interpolate xml.writer namespaces ;
-[XML <foo>bar</foo> XML] "%%%%" indenter [ pprint-xml ] with-variable "} {"
+{ $example "USING: xml.syntax xml.writer namespaces ;
+[XML <foo>bar</foo> XML] \"%%%%\" indenter [ pprint-xml ] with-variable " "
 <foo>
 %%%%bar
-</foo>"} } ;
+</foo>" } ;
 
 HELP: sensitive-tags
 { $var-description "Contains a sequence of " { $link name } "s where whitespace should be considered significant for prettyprinting purposes. The sequence can contain " { $link string } "s in place of names. For example, to preserve whitespace inside a " { $snippet "pre" } " tag:" }
-{ $example {" USING: xml.interpolate xml.writer namespaces ;
-[XML <html> <head>   <title> something</title></head><body><pre>bing
+{ $example "USING: xml.syntax xml.writer namespaces ;
+[XML <!DOCTYPE html> <html> <head> <title> something</title></head><body><pre>bing
 bang
-   bong</pre></body></html> XML] { "pre" } sensitive-tags [ pprint-xml ] with-variable "} {"
+   bong</pre></body></html> XML] { \"pre\" } sensitive-tags [ pprint-xml ] with-variable"
+"
+<!DOCTYPE html>
 <html>
   <head>
     <title>
@@ -64,4 +72,4 @@ bang
 bang
    bong</pre>
   </body>
-</html>"} } ;
+</html>" } ;