|
Назначение ID раздела |
    |
|
Назначение ID раздела |
|
ID раздела (посмотрите во вкладке Опции раздела любого раздела, чтобы видеть его ID) - уникальный алфавитно-цифровой идентификатор раздела. Он должен быть уникален, потому что он используется, чтобы сослаться на раздел, и средством просмотра справки, и программистами, обращающимися к разделу из приложений. Все внутренние ссылки, которые Вы создаете в вашем проекте, обращаются к разделам в соответствии с их ID, например.
Больше основной информации см. ID разделов, номера контекста и ключевые слова в секции Справочной информации.
|
|
Избегайте ID раздела с 31 символом: Из-за пути обработки длинных имен раздела, Вы должны избежать использовать ID раздела с 31 символом или кратными 31 символу (62, 93 и т.д). Если Вы используете их, Вы можете испытать ошибки. См. здесь для деталей. |
ID раздела назначаются автоматически, когда Вы создаете новый раздел, но Вы можете также изменить их в любое время. См. Изменение ID раздела и контекстных чисел для деталей.
|
|
ID раздела сгенерированы автоматически на основе заголовка раздела, когда Вы создаете новый раздел. Как только Вы начинаете печатать заголовок (1) раздела, тот же текст также сгенерирован в области (2) ID раздела, заменяя пробелы символами подчеркивания, и не учитывая или преобразовывая любые символы, не позволенные в ID.
|
Вы можете
редактировать ID раздела в (2) перед нажатием 
,
чтобы создать раздел. (См. примечание относительно специальных
символов ниже.) Вы можете также изменить ID раздела позже в
любое время.)
|
|
Не используйте специальные символы в ID раздела! Можно использовать только .. z, A.. Z, 0.. 9, _ и (в некоторых специальных случаях) $ в ID раздела. Help & Manual не будет позволять Вам вводить символы, которые всегда вызывают проблемы, как пробелы и #, но Вы должны также избегать "позволенных" специальных символов, как скобки и так далее. Они могут работать, но помните, что Вы используете их полностью на ваш собственный риск! |
Использование описательных ID разделов:
Желательно дать разделам описательные ID, которые имеют смысл для Вас, так же как для вашей программы, поскольку это делает ваши проекты справки проще. Например, диалог Гиперссылки и функция Найти раздел отображают только ID раздела в алфавитных списках, не заголовки раздела, и подробные имена делают намного проще узнавание того, на что Вы ссылаетесь и ищете в этих списках!
Использование иерархических ID раздела:
"Иерархический" ID раздела может сделать управление вашими проектами справки намного проще, и начиная с введения ID с 256 символами в Help & Manual 4, это также очень удобно.
Что такое - "иерархический" ID? Предположим, что Вы имеете проект по имени Widget Editor с главой по имени Редактор, который содержит разделы О редакторе, Управления редактора и Использование редактора. Описательные иерархические ID для этих разделов выглядели бы так:
WE_Editor
WE_Editor_About
WE_Editor_Controls
WE_Editor_Using
Это держит разделы ваших глав вместе во всех алфавитных списках ID разделов, что делает эти списки намного более легкими для использования. Help & Manual 4 вводит ID с 256 символами, так что ввод описательных иерархических ID прост и настоятельно рекомендуется.
Использование уникального префикса проекта:
Вы можете задаться вопросом, почему примеры выше имеют префикс WE_. Это - уникальный префикс, который идентифицирует проект, и очень полезен, если Вы когда-либо создаете модульные проекты. Это помогает Вам удостоверяиться, что никогда не будут вызваны проблемы и ошибки в соответствии с двойными ID, когда Вы комбинируете ваши модули и делаете ссылку между ними, и это также предоставляет дополнительное напоминание для Вас, идентифицируя ваши цели, когда Вы создаете ссылки через модули.
| · | Вы можете конфигурировать Help & Manual, чтобы генерировать префикс по вашему выбору автоматически для каждого нового раздела, который Вы создаете. Только введите префикс, который Вы хотите использовать в Проект > Свойства проекта > Общие свойства> ID разделов и контекстная справка. |
См. также:
ID, контекстные числа и ключевые слова (Справочная информация)
