sphinxcontrib-microdata 0.1dev-20140921

安装

有关详细信息，请参见sphinx-contrib。

要安装插件，必须运行以下命令：

python setup.py build
python setup.py install

pyspice源代码位于https://github.com/FabriceSalvaire/sphinx-microdata

要克隆git存储库，请在终端中运行此命令：

git clone git@github.com:FabriceSalvaire/sphinx-microdata

用法

要加载插件，必须将其添加到conf.py文件中。

extensions=[...'sphinxcontrib.microdata',]

指令

微数据插件提供两个指令：

• itemscope，允许声明itemscope块的块指令：

  ..itemscope::<Schema type>:tag:element type (default: div):itemprop:optionnal itemprop attribute:compact:optionnal
  
      Nested content
  

• itemprop，允许用itemprop属性注释某些文本的内联指令/角色。

  :itemprop:`Displayed text <itemprop name>`:itemprop:`Displayed text <itemprop name:http://some.url/>`

示例

此重新构造的文本文档：

.. itemscope: Person
    :tag: p

    My name is :itemprop:`Bob Smith <name>`
    but people call me :itemprop:`Smithy <nickanme>`.
    Here is my home page:
    :itemprop:`www.exemple.com <url:http://www.example.com>`
    I live in Albuquerque, NM and work as an :itemprop:`engineer <title>`
    at :itemprop:`ACME Corp <affiliation>`.

将导致：

<pitemscopeitemtype="http://data-vocabulary.org/Person">
    My name is <spanitemprop="name">Bob Smith</span>
    but people call me <spanitemprop="nickname">Smithy</span>.
    Here is my home page:
    <ahref="http://www.example.com"itemprop="url">www.example.com</a>
    I live in Albuquerque, NM and work as an <spanitemprop="title">engineer</span>
    at <spanitemprop="affiliation">ACME Corp</span>.
</p>

此文档使用嵌套的itemscope重新构造文本：

..itemscope:: Person

    My name is :itemprop:`John Doe <name>`    ..itemscope:: Address
        :tag:p:itemprop:address

        I live in :itemprop:`Albuquerque <name>`

将导致：

<divitemscopeitemtype="http://data-vocabulary.org/Person"><p>
My name is <spanitemprop="name">John Doe</span></p><pitemprop="address"itemscopeitemtype="http://data-vocabulary.org/Address">
I live in <spanitemprop="name">Albuquerque</span>'
</p></div>

此文档使用嵌套且压缩的itemscope重新构造文本：

..itemscope:: Person
    :tag:p:compact:

    My name is :itemprop:`John Doe <name>`    ..itemscope:: Address
        :tag:span:itemprop:address

        I live in :itemprop:`Albuquerque <name>`

将导致：

<pitemscopeitemtype="http://data-vocabulary.org/Person">
My name is <spanitemprop="name">John Doe</span><spanitemprop="address"itemscopeitemtype="http://data-vocabulary.org/Address">
I live in <spanitemprop="name">Albuquerque</span></span></p>