Compare commits

..

1 Commits

Author SHA1 Message Date
Nick
4737d085fe
Add light mode in addition to night mode
This utilizes Anki's theme_manager to determine if the default light version of a card should be used in the Editor Live Preview or if the night mode version should be used.
2022-08-03 11:34:27 -05:00
7 changed files with 32 additions and 164 deletions

View File

@ -1,31 +0,0 @@
---
kind: pipeline
type: docker
name: Build Anki Plugin
trigger:
event:
include:
- tag
steps:
- name: Build Archive
image: debian:bookworm
pull: always
commands:
- apt-get update && apt-get install -y zip
- ./build.sh
- name: Upload Artifact to Gitea
depends_on:
- Build Archive
image: plugins/gitea-release
settings:
api_key:
from_secret: gitea_api_token
checksum: sha256
base_url: https://git.tobiasmanske.de
files: editor-preview.ankiaddon
image_pull_secrets:
- registry

5
.gitignore vendored
View File

@ -117,7 +117,6 @@ venv/
ENV/ ENV/
env.bak/ env.bak/
venv.bak/ venv.bak/
.idea
# Spyder project settings # Spyder project settings
.spyderproject .spyderproject
@ -166,7 +165,3 @@ tags
# End of https://www.toptal.com/developers/gitignore/api/vim,python # End of https://www.toptal.com/developers/gitignore/api/vim,python
*.ankiaddon *.ankiaddon
.DS_Store
# Stores actual addon config if the src directory is symlinked into an anki installation during development
src/meta.json

View File

@ -6,6 +6,6 @@ if [ -d src/__pycache__ ]; then
fi fi
cd src cd src
zip -r ../editor-preview.ankiaddon --exclude meta.json -- * zip -r ../editor-preview.ankiaddon *
cd .. cd ..
unzip -l editor-preview.ankiaddon unzip -l editor-preview.ankiaddon

View File

