微格式解析库microformat-shiv技术文档

1. 安装指南

使用Bower进行安装：

$ bower install microformat-shiv

2. 项目使用说明

microformat-shiv是一个跨浏览器的JavaScript微格式解析器，也可以用来构建浏览器扩展。该库被内置到Firefox浏览器中作为一个内部组件。

方法

• 解析

  • get
  • getParent

• 发现

  • count
  • isMicroformat
  • hasMicroformats

get

简单的HTML文档或HTML文档选定部分的解析。

<script src="microformat-shiv.min.js" type="text/javascript"></script>
<script type="text/javascript">
    var items;

    items = Microformats.get()
    // 对数据 `items` 做些处理
</script>

使用选项：

<script src="microformat-shiv.min.js" type="text/javascript"></script>
<script type="text/javascript">
    var items,
        options;

    options = {'filters': ['h-card']};
    var items = Microformats.get( options )
    // 对数据 `items` 做些处理
</script>

针对HTML文档的一部分进行解析：

<script src="microformat-shiv.min.js" type="text/javascript"></script>
<script type="text/javascript">
    var items,
        options;

    options = {
        'filters': ['h-card'],
        'node': document.getElementById('target')
    };
    var items = Microformats.get( options )
    // 对数据 `items` 做些处理
</script>

解析HTML字符串：

<script src="microformat-shiv.min.js" type="text/javascript"></script>
<script type="text/javascript">
    var items,
        options;

    options = {
        'baseUrl': 'http://glennjones.net',
        'html': '<a class="h-card" href="/about.html">Glenn</a>'
    };
    var items = Microformats.get( options )
    // 对数据 `items` 做些处理
</script>

注意：baseUrl 是可选的，用于解析相对URL。

getParent

给定一个HTML DOM节点，它会返回它的第一个父微格式。

<script src="microformat-shiv.min.js" type="text/javascript"></script>
<script type="text/javascript">
    var items,
        node = document.getElementById('target');

    items = Microformats.getParent( node )
    // 对数据 `items` 做些处理
</script>

getParent 方法接受与 get 方法相同的 options。不同之处在于 options.filters 属性如何影响输出。向 getParent 添加过滤器列表将允许搜索父节点时跳过不希望定位的微格式。

<script src="microformat-shiv.min.js" type="text/javascript"></script>
<script type="text/javascript">
    var items,
        options = {'filters': ['h-entry']},
        node = document.getElementById('target');

    items = Microformats.getParent( node, options )
    // 对数据 `items` 做些处理
</script>

Count

count 方法返回找到的每种微格式类型的数量。它不会进行完整的解析，因此比 get 快得多，可以用于向UI添加通知等任务。该方法可以接受一个 options 对象作为参数。

<script src="microformat-shiv.min.js" type="text/javascript"></script>
<script type="text/javascript">
    var counts = Microformats.count()
    // 对 counts 数据做些处理
</script>

输出：

{
    'h-event': 1,
    'h-card': 2,
    'rels': 6
}

isMicroformat

isMicroformat 方法返回一个节点是否具有有效的微格式类。目前它不考虑 rel=* 为微格式。该方法可以接受一个 options 对象作为第二个参数。

<script src="microformat-shiv.min.js" type="text/javascript"></script>
<script type="text/javascript">
    var node = document.getElementById('target');
    var isValid = Microformats.isMicroformat( node );
    // 对 isValid 布尔值做些处理
</script>

hasMicroformats

hasMicroformats 方法返回一个文档或节点是否有任何有效的微格式类。目前它不考虑 rel=* 微格式。该方法可以接受一个 options 对象作为第二个参数。

<script src="microformat-shiv.min.js" type="text/javascript"></script>
<script type="text/javascript">
    var isValid,
        node = document.getElementById('target');

    isValid = Microformats.isMicroformat( node );
    // 对 isValid 布尔值做些处理
</script>

3. 项目API使用文档

请参考上面的“项目使用说明”部分，其中的代码示例和说明即为API的使用文档。

4. 项目安装方式

请参考“安装指南”部分，使用Bower进行安装：

$ bower install microformat-shiv