CC Ajax 授權條款選擇介面文件集

作者:$Author: nyergler $
版本:$Revision: 1.2 $
更動:$Date: 2005/08/01 14:52:52 $

這是啥

本套件為 Creative Commons 授權引擎網頁服務實做了一個瀏覽器用戶端範例. 關於這項授權引擎服務, 在 http://api.creativecommons.org 有更為詳盡的資訊.

在本套件內的實做成品中, 使用了 PHP 來做出網頁代理伺服器, 處理由您的網頁主機送至 api.creativecommons.org 的請求. 它同時也用了 Javascript 來實做出 AJAX 介面, 就跟您所能在 wpLicense 看到的一樣.

怎麼用

在這份 cc_ajax 套件中, 同時提供了一些 PHP 檔案和 Javascript 檔案, 這些檔案一起實做了基本的授權條款選擇介面. 當您想要把這個授權條款選擇介面整合到您自己的網頁應用程式時, 您需要這麼做:

  1. 修改 cc_ajax/client.js 檔案裏的 WS_ROOT_URL 變數, 把它指到您自己的 ccwsclient.php 所在處. 基於瀏覽器安全性的限制, 這個位置一定要跟您的授權條款選擇介面位於相同的網域內纔行.

    舉例來說, 如果您正要把授權條款選擇介面整合到 http://example.com/choose.php, 而您的 cc_ajax 函式庫安裝於根目錄的話, WS_ROOT_URL 就應該要設成 http://example.com/cc_ajax/ccwsclient.php.

  2. 把 cc_ajax 套件上傳至您的網頁伺服器.

  3. 對 cc_ajax/cc_ajax.php 函式庫提出需求, 以將授權條款選擇介面囊括至您的頁面中. 這個檔案定義了兩個函式, 用來產生授權條款選擇介面:

    1. scriptHeader($base)

      產生用來將 Javascript 函式庫囊括進來所需的 <script> 標籤. 在上述的範例中, 您可能會用:

      <?php scriptHeader("http://example.com"); ?>
      
    2. licenseChooser($action, $prefix)

      產生授權條款選擇介面本身. $action 指定了要將表單送往的網址; 本套件中含有一個 choose.php 檔案, 能把表單的結果顯示出來. $prefix 則指定表單變數的前綴字串. 例如:

      <?php licenseChooser('choose.php', ''); ?>
      
  4. 表單則使用了下列的變數:

    • license_name 讓一般人也能看懂的授權條款名稱
    • license_uri 授權條款標章的網址
    • license_rdf 描述著授權許可事項、禁止事項及要件的 RDF 區塊, 也就是授權條款的數位標籤版本 (RDF 格式的後設資料).
    • license_html HTML 區塊, 嵌入了 RDF 格式的後設資料, 適合用於嵌入網站頁面中.

致謝

cc_ajax 用了一些很棒的開放源碼函式庫纔得以被打造出來, 這些函式庫包括了:

授權條款

cc_ajax 係採用 GNU GPL 第 2 版或更新的版本所授權. 授權條款全文請參見這個套件中的 docs/LICENSE 檔案. 本文件集則採用 Creative Commons 姓名標示 2.5 授權條款所授權.