Índice
Descripción general
Sintaxis
Google Code Search permite a los usuarios buscar archivos en la Web que contengan código fuente. Nuestro software localiza los archivos de código fuente almacenados y detecta el lenguaje y la licencia. De la misma manera que usted puede utilizar un Sitemap normal para facilitarnos información sobre las páginas de su sitio, también puede utilizar un archivo packagemap para indicarnos el lenguaje y la licencia del código fuente de sus archivos.
El código está en XML. A continuación se muestra un ejemplo:
<?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>
Nombres de archivo
En un Sitemap de Code Search, especifique el nombre del packagemap con la etiqueta <packagemap>. Si no especifica un archivo packagemap, comprobaremos el directorio principal almacenado para buscar archivos y utilizaremos el primero que encontremos:
- PACKAGEMAP.XML
- PACKAGEMAP.xml
- Packagemap.xml
- packagemap.xml
- PACKAGEMAP
- Packagemap
- packagemap
Definiciones del código XML
Las etiquetas XML disponibles se describen a continuación.
<fileset> |
obligatorio |
Encapsula el archivo y hace referencia al protocolo estándar actual. |
<file> |
obligatorio |
Dependiente del juego de archivos <> |
<path> |
obligatorio |
Dependiente del <archivo>. Describe la ruta de archivo almacenado. Distingue entre mayúsculas y minúsculas y puede contener cualquier carácter. |
<type> |
obligatorio |
Dependiente del <archivo>. El valor puede ser un nombre de lenguaje o "archivo". Ejemplos de nombre de lenguaje: "C", "Python", "C#", "Java" o "Vim".
No distingue mayúsculas de minúsculas; "Java" "JAVA" y "java" son equivalentes.
El valor debe expresarse en caracteres ASCII imprimibles sin espacios en blanco.
El nombre debe ser de uno de los lenguajes compatibles.
Solo se indexarán los archivos con lenguajes compatibles. El resto de archivos se ignorará. Puede utilizar un nombre de lenguaje que aún no sea compatible, y quizá Google indexe el archivo más adelante.
El valor especial "archivo" se puede utilizar para archivos dentro de archivos. Solo resultará útil en caso de que este archivo contenga código fuente.
Como Code Search indexa solamente el código fuente, no es necesario añadir una entrada para cualquier archivo que contenga solo texto, html, etc. |
<license> |
opcional |
Dependiente del <archivo>. El valor debe ser el nombre de la licencia de copyright. Ejemplos: "GPL", "BSD", "Python", "disclaimer".
No distingue mayúsculas de minúsculas; "LGPL" "Lgpl" y "lgpl" son equivalentes.
Cuando el <tipo> sea "archivo", el valor de <licencia> es la licencia predeterminada de los archivos almacenados en ese archivo. Se puede especificar una licencia diferente para archivos concretos con un packagemap en el archivo.
La licencia debe ser de una de las licencias admitidas. Google ignora las licencias desconocidas y nombra el valor de la licencia como "desconocida". |
<packagemap> |
opcional |
Dependiente del <archivo>. El nombre del archivo packagemap almacenado. Recomendamos "PACKAGEMAP.xml". En este caso, detectamos automáticamente el archivo packagemap, así que no es necesario que lo incluya aquí.
Distingue entre mayúsculas y minúsculas.
Esta etiqueta se puede utilizar para entradas de <archivo> en los que el valor <tipo> es "archivo". |
Caracteres de escape de entidad
Se ignoran los espacios en blanco a inicio y final de la palabra. La codificación UTF-8 es obligatoria. Al igual que con todos los archivos XML, los valores de datos (incluidas las URL) deben utilizar caracteres de escape de entidad para los caracteres de la tabla que encontrará más abajo.
| Carácter |
Código con caracteres de escape |
| Símbolo de unión |
& |
& |
| Comillas simples |
' |
' |
| Comillas |
" |
" |
| Mayor que |
> |
> |
| Menor que |
< |
< |
