Типы списков

1. Описание типов списков

1.1 Словарь (eWordListType_Dictionary, “Dictionary”)

Основной список словарей – содержит заголовки статей (при необходимости –  с сопутствующей информацией, задаваемой вариантами написания) и предназначен для отображения и подмотки к наиболее похожим словам. Обычно сортирован (либо по алфавиту, либо с помощью ключей сортировки). Может быть иерархическим – например, в английском словаре, содержать папку “set” с отдельными статьями для разных частей речи внутри.

1.2 Каталог (eWordListType_Catalog, “Catalog”)

Каталог (разговорник) – отображаемый список, содержащий разделенные по категориям статьи, т.е. основное его назначение – группировка основных статей словаря по темам. Например:

• группировка фраз по различным областям их употребления в разговорниках;
• группировка грамматических правил по темам или частям речи в базах грамматики;

1.3 Дополнительная информация (eWordListType_AdditionalInfo, “AdditionalInfo”)

Дополнительные информационные статьи – информация о провайдере, статьи об обозначениях в словаре, таблицы фонетики и другая справочная информация. Также может содержать иерархию для группировки разрозненной информации.

1.4 Результаты поиска (eWordListType_RegularSearch)

Cписок с результатами поиска – в базу не зашивается: создается в рантайме и является выборкой статей, соответствующих введенному поисковому запросу. Является результатом работы функций продвинутого поиска (поиска по шаблону, полнотекстового поиска, etc.), но не базовой подмотки. Элементы списка являются ссылками на оригинальные записи других списков.

1.5 Озвучка (eWordListType_Sound, “Sound”)

Список слов с озвучкой – содержит набор заголовков, к которым привязаны звуковые файлы. Сами заголовки выполняют роль поисковых ключей и потому могут быть как просто озвучиваемым текстом (самый распространенный случай) так и любым другим текстовым ключом.  В этом случае формат ключа должен быть известен заранее – он обычно задается метаданными в тексте статьи другой словарной базы. При этом для более тонкий привязки допускается использование необходимых вариантов написания. Сам список обычно используется в звуковых базах и не встречается в словарных, и в силу сервисного назначения звуковой базы – не отображается.

1.6 Полнотекстовый поиск (eWordListType_FullTextSearchBase, “FullTextSearch_…”)

Списки полнотекстового поиска – заранее подготовленные (и обычно тематические – см. ниже в этом разделе) индексы для быстрого поиска слов в тексте статей, им посвящен отдельный раздел.

Для полнотекстового поиска отведено несколько диапазонов. Предполагается, что при индексировании контента используется информация о семантическом назначении блоков статьи (отклонение от этого считается warning-ом):

• базовый полнотекстовый поиск (диапазон [eWordListType_FullTextSearchBase, eWordListType_FullTextSearchBase+0x0F], “FullTextSearch”)
• поиск по заголовкам статей (диапазон [eWordListType_FullTextSearchHeadword, eWordListType_FullTextSearchHeadword+0x0F], “FullTextSearch_Headword”)
• поиск по контенту – без дополнительного разделения на семантические типы (переводы, примеры, etc.) внутри; таким образом, в этот индекс могут попадать и заголовки статей, дублируя содержание поиска по заголовкам. По наполнению список похож на базовый полнотекстовый поиск и отличается лишь в сочетаниях с остальными списками: базовый поиск обычно является единственным полнотекстовым индексом, а поиск по контенту часто создается в дополнение к поиску по заголовкам (диапазон [eWordListType_FullTextSearchContent, eWordListType_FullTextSearchContent+0x0F], “FullTextSearch_Content”)
• поиск по переводам ([eWordListType_FullTextSearchTranslation, eWordListType_FullTextSearchTranslation+0x0F], “FullTextSearch_Translation”)
• поиск по примерам ([eWordListType_FullTextSearchExample, eWordListType_FullTextSearchExample+0x0F], “FullTextSearch_Example”)
• поиск по определениям ([eWordListType_FullTextSearchDefinition, eWordListType_FullTextSearchDefinition+0x0F], “FullTextSearch_Definition”)
• поиск по фразам ([eWordListType_FullTextSearchPhrase, eWordListType_FullTextSearchPhrase+0x0F], “FullTextSearch_Phrase”)
• поиск по идиомам ([eWordListType_FullTextSearchIdiom, eWordListType_FullTextSearchIdiom+0x0F], “FullTextSearch_Idiom”)

