Изменения документа Аннотирование документов в XWiki

Редактировал(а) Coluns 16.08.2024
От версии 8.3
отредактировано Coluns
на 01.03.2023
Изменить комментарий: Добавлен комментарий
К версии 1.7
отредактировано Coluns
на 09.12.2022
Изменить комментарий: К данной версии нет комментариев

Сводка

Подробности

Свойства страницы
Скрытые
... ... @@ -1,1 +1,1 @@
1 -false
1 +true
Теги
... ... @@ -1,1 +1,0 @@
1 -функции|комментирование|аннотации
Содержимое
... ... @@ -36,41 +36,8 @@
36 36  (% style="text-align:center" %)
37 37  [[image:image-20221209204812-4.png||height="615" width="1200"]]
38 38  
39 -Продолжайте работать с аннотациями.
39 +[[image:image-20221209205435-5.png]]
40 40  
41 -Вы можете оставлять много разных аннотаций в одном документе.
42 -
43 -Каждая из них будет помечена желтым маркером (1) с иконкой заметки в конце (2), нажав на которую можно открыть комментарий (3).
44 -
45 -В открытом комментарии можно увидеть кто автор (4), совершить те или иные действия (5), например ответив на комментарий.
46 -
47 -Также можно перейти к данному комментарию в разделе комментариев (6).
48 -
49 -(% style="text-align:center" %)
50 -[[image:image-20221209205435-5.png||height="586" width="1200"]]
51 -
52 - Все аннотации добавляются в раздел комментариев.
53 -
54 - Иконка аннотации (7) показывает что это именно комментарий-аннотация, а выделенный при создании аннотации текст становится ссылкой (8), нажав на которую можно попасть в то место документа, где размещена аннотация.
55 -
56 -(% style="text-align:center" %)
57 -[[image:image-20221209205936-6.png||height="431" width="1200"]]
58 -
59 -Таким образом, механизм аннотаций позволяет легко комментировать большие документы, что существенно упрощает групповую работу.
60 -
61 -Например, при подготовке договоров или иных документов требующих групповой работы.
62 -
63 -Мы добавили к данной странице несколько аннотаций для иллюстрации механизма.
64 -
65 -Попробуйте включить аннотации для данной страницы и посмотрите как это работает.
66 -
67 -{{cl-plate-advice}}
68 -В настройках механизма аннотаций вы можете включить отображение аннотаций по умолчанию при загрузке страницы.
69 -{{/cl-plate-advice}}
70 70  ----
71 -**Не любите читать? Посмотрите видео на эту тему на нашем канале:**
72 72  
73 -{{video url="https://www.youtube.com/watch?v=ZYH3m7cFLFE"/}}
74 -----
75 -
76 76  {{cl-plate-help/}}
image-20221209205936-6.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.coluns
Размер
... ... @@ -1,1 +1,0 @@
1 -91.7 KB
Содержимое
XWiki.XWikiComments[0]
Автор
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.coluns
Комментарий
... ... @@ -1,1 +1,0 @@
1 -Первая аннотация
Дата
... ... @@ -1,1 +1,0 @@
1 -2022-12-09 18:15:37.0
Selection
... ... @@ -1,1 +1,0 @@
1 -Такая возможность
State
... ... @@ -1,1 +1,0 @@
1 -SAFE
Target
... ... @@ -1,1 +1,0 @@
1 -Stati.Funktsii-XWiki.Annotirovanie-dokumentov-v-XWiki.WebHome
XWiki.XWikiComments[1]
Автор
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.coluns
Комментарий
... ... @@ -1,1 +1,0 @@
1 -Вторая аннотация
Дата
... ... @@ -1,1 +1,0 @@
1 -2022-12-09 18:15:57.0
Selection
... ... @@ -1,1 +1,0 @@
1 -ниже выделенного текста
State
... ... @@ -1,1 +1,0 @@
1 -SAFE
Target
... ... @@ -1,1 +1,0 @@
1 -Stati.Funktsii-XWiki.Annotirovanie-dokumentov-v-XWiki.WebHome
XWiki.XWikiComments[2]
Комментарий
... ... @@ -1,1 +1,0 @@
1 -Пробная аннотация
Дата
... ... @@ -1,1 +1,0 @@
1 -2023-02-16 11:21:23.0
Selection
... ... @@ -1,1 +1,0 @@
1 -аннотаций
Selection Left Context
... ... @@ -1,1 +1,0 @@
1 -Мы добавили к данной странице несколько
Selection Right Context
... ... @@ -1,1 +1,0 @@
1 -для иллюстрации механизма.
State
... ... @@ -1,1 +1,0 @@
1 -SAFE
Target
... ... @@ -1,1 +1,0 @@
1 -Stati.Funktsii-XWiki.Annotirovanie-dokumentov-v-XWiki.WebHome
XWiki.XWikiComments[3]
Автор
... ... @@ -1,1 +1,0 @@
1 -hp
Комментарий
... ... @@ -1,11 +1,0 @@
1 -Да, XWiki удобна в плане ревью, поскольку поддерживает как общие, так и внутритекстовые комментарии.
2 -
3 -Но есть один нюанс, о котором здесь не сказано. Возможно, вы просто с этим еще не столкнулись, а я уже ))
4 -
5 -Суть проблемы в том, что, судя по всему, внутритекстовые комментарии ("аннотации" в терминах XWIKI) привязываются не к позиции комментируемого фрагмента текста, а к его окружению в пределах абзаца. Отсюда возникают нюансы: если текст в разных абзацах полностью идентичен, то аннотация в итоге будет привязана не к выделеному изначально фрагменту текста, а к самому первому совпадению с ним.
6 -
7 -Вот ссылка на видео, демонстрирующее этот баг: [[https:~~/~~/youtu.be/OGHdG56B~~-~~-0>>https://youtu.be/OGHdG56B--0]]
8 -
9 -----
10 -
11 -PS: пробную аннотацию выше можно удалить, это был я )
Дата
... ... @@ -1,1 +1,0 @@
1 -2023-02-28 16:52:42.0
XWiki.XWikiComments[4]
Автор
... ... @@ -1,1 +1,0 @@
1 -XWiki.coluns
Комментарий
... ... @@ -1,27 +1,0 @@
1 -Добрый день!
2 -
3 -Да, вы правы. Такая особенность действительно есть. Спасибо за то, что обращаете внимание.
4 -
5 -Эта проблема известна и есть обсуждение с авторами данного плагина.
6 -
7 -//"Система аннотаций имеет хранилище контекста для правильного размещения аннотации на основе окружающего текста (а не только аннотируемых слов), и существует алгоритм для обнаружения этого контекста при добавлении аннотации. //
8 -
9 -//Этот алгоритм использует инкрементный метод, так что он обнаруживает как можно более короткий контекст, который делает аннотацию уникальной;//
10 -
11 -// слишком большой контекст будет чувствителен к любым изменениям, даже в частях документа, совершенно не связанных с аннотацией, и приведет к сбою идентификации аннотации.//
12 -
13 -//Мы пытаемся найти “золотую середину” между одним риском и другим.//
14 -
15 -//В некоторых случаях этому алгоритму не удается найти уникальный контекст, даже при расширении контекста пару раз, и в результате аннотация помещается в первое вхождение этого контекста, а не во второе. //
16 -
17 -//Этот случай, который вы обнаружили, является одним из таких случаев, и он связан с тем фактом, что один и тот же абзац, который также довольно длинный, появляется в документе дважды.
18 -Принцип этого алгоритма заключается в том, чтобы наилучшим образом охватить реальные ситуации, но не обязательно все тестовые ситуации (существует множество тестовых случаев, для которых размещение аннотаций может завершиться неудачно, но энтропия этого контента не та, которая встречается на практике).
19 -Это добавленный вами тестовый контент или у вас есть реальный контент, в котором возникает такая ситуация?//
20 -
21 -//Существует проблема, открытая для этого ограничения здесь [[https:~~/~~/jira.xwiki.org/browse/XWIKI-8400>>url:https://jira.xwiki.org/browse/XWIKI-8400]]"//
22 -
23 -Очень похожий на Ваш случай.
24 -
25 -
26 -
27 -
Дата
... ... @@ -1,1 +1,0 @@
1 -2023-03-01 03:36:25.402