Google ソースコード検索の packagemap ファイルの定義

概要

Google ソースコードの検索では、ソースコードを含むアーカイブのウェブ検索ができます。 Google のソフトウェアでは、アーカイブの中にソースコードファイルが配置され、言語とライセンスが検出されます。ご自身のサイトにあるページについての情報を Google に提供する際、通常のサイトマップを使用するのと同様に、アーカイブファイルのソースコードの言語やライセンスの連絡に 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>

ファイル名

ソースコード検索のサイトマップで、<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 などのデータ値では、次の文字にエンティティのエスケープコードを使用する必要があります。

文字		エスケープコード
アンパサンド	&	&
一重引用符	'	'
二重引用符	"	"
不等記号 (より大)	>	>
不等記号 (より小)	<	<