# web.entities 库模块帮助文档

## web.entities 成员列表 <a id="web.entities" href="#web.entities">&#x23;</a>

HTML 全部实体字符编码表。  
实体字符必须以 `&` 开始，以 `;` 号结束，并区分大小写。  
导入此库以后 string.html.unescape,string.xml.unescape 即可解码所有 HTML 命名实体。  
否则这 2 个函数只会解码常用的几个 HTML 命名实体。  

目前 UTF-8 编码 已经完全普及的 ，这些命名实体基本是无意义的历史遗留产物。  
一般没必要使用这个库。

### web.entities.escape(str) <a id="web.entities.escape" href="#web.entities.escape">&#x23;</a>
NCR 编码与 HTML 全部命名实体编码。  
这个编码要处理数千个命名实体以及多字符实体，  
需要执行一个较复杂的模式匹配（模式串就有近 700 个字符）。  
一般没有必要也不建议调用这个函数。  
目前 UTF-8 编码 已经完全普及的 ，这些命名实体基本是无意义的历史遗留产物。  
一般不建议使用这个函数。  

这个函数会编码所有 HTML 命名实体以及全部非 ASCII 字符。  
如果只想编码`<>&"'` 这 5 个基本实体字符请使用更简单的。  
string.html.escape（或  str.xml.escape ） 函数。  
如果不需要  HTML 命名实体编码，建议使用  
string.html.escape2（或 string.xml.escape2）函数。

### web.entities.unescape(str) <a id="web.entities.unescape" href="#web.entities.unescape">&#x23;</a>
NCR 编码字符、HTML 实体字符还原为 UTF8 文本
