Definição do arquivo packagemap da Pesquisa de Código do Google

Índice

Visão geral

A Pesquisa de Código do Google permite que os usuários procurem na web arquivamentos que contenham código-fonte. Nosso software localiza os arquivos de código-fonte nesses arquivamentos e detecta a linguagem e a licença. Assim como é possível usar um sitemap normal para fornecer informações sobre as páginas do seu site, você pode usar um arquivo packagemap para informar a linguagem e a licença do código-fonte dos seus arquivos de arquivamento.

Sintaxe

[Índice]

O código está em XML. Veja um exemplo:

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

Nomes de arquivo

Em um sitemap da Pesquisa de código, especifique o nome do arquivo packagemap com a tag <packagemap>. Se você não especificar o arquivo packagemap, vamos verificar o diretório superior do arquivamento para procurar os seguintes arquivos e usar o primeiro que for encontrado:

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

Definições de tag em XML

As tags XML disponíveis estão descritas abaixo.

<fileset>	obrigatório	Executa o encapsulamento do arquivo e faz referência ao padrão de protocolo atual.
<file>	obrigatório	Filha de <fileset>
<path>	obrigatório	Filha de <file>. Descreve o caminho do arquivo no arquivamento. Diferencia maiúsculas e minúsculas; pode conter qualquer caractere.
<type>	obrigatório	Filha de <file>. O valor pode ser um nome de linguagem ou "archive". Veja alguns exemplos de nome de linguagem: "C", "Python", "C#", "Java", "Vim". Não há diferença entre maiúsculas e minúsculas; "Java", "JAVA" e "java" são equivalentes. O valor deve ser caracteres ASCII imprimíveis, sem espaços em branco. O nome deve ser uma das linguagens suportadas. Somente arquivos com uma linguagem suportada são indexados. Todos os outros arquivos são ignorados. Você pode usar um nome de idioma para o qual ainda não oferecemos suporte e o arquivo pode ser indexado futuramente. O "archive" de valor especial pode ser usado para um arquivamento dentro de um arquivamento. Isso é útil apenas se esse arquivamento tiver o código-fonte. Como a Pesquisa de Código indexa somente códigos-fonte, não é necessário adicionar nenhuma entrada para nenhum arquivamento que contém somente texto, HTML, etc.
<license>	opcional	Filha de <file>. O valor de ser o nome da licença de direitos autorais. Exemplos: "GPL", "BSD", "Python", "disclaimer". Não há diferença entre maiúsculas e minúsculas; "LGPL", "Lgpl" e "lgpl" são equivalentes. Quando <type> é "archive", o valor de <license> é a licença padrão dos arquivos no arquivamento. Uma licença diferente pode ser especificada para arquivos específicos com um packagemap no arquivamento. A licença deve ser uma das licenças suportadas. Ignoramos licenças não reconhecidas e listamos o valor da licença como "desconhecida".
<packagemap>	opcional	Filha de <file>. O nome do arquivo packagemap dentro do arquivamento. Recomendamos "PACKAGEMAP.xml". Nesse caso, o arquivo packagemap vai ser detectado automaticamente; não é necessário incluí-lo aqui. Diferencia maiúsculas e minúsculas. Essa tag pode ser usada somente para as entradas <file> quando o valor de <type> for "archive".

Escape de entidade

Os espaços em branco inicial e final são ignorados. A codificação UTF-8 é obrigatória. Assim como em todos os arquivos XML, quaisquer valores de dados (inclusive os URLs) devem usar códigos de escape de entidade para os caracteres listados na tabela abaixo.

Caractere		Código de escape
E comercial	&	&
Aspas simples	'	'
Aspas duplas	"	"
Maior que	>	>
Menos que	<	<