README

需求

为了使用 RDFauthor，您的 Web 项目必须满足以下要求

• RDFa 必须用于在您的 XHTML 标记中嵌入 RDF 三元组。
• 您的数据来源的三元组存储必须提供 SPARQL/Update 端点。
• 更新端点的 URI 必须使用我们的 更新词汇表 嵌入到页面中。

安装

RDFauthor 是一个 JavaScript 库，因此不需要安装。

在您的项目中使用 RDFauthor

要在您的项目中使用 RDFauthor，需要三个步骤。

1. 在您的页面中嵌入命名图的原产地信息（作为 RDFa）。如果您不使用命名图，则页面 URI 被用作图 URI。

2. 定义一个名为 RDFAUTHOR_BASE 的全局 JavaScript 变量，其中包含您 Web 服务器上 RDFauthor 的 URI（例如 http://example.com/MyWebApp/lib/rdfauthor/）。

3. 定义另一个名为 RDFAUTHOR_READY_CALLBACK 的全局变量，其中包含一个当 RDFauthor 加载完成后要执行的功能。典型用法是调用 setOptions() 和 start()

    RDFAUTHOR_READY_CALLBACK = function () {
        // RDFauthor is now loaded and ready to use
        RDFauthor.setOptions({});
        RDFauthor.start();
    };
   

4. 懒加载 rdfauthor.js（位于 RDFAUTHOR_BASE 下）。

选项

目前有以下选项存在

var _defaultOptions = {
    title: 'Title', 
    saveButtonTitle: 'saveButtonTitle', 
    cancelButtonTitle: 'cancelButtonTitle', 
    showButtons: true, 
    useAnimations: true, 
    autoParse: true, 
    usePredicateInfo: true, 
    useSPARQL11: false, 
    fetchAllPredicates: true, 
    viewOptions: {
        type: 'popover' /* inline or popover */
    }
};

除非您使用 Ontowiki 的更新-API up，否则您可能希望将 useSPARQL11 设置为 true，以便它使用 SPARQL-update。

API 文档

RDFauthor 的 API 文档可以使用 JsDoc Toolkit 构建。在 Ubuntu 上，您可以通过运行 sudo apt-get install jsdoc-toolkit 来安装它。之后，在 RDFauthor 目录中运行 jsdoc -d=./doc ./src。

如果您手动下载了工具包，您需要设置两个环境变量

• 将 $JSDOCDIR 设置为您安装 JsDoc 的路径（例如 /opt/local/jsdoc-toolkit）。
• 将 $JSDOCTEMPLATEDIR 设置为 RDFauthor 的文档模板目录（例如 /opt/local/rdfauthor/misc/jsdoc-template）。模板目录位于您的 RDFauthor 目录下的 misc/jsdoc-templates 中。

假设 jsrun.sh 可在您的路径中找到，您可以从 RDFauthor 目录中使用以下命令运行 JsDoc

jsrun.sh -d=./doc ./src

这将构建在 RDFauthor 目录下名为 doc 的目录中的 API 文档。