Примечание в confluence как сделать

Добавил пользователь Алексей Ф.
Обновлено: 05.10.2024

Текстовые эффекты используются для изменения форматирования слов и предложений.

Чтобы сделать весь параграф цитированным - поместите "bq. " перед ним.

Цитировать блок текста, длиннее одного абзаца.

Изменяет цвет блока текста.

Смотри, ма - красный текст!

Текстовые разрывы

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

Нотация	Комментарий
Создает новый абзац
Переносит текст на следующую строку. Редко нужно - в большинстве случаев Вики-рендерер сможет сам правильно переносить текст на новую строку.
Создает горизонтальную направляющую линию.
Создает — символ длинного тире.
Создает – символ короткого тире.

Ссылки

Важно узнать, как быстро создавать ссылки.

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

Скобки [] вокруг внешних ссылок ставятся по усмотрению, если вы не хотите использовать никакие псевдонимы для ссылок.

Создает ссылку на почтовый адрес.

Создает ссылку на скачивание файла на ваш компьютер или в сетевую папку, которую вы выбрали на диске. Чтобы получить доступ к файлу, надмите правую кнопку на ссылке и выберете "Сохранить Как".

По умолчанию, это работает только в Internet Explorer, но также может быть задействовано в Firefox (Смотрите документацию).

Списки

Списки позволяют вам представлять информацию в виде серии упорядоченных элементов.

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

Элементы списка (с -), несколько строк образуют единственный список.

Вы также можете создавать любые смешанные вложенные списки.

Изображения

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

Вставляет изображение на страницу.

Если подходящий URL указан для изображения - оно будет отображаться с удаленного источника, иначе будет отображаться приложенный файл с картинкой.

Вставить миниатюру на станицу (работает только с изображениями, приложенными к странице).

Для любого изображения вы можете определить аттрибуты тэга изображения - такие, как список, разделенный запятыми и пр.

Вложения

Некоторые вложения особого типа могут быть вставлены в визуальное Вики-поле из приложенного файла.

Вставка объекта на страницу, вставляя свойства разделенные запятыми.

Форматы, поддерживаемые по умолчанию.:

Flash (.swf)
Quicktime клипы (.mov)
Windows Media (.wma, .wmv)
Real Media (.rm, .ram)
MP3 файлы (.mp3)

Прочие типы файлов могут быть использованы, но могут потребовать указание свойств "classid", "codebase" и "pluginspage", чтобы быть распознанными веб-браузерами.

ширина - ширина медиа-файла
высота - высота медиа-файла
ID - ID присвоенный вставленному объекту

Благодаря запросам безопасности файлы, расположенные на удаленных серверах не поддерживают Стилизацию
По умолчанию, каждый вставляемый объект обернут тегом "div". Если вы хотите стилизировать div и его содержимое - перепишите содержимое CSS-класса "embeddedObject". Указание ID в качестве свойства также позволяет вам стилизировать разные вставленные объекты. Используются имена CSS-классов в формате "embeddedObject-ID".

Таблицы

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

Создает таблицу. Используйте double bars для заголовочных строк таблицы.

Код, заданный здесь, создает таблицу которая выглядит как:

Расширенное форматирование

Расширенное форматирование текста.

Делает предварительно отформатированный блок текста без синтаксической подсветки. Все опциональные параметры макроса также действительны для .

без панели: Окружает блок текста полностью настраиваемой панелью. Опциональные параметры, которые вы можете задать:

Окружает блок текста полностью настраиваемой панелью. Опциональные параметры, которые вы можете задать:

title: Заголовок панели
borderStyle: Стиль границы, которая используется в панели (сплошная, пунктирная и любая другая CSS-valid)
borderColor: Цвет границы, которая используется в панели
borderWidth: ширина границы, которая используется в панели
bgColor: Цвет фона этой панели
titleBGColor: Цвет фона заглавной секции этой панели

Делает предварительно отформатированный блок текста синтаксически подсвеченным. Все опциональные параметры макроса также действительны для . Язык по умолчанию - Java, но вы такуже можете указать JavaScript, ActionScript, XML или SQL.

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

Есть ли способ раскрыть все встроенные комментарии в Confluence, похожие на изменения треков Microsoft Word или просмотр комментариев к документам Google?

1 ответ

Согласно этот атласский Ответ на вопрос , нет встроенного способа сделать это.

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

Зачем и почему

В проекте, в котором мне довелось работать, родился следующий процесс подготовки и согласования требований:

