Merge pull request #58 from chnm/feature/annotation-translations

refactor: Include annotation tools for translated text
chnm · Nov 21, 2024 · 7c68816 · 7c68816
2 parents c7f8002 + 91db249
commit 7c68816
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 26 deletions.
diff --git a/manuscript/admin.py b/manuscript/admin.py
@@ -301,9 +301,12 @@ class StanzaTranslatedAdmin(admin.ModelAdmin):
     list_display = ("stanza", "stanza_text", "language")
     search_fields = ("stanza", "stanza_text")
     list_filter = ("language",)
+    inlines = [TextAnnotationInline]
 
+    class Media:
+        css = {"all": ("css/text_annotations.css",)}
+        js = ("js/text_annotations.js",)
 
-# Register to the admin interface.
 
 admin.site.register(Library, LibraryAdmin)
 admin.site.register(EditorialStatus, EditorialStatusAdmin)

diff --git a/manuscript/views.py b/manuscript/views.py
@@ -34,29 +34,28 @@
 @ensure_csrf_cookie
 def create_annotation(request):
     try:
-        # Validate the request
         if not request.headers.get("X-Requested-With") == "XMLHttpRequest":
             raise ValueError("AJAX required")
 
         # Get required fields
-        stanza_id = request.POST.get("stanza_id")
+        object_id = request.POST.get("stanza_id")
         selected_text = request.POST.get("selected_text")
         annotation_text = request.POST.get("annotation")
         annotation_type = request.POST.get("annotation_type")
+        model_type = request.POST.get("model_type", "stanza")
 
-        # Validate all required fields are present
-        if not all([stanza_id, selected_text, annotation_text, annotation_type]):
+        # Validate required fields
+        if not all([object_id, selected_text, annotation_text, annotation_type]):
             missing_fields = [
                 field
                 for field, value in {
-                    "stanza_id": stanza_id,
+                    "stanza_id": object_id,
                     "selected_text": selected_text,
                     "annotation": annotation_text,
                     "annotation_type": annotation_type,
                 }.items()
                 if not value
             ]
-
             logger.error(f"Missing required fields: {missing_fields}")
             return JsonResponse(
                 {
@@ -66,25 +65,23 @@ def create_annotation(request):
                 status=400,
             )
 
-        # Get the stanza
-        try:
-            stanza = Stanza.objects.get(id=stanza_id)
-        except Stanza.DoesNotExist:
-            logger.error(f"Stanza not found: {stanza_id}")
-            return JsonResponse(
-                {"success": False, "error": f"Stanza not found: {stanza_id}"},
-                status=404,
-            )
+        # Get the appropriate model and object
+        if model_type == "stanzatranslated":
+            content_type = ContentType.objects.get_for_model(StanzaTranslated)
+            annotated_object = get_object_or_404(StanzaTranslated, id=object_id)
+        else:
+            content_type = ContentType.objects.get_for_model(Stanza)
+            annotated_object = get_object_or_404(Stanza, id=object_id)
 
         # Create the annotation
         annotation = TextAnnotation.objects.create(
-            content_type=ContentType.objects.get_for_model(Stanza),
-            object_id=stanza.id,
+            content_type=content_type,
+            object_id=object_id,
             selected_text=selected_text,
             annotation=annotation_text,
             annotation_type=annotation_type,
-            from_pos=json.loads(request.POST.get("from_pos", "0")),
-            to_pos=json.loads(request.POST.get("to_pos", "0")),
+            from_pos=request.POST.get("from_pos"),
+            to_pos=request.POST.get("to_pos"),
         )
 
         return JsonResponse(

diff --git a/static/js/text_annotations.js b/static/js/text_annotations.js
@@ -160,12 +160,14 @@ document.addEventListener("DOMContentLoaded", function () {
   annotationGroup.appendChild(annotateButton);
   toolbar.appendChild(annotationGroup);
 
-  // Function to get stanza ID (keeping existing implementation)
+  // Function to get stanza ID
   function getStanzaId() {
-    const urlMatch = window.location.pathname.match(/\/stanza\/(\d+)\//);
-    if (urlMatch) return urlMatch[1];
+    const urlMatch = window.location.pathname.match(
+      /\/(stanza|stanzatranslated)\/(\d+)/,
+    );
+    if (urlMatch) return urlMatch[2];
 
-    const form = document.querySelector("#stanza_form");
+    const form = document.querySelector("#stanza_form, #stanzatranslated_form");
     if (form) {
       const objectId =
         form.getAttribute("data-object-id") ||
@@ -273,6 +275,12 @@ document.addEventListener("DOMContentLoaded", function () {
 
       // Prepare the data
       const formData = new FormData();
+      formData.append(
+        "model_type",
+        window.location.pathname.includes("stanzatranslated")
+          ? "stanzatranslated"
+          : "stanza",
+      );
       formData.append("stanza_id", stanzaId);
       formData.append("selected_text", selectedText);
       formData.append("annotation", annotationText);

diff --git a/templates/stanzas.html b/templates/stanzas.html
@@ -124,7 +124,9 @@ <h2 id="book-{{book_number}}" class="text-xl font-bold mb-4">Book {{ book_number
                               </span>
                             </a>
                           </span>
-                          <span class="flex-1 pl-4">{{ stanza.unescaped_stanza_text|safe }}</span>
+                          <span class="flex-1 pl-4">
+                            {{ stanza.unescaped_stanza_text|annotate_text:stanza.annotations.all|safe }}
+                          </span>
                         </div>
                       </div>
                     {% endfor %}

diff --git a/textannotation/migrations/0003_alter_textannotation_annotation_type.py b/textannotation/migrations/0003_alter_textannotation_annotation_type.py
@@ -0,0 +1,25 @@
+# Generated by Django 5.0.2 on 2024-11-21 16:06
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("textannotation", "0002_alter_textannotation_options_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="textannotation",
+            name="annotation_type",
+            field=models.CharField(
+                choices=[
+                    ("note", "Editorial Note"),
+                    ("variant", "Textual Variant"),
+                    ("reference", "Cross Reference"),
+                ],
+                default="note",
+                max_length=20,
+            ),
+        ),
+    ]
diff --git a/textannotation/models.py b/textannotation/models.py
@@ -26,7 +26,6 @@ class TextAnnotation(models.Model):
 
     ANNOTATION_TYPES = (
         ("note", "Editorial Note"),
-        ("translation", "Translation"),
         ("variant", "Textual Variant"),
         ("reference", "Cross Reference"),
     )