Knowledge Base

User Tools

Site Tools

Trace:
criterion:annotations

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
criterion:annotations [2026/03/12 17:20] – finconscriterion:annotations [2026/03/17 10:50] (current) – fincons
Line 3: Line 3:
 ===== Overview ===== ===== Overview =====
  
-This module enables users to create, manage, and organize annotations—also referred to as **comments**—within the main text and apparatus of a critical edition. Users can insert annotations, assign categories, control visibility, integrate them seamlessly with document content, and search annotations.+This module enables users to create, manage, and organize annotations also referred to as **comments** within the main text and apparatus of a critical edition. Users can insert annotations, assign categories, control visibility, integrate them seamlessly with document content, and search annotations.
  
-This feature mimics professional editing tools like Microsoft Word or Google Docs, ensuring ease of use and powerful functionality. 
  
 {{ :criterion:annotation_management.png?nolink&600 |}} {{ :criterion:annotation_management.png?nolink&600 |}}
Line 13: Line 12:
 ==== Accessing the Annotation Sidebar ==== ==== Accessing the Annotation Sidebar ====
  
-  1. Click the annotation icon in the toolbar to toggle the **Annotation Sidebar**+  1. Click the annotation icon in the toolbar to toggle the Annotation Sidebar
   2. The sidebar appears on the left-hand side and lists all annotations, optionally grouped into categories   2. The sidebar appears on the left-hand side and lists all annotations, optionally grouped into categories
  
Line 42: Line 41:
 ==== Annotation Structure ==== ==== Annotation Structure ====
  
-{{ :criterion:annotation_structure.png?nolink&600 |}}+{{ :criterion:annotation_structure.png?nolink&400 |}}
  
 Each annotation contains: Each annotation contains:
  
 | **Component** | **Details** | | **Component** | **Details** |
-| **Metadata** | Author name (from system username), Creation or last modification dates | +| Metadata | Author name (from system username), Creation or last modification dates | 
-| **Text Reference** | Highlighted portion of selected text; Tooltip preview if text exceeds 20 characters | +| Text Reference | Highlighted portion of selected text; Tooltip preview if text exceeds 20 characters | 
-| **Description** | Editable up to 2000 characters; Tooltip shown if longer than 150 characters |+| Description | Editable up to 2000 characters; Tooltip shown if longer than 150 characters |
  
 ---- ----
Line 58: Line 57:
  
 **Edit**: **Edit**:
-  1. Click the description or use the **Edit** button+  1. Click the description or use the Edit button
   2. Changes to the reference text in the editor are reflected automatically   2. Changes to the reference text in the editor are reflected automatically
  
 **Delete**: **Delete**:
-  1. Click the **Delete** menu beside the annotation, or delete all text containing the annotation using backspace+  1. Click the Delete menu beside the annotation, or delete all text containing the annotation using backspace
   2. Annotations are also removed if their referenced text is deleted   2. Annotations are also removed if their referenced text is deleted
-  3. Use **Undo** to restore deleted annotations+  3. Use Undo to restore deleted annotations
  
 ---- ----
Line 77: Line 76:
  
 | **Feature** | **Description** | | **Feature** | **Description** |
-| **Search Field Location** | Text input field in left sidebar, within Comments section | +| Search Field Location | Text input field in left sidebar, within Comments section | 
-| **Incremental Search** | Results update in real time as you type | +| Incremental Search | Results update in real time as you type | 
-| **Searchable Content** | Author's name, references, and annotation description (comment text) | +| Searchable Content | Author's name, references, and annotation description (comment text) | 
-| **Contextual Filtering** | Only matching annotations displayed within original category | +| Contextual Filtering | Only matching annotations displayed within original category | 
-| **Automatic Filter Reset** | Clicking outside search field clears filter and restores full list | +| Automatic Filter Reset | Clicking outside search field clears filter and restores full list | 
-| **No-Results Handling** | If no matches found, comment list remains unchanged | +| No-Results Handling | If no matches found, comment list remains unchanged | 
-| **Document Scope** | Search limited to annotations in currently open document | +| Document Scope | Search limited to annotations in currently open document | 
-| **Exclusion from Global Search** | Annotations not included in "Edit > Find" functionality |+| Exclusion from Global Search | Annotations not included in "Edit > Find" functionality |
  
 ---- ----
Line 96: Line 95:
  
 **Rename**: **Rename**:
-  1. Double-click the category name or use the **Edit** menu+  1. Double-click the category name or use the Edit menu
  
 **Expand/Collapse**: **Expand/Collapse**:
Line 106: Line 105:
 {{ :criterion:move_all_comments_to_another_category.png?nolink&600 |}} {{ :criterion:move_all_comments_to_another_category.png?nolink&600 |}}
  
-  1. Use the **Delete** menu+  1. Use the Delete menu
   2. Choose to:   2. Choose to:
-    * Delete all annotations in the category +  - Delete all annotations in the category 
-    * Move annotations to another category (dropdown shown)+  - Move annotations to another category (dropdown shown)
   3. If no categories exist, moved annotations go to "Uncategorised"   3. If no categories exist, moved annotations go to "Uncategorised"
  
criterion/annotations.1773332452.txt.gz · Last modified: by fincons