Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add demo add-on for adding a custom exporter #21

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions demos/add_exporter/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
"""
An example of adding an exporter to export page.
"""

from pathlib import Path

from aqt import gui_hooks
from aqt.webview import AnkiWebView


def setup(webview: AnkiWebView) -> None:
webview.eval(Path(__file__).with_name("init.js").read_text(encoding="utf8"))


gui_hooks.webview_did_inject_style_into_page.append(setup)
27 changes: 27 additions & 0 deletions demos/add_exporter/init.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
function updateExporters(exporters) {
for (const exporter of exporters) {
exporter.isDefault = false;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That feels like something every add-on author will try to do? What happens when multiple add-ons try to become the default?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If they do it like this the last one will win; if there are multiple defaults the first one due to how findIndex() works.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just wonder if it's useful to expose this - presumably all add-ons will want to do it, and then we might as well make it the default, or leave the defaults alone so things are consistent.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hadn't assumed users would have multiple add-ons adding custom exporters enabled at once very often.
How about we leave isDefault customisable, but remove it from the example?
That said, it doesn't really matter to me if we expose this, it's just a bit simpler this way.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Colud we perhaps make it simpler by making it a wantDefault instead? The standard importers could leave it off, and we could then select the first wantDefault, and fall back on the first importer if none have it set.

But that's assuming we want to expose this. One counterpoint for example: the 'special fields' add-on breaks the import of recent .apkg files. Allowing the defaults to be changed could make it harder for the user to realise that problems are caused by an add-on.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, no problem, I'll remove the default flag on the next occasion.

}
exporters.push({
extension: "csv",
label: "My fancy CSV",
showDeckList: true,
showIncludeScheduling: false,
showIncludeDeckConfigs: false,
showIncludeMedia: false,
showIncludeTags: false,
showIncludeHtml: false,
showLegacySupport: false,
showIncludeDeck: false,
showIncludeNotetype: false,
showIncludeGuid: false,
dae marked this conversation as resolved.
Show resolved Hide resolved
isDefault: true,
doExport: (outPath, limit, options) => {
alert("Not implemented!");
return Promise.resolve();
}
});
return exporters;
}

requireAsync("anki/ExportPage").then(mod => mod.exporters.update(updateExporters));