Управление ID и контекстными числами

В этом разделе:

В модульных проектах Вы также должны обудмать и распланировать ID раздела и контекстные числа. Модули - полностью отдельные проекты, а Help & Manual может предотвратить конфликты, вызванные двойными ID и контекстными числами, только в пределах одного проекта. Это означает, что Вы ответственны за то, что удостоверились, что Вы не имеете дубликатов в модулях, которые Вы собираетесь включить в вашу систему справки.

Когда Вы должны избегать дубликатов:

·	Действительно важно предотвратить дубликаты, только когда Вы используете слияние при компиляции. Двойные ID раздела и числа справочного контекста в модулях, слитых при компиляции, вызовут сбой ссылок и другие ошибки, потому что все они - в том же файле справки.

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

Как избегать двойных ID раздела:

Help & Manual имеет новую особенность, которая делает предотвращение двойных ID раздела очень простым. В каждом проекте Вы можете автоматически добавить уникальный префикс к вашим ID раздела. Тогда даже разделы с тем же основным ID фактически будут другими. Например, с автопрефиксом Introduction ID могло быть Master_Introduction в одном проекте и Mod1_Introduction в другом проекте.

1.	Найдите Проект > Свойства проекта > Общие свойства> ID раздела и Контекстная справка.

2.	Введите префикс для ваших ID раздела в области Префикс ID раздела:. Полезно добавить символ подчеркивания после префикса, это делает ID более легкими для чтения в различных списках ID, отображаемых в Help & Manual. Например, все разделы в этом файле справки используют префикс HM_.

3.	Повторите для каждого проекта, который Вы хотите включить в вашу модульную систему справки.

Если Вы назначите уникальный префикс на каждый проект, используемый в вашей системе справки, и удостоверитесь, что он используется для всех модулей, Вы не будете иметь никаких проблем с конфликтами ID.

Как избегать двойных чисел справочного контекста:

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

Выберите диапазон чисел для каждого из ваших модулей. Удостоверьтесь, что диапазон является достаточно большим, чтобы избежать перекрытий, даже если Вы добавляете намного больше разделов к вашему проекту, чем Вы первоначально ожидали использовать! Числа контекста справки могут иметь значение 0 - 4294967295 (4-байтовое целое число без знака), таким образом это не должно быть проблемой.

2.	Найдите Проект > Свойства проекта > Общие свойства> ID раздела и Контекстная справка.

3.	Введите стартовое число для диапазона, назначенного для текущего проекта в области Начать с: .

4.	Введите разумное число для значения Шаг:. Оно должно быть достаточно большим, чтобы позволить Вам добавлять разделы между существующими разделами, но достаточно маленьким так, чтобы Вы не вышли из назначенного диапазона контекстного числа, даже если Вы добавите много разделов к вашему проекту.

5.	Повторите для каждого проекта, который Вы хотите включить в вашу модульную систему справки.

Как настроить существующие проекты, чтобы избежать конфликтов:

Вышеупомянутые методы прекрасны для новых проектов. Однако, когда Вы хотите включить существующие проекты в модульную систему справки, Вы можете уже иметь конфликты дубликатов, с которыми Вы должны иметь дело.

1.	Проверьте ваши проекты, имеют ли диапазоны контекстных чисел и используемые ID потенциальные конфликты. Инструмент Отчеты проекта может быть здесь полезной помощью.

2.	Используйте Инструмент контекста справки , чтобы назначить новые контекстные числа на ваши индивидуальные модули.

Помните, что, когда Вы изменяете контекстные числа, ваши программисты должны также изменить соответствующие обращения в разделы, сделанные из вашего приложения!

3.	Редактируйте ваши ID раздела, чтобы устранить конфликты. Введите префикс имени ID с разным префиксом для каждого модуля. (Это должно быть сделано вручную. Поиск и замена была преднамеренно исключена для ID раздела, потому что это потенциально опасно.)

4.	После выполнения этого используйте Инструмент контекста справки и Отчеты проекта для экспортирования списков новых контекстных чисел и ID раздела для ваших программистов.

5.	Проверьте, содержат ли какие-нибудь сценарии или объекты кода HTML, вставленные в вашем проекте, ссылки на старые ID раздела. Они не обновляются автоматически и должны быть проверены. То же относится к любым ссылкам к старым ID bp других проектов и файлов справки.

См. также:

Модульные проекты (Справочная информация)

ID, контекстные числа и ключевые слова (Справочная информация)