Оглавление в Confluence Cloud: проверяем заголовки и ссылки на разделы

Задача: находить проверку и откат внутри одной инструкции

В длинной инструкции читателю нужно быстро открыть подготовку, выполнение, проверку результата или откат. Ручной список ссылок приходится поддерживать отдельно от текста, поэтому он легко расходится с содержимым. В Confluence Cloud макрос Table of Contents строит оглавление по заголовкам текущего материала. Для пилота достаточно одной учебной страницы с нейтральным процессом, без рабочих команд и конфиденциальных данных.

Это навигация внутри страницы, а не каталог дочерних инструкций. Если задача состоит в обходе дерева материалов, нужен другой сценарий. Ниже рассматривается обычная страница Cloud в актуальном редакторе; Cloud обновляется непрерывно и не имеет одной установленной версии для всех клиентов. Для Data Center сверяйте возможности редактора и макроса со справкой своей версии. Вики-разметку старого редактора здесь не используем.

Пилот описывает ожидаемое поведение, а не выполненную настройку клиентского Confluence. До изменения рабочей инструкции согласуйте владельца, список контрольных переходов и право редактировать материал. Не начинайте с массовой замены шаблонов: сначала проверьте, что одна страница читается правильно под обычной учётной записью.

Подготовьте структуру из настоящих заголовков

Создайте учебную страницу и оформите основные разделы стилем Heading 2, а подразделы — Heading 3. Для этого используйте выбор стиля текста или команду /heading. Просто увеличить шрифт или выделить строку жирным недостаточно: визуально похожая строка не становится заголовком. Не подбирайте уровень только ради размера букв — он должен отражать вложенность смысла.

Возьмите структуру ниже. Строку Пример результата оставьте обычным жирным текстом, а Детали диагностики оформите Heading 4. Эти два элемента нужны для отрицательной проверки. Под каждым заголовком добавьте несколько нейтральных предложений, чтобы разделы можно было различить при переходе. Не добавляйте одинаковые заголовки Проверка в нескольких местах: название должно помогать читателю понять, куда он попадёт.

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

Heading 2: Подготовка
  Heading 3: Проверка перед началом
Heading 2: Выполнение
  Heading 3: Проверка результата
    Heading 4: Детали диагностики
Обычный жирный текст: Пример результата
Heading 2: Откат
  Heading 3: Условия остановки
Heading 2: Служебные заметки

Добавьте макрос и настройте диапазон уровней

В редакторе поставьте курсор после короткого описания назначения инструкции. Введите / и найдите Table of Contents, затем вставьте макрос. Если вы используете меню добавления элементов, выберите макрос по тому же имени. Он должен находиться в обычном содержимом страницы, а не внутри Excerpt: для вложенного содержимого область работы может отличаться от всей инструкции.

Выделите макрос и откройте его настройки через Edit. В базовой конфигурации выберите вертикальный список, диапазон Include heading levels from 2 to 3 и оставьте нумерацию разделов выключенной. Фильтры включения и исключения пока очистите. Не меняйте сразу отступы, CSS-классы и формат вывода: для приёмки важны состав и правильность ссылок, а не декоративная настройка.

Просмотрите результат и опубликуйте изменение. Проверяйте именно сохранённую страницу в режиме чтения, а не только предпросмотр в редакторе. Запишите выбранные уровни и место макроса рядом с исходной версией в журнале изменения. Это позволит вернуть параметры отдельно от текста инструкции.

Проверьте состав оглавления и отрицательные примеры

Для указанной учебной структуры ожидаются семь пунктов: три основных рабочих раздела, три подраздела и Служебные заметки. Детали диагностики не должны попасть в список из-за уровня Heading 4. Пример результата не должен появиться, поскольку это обычный абзац, даже если он выглядит как заголовок. Сопоставьте каждый пункт оглавления с реальным элементом страницы.

Перейдите по всем семи ссылкам. После каждого перехода сверяйте заголовок и первый абзац целевого раздела, особенно на короткой странице, где прокрутка может быть почти незаметна. Повторите проверку на узком экране: длинный пункт должен оставаться понятным и доступным для выбора. Отсутствие горизонтальной прокрутки само по себе не доказывает, что ссылка ведёт в нужное место.

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

• Семь ожидаемых пунктов присутствуют до настройки исключения.
• Heading 4 и жирный абзац отсутствуют в оглавлении.
• Каждая ссылка приводит к своему заголовку и содержимому.
• Навигация остаётся пригодной для чтения на узком экране.

Исключите служебный пункт, сохранив доступ к тексту

Откройте расширенные параметры макроса и в Exclude headings with укажите Служебные заметки с тем же регистром, что в заголовке. Поле Include headings with для этого пилота оставьте пустым. После сохранения ожидаются шесть пунктов; служебный раздел должен остаться в самом материале. Запишите оба результата, чтобы не спутать фильтрацию навигации с удалением текста.

Такое исключение не является ограничением доступа. Любой читатель страницы по-прежнему может прокрутить к служебным заметкам или открыть прямую ссылку на заголовок. Если сведения нельзя показывать этой аудитории, их нужно вынести в отдельно защищённый материал и проверить доступ; скрытие пункта в Table of Contents для этого не подходит.

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

Проверьте обычного читателя и внешнюю ссылку на раздел

Откройте опубликованную страницу под отдельной учётной записью предполагаемого читателя. Убедитесь, что у неё есть согласованный доступ к пространству и самой странице, затем повторите переходы. Администраторская сессия не заменяет такую проверку. При отказе доступа разберите ограничения страницы и родителей; не снимайте их все только ради работающей ссылки.

Наведите указатель рядом с заголовком Проверка результата и воспользуйтесь появившимся значком ссылки. Скопируйте адрес в отдельную вкладку, затем проверьте его под тем же читателем. Используйте скопированный адрес, а не самостоятельно собранный fragment URL: при разной редакции текста или представлении заголовка ручная догадка может оказаться неверной.

Не отправляйте тестовый адрес коллегам или в общие каналы ради проверки. Для пилота достаточно своей отдельной сессии. После изменения названия заголовка отдельно проверьте уже используемые внешние ссылки: обновление пунктов оглавления и пригодность ранее скопированных адресов — разные условия приёмки.

Разберите типичные ошибки без перестройки страницы

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

Если читателю нужен список других страниц, изменение уровней текущего оглавления не решит задачу. Используйте навигацию по материалам отдельно от переходов внутри инструкции. Не вставляйте второй одинаковый макрос как способ починить первый: сначала сравните его настройки, область содержимого и сохранённую версию страницы.

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

Верните прежнюю навигацию и зафиксируйте приёмку

Если изменялись только параметры Table of Contents, верните диапазон, фильтры и место макроса по исходной записи. Для отмены только нового оглавления удалите его из редактора и опубликуйте правку, сохранив заголовки и текст. Если нужно вернуть старые стили заголовков, сделайте это отдельно и снова проверьте ссылки.

Восстановление всей страницы через Version history используйте, когда требуется вернуть именно её содержание. Сначала сравните версии и убедитесь, что не потеряете более свежие полезные изменения коллег. Команда Restore this version сохраняет историю последующих версий; удаление версии не является способом отката и может быть необратимым.

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