-
Notifications
You must be signed in to change notification settings - Fork 58
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
RumovZ
wants to merge
2
commits into
ankitects:main
Choose a base branch
from
RumovZ:add-exporter
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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; | ||
} | ||
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)); |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.