Для ведения документации использовался Confluence.
Команда поставщика готовила описания бизнес-процессов и их шагов в виде отдельных страниц по шаблону.
Раз в неделю партия подготовленных описаний передавалась заказчику для вычитки.
Команда заказчика все вопросы и дополнения оставляла на соответствующей странице в виде встроенных комментариев.
А команда поставщика дополняла содержание, отвечала на комментарии, фиксировала вопросы для дополнительной проработки.
Если вопрос отвечен и содержание обновлено или зафиксирована задача для проработки, команда заказчика должна закрыть комментарий.
Вопросы по партии документов с текущей недели должны быть закрыты к моменту передачи следующей партии на следующей неделе.

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

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

Поиски инструментов успехом не увенчались. К тому же, Confluence развернут на стороне заказчика, плагины не установишь, не говоря уже о купить. Экспертизы по разработке макросов нет.

В какой-то момент я вспомнил о наличии у Confluence REST API и предыдущем опыте использования аналогичного API Jira. Поиск и эксперименты с вызовом функций из браузера показали, что добраться до комментариев и их свойств можно. Дальше нужно было выбрать инструмент для автоматизации, и можно приступать к решению. У меня есть кое-какой опыт создания скриптов на инструментах, которые, скорее, ближе администраторам, вроде Bash, Perl, JScript. Я не разработчик, хорошо знакомых или привычных инструментов у меня не было. Хотелось попробовать что-то более распространенное или подходящее. Тут обнаружил обертку для API на Python и решил попробовать с ним.

Общий принцип

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

Ставлю Python, просматриваю азы работы с ним, и поехали. Первым делом создаем подключение:

Для поиска страниц из недельной партии решил использовать метки. Как их массово поставить — отдельная задача.

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

Особенности API

Теперь давайте разберемся, как обработать страницу. По умолчанию API выдает только базовую информацию, вроде идентификатора или названия страницы. Все дополнительные свойства нужно прописать явно. Их можно подсмотреть, анализируя результат вызова. Дополнительные данные можно найти в секциях или подсекциях _expandable. Дописываем нужный пункт в expand и смотрим дальше, пока не найдем нужные данные.

А еще есть ограничение по количеству выдаваемых результатов, пагинация. Оно конфигурируется на стороне сервера (API?) и в нашем случае равно 25. Для некоторых запросов его можно изменить, указав явно, но оно будет действовать только для верхнего уровня. А раскрыв комментарии к странице, мы получим все равно только 25, при этом еще и size подвирает. В примере их было 29 в реальности. Пагинацию комментариев удалось обойти с помощью отдельной функции в модуле Confluence — get_page_comments с возможностью указания размера страницы.

Следующий подводный камень ждал в особенностях сохранения и выдачи спецсимволов. Тело страницы или комментария можно получить в нескольких представлениях: внутреннем XML — storage, промежуточном HTML без вывода макросов — view и HTML с выводом макросов — export_view. А вот название страницы title и исходный комментируемый текст originalSelection выдаются всегда в виде, пригодном для чтения. Т.к. в дальнейшем эти данные попадают в тело страницы со статистикой, то некоторые символы приводили к ошибкам преобразования. Пришлось написать процедуру замены выше.

Комментарии к странице

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

Статистика и таблицы

Для наглядности представления данных соберем статистику по ним и оформим в виде таблиц.

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

Теперь все готово. После простановки меток и запуска скрипта получим страницу примерно следующего вида:

Конечно, это не все, что получилось в итоге. Появился парсинг страниц и поиск макроса с номером задачи в Jira. Появилась автоматическая простановка меток по номерам задач в Jira и ссылкам из них на Confluence. Появилось сравнение и проверка недельных списков поставки. Появилось сохранение комментариев в Excel и сборка общих данных из нескольких недельных Excel файлов. А недавно добавился парсинг комментариев из Word.

Confluence 6 Введение в использование CSS для стилизации Confluence

На этой странице объясняется, как Confluence меняет внешний вид, изменяя CSS.

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

Описание:По умолчанию только администрация системы может редактировать таблицу стилей CSS для всего сайта Confluence. Я надеюсь разрешить любым таблицам стилей CSS с правами администратора пространства редактировать пространство, введите > Общая конфигурация >Конфигурация безопасности (Конфигурация безопасности)Тогда выбирайПользовательские таблицы стилей для пространств。

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

Чтобы помочь вам внести изменения в эту область, мы создали эту справочную страницу:basic styling tutorial Позвольте вам получить базовое представление о CSS.

Читайте также: