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

Редактировал(а) Coluns 16.08.2024
От версии 1.3
отредактировано Coluns
на 09.12.2022
Изменить комментарий: (Autosaved)
К версии 8.2
отредактировано XWikiGuest
на 28.02.2023
Изменить комментарий: Добавлен комментарий

Сводка

Подробности

Свойства страницы
Автор документа
... ... @@ -1,1 +1,1 @@
1 -XWiki.coluns
1 +XWiki.XWikiGuest
Скрытые
... ... @@ -1,1 +1,1 @@
1 -true
1 +false
Теги
... ... @@ -1,0 +1,1 @@
1 +функции|комментирование|аннотации
Содержимое
... ... @@ -20,7 +20,57 @@
20 20  
21 21  После этого, находясь на странице которую вы хотите аннотировать, выберите соответствующий пункт в меню страницы:
22 22  
23 +(% style="text-align:center" %)
24 +[[image:image-20221209204547-3.png]]
23 23  
26 + После этого в верхней части страницы появиться меню аннотирования:
27 +
28 +В (1) будет подсказка.
29 +
30 +Создавать аннотации очень просто.
31 +
32 +Выделите нужный текст, нажмите комбинацию клавиш и ниже выделенного текста появится окошко ввода комментария.
33 +
34 +Редактируйте комментарий обычным образом после чего сохраните его.
35 +
36 +(% style="text-align:center" %)
37 +[[image:image-20221209204812-4.png||height="615" width="1200"]]
38 +
39 +Продолжайте работать с аннотациями.
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}}
24 24  ----
71 +**Не любите читать? Посмотрите видео на эту тему на нашем канале:**
25 25  
73 +{{video url="https://www.youtube.com/watch?v=ZYH3m7cFLFE"/}}
74 +----
75 +
26 26  {{cl-plate-help/}}
image-20221209204518-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.coluns
Размер
... ... @@ -1,0 +1,1 @@
1 +51.7 KB
Содержимое
image-20221209204547-3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.coluns
Размер
... ... @@ -1,0 +1,1 @@
1 +63.2 KB
Содержимое
image-20221209204812-4.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.coluns
Размер
... ... @@ -1,0 +1,1 @@
1 +293.8 KB
Содержимое
image-20221209205435-5.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.coluns
Размер
... ... @@ -1,0 +1,1 @@
1 +302.0 KB
Содержимое
image-20221209205936-6.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.coluns
Размер
... ... @@ -1,0 +1,1 @@
1 +91.7 KB
Содержимое
XWiki.XWikiComments[0]
Автор
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.coluns
Комментарий
... ... @@ -1,0 +1,1 @@
1 +Первая аннотация
Дата
... ... @@ -1,0 +1,1 @@
1 +2022-12-09 18:15:37.0
Selection
... ... @@ -1,0 +1,1 @@
1 +Такая возможность
State
... ... @@ -1,0 +1,1 @@
1 +SAFE
Target
... ... @@ -1,0 +1,1 @@
1 +Stati.Funktsii-XWiki.Annotirovanie-dokumentov-v-XWiki.WebHome
XWiki.XWikiComments[1]
Автор
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.coluns
Комментарий
... ... @@ -1,0 +1,1 @@
1 +Вторая аннотация
Дата
... ... @@ -1,0 +1,1 @@
1 +2022-12-09 18:15:57.0
Selection
... ... @@ -1,0 +1,1 @@
1 +ниже выделенного текста
State
... ... @@ -1,0 +1,1 @@
1 +SAFE
Target
... ... @@ -1,0 +1,1 @@
1 +Stati.Funktsii-XWiki.Annotirovanie-dokumentov-v-XWiki.WebHome
XWiki.XWikiComments[2]
Комментарий
... ... @@ -1,0 +1,1 @@
1 +Пробная аннотация
Дата
... ... @@ -1,0 +1,1 @@
1 +2023-02-16 11:21:23.0
Selection
... ... @@ -1,0 +1,1 @@
1 +аннотаций
Selection Left Context
... ... @@ -1,0 +1,1 @@
1 +Мы добавили к данной странице несколько
Selection Right Context
... ... @@ -1,0 +1,1 @@
1 +для иллюстрации механизма.
State
... ... @@ -1,0 +1,1 @@
1 +SAFE
Target
... ... @@ -1,0 +1,1 @@
1 +Stati.Funktsii-XWiki.Annotirovanie-dokumentov-v-XWiki.WebHome
XWiki.XWikiComments[3]
Автор
... ... @@ -1,0 +1,1 @@
1 +hp
Комментарий
... ... @@ -1,0 +1,11 @@
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,0 +1,1 @@
1 +2023-02-28 16:52:42.439