Add debug builds

Signed-off-by: Tobias Manske <tobias.manske@mailbox.org>

.drone.yml

@@ -0,0 +1,32 @@
+---
+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 slugify
+      - ./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:
+        - "*.ankiaddon"
+
+image_pull_secrets:
+  - registry

.gitignore

@@ -166,3 +166,7 @@ tags
 # End of https://www.toptal.com/developers/gitignore/api/vim,python
 *.ankiaddon
 .DS_Store
+
+# Stores actual addon config if the src directory is symlinked into an anki installation during development
+src/meta.json
+src/manifest.json

build.sh

@@ -1,11 +1,27 @@
 #!/bin/bash
 set -e
+set -o nounset
+
+SLUG=$(slugify "${DRONE_COMMIT_REF}")
 
 if [ -d src/__pycache__ ]; then
     rm -r src/__pycache__
 fi
 
 cd src
-zip -r ../editor-preview.ankiaddon *
+
+# Create Manifest
+cat - > manifest.json <<EOF
+{
+  "name": "Editor Live Preview - ${SLUG}",
+  "package": "editor-live-preview-${SLUG}"
+}
+EOF
+
+zip -r ../editor-preview-external.ankiaddon --exclude meta.json -- *
+zip -r ../editor-preview-ankiweb.ankiaddon --exclude meta.json --exclude manifest.json -- *
 cd ..
-unzip -l  editor-preview.ankiaddon
+echo "Ankiweb Contents"
+unzip -l editor-preview-ankiweb.ankiaddon
+echo "External Contents"
+unzip -l editor-preview-external.ankiaddon

src/__init__.py

@@ -8,8 +8,9 @@ from aqt.webview import AnkiWebView
 
 config = mw.addonManager.getConfig(__name__)
 
+
 class EditorPreview(object):