@ -1,5 +1,4 @@
import json import json
from typing import Set
from anki import hooks, buildinfo from anki import hooks, buildinfo
from aqt import editor, gui_hooks, mw from aqt import editor, gui_hooks, mw
@ -7,12 +6,9 @@ from aqt.utils import *
from aqt.theme import theme_manager from aqt.theme import theme_manager
from aqt.webview import AnkiWebView from aqt.webview import AnkiWebView
config = mw.addonManager.getConfig(__name__)
class EditorPreview(object): class EditorPreview(object):
editors: Set[editor.Editor] = set() js=[
js = [
"js/mathjax.js", "js/mathjax.js",
"js/vendor/mathjax/tex-chtml.js", "js/vendor/mathjax/tex-chtml.js",
"js/reviewer.js", "js/reviewer.js",
@ -21,18 +17,7 @@ class EditorPreview(object):
def __init__(self): def __init__(self):
gui_hooks.editor_did_init.append(self.editor_init_hook) gui_hooks.editor_did_init.append(self.editor_init_hook)
gui_hooks.editor_did_init_buttons.append(self.editor_init_button_hook) gui_hooks.editor_did_init_buttons.append(self.editor_init_button_hook)
gui_hooks.editor_did_load_note.append(self.editor_note_hook) if int(buildinfo.version.split(".")[2]) < 45: # < 2.1.45
gui_hooks.editor_did_fire_typing_timer.append(self.onedit_hook)
buildversion = buildinfo.version.split(".")
# Anki changed their versioning scheme in 2023 to year.month(.patch), causing things to explode here.
if int(buildversion[0]) >= 24 or (int(buildversion[0]) == 23 and int(buildversion[1]) == 12 and 2 < len(buildversion) and int(buildversion[2])) >= 1: # >= 23.12.1
self.js = [
"js/mathjax.js",
"js/vendor/mathjax/tex-chtml-full.js",
"js/reviewer.js",
]
elif int(buildversion[0]) < 23 and int(buildversion[2]) < 45: # < 2.1.45
self.js = [ self.js = [
"js/vendor/jquery.min.js", "js/vendor/jquery.min.js",
"js/vendor/css_browser_selector.min.js", "js/vendor/css_browser_selector.min.js",
@ -41,112 +26,64 @@ class EditorPreview(object):
"js/reviewer.js", "js/reviewer.js",
] ]
def editor_init_hook(self, ed: editor.Editor): def editor_init_hook(self, ed: editor.Editor):
ed.editor_preview = AnkiWebView(title="editor_preview") ed.webview = AnkiWebView(title="editor_preview")
# This is taken out of clayout.py # This is taken out of clayout.py
ed.editor_preview.stdHtml( ed.webview.stdHtml(
ed.mw.reviewer.revHtml(), ed.mw.reviewer.revHtml(),
css=["css/reviewer.css"], css=["css/reviewer.css"],
js=self.js, js=self.js,
context=ed, context=ed,
) )
if not config["showPreviewAutomatically"]:
ed.editor_preview.hide()
self._inject_splitter(ed) self._inject_splitter(ed)
gui_hooks.editor_did_fire_typing_timer.append(lambda o: self.onedit_hook(ed, o))
def _get_splitter(self, editor): gui_hooks.editor_did_load_note.append(lambda o: None if o != ed else self.editor_note_hook(o))
mainR, editorR = [int(r) * 10000 for r in config["splitRatio"].split(":")]
location = config["location"]
split = QSplitter()
if location == "above":
split.setOrientation(Qt.Orientation.Vertical)
split.addWidget(editor.editor_preview)
split.addWidget(editor.wrapped_web)
sizes = [editorR, mainR]
elif location == "below":
split.setOrientation(Qt.Orientation.Vertical)
split.addWidget(editor.wrapped_web)
split.addWidget(editor.editor_preview)
sizes = [mainR, editorR]
elif location == "left":
split.setOrientation(Qt.Orientation.Horizontal)
split.addWidget(editor.editor_preview)
split.addWidget(editor.wrapped_web)
sizes = [editorR, mainR]
elif location == "right":
split.setOrientation(Qt.Orientation.Horizontal)
split.addWidget(editor.wrapped_web)
split.addWidget(editor.editor_preview)
sizes = [mainR, editorR]
else:
raise ValueError("Invalid value for config key location")
split.setSizes(sizes)
return split
def _inject_splitter(self, editor: editor.Editor): def _inject_splitter(self, editor: editor.Editor):
layout = editor.web.parentWidget().layout() layout = editor.outerLayout
if layout is None: split = QSplitter()
layout = QVBoxLayout() split.setOrientation(Qt.Vertical)
editor.web.parentWidget().setLayout(layout)
web_index = layout.indexOf(editor.web) web_index = layout.indexOf(editor.web)
layout.removeWidget(editor.web) layout.removeWidget(editor.web)
split.addWidget(editor.web)
# Wrap a widget on the outer layer of the webview split.addWidget(editor.webview)
# So that other plugins can continue to modify the layout split.setStretchFactor(0, 0)
editor.wrapped_web = QWidget() split.setStretchFactor(1, 1)
wrapLayout = QHBoxLayout() split.setStretchFactor(2, 1)
editor.wrapped_web.setLayout(wrapLayout)
wrapLayout.addWidget(editor.web)
split = self._get_splitter(editor)
layout.insertWidget(web_index, split) layout.insertWidget(web_index, split)
def editor_note_hook(self, editor): def editor_note_hook(self, editor):
self.editors = set(filter(lambda it: it.note is not None, self.editors)) self.onedit_hook(editor, editor.note)
self.editors.add(editor)
# The initial loading of notes will also trigger an editing event
# which will cause a second refresh
# Caching the content of notes here will be used to determine if the content has changed
editor.cached_fields = list(editor.note.fields)
self.refresh(editor)
def editor_init_button_hook(self, buttons, editor): def editor_init_button_hook(self, buttons, editor):
addon_path = os.path.dirname(__file__) b = editor.addButton(icon=None, cmd="_editor_toggle_preview", label='P', tip='Toggle Live Preview',
icons_dir = os.path.join(addon_path, "icons") func=lambda o=editor: self.onEditorPreviewButton(o), disables=False
b = editor.addButton(
icon=os.path.join(icons_dir, "file.svg"),
cmd="_editor_toggle_preview",
tip="Toggle Live Preview",
func=lambda o=editor: self.onEditorPreviewButton(o),
disables=False,
) )
buttons.append(b) buttons.append(b)
def onEditorPreviewButton(self, origin: editor.Editor): def onEditorPreviewButton(self, origin: editor.Editor):
if origin.editor_preview.isHidden(): if origin.webview.isHidden():
origin.editor_preview.show() origin.webview.show()
else: else:
origin.editor_preview.hide() origin.webview.hide()
def _obtainCardText(self, note): def _obtainCardText(self, note):
c = note.ephemeral_card() c = note.ephemeral_card()
a = mw.prepare_card_text_for_display(c.answer()) a = mw.prepare_card_text_for_display(c.answer())
a = gui_hooks.card_will_show(a, c, "clayoutAnswer") a = gui_hooks.card_will_show(a, c, "clayoutAnswer")
bodyclass = theme_manager.body_classes_for_card_ord(c.ord, theme_manager.night_mode) if theme_manager.night_mode:
bodyclass += " editor-preview" bodyclass = theme_manager.body_classes_for_card_ord(c.ord, mw.pm.night_mode())
else:
bodyclass = theme_manager.body_classes_for_card_ord(c.ord)
return f"_showAnswer({json.dumps(a)},'{bodyclass}');" return f"_showAnswer({json.dumps(a)},'{bodyclass}');"
def onedit_hook(self, note): def onedit_hook(self, editor, origin):
for editor in self.editors: if editor.note == origin:
if editor.note == note and editor.cached_fields != note.fields: editor.webview.eval(self._obtainCardText(editor.note))
editor.cached_fields = list(note.fields)
self.refresh(editor)
def refresh(self, editor):
editor.editor_preview.eval(self._obtainCardText(editor.note))
eprev = EditorPreview() eprev = EditorPreview()

View File

@ -1,5 +0,0 @@
{
"showPreviewAutomatically": true,
"splitRatio": "1:1",
"location": "below"
}

View File

@ -1,9 +0,0 @@
### Config
\- `showPreviewAutomatically` [boolean (true | false)]:<br/>
&nbsp;&nbsp;&nbsp;Defines if the preview window should show up automatically as you enter the Editor (default: true)<br/><br/>
\- `splitRatio` [int:int]:<br/>
&nbsp;&nbsp;&nbsp;Defines the default split ratio of the main view and preview view (default: 1:1)<br/>
<br/>
\- `location` [string (above | below | left | right)]:<br/>
&nbsp;&nbsp;&nbsp;Defines where to render the preview (default: below)
<br/>

View File

@ -1,19 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 26.4.1, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" id="Layer_2" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
viewBox="0 0 16 16" style="enable-background:new 0 0 16 16;" xml:space="preserve">
<style type="text/css">
.st0{stroke:#000000;stroke-width:0.5;stroke-miterlimit:10;}
</style>
<g>
<path class="st0" d="M8.7,14.1H2.2c-0.2,0-0.4-0.2-0.4-0.4V2.4c0-0.2,0.2-0.4,0.4-0.4h9.3c0.2,0,0.4,0.2,0.4,0.4v2.8
c0,0.2,0.2,0.4,0.4,0.4c0.2,0,0.4-0.2,0.4-0.4V2.4c0-0.7-0.6-1.3-1.3-1.3H2.2c-0.7,0-1.3,0.6-1.3,1.3v11.3c0,0.7,0.6,1.3,1.3,1.3
h6.5c0.2,0,0.4-0.2,0.4-0.4S9,14.1,8.7,14.1z"/>
<path class="st0" d="M15.4,14.2l-1.9-2c0.5-0.6,0.8-1.4,0.8-2.3c0-2-1.6-3.6-3.6-3.6S7.1,8,7.1,10s1.6,3.6,3.6,3.6
c0.8,0,1.6-0.3,2.2-0.7l1.9,2c0.1,0.1,0.2,0.1,0.3,0.1c0.1,0,0.2,0,0.3-0.1C15.6,14.7,15.6,14.4,15.4,14.2L15.4,14.2z M10.7,12.7
C9.2,12.7,8,11.5,8,10s1.2-2.7,2.7-2.7s2.7,1.2,2.7,2.7S12.2,12.7,10.7,12.7z M9.1,5.2c0-0.2-0.2-0.4-0.4-0.4H3.6
C3.4,4.8,3.2,5,3.2,5.2c0,0.2,0.2,0.4,0.4,0.4h5.1C9,5.6,9.1,5.4,9.1,5.2z M6.5,7.6c0-0.2-0.2-0.4-0.4-0.4H3.6
c-0.2,0-0.4,0.2-0.4,0.4S3.4,8,3.6,8h2.5C6.3,8,6.5,7.8,6.5,7.6z M3.6,9.6c-0.2,0-0.4,0.2-0.4,0.4c0,0.2,0.2,0.4,0.4,0.4h1.3
c0.2,0,0.4-0.2,0.4-0.4c0-0.2-0.2-0.4-0.4-0.4H3.6z"/>
</g>
</svg>

Before

Width:  |  Height:  |  Size: 1.4 KiB