Да, XWiki удобна в плане ревью, поскольку поддерживает как общие, так и внутритекстовые комментарии.
Но есть один нюанс, о котором здесь не сказано. Возможно, вы просто с этим еще не столкнулись, а я уже ))
Суть проблемы в том, что, судя по всему, внутритекстовые комментарии ("аннотации" в терминах XWIKI) привязываются не к позиции комментируемого фрагмента текста, а к его окружению в пределах абзаца. Отсюда возникают нюансы: если текст в разных абзацах полностью идентичен, то аннотация в итоге будет привязана не к выделеному изначально фрагменту текста, а к самому первому совпадению с ним.
Да, вы правы. Такая особенность действительно есть. Спасибо за то, что обращаете внимание.
Эта проблема известна и есть обсуждение с авторами данного плагина.
"Система аннотаций имеет хранилище контекста для правильного размещения аннотации на основе окружающего текста (а не только аннотируемых слов), и существует алгоритм для обнаружения этого контекста при добавлении аннотации.
Этот алгоритм использует инкрементный метод, так что он обнаруживает как можно более короткий контекст, который делает аннотацию уникальной;
слишком большой контекст будет чувствителен к любым изменениям, даже в частях документа, совершенно не связанных с аннотацией, и приведет к сбою идентификации аннотации.
Мы пытаемся найти “золотую середину” между одним риском и другим.
В некоторых случаях этому алгоритму не удается найти уникальный контекст, даже при расширении контекста пару раз, и в результате аннотация помещается в первое вхождение этого контекста, а не во второе.
Этот случай, который вы обнаружили, является одним из таких случаев, и он связан с тем фактом, что один и тот же абзац, который также довольно длинный, появляется в документе дважды. Принцип этого алгоритма заключается в том, чтобы наилучшим образом охватить реальные ситуации, но не обязательно все тестовые ситуации (существует множество тестовых случаев, для которых размещение аннотаций может завершиться неудачно, но энтропия этого контента не та, которая встречается на практике). Это добавленный вами тестовый контент или у вас есть реальный контент, в котором возникает такая ситуация?
Да, думал про этот вариант, но он не очень подходит для проведения коллективного ревью, т.к. не все участники могут иметь права на редактирование статей. Ну и сам процесс усложняется - нужно обязательно входить в режим редактирования ((
Возможным решением кажется учитывать при определении контекста номера строк.
Т.е. чтобы система учитывала не только "слова слева" и "слова справа" но и скажем так "диапазон строк" в котором искать контекст.
Это позволит решить проблему.
Как думаете?
hp, 05.03.2023
Согласен, решение выглядит здравым. Только надо понимать, что при редактировании документа номер строки может меняться, в этом случае позиция привязки должна автоматически обновляться при сохранении статьи.
И в этом свете лучше привязываться не к номеру строки, а к номеру абзаца — он будет меняться реже при редактировании.
Есть еще один баг, с которым мы столкнулись: если переместить аннотированную страницу, то все внутритекстовые аннотации преобразуются в нижние комментарии и теряют связь с откомментированными фрагментами текста. Это очень плохо, т.к. после реструктуризации серьезно усложняется анализ ревью ((
Проверили, связана с тем, что в объекте который хранит в себе аннотацию, есть поле "target" в котором хранится ссылка на аннотируемую страницу.
При стандартном перемещении, данное поле не меняется, поэтому аннотации перестают отображаться (хотя и остаются физически в странице как объекты).
Очевидным решением будет сделать так, чтобы механизм отображения аннотаций не учитывал данное поле.
Не понятен на самом деле его смысл: ведь аннотация по определению относится к "текущей" странице и поле "target" кажется избыточным.
Мы зафиксировали данную ошибку в нашем трекере и постараемся устранить.
Так как для корпоративной базы знаний, функция аннотирования нам кажется важной.
Спасибо вам за наблюдательность! 👍
hp, 03.03.2023
Пожалуйста )) Очень надеюсь, что удастся устранить данный баг. Если найдете решение – поделитесь, плиз ))
Я довольно давно использую XWiki и тоже заинтересован в развитии этой замечательной платформы )) Готов делиться не только найденными багами, но и рецептами по улучшению функциональности )) К сожалению, не встречал русскоязычного сообщества активных пользователей XWiki, только иностранные форумы. А платформа перспективна и наверняка будет распространяться все шире, особенно в свете политики Atlassian ))
Первая аннотация
Вторая аннотация
Пробная аннотация
Да, XWiki удобна в плане ревью, поскольку поддерживает как общие, так и внутритекстовые комментарии.
Но есть один нюанс, о котором здесь не сказано. Возможно, вы просто с этим еще не столкнулись, а я уже ))
Суть проблемы в том, что, судя по всему, внутритекстовые комментарии ("аннотации" в терминах XWIKI) привязываются не к позиции комментируемого фрагмента текста, а к его окружению в пределах абзаца. Отсюда возникают нюансы: если текст в разных абзацах полностью идентичен, то аннотация в итоге будет привязана не к выделеному изначально фрагменту текста, а к самому первому совпадению с ним.
Вот ссылка на видео, демонстрирующее этот баг: https://youtu.be/OGHdG56B--0
PS: пробную аннотацию выше можно удалить, это был я )
Добрый день!
Да, вы правы. Такая особенность действительно есть. Спасибо за то, что обращаете внимание.
Эта проблема известна и есть обсуждение с авторами данного плагина.
"Система аннотаций имеет хранилище контекста для правильного размещения аннотации на основе окружающего текста (а не только аннотируемых слов), и существует алгоритм для обнаружения этого контекста при добавлении аннотации.
Этот алгоритм использует инкрементный метод, так что он обнаруживает как можно более короткий контекст, который делает аннотацию уникальной;
слишком большой контекст будет чувствителен к любым изменениям, даже в частях документа, совершенно не связанных с аннотацией, и приведет к сбою идентификации аннотации.
Мы пытаемся найти “золотую середину” между одним риском и другим.
В некоторых случаях этому алгоритму не удается найти уникальный контекст, даже при расширении контекста пару раз, и в результате аннотация помещается в первое вхождение этого контекста, а не во второе.
Этот случай, который вы обнаружили, является одним из таких случаев, и он связан с тем фактом, что один и тот же абзац, который также довольно длинный, появляется в документе дважды.
Принцип этого алгоритма заключается в том, чтобы наилучшим образом охватить реальные ситуации, но не обязательно все тестовые ситуации (существует множество тестовых случаев, для которых размещение аннотаций может завершиться неудачно, но энтропия этого контента не та, которая встречается на практике).
Это добавленный вами тестовый контент или у вас есть реальный контент, в котором возникает такая ситуация?
Существует проблема, открытая для этого ограничения здесь https://jira.xwiki.org/browse/XWIKI-8400"
Очень похожий на Ваш случай.
Да, все так. Остается надеяться, что когда-нибудь поправят...
Есть такой макрос Комментарий
Нужен для того чтобы в тексте оставлять заметки невидимые.
Можно реализовать что то вроде этого. Т.е. вставлять комментарий прямо в текст страницы.
Но это будет влиять на содержание. Так что тоже возможно спорное решение.
Да, думал про этот вариант, но он не очень подходит для проведения коллективного ревью, т.к. не все участники могут иметь права на редактирование статей. Ну и сам процесс усложняется - нужно обязательно входить в режим редактирования ((
Возможным решением кажется учитывать при определении контекста номера строк.
Т.е. чтобы система учитывала не только "слова слева" и "слова справа" но и скажем так "диапазон строк" в котором искать контекст.
Это позволит решить проблему.
Как думаете?
Согласен, решение выглядит здравым. Только надо понимать, что при редактировании документа номер строки может меняться, в этом случае позиция привязки должна автоматически обновляться при сохранении статьи.
И в этом свете лучше привязываться не к номеру строки, а к номеру абзаца — он будет меняться реже при редактировании.
Мысль про номер абзаца хорошая.
Спасибо!
Есть еще один баг, с которым мы столкнулись: если переместить аннотированную страницу, то все внутритекстовые аннотации преобразуются в нижние комментарии и теряют связь с откомментированными фрагментами текста. Это очень плохо, т.к. после реструктуризации серьезно усложняется анализ ревью ((
Вы правы, есть такая ошибка.
Проверили, связана с тем, что в объекте который хранит в себе аннотацию, есть поле "target" в котором хранится ссылка на аннотируемую страницу.
При стандартном перемещении, данное поле не меняется, поэтому аннотации перестают отображаться (хотя и остаются физически в странице как объекты).
Очевидным решением будет сделать так, чтобы механизм отображения аннотаций не учитывал данное поле.
Не понятен на самом деле его смысл: ведь аннотация по определению относится к "текущей" странице и поле "target" кажется избыточным.
Мы зафиксировали данную ошибку в нашем трекере и постараемся устранить.
Так как для корпоративной базы знаний, функция аннотирования нам кажется важной.
Спасибо вам за наблюдательность! 👍
Пожалуйста )) Очень надеюсь, что удастся устранить данный баг. Если найдете решение – поделитесь, плиз ))
Я довольно давно использую XWiki и тоже заинтересован в развитии этой замечательной платформы )) Готов делиться не только найденными багами, но и рецептами по улучшению функциональности ))
К сожалению, не встречал русскоязычного сообщества активных пользователей XWiki, только иностранные форумы. А платформа перспективна и наверняка будет распространяться все шире, особенно в свете политики Atlassian ))
Будем очень рады и благодарны если будете делиться
Присылайте материалы на info@corpwiki.ru и мы их опубликуем с указанием авторства.
И конечно, когда найдем решение проблемы, то обязательно с вами поделимся.