Google 程式碼搜尋 packagemap 檔案定義

內容

總覽

「Google 程式碼搜尋」可讓使用者在網路上搜尋包含原始程式碼的封存。我們的軟體會找出位於這些封存中的原始程式碼檔案，並偵測出其語言和授權。就如同您可以使用一般 Sitemap 來告訴我們關於您網站的資訊一樣，您也可以使用 packagemap 檔案來讓我們知道您封存檔案中原始程式碼的語言和授權。

語法

[內容]

程式碼是以 XML 撰寫。範例如下：

<?xml version="1.0" encoding="UTF-8"?>
<fileset>
<file>
   <path>source/myfile.cpp</path>
   <type>C++</type>
   <license>LGPL</icense>
</file>    

<file>     
   <path>messages/messages.tgz</path>
   <type>archive</type>     
   <license>BSD</license>     
   <packagemap>info/PackageMap.xml</packagemap>  
</file>    
</fileset>

檔名

在「程式碼搜尋 Sitemap」中，使用 <packagemap> 標記來指定 packagemap 名稱。如果您沒有指定 packagemap 檔案，我們會在封存的頂層目錄中尋找下列檔案，並使用第一個找到的檔案：

PACKAGEMAP.XML
PACKAGEMAP.xml
Packagemap.xml
packagemap.xml
PACKAGEMAP
Packagemap
packagemap

XML 標記定義

可用的 XML 標記如下所述。

<fileset>	需求條件	壓縮檔案並參照最新的通訊協定標準。
<file>	需求條件	<fileset 的子層>
<path>	需求條件	<file> 的子層。說明封存中的檔案路徑。區分大小寫；可包含任何字元。
<type>	需求條件	<file> 的子層。此值可以是語言名稱或「archive」。語言名稱的範例如下：「C」、「Python」、「C#」、「Java」、「Vim」。不區分大小寫；「Java」、「JAVA」和「java」都是相同的。此值必須是可列印的 ASCII 字元，且不含空格。名稱必須是其中一個支援的語言。我們只會為使用支援語言的檔案建立索引。所有其他檔案都會被忽略。您可以使用我們尚未支援的語言名稱，未來我們可能會為該檔案建立索引。特殊值「archive」可用於封存之內的封存。此值只有當此封存包含原始程式碼時才會有幫助。「程式碼搜尋」只會為原始程式碼建立索引，因此不需為任何僅包含文字、html 等檔案的封存新增項目。
<license>	選擇性	<file> 的子層。此值必須是版權授權名稱。這類的例子有：「GPL」、「BSD」、「Python」、「disclaimer」。不區分大小寫；「LPGL」、「Lgpl」和「lgpl」都是相同的。當 <type> 是「archive」時，<license> 的值是封存中所有檔案的預設授權。在封存中使用 packagemap 的特定檔案可以指定不同的授權。授權必須是其中一個支援的授權。我們會忽略無法辨識的授權，並將授權值列為「未知」。
<packagemap>	選擇性	<file> 的子層。封存內 Packagemap 檔案的名稱。我們建議使用「PACKAGEMAP.xml」。在這種情況下，我們會自動偵測 packagemap 檔案，如此您就不需要將它包含在這裡。區分大小寫。此標記僅適用於 <type> 的值為「archive」的 <file> 項目。

實體逸出

開頭和結尾的空格都會被忽略。必須使用 UTF-8 編碼。如同所有的 XML 檔案一樣，下表所列字元的任何資料值 (包括 URL)，都必須使用實體逸出碼。

字元		逸出碼
& 符號	&	&
單引號	'	'
雙引號	"	"
大於	>	>
小於	<	<