-    js=[
+    js = [
         "js/mathjax.js",
         "js/vendor/mathjax/tex-chtml.js",
         "js/reviewer.js",
@@ -18,7 +19,8 @@ class EditorPreview(object):
     def __init__(self):
         gui_hooks.editor_did_init.append(self.editor_init_hook)
         gui_hooks.editor_did_init_buttons.append(self.editor_init_button_hook)
-        if int(buildinfo.version.split(".")[2]) < 45: # < 2.1.45
+        self.scrollLock = config["enableScrollLockByDefault"]
+        if int(buildinfo.version.split(".")[2]) < 45:  # < 2.1.45
             self.js = [
                 "js/vendor/jquery.min.js",
                 "js/vendor/css_browser_selector.min.js",
@@ -27,71 +29,126 @@ class EditorPreview(object):
                 "js/reviewer.js",
             ]
 
-
     def editor_init_hook(self, ed: editor.Editor):
-        ed.webview = AnkiWebView(title="editor_preview")
+        ed.editor_preview = AnkiWebView(title="editor_preview")
         # This is taken out of clayout.py
-        ed.webview.stdHtml(
+        ed.editor_preview.stdHtml(
             ed.mw.reviewer.revHtml(),
             css=["css/reviewer.css"],
             js=self.js,
             context=ed,
         )
 
-        if not config['showPreviewAutomatically']:
+        if not config["showPreviewAutomatically"]:
-            ed.webview.hide()
+            ed.editor_preview.hide()
 
         self._inject_splitter(ed)
         gui_hooks.editor_did_fire_typing_timer.append(lambda o: self.onedit_hook(ed, o))
-        gui_hooks.editor_did_load_note.append(lambda o: None if o != ed else self.editor_note_hook(o))
+        gui_hooks.editor_did_load_note.append(
+            lambda o: None if o != ed else self.editor_note_hook(o)
+        )
+
+    def _get_splitter(self, editor):
+        layout = editor.outerLayout
+        mainR, editorR = [int(r) for r in config["splitRatio"].split(":")]
+        location = config["location"]
+        split = QSplitter()
+        if location == "above":
+            split.setOrientation(Qt.Vertical)
+            split.addWidget(editor.editor_preview)
+            split.addWidget(editor.web)
+            sizes = [editorR, mainR]
+        elif location == "below":
+            split.setOrientation(Qt.Vertical)
+            split.addWidget(editor.web)
+            split.addWidget(editor.editor_preview)
+            sizes = [mainR, editorR]
+        elif location == "left":
+            split.setOrientation(Qt.Horizontal)
+            split.addWidget(editor.editor_preview)
+            split.addWidget(editor.web)
+            sizes = [editorR, mainR]
+        elif location == "right":
+            split.setOrientation(Qt.Horizontal)
+            split.addWidget(editor.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):
         layout = editor.outerLayout
-        split = QSplitter()
-        split.setOrientation(Qt.Vertical)
         web_index = layout.indexOf(editor.web)
         layout.removeWidget(editor.web)
-        split.addWidget(editor.web)
+
-        split.addWidget(editor.webview)
+        split = self._get_splitter(editor)
-        splitRatio = config['splitRatio']
-        upperR, lowerR = [int(r) for r in splitRatio.split(":")]
-        split.setStretchFactor(0, upperR)
-        split.setStretchFactor(1, lowerR)
         layout.insertWidget(web_index, split)
 
+    def isScrollLocked(self):
+        return self.scrollLock
+
+    def toggleScrollLock(self):
+        self.scrollLock = not self.scrollLock
 
     def editor_note_hook(self, editor):
-        self.onedit_hook(editor, editor.note)
+        # Dont lock the editor in place when loading a new note
+        # i.e. when using the cards browser
+        self.onedit_hook(editor, editor.note, keep_scrollbar_value=False)
 
     def editor_init_button_hook(self, buttons, editor):
         addon_path = os.path.dirname(__file__)
-        icons_dir = os.path.join(addon_path, 'icons')
+        icons_dir = os.path.join(addon_path, "icons")
-        b = editor.addButton(icon=os.path.join(icons_dir, 'file.svg'), cmd="_editor_toggle_preview", tip='Toggle Live Preview',
+        previewButton = editor.addButton(
-                    func=lambda o=editor: self.onEditorPreviewButton(o), disables=False
+            icon=os.path.join(icons_dir, "file.svg"),
-             )
+            cmd="_editor_toggle_preview",
-        buttons.append(b)
+            tip="Toggle Live Preview",
+            func=lambda o=editor: self.onEditorPreviewButton(o),
+            disables=False,
+        )
+        scrollLockButton = editor.addButton(
+            # icon=os.path.join(icons_dir, "file.svg"),
+            icon=None,
+            label="🔒",
+            cmd="_editor_toggle_scroll_lock",
+            tip="Toggle Scroll Locking",
+            func=lambda o=editor: self.onEditorScrollLockButton(o),
+            disables=True,
+        )
+        buttons.append(previewButton)
+        buttons.append(scrollLockButton)
 
     def onEditorPreviewButton(self, origin: editor.Editor):
-        if origin.webview.isHidden():
+        if origin.editor_preview.isHidden():
-            origin.webview.show()
+            origin.editor_preview.show()
         else:
-            origin.webview.hide()
+            origin.editor_preview.hide()
 
+    def onEditorScrollLockButton(self, origin: editor.Editor):
+        self.toggleScrollLock()
 
     def _obtainCardText(self, note):
         c = note.ephemeral_card()
         a = mw.prepare_card_text_for_display(c.answer())
         a = gui_hooks.card_will_show(a, c, "clayoutAnswer")
-        if theme_manager.night_mode:
+        bodyclass = theme_manager.body_classes_for_card_ord(
-            bodyclass = theme_manager.body_classes_for_card_ord(c.ord, mw.pm.night_mode())
+            c.ord, theme_manager.night_mode
-        else:
+        )
-            bodyclass = theme_manager.body_classes_for_card_ord(c.ord)
         bodyclass += " editor-preview"
 
         return f"_showAnswer({json.dumps(a)},'{bodyclass}');"
 
-    def onedit_hook(self, editor, origin):
+    def onedit_hook(self, editor, origin, keep_scrollbar_value=True):
         if editor.note == origin:
-            editor.webview.eval(self._obtainCardText(editor.note))
+            page: QWebEnginePage = editor.editor_preview.page()
+            scrollbar_value = page.scrollPosition()
+            editor.editor_preview.eval(self._obtainCardText(editor.note))
+            if keep_scrollbar_value and self.isScrollLocked():
+                page.runJavaScript(
+                    f"window.scrollTo({scrollbar_value.x()}, {scrollbar_value.y()});"
+                )
+
 
 eprev = EditorPreview()

src/config.json

@@ -1 +1,6 @@
-{"showPreviewAutomatically": true, "splitRatio": "4:1"}
+{
+  "showPreviewAutomatically": true,
+  "splitRatio": "1:1",
+  "location": "below",
+  "enableScrollLockByDefault": true
+}

src/config.md

@@ -2,5 +2,11 @@
 \- `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: 4:1)
+&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/>
+\- `showPreviewAutomatically` [boolean (true | false)]:<br/>
+&nbsp;&nbsp;&nbsp;Whether to keep the scrollbar at the same location when text changed or not (default: true)<br/>
 <br/>