1.7 Скрытый список (eWordListType_Hidden, “Hidden”)

Обычно содержит набор записей, которые не являются самостоятельными – перейти на них можно по ссылкам из других списков (из текста статей или при обращении к записям списка). При этом список может быть как условно отображаемым (например, для него не будет отдельной вкладки в UI приложения, но из него будут выбираться отображаемые результаты поиска), так и полностью скрытым (в этом случае отображаемым контентом являются тексты статей, а элементы самого скрытого списка нужны для корректного к ним доступа).

Используется для:

• хранения статьей с отображаемой информацией – например, с биографиями людей, со списком примеров к конкретному слову в словаре. Ссылки на эти статьи могут встречаться в самом словаре не будут ничем отличаться от ссылок на статьи в других словарных списках;
• хранения полного списка производных форм (см. список базовых форм) – в этом случае записи списка могут не ссылаться на текст статей;
• хранения списка результатов поиска (не полнотекстового);
• (deprecated) как вспомогательный список для полнотекстового поиска (в базах старой генерации – v.104 build 53 и ранее). В этом случае он содержит несколько вариантов написания. Структурно и по назначению полностью соответствует актуальному аналогу – списку с контекстом поиска (FullTextAuxiliary)

1.8 Список поисковых запросов (eWordListType_DictionaryForSearch, “DictionaryForSearch”)

Список пресетов полнотекстового поиска, т.е. это отображаемый (в отличие от списков полнотекстового поиска) индекс, каждая запись которого является допустимым поисковым запросом. Поиск по такому запросу должен выдавать набор результатов (в т.ч. – из разных списков) по аналогии с полнотекстовым поиском.

1.9 Список базовых форм (eWordListType_MorphologyBaseForm, “MorphologyBaseForm”)

Морфологический список, который содержит базовые формы слов, ссылающиеся на их возможные словоформы – т.е. в дополнение к нему в базе должен существовать список, содержащий все необходимые словоформы для заданных базовых форм (обычно такой список требуется формировать дополнительно).

1.10 Список производных форм (eWordListType_MorphologyInflectionForm, “MorphologyInflectionForm”)

Морфологический список, который содержит все возможные словоформы (то есть и базовые формы, и производные), которые ссылаются на свои базовые формы. Список базовых форм при этом может как формироваться отдельно, так и быть обычным словарным списком (зачастую его записи – как раз базовые формы слов).

1.11 Грамматические тесты (eWordListType_GrammaticTest, “GrammaticTest”)

Предназначен для хранения грамматических тестов (одного вида поддерживаемых тестов или quiz-ов) – статей, содержимым которых является, например, вопрос “выберите правильный вариант ответа”, “введите ответ” и т.п. Статьи в списке могут объединяться в папки для группировки вопросов по темам. Сам список может быть как отображаемым, так и скрываться после начала теста (определяется требованиями к финальному приложению).

