Packagemap-Dateidefinition für die Google Codesuche

Inhalt

Überblick

Google Codesuche ermöglicht Nutzern, das Web nach Archiven zu durchsuchen, die Quellcode enthalten. Unsere Software findet Quellcodedateien innerhalb dieser Archive und erkennt die Sprache und die Lizenz. So, wie Sie uns mithilfe einer normalen Sitemap Informationen über die Seiten auf Ihrer Website übermitteln, können Sie uns mit einer Packagemap über die Sprache und die Lizenz des Quellcodes in Ihren Archivdateien informieren.

Syntax

[Inhalt]

Der Code ist in XML. Hier finden Sie ein Beispiel:

<?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>

Dateinamen

Geben Sie in einer Sitemap für die Codesuche den Namen der Packagemap mit dem <packagemap>- Tag an. Wenn Sie die Packagemap-Datei nicht angeben, überprüfen wir das oberste Verzeichnis in dem Archiv auf die folgenden Dateien und verwenden die erste Datei, die gefunden wird:

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

XML-Tag-Definitionen

Die verfügbaren XML-Tags werden unten beschrieben.

<fileset>	erforderlich	Fasst die Datei zusammen und verweist auf den aktuellen Protokollstandard.
<file>	erforderlich	Untergeordnetes Element von <fileset>
<path>	erforderlich	Untergeordnetes Element von <file> Beschreibt den Dateipfad innerhalb des Archivs. Groß-/Kleinschreibung wird beachtet, darf alle Zeichen enthalten.
<type>	erforderlich	Untergeordnetes Element von <file>. Wert kann Bezeichnung einer Sprache oder "archive" sein. Beispiele für die Bezeichnung der Sprache sind u. a.: "C", "Python", "C#", "Java", "Vim". Groß-/Kleinschreibung wird nicht beachtet, "JAVA" und "java" sind äquivalent. Der Wert muss in druckbaren ASCII-Zeichen angegeben sein, ohne Leerzeichen. Die Bezeichnung muss die einer der unterstützten Sprachensein. Nur Dateien mit unterstützten Sprachen werden indiziert. Alle anderen Dateien werden nicht berücksichtigt. Sie können eine Sprachbezeichnung verwenden, die wir noch nicht unterstützen, und wir werden die Datei möglicherweise in Zukunft indizieren. Der Sonderwert "archive" kann für ein Archiv innerhalb eines Archivs verwendet werden. Dies ist nur dann nützlich, wenn dieses Archiv Quellcode enthält. Da die Codesuche nur Quellcode indiziert, ist es nicht erforderlich, Einträge für Archive hinzuzufügen, die nur Text, HTML usw. enthalten.
<license>	Optional	Untergeordnetes Element von <file>. Der Wert sollte der Name der Urheberrechtslizenz sein. Hierzu gehören beispielsweise: "GPL", "BSD", "Python" oder "disclaimer". Groß-/Kleinschreibung wird nicht beachtet, "LPGL" "Lgpl" und "lgpl" sind äquivalent. Wenn der <type> "archive" ist, ist der Wert von <licence> die Standardlizenz für die Dateien in dem Archiv. Es kann eine andere Lizenz für bestimmte Dateien mit einer Packagemap in dem Archiv angegeben werden. Die Lizenz muss eine der unterstützten Lizenzen sein. Nicht anerkannte Lizenzen werden ignoriert und der Wert für solche Lizenzen wird als unbekannt aufgeführt.
<packagemap>	Optional	Untergeordnetes Element von <file> Der Name der Packagemap-Datei im Archiv. Wir empfehlen hierfür "PACKAGEMAP.xml". In diesem Fall erkennen wir die Packagemap-Datei automatisch, Sie müssen sie daher hier nicht einfügen. Groß- und Kleinschreibung wird beachtet. Dieses Tag kann nur für <file>-Einträge verwendet werden, bei denen der Wert für <type> "archive" ist.

Entity Escaping

Leerzeichen am Anfang und Ende werden nicht berücksichtigt. UTF-8-Codierung ist erforderlich. Wie bei XML-Dateien üblich, müssen alle Datenwerte (einschließlich URLs) Entity-Escape-Codes für die in der nachfolgenden Tabelle aufgeführten Zeichen verwenden.

Zeichen		Escape-Code
Kaufmännisches Und-Zeichen	&	&
Einfaches Anführungszeichen	'	'
Doppeltes Anführungszeichen	"	"
Größer als	>	>
Kleiner als	<	<