Definizione del file packagemap di Google Ricerca Codici

Contenuti

Introduzione

Google Ricerca Codici consente agli utenti di eseguire ricerche nel Web per individuare archivi contenenti codice sorgente. Il nostro software individua i file di codice sorgente all'interno di tali archivi e rileva il linguaggio e la licenza. Come accade con una normale sitemap che consente di inviarci informazioni sulle pagine del tuo sito, un file packagemap può essere utilizzato per comunicarci il linguaggio e la licenza del codice sorgente nei file archivio.

Sintassi

[Contenuti]

Il codice è in XML. Ecco un esempio:

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

Nomi file

In una Sitemap Ricerca Codici, specifica il nome del file packagemap con il tag <packagemap>. Se non specifichi il file packagemap, controlleremo all'interno della directory principale dell'archivio per individuare i seguenti file e utilizzeremo il primo trovato:

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

Definizioni dei tag XML

I tag XML disponibili vengono descritti di seguito.

<fileset>	obbligatorio	Incapsula il file e fa riferimento agli standard del protocollo corrente.
<file>	obbligatorio	Derivato di <fileset>
<path>	obbligatorio	Derivato di <file>. Descrive il percorso del file all'interno dell'archivio. Fa distinzione tra maiuscole e minuscole; può contenere qualsiasi carattere.
<type>	obbligatorio	Derivato di <file>. Il valore può essere il nome di un linguaggio o "archivio". Tra gli esempi di nome di linguaggio vi sono: "C", "Python", "C#", "Java", "Vim". Non fa distinzione tra maiuscole e minuscole; "Java", "JAVA" e "java" si equivalgono. Il valore deve essere espresso in caratteri ASCII stampabili senza l'aggiunta di spazi. Il nome deve essere uno dei linguaggi supportati. Saranno indicizzati solo i file il cui linguaggio è supportato. Tutti gli altri file saranno ignorati. Puoi utilizzare il nome di un linguaggio non ancora supportato. Il file potrebbe venire indicizzato in futuro. Lo speciale valore "archivio" può essere utilizzato per un archivio all'interno di un archivio. Ciò risulta utile solo se questo archivio contiene codice sorgente. Poiché Google Ricerca Codici indicizza solo il codice sorgente, non è necessario aggiungere una voce per un archivio contenente solo testo, html, ecc.
<license>	opzionale	Derivato di <file>. Il valore deve essere il nome della licenza di copyright. Tra gli esempi vi sono: "GPL", "BSD", "Python", "disclaimer". Non fa distinzione tra maiuscole e minuscole; "LPGL", "Lgpl" e "lgpl" si equivalgono. Se <type> è "archivio", il valore di <license> è la licenza predefinita per i file dell'archivio. È possibile specificare una licenza diversa per file specifici con un file packagemap nell'archivio. La licenza deve essere una delle licenze supportate. Le licenze non riconosciute vengono ignorate e il valore della licenza viene indicato come "sconosciuto".
<packagemap>	opzionale	Derivato di <file>. Il nome del file packagemap all'interno dell'archivio. Consigliamo di utilizzare "PACKAGEMAP.xml". In questo caso, rileveremo automaticamente il file packagemap, che non dovrà quindi essere incluso in questo punto. Distinzione tra maiuscole e minuscole. Questo tag può essere utilizzato solo per voci <file> nelle quali il valore di <type> è "archivio".

Codici di escape per le entità

Gli spazi vuoti iniziali e finali sono ignorati. La codifica UTF-8 è obbligatoria. Analogamente a quanto accade con i file XML, tutti i valori dei dati (inclusi gli URL) devono utilizzare codici di escape per i caratteri elencati nella seguente tabella.

Carattere		Codice di escape
E commerciale	&	&
Virgolette semplici	'	'
Virgolette doppie	"	"
Maggiore di	>	>
Minore di	<	<