Add support for underline annotation import and export

zotero · Jul 21, 2023 · b534796 · b534796
1 parent 23ba495
commit b534796
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 9 deletions.
diff --git a/src/annotations/common.js b/src/annotations/common.js
@@ -62,7 +62,7 @@ function getAnnotationID(rawAnnot) {
 
 function isTransferable(rawAnnot) {
 	let id = getAnnotationID(rawAnnot);
-	return !!(['/Text', '/Highlight'].includes(rawAnnot['/Subtype'])
+	return !!(['/Text', '/Highlight', '/Underline'].includes(rawAnnot['/Subtype'])
 		|| ['/Square', '/Ink'].includes(rawAnnot['/Subtype']) && id);
 }
 

diff --git a/src/annotations/read.js b/src/annotations/read.js
@@ -111,10 +111,7 @@ exports.readRawAnnotation = function (rawAnnot, pageIndex, view) {
 	}
 
 	type = type.toLowerCase();
-	if (type === 'underline') {
-		type = 'highlight';
-	}
-	else if (type === 'text') {
+	if (type === 'text') {
 		type = 'note';
 	}
 	else if (type === 'square') {
@@ -133,7 +130,7 @@ exports.readRawAnnotation = function (rawAnnot, pageIndex, view) {
 		return null;
 	}
 
-	if (['highlight', 'note', 'image'].includes(annotation.type)) {
+	if (['highlight', 'underline', 'note', 'image'].includes(annotation.type)) {
 		let rects;
 		if (Array.isArray(rawAnnot['/QuadPoints'])
 			&& rawAnnot['/QuadPoints'].length % 8 === 0

diff --git a/src/annotations/write.js b/src/annotations/write.js
@@ -12,7 +12,7 @@ exports.writeRawAnnotations = function (structure, annotations) {
 			continue;
 		}
 		page['/Annots'].push(rawAnnotation);
-		if (annotation.type === 'highlight' && annotation.comment) {
+		if (['highlight', 'underline'].includes(annotation.type) && annotation.comment) {
 			page['/Annots'].push(addPopup(rawAnnotation));
 		}
 	}
@@ -198,6 +198,66 @@ function annotationToRaw(annotation) {
 
 		return res;
 	}
+	else if (annotation.type === 'underline') {
+		let p = '';
+		for (let rect of annotation.position.rects) {
+			p += rect[0] + ' ' + rect[1] + ' m\r';
+			p += rect[2] + ' ' + rect[1] + ' l\r';
+			p += rect[2] + ' ' + (rect[1] + 3) + ' l\r';
+			p += rect[0] + ' ' + (rect[1] + 3) + ' l\rh\r';
+		}
+
+		let res = {
+			'/Type': '/Annot',
+			'/Rect': containerRect,
+			'/Subtype': '/Underline',
+			'/QuadPoints': rectsToQuads(annotation.position.rects),
+			'/M': '(' + dateToRaw(annotation.dateModified) + ')',
+			'/T': '(' + stringToRaw(annotation.authorName) + ')',
+			'/Contents': '(' + stringToRaw(annotation.comment) + ')',
+			'/NM': '(' + 'Zotero-' + annotation.id + ')',
+			'/Zotero:Key': '(' + annotation.id + ')',
+			'/Zotero:AuthorName': '(' + stringToRaw(annotation.authorName) + ')',
+			'/F': 4,
+			'/C': colorToRaw(annotation.color),
+			'/AP': {
+				'/N': {
+					'/BBox': containerRect,
+					'/FormType': 1,
+					'/Resources': {
+						'/ExtGState': {
+							'/G0': {
+								'/BM': '/Multiply',
+								'/CA': 1,
+								'/ca': 1,
+								num: 0,
+								gen: 0
+							},
+							num: 0,
+							gen: 0
+						}, num: 0, gen: 0
+					},
+					'/Subtype': '/Form',
+					'/Type': '/XObject',
+					stream: '/G0 gs\r' + colorToRaw(annotation.color).join(' ') + ' rg\r' + p + 'f\r',
+					num: 0,
+					gen: 0
+				}
+			},
+			num: 0,
+			gen: 0
+		};
+
+		if (!annotation.comment) {
+			delete res['/Contents'];
+		}
+
+		if (annotation.tags.length) {
+			res['/Zotero:Tags'] = '(' + stringToRaw(JSON.stringify(annotation.tags)) + ')';
+		}
+
+		return res;
+	}
 	else if (annotation.type === 'image') {
 		let p = [
 			containerRect[0],

diff --git a/src/index.js b/src/index.js
@@ -188,7 +188,7 @@ async function importAnnotations(buf, existingAnnotations, password, transfer, c
 		annotation.pageLabel = pageLabel || (pageIndex + 1).toString();
 
 		let offset = 0;
-		if (annotation.type === 'highlight') {
+		if (['highlight', 'underline'].includes(annotation.type)) {
 			let range = getRangeByHighlight(structuredText, annotation.position.rects);
 			if (range) {
 				offset = range.offset;
@@ -210,7 +210,7 @@ async function importAnnotations(buf, existingAnnotations, password, transfer, c
 		}
 
 		let top = 0;
-		if (['highlight', 'note', 'image'].includes(annotation.type)) {
+		if (['highlight', 'underline', 'note', 'image'].includes(annotation.type)) {
 			top = pageHeight - annotation.position.rects[0][3];
 		}
 		// Ink