Определение файла packagemap для службы Поиск кода Google

Содержание

Общая информация

Поиск кода Google дает пользователям возможность искать в Интернете архивы с исходным кодом. Наше программное обеспечение находит файлы с исходным кодом в этих архивах, определяя язык и лицензию. Обычный файл Sitemap дает нам представление о страницах вашего сайта. Аналогичным образом используется и файл packagemap, в котором записана информация о языке и лицензии исходного кода архивных файлов.

Синтаксис

[Содержание]

Здесь используется язык XML. Вот пример кода.

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

Имена файлов

В файле Sitemap Поиска кода укажите имя файла packagemap с тегом <packagemap>. Если файл packagemap не будет указан, мы проверим наличие в корневом каталоге архива следующих файлов и используем первый из найденных:

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

Определения тегов XML

Ниже приводится описание доступных тегов XML.

<fileset>	обязательный тег	Формирует файл, включая сведения о ссылках на текущий стандарт протокола.
<file>	обязательный тег	Дочерний тег тега <fileset>
<path>	обязательный тег	Дочерний тег тега <file>. Описывает путь к файлу в архиве. Чувствителен к регистру; может содержать любые символы.
<type>	обязательный тег	Дочерний тег тега <file>. В качестве значения используется название языка или "archive". Примеры названий языков: "C", "Python", "C#", "Java", "Vim". Регистр при этом не учитывается. Значения "Java", "JAVA" и "java" считаются эквивалентными. Данное значение должно состоять из печатаемых символов ASCII без пробелов. Название должно относиться к одному из поддерживаемых языков. Мы индексируем только файлы, написанные на поддерживаемом языке. Все остальные файлы будут игнорироваться. Можно выбрать название языка, который мы пока не поддерживаем, и файл, возможно, попадет в индекс в будущем. Особое значение "archive" используется тогда, когда в одном архиве содержится другой. Это полезно лишь в том случае, если этот архив содержит исходный код. Поскольку служба Поиск кода индексирует лишь исходный код, добавлять запись для архива, в котором имеется только текст, код html и тому подобное, нет необходимости.
<license>	необязательный тег	Дочерний тег тега <file>. В качестве значения используется имя лицензионного соглашения. Вот несколько примеров: "GPL", "BSD", "Python", "disclaimer". Регистр при этом не учитывается. Значения "LPGL", "Lgpl" и "lgpl" считаются эквивалентными. Если тегу <type> присвоено значение "archive", в качестве значения тега <license> выбирается лицензия, указанная по умолчанию для файлов в архиве. Если для некоторых файлов используется другая лицензия, это можно указать в файле packagemap в архиве. Лицензия должна относиться к числу поддерживаемых. Мы игнорируем нераспознанные лицензии, присваивая им значение "unknown" ("неизвестная").
<packagemap>	необязательный тег	Дочерний тег тега <file>. Имя файла packagemap в архиве. Рекомендуется использовать формат "PACKAGEMAP.xml". В этом случае файл packagemap будет обнаружен автоматически, и его не надо будет сюда включать. Чувствителен к регистру. Этот тег можно применять только в записях с тегом <file>, в которых тегу <type> присвоено значение "archive".

Маскирование элементов

Пробелы в начале и в конце игнорируются. Использование кодировки UTF-8 обязательно. Во всех файлах XML для любых значений данных (включая URL) необходимо применять коды маскирования элементов при использовании символов, перечисленных ниже в таблице.

Символ		Маскирование
Амперсанд	&	&
Одинарные кавычки	'	'
Двойные кавычки	"	"
Больше чем	>	>
Меньше чем	<	<