Google Recherche de code - Définition du fichier packagemap

Sommaire

Présentation générale

Google Recherche de code permet aux internautes de rechercher sur Internet des archives contenant du code source. Notre logiciel localise les fichiers de code source au sein de ces archives et identifie leur langage ainsi que leur licence. Tout comme vous pouvez utiliser un plan Sitemap standard pour nous renseigner sur les pages de votre site, vous disposez des fichiers packagemap pour nous indiquer le langage et la licence du code source figurant dans vos archives.

Syntaxe

[Contenu]

Le langage de programmation utilisé est XML. Voici un exemple :

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

Noms de fichier

Dans un plan Sitemap pour Google Recherche de code, spécifiez le nom du fichier packagemap à l'aide du tag <packagemap>. Si vous n'indiquez pas de fichier packagemap, nous rechercherons les fichiers suivants dans le répertoire racine de l'archive et utiliserons le premier rencontré :

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

Définition des tags XML

Les tags XML disponibles sont décrits ci-après.

<fileset>	obligatoire	Encapsule le fichier et référence le protocole utilisé.
<file>	obligatoire	Enfant de <fileset>
<path>	obligatoire	Enfant de <file>. Indique le chemin d'accès dans l'archive. Sensible à la casse ; peut contenir n'importe quel caractère.
<type>	obligatoire	Enfant de <file>. La valeur peut être le nom d'un langage ou "archive". Voici des exemples de langage : "C", "Python", "C#", "Java", "Vim". La casse n'est pas prise en compte ; vous pouvez aussi bien entrer "Java", "JAVA" ou "java". La valeur ne doit contenir que des caractères ASCII imprimables, sans espace. Ce nom doit être celui d'un des langages pris en charge. Seuls les fichiers dont le langage est pris en charge sont indexés. Les autres ne seront pas pris en compte. Vous pouvez cependant utiliser un nom de langage que nous ne prenons pas encore charge, car il se peut que nous l'indexions ultérieurement. La valeur spéciale "archive" peut être utilisée pour un fichier d'archivage au sein d'archives. Elle n'est utile que si l'archive contient du code source. Dans la mesure où Google Recherche de code indexe uniquement le code source, il est inutile d'ajouter une entrée pour une archive ne contenant que des données texte, html, etc.
<license>	facultatif	Enfant de <file>. La valeur doit être le nom de la licence de droit d'auteur. Exemples : "GPL", "BSD", "Python", "disclaimer". La casse n'est pas prise en compte ; vous pouvez aussi bien entrer "LPGL", "Lgpl" ou "lgpl". Lorsque <type> a pour valeur "archive", la valeur de <license> est la licence par défaut des fichiers contenus dans l'archive. Vous pouvez spécifier une autre licence pour des fichiers spécifiques à l'aide d'un fichier packagemap dans l'archive. La licence doit faire partie de celles prises en charge. Nous ne tenons pas compte des licences non reconnues, et la valeur de licence est alors "inconnu".
<packagemap>	facultatif	Enfant de <file>. Nom du fichier packagemap contenu dans l'archive. Nous recommandons "PACKAGEMAP.xml". Si vous choisissez ce nom, nous détecterons automatiquement le fichier packagemap et vous n'aurez pas besoin de l'inclure ici. Sensible à la casse. Ce tag ne peut être utilisé que pour les entrées <file> lorsque la valeur de <type> est "archive".

Caractères d'échappement

Les espaces de début et de fin ne sont pas pris en compte. Le codage UTF-8 est obligatoire. Comme pour tous les fichiers XML, les valeurs de donnée (URL comprises) doivent utiliser des codes d'échappement pour les caractères répertoriés dans le tableau ci-après.

Caractère		Code d'échappement
Perluète	&	&
Apostrophe	'	'
Guillemets droits	"	"
Supérieur à	>	>
Inférieur à	<	<