mirrors/zotero
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Show small PDF icon in Attachments column when there's a PDF

Browse source 
Closes #2265

There's also new code for showing a different icon for snapshots, files,
and DOI/URL links, like the web library and iOS app, but it's commented
out for now. The bitmap icons create too much visual noise with the
greater information density and hierarchical tree of the desktop app
(not to mention many more low-DPI displays). We can revisit after
switching to SVGs across the board.
This commit is contained in:
Dan Stillman 2021-12-22 03:38:12 -05:00
parent 04fa066a14
commit b0ba7e4646
6 changed files with 114 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
chrome/content/zotero/components/icons.jsx
View file

@ -86,6 +86,7 @@ i('Twisty', (
i('Cross', "chrome://zotero/skin/cross.png");
i('Tick', "chrome://zotero/skin/tick.png");
i('ArrowRefresh', "chrome://zotero/skin/arrow_refresh.png");
//i('Link', "chrome://zotero/skin/link.png");
i('RTFScanAccept', "chrome://zotero/skin/rtfscan-accept.png");
i('RTFScanLink', "chrome://zotero/skin/rtfscan-link.png");

69
chrome/content/zotero/itemTree.jsx
View file

@ -2644,28 +2644,57 @@ var ItemTree = class ItemTree extends LibraryTree {
return span;
}
// TEMP: For now, we use the blue bullet for all non-PDF attachments, but there's
// commented-out code for showing different icons for snapshots, files, and URL/DOI links
if (this.isContainer(index)) {
if (item.isRegularItem()) {
const state = item.getBestAttachmentStateCached();
const { type, exists } = item.getBestAttachmentStateCached();
let icon = "";
if (state === 1) {
icon = getDOMElement('IconBulletBlue');
let ariaLabel;
// If the item has a child attachment
if (type !== null && type != 'none') {
if (type == 'pdf') {
icon = getDOMElement('IconTreeitemAttachmentPDF');
ariaLabel = Zotero.getString('pane.item.attachments.hasPDF');
if (!exists) {
icon.classList.add('icon-missing-file');
}
}
else if (type == 'snapshot') {
//icon = getDOMElement('IconTreeitemAttachmentSnapshot');
icon = exists ? getDOMElement('IconBulletBlue') : getDOMElement('IconBulletBlueEmpty');
ariaLabel = Zotero.getString('pane.item.attachments.hasSnapshot');
}
else {
//icon = getDOMElement('IconTreeitem');
icon = exists ? getDOMElement('IconBulletBlue') : getDOMElement('IconBulletBlueEmpty');
ariaLabel = Zotero.getString('pane.item.attachments.has');
}
icon.classList.add('cell-icon');
//if (!exists) {
// icon.classList.add('icon-missing-file');
//}
}
else if (state === -1) {
icon = getDOMElement('IconBulletBlueEmpty');
icon.classList.add('cell-icon');
}
if (icon.setAttribute) {
icon.setAttribute('aria-label', Zotero.getString('pane.item.attachments.has') + '.');
//else if (type == 'none') {
// if (item.getField('url') || item.getField('DOI')) {
// icon = getDOMElement('IconLink');
// ariaLabel = Zotero.getString('pane.item.attachments.hasLink');
// icon.classList.add('cell-icon');
// }
//}
if (ariaLabel) {
icon.setAttribute('aria-label', ariaLabel + '.');
}
span.append(icon);
item.getBestAttachmentState()
// TODO: With no cell refreshing this is possibly somewhat inefficient
// Refresh cell when promise is fulfilled
.then(bestState => bestState != state && this.tree.invalidateRow(index));
.then(({ type: newType, exists: newExists }) => {
if (newType !== type || newExists !== exists) {
this.tree.invalidateRow(index);
}
});
}
}
@ -2673,8 +2702,24 @@ var ItemTree = class ItemTree extends LibraryTree {
const exists = item.fileExistsCached();
let icon = "";
if (exists !== null) {
icon = exists ? getDOMElement('IconBulletBlue') : getDOMElement('IconBulletBlueEmpty');
if (item.isPDFAttachment()) {
icon = getDOMElement('IconTreeitemAttachmentPDF');
if (!exists) {
icon.classList.add('icon-missing-file');
}
}
else if (item.isSnapshotAttachment()) {
//icon = getDOMElement('IconTreeitemAttachmentSnapshot');
icon = exists ? getDOMElement('IconBulletBlue') : getDOMElement('IconBulletBlueEmpty');
}
else {
//icon = getDOMElement('IconTreeitem');
icon = exists ? getDOMElement('IconBulletBlue') : getDOMElement('IconBulletBlueEmpty');
}
icon.classList.add('cell-icon');
//if (!exists) {
// icon.classList.add('icon-missing-file');
//}
}
span.append(icon);

2
chrome/content/zotero/itemTreeColumns.jsx
View file

@ -275,7 +275,7 @@ const COLUMNS = [
label: "zotero.tabs.attachments.label",
iconLabel: <Icons.IconAttachSmall />,
fixedWidth: true,
width: "14",
width: "16",
zoteroPersist: new Set(["hidden", "sortDirection"])
},
{

44
chrome/content/zotero/xpcom/data/item.js
View file

@ -2315,6 +2315,16 @@ Zotero.Item.prototype.isEmbeddedImageAttachment = function() {
}
/**
* @return {Boolean} - Returns true if item is a snapshot
*/
Zotero.Item.prototype.isSnapshotAttachment = function () {
return this.attachmentLinkMode == Zotero.Attachments.LINK_MODE_IMPORTED_URL
&& this.attachmentContentType == 'text/html';
};
/**
* @return {Boolean} - Returns true if item is a stored or linked PDF attachment
*/
@ -3631,28 +3641,42 @@ Zotero.Item.prototype.getBestAttachments = Zotero.Promise.coroutine(function* ()
/**
* Return state of best attachment
*
* @return {Promise<Integer>} Promise for 0 (none), 1 (present), -1 (missing)
* @return {Promise<Object>} - Promise for object with string 'type' ('none'|'pdf'|'snapshot'|'other')
* and boolean 'exists'
*/
Zotero.Item.prototype.getBestAttachmentState = Zotero.Promise.coroutine(function* () {
Zotero.Item.prototype.getBestAttachmentState = async function () {
if (this._bestAttachmentState !== null) {
return this._bestAttachmentState;
}
var item = yield this.getBestAttachment();
if (item) {
let exists = yield item.fileExists();
return this._bestAttachmentState = exists ? 1 : -1;
var item = await this.getBestAttachment();
if (!item) {
return this._bestAttachmentState = {
type: 'none'
};
}
return this._bestAttachmentState = 0;
});
var type;
if (item.isPDFAttachment()) {
type = 'pdf';
}
else if (item.isSnapshotAttachment()) {
type = 'snapshot';
}
else {
type = 'other';
}
var exists = await item.fileExists();
return this._bestAttachmentState = { type, exists };
};
/**
* Return cached state of best attachment for use in items view
*
* @return {Integer|null} 0 (none), 1 (present), -1 (missing), null (unavailable)
* @return {Object|null} - Resolved value from getBestAttachmentState() or { type: null } if
* unavailable
*/
Zotero.Item.prototype.getBestAttachmentStateCached = function () {
return this._bestAttachmentState;
return this._bestAttachmentState || { type: null };
}

5
chrome/locale/en-US/zotero/zotero.properties
View file

@ -405,7 +405,10 @@ pane.item.attachments.delete.confirm = Are you sure you want to delete this att
pane.item.attachments.count.zero = %S attachments:
pane.item.attachments.count.singular = %S attachment:
pane.item.attachments.count.plural = %S attachments:
pane.item.attachments.has = Has attachments
pane.item.attachments.has = Has attachment
pane.item.attachments.hasPDF = Has PDF attachment
pane.item.attachments.hasSnapshot = Has snapshot
pane.item.attachments.hasLink = Has link
pane.item.attachments.select = Select a File
pane.item.attachments.PDF.installTools.title = PDF Tools Not Installed
pane.item.attachments.PDF.installTools.text = To use this feature, you must first install the PDF tools in the Search pane of the Zotero preferences.

17
scss/components/_item-tree.scss
View file

@ -29,6 +29,23 @@
.cell.hasAttachment {
box-sizing: content-box;
padding: 0 4px;
height: 100%;
.icon-treeitemattachmentpdf {
min-width: 10px;
max-width: 10px;
margin: 3px;
}
.icon-link {
min-width: 14px;
max-width: 14px;
margin: 2px 1px;
}
.icon-missing-file {
opacity: 0.4;
}
}
.cell.numNotes {