Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8d842f2a80 | ||
|
|
2366db009b | ||
|
|
8393cca8dd | ||
|
|
15e55ee126 |
@@ -25,7 +25,7 @@ npm run release # Bump version, commit, tag, and build
|
||||
This project does not currently have automated tests. To test manually:
|
||||
|
||||
1. Run `npm run build` to create the XPI
|
||||
2. Install the XPI in Zotero 7
|
||||
2. Install the XPI in Zotero 7–10
|
||||
3. Test export functionality manually via Tools menu
|
||||
|
||||
---
|
||||
|
||||
@@ -12,7 +12,7 @@ Export PDF and EPUB annotations from Zotero to Org-mode files for use with Emacs
|
||||
|
||||
## Requirements
|
||||
|
||||
- **[Zotero](https://www.zotero.org/) 7.0+**
|
||||
- **[Zotero](https://www.zotero.org/) 7.0+ (through 10.x)**
|
||||
- **[Better Notes](https://github.com/windingwind/zotero-better-notes)** plugin — must be installed before this plugin
|
||||
- **[Pandoc](https://pandoc.org/)** — for Markdown to Org conversion
|
||||
|
||||
@@ -89,7 +89,7 @@ src/
|
||||
├── exporter.ts # Attachment detection, sync checking, batch export
|
||||
├── converter.ts # Markdown → Org via pandoc, file I/O
|
||||
├── notifier.ts # Zotero event handlers (sync finish, tab close)
|
||||
└── menu.ts # Menu registration (Zotero 7 + 8 compatible)
|
||||
└── menu.ts # Menu registration (Zotero 7 + 8/10 compatible)
|
||||
|
||||
addon/ # Static plugin files copied verbatim into the XPI
|
||||
├── manifest.json
|
||||
@@ -170,7 +170,7 @@ The dev server (`npm start`) watches for changes in `src/` and `addon/`, rebuild
|
||||
There are no automated tests. To test manually:
|
||||
|
||||
1. `npm run build` to produce the XPI
|
||||
2. Install the XPI in a Zotero 7 instance via **Tools → Add-ons → Install Add-on From File...**
|
||||
2. Install the XPI in a Zotero 7–10 instance via **Tools → Add-ons → Install Add-on From File...**
|
||||
3. Exercise the export functionality manually via the Tools menu and right-click context menu
|
||||
|
||||
### Releasing
|
||||
|
||||
+2
-2
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"manifest_version": 2,
|
||||
"name": "Zotero Org Export Annotations",
|
||||
"version": "1.0.0",
|
||||
"version": "1.0.1",
|
||||
"description": "Export Zotero PDF/EPUB annotations to Org-mode files for Emacs, org-roam, and citar",
|
||||
"author": "Ignacio",
|
||||
"homepage_url": "https://gitea.bueso.eu/ignacio.ballesteros/zotero-notes-export-org",
|
||||
@@ -14,7 +14,7 @@
|
||||
"id": "org-export-annotations@zotero.org",
|
||||
"update_url": "https://gitea.bueso.eu/ignacio.ballesteros/zotero-notes-export-org/releases/download/release/update.json",
|
||||
"strict_min_version": "7.0",
|
||||
"strict_max_version": "8.*"
|
||||
"strict_max_version": "10.0.*"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "zotero-org-export-annotations",
|
||||
"version": "1.0.0",
|
||||
"version": "1.0.3",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "zotero-org-export-annotations",
|
||||
"version": "1.0.0",
|
||||
"version": "1.0.3",
|
||||
"license": "GPL-3.0-or-later",
|
||||
"devDependencies": {
|
||||
"@types/node": "^20.11.0",
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "zotero-org-export-annotations",
|
||||
"version": "1.0.0",
|
||||
"version": "1.0.3",
|
||||
"description": "Export Zotero PDF/EPUB annotations to Org-mode files for Emacs integration",
|
||||
"config": {
|
||||
"addonName": "Zotero Org Export Annotations",
|
||||
|
||||
@@ -31,6 +31,10 @@ export class OrgExportAnnotationsAddon {
|
||||
this.log(`Initialized version ${this.version}`);
|
||||
}
|
||||
|
||||
isBetterNotesInstalled(): boolean {
|
||||
return Boolean(Zotero.BetterNotes?.api?.convert?.note2md);
|
||||
}
|
||||
|
||||
log(message: string, ...args: unknown[]): void {
|
||||
if (this.data.env === "development" || this.prefs?.debug) {
|
||||
Zotero.debug(`[OrgExportAnnotations] ${message}`, false);
|
||||
|
||||
+12
-4
@@ -12,14 +12,22 @@ export interface Hooks {
|
||||
onMenuExportSelected(): Promise<void>;
|
||||
}
|
||||
|
||||
function showNotification(message: string): void {
|
||||
function showNotification(message: string, headline = "Org Export"): void {
|
||||
const pw = new Zotero.ProgressWindow({ closeOnClick: true });
|
||||
pw.changeHeadline("Org Export");
|
||||
pw.changeHeadline(headline);
|
||||
pw.addDescription(message);
|
||||
pw.show();
|
||||
pw.startCloseTimer(4000);
|
||||
}
|
||||
|
||||
function warnBetterNotesRequired(addon: OrgExportAnnotationsAddon): void {
|
||||
const message =
|
||||
"Better Notes plugin is required for Org export.\n" +
|
||||
"Please install it from: https://github.com/windingwind/zotero-better-notes";
|
||||
addon.warn(message);
|
||||
showNotification(message, "Org Export - Missing Requirement");
|
||||
}
|
||||
|
||||
export function createHooks(addon: OrgExportAnnotationsAddon): Hooks {
|
||||
let notifierIDs: string[] = [];
|
||||
|
||||
@@ -35,8 +43,8 @@ export function createHooks(addon: OrgExportAnnotationsAddon): Hooks {
|
||||
Zotero.uiReadyPromise,
|
||||
]);
|
||||
|
||||
if (!Zotero.BetterNotes) {
|
||||
addon.warn("Better Notes plugin not found - some features may not work");
|
||||
if (!addon.isBetterNotesInstalled()) {
|
||||
warnBetterNotesRequired(addon);
|
||||
}
|
||||
|
||||
Zotero.PreferencePanes.register({
|
||||
|
||||
@@ -9,6 +9,7 @@ Zotero.OrgExportAnnotations = {
|
||||
log: addon.log.bind(addon),
|
||||
error: addon.error.bind(addon),
|
||||
warn: addon.warn.bind(addon),
|
||||
isBetterNotesInstalled: addon.isBetterNotesInstalled.bind(addon),
|
||||
get id() {
|
||||
return addon.id;
|
||||
},
|
||||
|
||||
@@ -9,6 +9,13 @@ export async function convertToOrg(
|
||||
const mdPath = PathUtils.join(notesPath, `${citationKey}.md`);
|
||||
|
||||
try {
|
||||
if (!Zotero.OrgExportAnnotations.isBetterNotesInstalled()) {
|
||||
throw new Error(
|
||||
"Better Notes plugin is required for Org export. " +
|
||||
"Please install it from: https://github.com/windingwind/zotero-better-notes"
|
||||
);
|
||||
}
|
||||
|
||||
const mdContent = await Zotero.BetterNotes!.api.convert.note2md(note, notesPath);
|
||||
await Zotero.File.putContentsAsync(mdPath, mdContent);
|
||||
|
||||
|
||||
@@ -143,8 +143,11 @@ export class OrgExporter {
|
||||
throw new Error("Notes path is not configured");
|
||||
}
|
||||
|
||||
if (!Zotero.BetterNotes?.api?.convert?.note2md) {
|
||||
throw new Error("Better Notes plugin is required but not found");
|
||||
if (!Zotero.OrgExportAnnotations.isBetterNotesInstalled()) {
|
||||
throw new Error(
|
||||
"Better Notes plugin is required for Org export. " +
|
||||
"Please install it from: https://github.com/windingwind/zotero-better-notes"
|
||||
);
|
||||
}
|
||||
|
||||
await this.prefs.ensureNotesDirectory();
|
||||
|
||||
@@ -18,7 +18,7 @@ export default defineConfig({
|
||||
{
|
||||
entryPoints: ["src/index.ts"],
|
||||
bundle: true,
|
||||
target: "firefox128",
|
||||
target: "firefox140",
|
||||
outfile: ".scaffold/build/addon/content/scripts/index.js",
|
||||
},
|
||||
],
|
||||
|
||||
Reference in New Issue
Block a user