steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

html.entities: adding some examples to the docs.

db4
John Benediktsson 2014-04-22 15:51:25 -07:00
parent c6de3e9967
commit 5373a985d7
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
extra/html/entities/entities-docs.factor
View File

@ -3,8 +3,18 @@ IN: html.entities
HELP: html-escape
{ $values { "str" string } { "newstr" string } }
{ $description "Replaces special characters " { $snippet "&" } ", " { $snippet "<" } ", " { $snippet ">" } ", " { $snippet "\"" } ", and " { $snippet "'" } " to HTML-safe sequences." } ;
{ $description "Replaces special characters " { $snippet "&" } ", " { $snippet "<" } ", " { $snippet ">" } ", " { $snippet "\"" } ", and " { $snippet "'" } " to HTML-safe sequences." }
{ $examples
{ $example "USING: html.entities prettyprint ;"
"\"<foo>\" html-escape ."
"\"&lt;foo&gt;\"" }
} ;
HELP: html-unescape
{ $values { "str" string } { "newstr" string } }
{ $description "Convert all named and numeric character references (e.g. " { $snippet "&gt;" } ", " { $snippet "&#62;" } ", " { $snippet "&#x3e;" } ") in the string " { $snippet "str" } " to the corresponding unicode characters using the rules defined by the HTML5 standard." } ;
{ $description "Convert all named and numeric character references (e.g. " { $snippet "&gt;" } ", " { $snippet "&#62;" } ", " { $snippet "&#x3e;" } ") in the string " { $snippet "str" } " to the corresponding unicode characters using the rules defined by the HTML5 standard." }
{ $examples
{ $example "USING: html.entities prettyprint ;"
"\"x &lt; 2 &amp;&amp y &gt; 5\" html-unescape ."
"\"x < 2 && y > 5\"" }
} ;