1.12 Специальные списки доп.информации (eWordListType_SpecialAdditionalInfoBase, “SpecialAdditionalInfo_[0…255]”

Списки из этого диапазона предназначены для хранения статей с разнообразной доп.информацией как для пользователей (к примеру, грамматическими правилами), так и для работы некоторых фич приложения (например, кастомной навигации).

Использование отдельного диапазона позволяет правильно идентифицировать список и отображаться его отдельно от остальных доп.статей или  привязать логику работы именно к его записям.

1.13 Объединенный список нескольких языков (eWordListType_MergedDictionary, “MergedDictionary”)

Объединенный словарный список слов, в котором есть слова из обоих направлений (прямого и обратного); содержит коды языков заголовков для отличия слов одного языка от другого (например, для разной визуализации).

1.14 Специальные списки для интерактивного функционала (eWordListType_SpecialAdditionalInteractiveInfoBase, “SpecialAdditionalInteractiveInfo_[0…255]”)

Диапазон списков, которые хранят разные наборы статей, используемые в различных интерактивных фичах приложения. Т.е. статьи не просто отображаются статически, но предоставляют разметку для фич, требующих активности пользователя. Например:

• тренировка практики произношения – в этом случае в тексте статей словарного списка делаются ссылки на SpecialAdditionalInteractiveInfo-список, содержащий вспомогательные статьи с placeholder-ами для кнопок записи/проигрывания озвучки
• информация о записях другого словаря для настройки межсловарного взаимодействия

1.15 Морфологические статьи (eWordListType_MorphologyArticles, “MorphologyArticles”)

Этот список предназначен для хранения статей с морфологической информацией. Например:

• в L School это небольшие таблицы, содержащие формы единственного и множественного числа (для существительных) или формы первого лица, единственного числа разных времен (для глаголов);
• в Duden D1 (auf. 26) в таблицах указана часть речи слова и его словоформы

Список обычно не отображается, доступ к его записям (и статьям, на которые они ссылаются) осуществляется через ссылки в начале основных словарных статей (для работы с ними приложение использует CSldDictionary::GetArticleLinks).

1.16. Настройки скрываемых блоков (eWordListType_ArticlesHideInfo, “ArticlesHideInfo”)

Список, содержащий статью (при необходимости – несколько статей), на примере которой настраивается отображение скрываемых блоков (hide, switch) в статьях. Т.е. статьи этого списка в совокупности содержат все виды регулируемых настройками приложения скрываемых блоков. Посредством настройки в специальном меню (приложение для этого меню реализует кастомную логику работы со скрываемыми блоками в тексте статей) выбирается требуемое представление блоков в других словарных статьях.

1.17 Лингвистические игры (eWordListType_GameArticles, “GameArticles”)

Список, содержащий каталог со статьями лингвистических игр – “Подберите определение к картинке”, “Виселица” и т.п.

Точное содержимое списка, логика использования и компоновки этих данных (они могут содержать тексты вопросов и подсказок, связь изображений с правильными ответами или просто набор слов, участвующих в тесте) определяется приложением и требованиями к конкретной игре.

1.18 Флэш-карточки (лицевая сторона) (eWordListType_FlashCardsFront, “FlashCardsFront”)

Список используется для хранения лицевых сторон (“вопросов”) встроенных в базу флеш-карточек. Соответствие оригинальных статей (из словарного списка) и записи списка флэш-карточек обеспечивается привязкой через специальный вид ссылок (доступны приложению через CSldDictionary::GetArticleLinks).

1.19 Флэш-карточки (обратная сторона) (eWordListType_FlashCardsBack, “FlashCardsBack”)

Список используется для хранения обратных сторон (“ответов”) встроенных в базу флеш-карточек. Соответствие оригинальных статей (из словарного списка) и записи списка флэш-карточек обеспечивается привзкой через специальный вид ссылок (доступны приложению через CSldDictionary::GetArticleLinks).

1.20 Демо статьи (eWordListType_InApp, “InApp”)

Список, содержащий доступные для просмотра записи и статьи демо базы.

1.21 Контекст поиска (eWordListType_FullTextAuxiliary, “FullTextAuxiliary”)

Вспомогательный список для полнотекстового поиска – хранит набор возможных результатов полнотекстового поиска: в базе основной FTS-индекс (см. полнотекстовый поиск) ссылается на набор записей данного списка, которые являются результатами поиска по одному из слов (детали индексирования рассмотрены в этой статье). В процессе работы приложения записи списка с результатами поиска (eWordListType_RegularSearch) ссылаются на этот список.

Структурно обычно состоит из набора следующих вариантов написания:

• Show – заголовка статьи
• Phrase – фразы, в которой встретилось слово
• Label – метки в статье, к которой нужно подмотаться при открытии результата полнотекстового поиска (месту расположения фразы)

1.22 Всплывающие статьи (eWordListType_PopupArticles, “PopupArticles”)

Список, содержащий всплывающие статьи. Сам по себе не является отображаемым, его статьи (представляющие собой обычно расшифровки аббревиатур или аналогичный книжным сноскам текст) доступны по специальным ссылкам из других статей.

1.23 Сортированный индекс (eWordListType_SimpleSearch)

Этот список генерится автоматически при сборке словарной базы для любого несортированного списка или списка сортированного не по Show-варианту (в т.ч. для списков, содержащих иерархию). Структурно представляет собой сортированный по Show-варианту список, хранящий индексы слов из базового, несортированного списка. Оболочки могут игнорировать этот список, так как он нужен только для выполненя функций поиска и обращения к нему происходят автоматически.

1.24 “О пользовании словарём” (eWordListType_DictionaryUsageInfo, “DictionaryUsageInfo”)

Список, содержащий информацию о пользовании словарем (help). В силу того, что подобная информация может отличаться для разных платформ (как по количеству, так и по наполнению статей) список предполагает хранение наборов статей для разных платформ в разных элементах иерархии.

1.25 Кастомный список (eWordListType_CustomList)

Создается в рантайме на основе другого списка и предназначен для альтернативного варианта отображения его записей.

Например, каталог (eWordListType_Catalog) содержит распределенные по папкам статьи и нужно вместо навигации с заходом внутрь папки (и скрытием родительского уровня) предоставить возможность отображать иерархию каталога в виде древовидной структуры с отступами. В этом случае на базе оригинального каталога создается tree-view представление его иерархии и уже кастомный список хранит текущее количество отображаемых элементов, набор открытых папок и т.п.

1.26 Нумерация страниц (eWordListType_PageNumerationIndex, “PageNumerationIndex”)

Список, содержащий соответствие словарной статьи и пронумерованных страниц (реализуемых через метки) в ее тексте. Используется в случаях, когда текст словарной статьи достаточно велик (и/или нужно структурно сделать его похожим на многостраничную статью книги), требует доступа в определенные части, а возможности разделить статью на несколько нет.

1.27 Бинарные ресурсы (eWordListType_BinaryResource, “BinaryResource”)

Список бинарных ресурсов, содержащихся в базе – используется для загрузки ресурсов по обращению из внешней базы.

1.28 Приоритеты внешних ресурсов (eWordListType_ExternResourcePriorityFirst, “ExternResourcePriority_[0…15]”)

Приоритезированный (по убыванию; First или 0 считается высшим приоритетом, Last или 15 – низшим) набор списков с проиндексированными внешними ресурсами, которые должны загружаться в первую очередь. Содержится в основной базе и используется для подкачивания необходимых ресурсов (логика обработки приоритетов содержится на стороне приложения).

1.29 DictID внешних баз (eWordListType_ExternBaseName, “ExternBaseName”)

Список имен баз, в которых содержатся внешние ресурсы – используется для оценки набора необходимых для работы вспомогательных баз (в т.ч. – для скачивания их приложением), так и непосредственно для открытия этих баз с целью получения ресурсов.

1.30 Строки метаданных (eWordListType_StructuredMetadataStrings)

Список строковых значений в структурированных метаданных – создается автоматически при сборке словарной базы, используется логикой словарного движка при построении текста перевода статьи

1.31 Строки CSS (eWordListType_CSSDataStrings)

Список строковых значений в css метаданных – создается автоматически при сборке словарной базы, используется логикой словарного движка при построении текста перевода статьи

1.32 Шаблоны статей (eWordListType_ArticleTemplates, “ArticleTemplates”)

Список шаблонов для статей.

1.33 Вспомогательный поисковый список (eWordListType_AuxiliarySearchList, “AuxiliarySearchList”)

Этот список используется в мультиязычных словарных базах и содержит соответствие поискового ключа для языка текущего списка (например, “яблоко” в русском списке и “apfel” в немецком) и универсального поискового ключа базы (“apple”, если универсальные поисковые ключи – SourceSortKey – английские). Используется при поиске статей в мультиязычных базах, за счет трансляции текущего ключа в универсальный поиск не зависит от выбранной локали.

1.34 Справочник (eWordListType_Enchiridion, “Enchiridion”)

Список, содержащий справочную информацию.

1.35 Слово дня (eWordlistType_WordOfTheDay, “WordOfTheDay”)

Список содержит набор статей, которые используются в рамках фичи “слово дня” (отображение одной избранной статьи ежедневно). В зависимости от требований к отображению слова дня, список может как содержать ссылки на сами отображаемые статьи, так и набор необходимой для вёрстки информации в вариантах написания (в этом случае вёрстка страницы со словом дня происходит отдельно) и связь с оригинальными статьями.

1.36 Предустановленное избранное (eWordlistType_PreloadedFavourites, “PreloadedFavourites”)

Список набор статей, которые должны находиться в списке избранного сразу после установки приложения. Может содержать иерархию – в этом случае список может быть по смыслу похож на разговорник (набор тематических категорий, по которым распределены статьи словаря). Записи предустановленного избранного указывают на оригинальные статьи из словарного списка.

1.37 Пользовательский список (eWordListType_SwissKnifeList)

Пользовательский список создается в процессе работы приложения и предназначен для хранения указанного набора записей словаря с возможностью группировки по папкам (как изначально существующим в словаре, так и создающимся “на лету”).

Используется например для реализации функционала избранного в приложении: при первом запуске на основе пользовательский список заполняется на основе списка предустановленного избранного. Далее в процессе работы в него добавляются новые статьи словаря, отмечаемые как избранные. При этом в произвольном месте иерархии (как на корневом, так и на вложенных уровнях) могут создаваться папки (имена папок произвольные и вводятся пользователем) и добавляемые статьи распределяются по этим папкам. По окончании сессии содержимое списка сериализуется и десериализуется в начале следующей сессии работы со словарем. При этом пользовательский список предоставляет нативный (с точки зрения работы словарного ядра) способ работы с записями внутри (получение текста, поиск и т.п.).

2. Информация для разработчиков приложений

/// Перечисление вариантов предназначения списков слов.
enum EWordListTypeEnum
{
    /// неизвестный - ошибка
    eWordListType_Unknown = 0,
    /// Словарь
    eWordListType_Dictionary,
    /// Каталог (разговорник); содержит иерархический список статей
    eWordListType_Catalog,
    /// Дополнительные информационные статьи - информация о провайдере, статьи об обозначениях в словаре, различные таблицы
    eWordListType_AdditionalInfo,
    /// Cписок с результатами поиска
    eWordListType_RegularSearch,
    /// Список слов с озвучкой
    eWordListType_Sound,
    /// Начало диапазона полнотекстовых поисковых списков
    eWordListType_FullTextSearchBase = 0x100,
    /// Список полнотекстового поиска по заголовка
    eWordListType_FullTextSearchHeadword = 0x110,
    /// Список полнотекстового поиска по всему контенту статьи
    eWordListType_FullTextSearchContent = 0x120,
    /// Список полнотекстового поиска по переводам
    eWordListType_FullTextSearchTranslation = 0x130,
    /// Список полнотекстового поиска по примерам
    eWordListType_FullTextSearchExample = 0x140,
    /// Список полнотекстового поиска по определениям
    eWordListType_FullTextSearchDefinition = 0x150,
    /// Список полнотекстового поиска по фразам
    eWordListType_FullTextSearchPhrase = 0x160,
    /// Список полнотекстового поиска по идиомам
    eWordListType_FullTextSearchIdiom = 0x170,
    /// Конец диапазона полнотекстовых поисковых списков
    eWordListType_FullTextSearchLast = 0x1FF,
    /// Скрытый список слов (не отображаемый)
    /// Обычно содержит статьи с дополнительной информацией, перейти на которые можно по ссылкам из других списков;
    /// Используется для:
    /// 1) хранения статьей с отображаемой информацией - биографиями людей, со списком примеров к конкретному слову в словаре;
    /// ссылки на эти статьи могут встречаться в самом словаре (ссылка на статью в этом списке ничем не отличается от ссылок на статьи в словарных списках)
    /// 2) как вспомогательный список для полнотекстового поиска (в базах старой генерации - v.104 build 53 и ранее);
    /// в этом случае он содержит несколько вариантов написания (см. EListVariantTypeEnum) -
    /// с их помощью кроме самой найденной статьи можно, например, узнать:
    /// - фразу, в которой встретилось слово
    /// - метку в статье, на которую нужно перейти
    /// - часть речи
    eWordListType_Hidden,
    /// Список пресетов полнотекстового поиска(см. CSldDictionaryHelper::SearchForDictionaryForSearchList())
    eWordListType_DictionaryForSearch,
    /// Морфологический список, который содержит базовые формы слов, ссылающиеся на их возможные словоформы
    eWordListType_MorphologyBaseForm,
    /// Морфологический список, который содержит все возможные словоформы (то есть и базовые формы, и производные), которые ссылаются на свои базовые формы
    eWordListType_MorphologyInflectionForm,
    /// Грамматические тесты
    eWordListType_GrammaticTest,
    /// Начало диапазона специальных списков слов с доп. статьями
    eWordListType_SpecialAdditionalInfoBase = 0x300,
    /// Конец диапазона специальных списков слов с доп. статьями
    eWordListType_SpecialAdditionalInfoLast = 0x3FF,
    /// Объединенный словарный список слов (не каталог), в котором есть слова из обоих направлений (прямого и обратного).
    /// Коды языков направлений хранятся в соответствующих полях заголовка списка слов: LanguageCodeFrom и LanguageCodeTo.
    eWordListType_MergedDictionary,
    /// Начало диапазона специальных списков слов с интерактивными доп. статьями (которые можно просматривать из различных GUI-элементов)
    eWordListType_SpecialAdditionalInteractiveInfoBase = 0x500,
    /// Конец диапазона специальных списков слов с интерактивными доп. статьями
    eWordListType_SpecialAdditionalInteractiveInfoLast = 0x5FF,
    /// Морфологический список, содержащий статьи с морфологической информацией, например, таблицы словоформ (аналог eWordListType_Dictionary)
    eWordListType_MorphologyArticles,
    /// Список, содержащий статьи, на примере которых настраивается отображение скрываемых блоков в статьях
    eWordListType_ArticlesHideInfo,
    /// Список, содержащий каталог со статьями лингвистических игр
    eWordListType_GameArticles,
    /// Список, содержащий лицевые стороны встроенных в базу флеш-карточек
    eWordListType_FlashCardsFront,
    /// Список, содержащий обратные стороны встроенных в базу флеш-карточек
    eWordListType_FlashCardsBack,
    /// Список, содержащий избранные статьи InApp базы
    eWordListType_InApp,
    /// Вспомогательный список для полнотекстового поиска
    /// т.е. список с результатами полнотекстового поиска может ссылаться на этот список
    eWordListType_FullTextAuxiliary,
    /// Список, содержащий основной учебный материал в учебнике
    eWordListType_TextBook,
    /// Список, содержащий тесты к учебному материалу
    eWordListType_Tests,
    /// Список, содержащий предметный указатель учебного материала
    eWordListType_SubjectIndex,
    /// Список, содержащий всплывающие статьи
    eWordListType_PopupArticles,
    /// Сортированный по Show варианту вспомогательный список для несортированных списков
    eWordListType_SimpleSearch,
    /// Список, содержащий информацию о пользовании словарем(help)
    eWordListType_DictionaryUsageInfo,
    /// Пользовательский список
    eWordListType_CustomList,
    /// Список, содержащий ссылки на слайдшоу
    eWordListType_SlideShow,
    /// Список, содержащий карты
    eWordListType_Map,
    /// Список, содержащий КЭСы
    eWordListType_KES,
    /// Список, содержащий ФП
    eWordListType_FC,
    /// Список, содержащий AtomicObject-ы
    eWordListType_Atomic,
    /// Список, содержащий индекс нумерации страниц
    eWordListType_PageNumerationIndex,
    /// Список бинарных ресурсов, содержащихся в базе
    eWordListType_BinaryResource,
    /// Список, с проиндексированными внешними ресурсами, которые должны загружаться в первую очередь
    /// Далее идет диапазон списков, соответсвующий приоритету загрузки ресурсов из внешних баз
    eWordListType_ExternResourcePriorityFirst,
    /// Список, с проиндексированными внешними ресурсами, которые должны загружаться в последнюю очередь
    eWordListType_ExternResourcePriorityLast = eWordListType_ExternResourcePriorityFirst + 0xF,
    /// Список имен баз, в которых содержаться внешние ресурсы
    eWordListType_ExternBaseName,
    /// Список строковых значений в структурированных метаданных
    eWordListType_StructuredMetadataStrings,
    /// Список строковых значений в css метаданных
    eWordListType_CSSDataStrings,
    /// Список шаблонов для статей
    eWordListType_ArticleTemplates,
    /// Вспомогательный поисковый список
    eWordListType_AuxiliarySearchList,
    /// Список, содержащий справочную информацию
    eWordListType_Enchiridion,
    /// Список для информации страницы Word of the Day (OALD10)
    eWordlistType_WordOfTheDay,
    /// Список предустановленного избранного
    eWordlistType_PreloadedFavourites,
    /// Пользовательский список, поддерживающий разный типы слов
    eWordListType_SwissKnifeList
};
 
/// Чтобы получить тип списка, используем метод класса CSldListInfo
 
    /// Возвращает код использования данного списка слов, т.е. для каких действий
    /// он предназначен
    ESldError CSldListInfo::GetUsage(UInt32 *aUsage) const;

/// Перечисление вариантов предназначения списков слов.

enum EWordListTypeEnum

{

/// неизвестный - ошибка

eWordListType_Unknown = 0,

/// Словарь

eWordListType_Dictionary,

/// Каталог (разговорник); содержит иерархический список статей

eWordListType_Catalog,

/// Дополнительные информационные статьи - информация о провайдере, статьи об обозначениях в словаре, различные таблицы

eWordListType_AdditionalInfo,

/// Cписок с результатами поиска

eWordListType_RegularSearch,

/// Список слов с озвучкой

eWordListType_Sound,

/// Начало диапазона полнотекстовых поисковых списков

eWordListType_FullTextSearchBase = 0x100,

/// Список полнотекстового поиска по заголовка

eWordListType_FullTextSearchHeadword = 0x110,

/// Список полнотекстового поиска по всему контенту статьи

eWordListType_FullTextSearchContent = 0x120,

/// Список полнотекстового поиска по переводам

eWordListType_FullTextSearchTranslation = 0x130,

/// Список полнотекстового поиска по примерам

eWordListType_FullTextSearchExample = 0x140,

/// Список полнотекстового поиска по определениям

eWordListType_FullTextSearchDefinition = 0x150,

/// Список полнотекстового поиска по фразам

eWordListType_FullTextSearchPhrase = 0x160,

/// Список полнотекстового поиска по идиомам

eWordListType_FullTextSearchIdiom = 0x170,

/// Конец диапазона полнотекстовых поисковых списков

eWordListType_FullTextSearchLast = 0x1FF,

/// Скрытый список слов (не отображаемый)

/// Обычно содержит статьи с дополнительной информацией, перейти на которые можно по ссылкам из других списков;

/// Используется для:

/// 1) хранения статьей с отображаемой информацией - биографиями людей, со списком примеров к конкретному слову в словаре;

/// ссылки на эти статьи могут встречаться в самом словаре (ссылка на статью в этом списке ничем не отличается от ссылок на статьи в словарных списках)

/// 2) как вспомогательный список для полнотекстового поиска (в базах старой генерации - v.104 build 53 и ранее);

/// в этом случае он содержит несколько вариантов написания (см. EListVariantTypeEnum) -

/// с их помощью кроме самой найденной статьи можно, например, узнать:

/// - фразу, в которой встретилось слово

/// - метку в статье, на которую нужно перейти

/// - часть речи

eWordListType_Hidden,

/// Список пресетов полнотекстового поиска(см. CSldDictionaryHelper::SearchForDictionaryForSearchList())

eWordListType_DictionaryForSearch,

/// Морфологический список, который содержит базовые формы слов, ссылающиеся на их возможные словоформы

eWordListType_MorphologyBaseForm,

/// Морфологический список, который содержит все возможные словоформы (то есть и базовые формы, и производные), которые ссылаются на свои базовые формы

eWordListType_MorphologyInflectionForm,

/// Грамматические тесты

eWordListType_GrammaticTest,

/// Начало диапазона специальных списков слов с доп. статьями

eWordListType_SpecialAdditionalInfoBase = 0x300,

/// Конец диапазона специальных списков слов с доп. статьями

eWordListType_SpecialAdditionalInfoLast = 0x3FF,

/// Объединенный словарный список слов (не каталог), в котором есть слова из обоих направлений (прямого и обратного)

/// Коды языков направлений хранятся в соответствующих полях заголовка списка слов: LanguageCodeFrom и LanguageCodeTo.

eWordListType_MergedDictionary,

/// Начало диапазона специальных списков слов с интерактивными доп. статьями (которые можно просматривать из различных GUI-элементов)

eWordListType_SpecialAdditionalInteractiveInfoBase = 0x500,

/// Конец диапазона специальных списков слов с интерактивными доп. статьями

eWordListType_SpecialAdditionalInteractiveInfoLast = 0x5FF,

/// Морфологический список, содержащий статьи с морфологической информацией, например, таблицы словоформ (аналог eWordListType_Dictionary)

eWordListType_MorphologyArticles,

/// Список, содержащий статьи, на примере которых настраивается отображение скрываемых блоков в статьях

eWordListType_ArticlesHideInfo,

/// Список, содержащий каталог со статьями лингвистических игр

eWordListType_GameArticles,

/// Список, содержащий лицевые стороны встроенных в базу флеш-карточек

eWordListType_FlashCardsFront,

/// Список, содержащий обратные стороны встроенных в базу флеш-карточек

eWordListType_FlashCardsBack,

/// Список, содержащий избранные статьи InApp базы

eWordListType_InApp,

/// Вспомогательный список для полнотекстового поиска

/// т.е. список с результатами полнотекстового поиска может ссылаться на этот список

eWordListType_FullTextAuxiliary,

/// Список, содержащий основной учебный материал в учебнике

eWordListType_TextBook,

/// Список, содержащий тесты к учебному материалу

eWordListType_Tests,

/// Список, содержащий предметный указатель учебного материала

eWordListType_SubjectIndex,

/// Список, содержащий всплывающие статьи

eWordListType_PopupArticles,

/// Сортированный по Show варианту вспомогательный список для несортированных списков

eWordListType_SimpleSearch,

/// Список, содержащий информацию о пользовании словарем(help)

eWordListType_DictionaryUsageInfo,

/// Пользовательский список

eWordListType_CustomList,

/// Список, содержащий ссылки на слайдшоу

eWordListType_SlideShow,

/// Список, содержащий карты

eWordListType_Map,

/// Список, содержащий КЭСы

eWordListType_KES,

/// Список, содержащий ФП

eWordListType_FC,

/// Список, содержащий AtomicObject-ы

eWordListType_Atomic,

/// Список, содержащий индекс нумерации страниц

eWordListType_PageNumerationIndex,

/// Список бинарных ресурсов, содержащихся в базе

eWordListType_BinaryResource,

/// Список, с проиндексированными внешними ресурсами, которые должны загружаться в первую очередь

/// Далее идет диапазон списков, соответствующий приоритету загрузки ресурсов из внешних баз

eWordListType_ExternResourcePriorityFirst,

/// Список, с проиндексированными внешними ресурсами, которые должны загружаться в последнюю очередь

eWordListType_ExternResourcePriorityLast = eWordListType_ExternResourcePriorityFirst + 0xF,

/// Список имен баз, в которых содержаться внешние ресурсы

eWordListType_ExternBaseName,

/// Список строковых значений в структурированных метаданных

eWordListType_StructuredMetadataStrings,

/// Список строковых значений в css метаданных

eWordListType_CSSDataStrings,

/// Список шаблонов для статей

eWordListType_ArticleTemplates,

/// Вспомогательный поисковый список

eWordListType_AuxiliarySearchList,

/// Список, содержащий справочную информацию

eWordListType_Enchiridion,

/// Список для информации страницы Word of the Day (OALD10)

eWordlistType_WordOfTheDay,

/// Список предустановленного избранного

eWordlistType_PreloadedFavourites,

/// Пользовательский список, поддерживающий разный типы слов

eWordListType_SwissKnifeList

};

/// Чтобы получить тип списка, используем метод класса CSldListInfoэ

/// Возвращает код использования данного списка слов, т.е. для каких действий

/// он предназначен

ESldError CSldListInfo::GetUsage(UInt32 *aUsage) const;