youfoundjk_TeXcore/docs/features/quick-preview.md
JK ba4f64eeb4 Refactor documentation and enhance features for TeXcore plugin
- Updated PDF export documentation to clarify features and settings.
- Improved quick preview functionality with detailed technical architecture.
- Enhanced equation search and autocomplete sections for better user guidance.
- Streamlined snippets documentation for command usage and text transformations.
- Revamped TikZ diagrams section to include graphical editor details and usage instructions.
- Revised getting started guide for clearer step-by-step setup instructions.
- Added new navigation and configuration options in the documentation structure.
- Updated plugin manifest files with improved descriptions for clarity.
2026-06-06 11:50:35 +02:00

1.9 KiB

Quick Hover Previews

TeXcore integrates with Obsidian's core page preview mechanics to display real-time, mathematical popups whenever you hover over an equation link like [[#^eq-einstein]] or highlight items in the Autocomplete Suggestions Menu.


Technical Architecture

The preview lookup hooks into Obsidian's internal page-preview engine. TeXcore intercepts link hover events, references the identifier against the active document's equation cache, locates the line offset, and scrolls the popup container to display the equation in focus.

sequenceDiagram
    participant User as Editor hover
    participant PP as Page Preview Plugin
    participant C as TeXcore Cache
    participant V as Preview Popup View
    
    User->>PP: Hover [[#^eq-id]]
    PP->>C: Query eq-id coordinate
    C-->>PP: Return line number
    PP->>V: Compile MathJax & scroll to line
    V->>User: Display preview popup

Requirements & Setup

!!! important "Enable Core Page Preview" This feature relies on Obsidian's core architecture. Open SettingsCore plugins and toggle Page preview to Enable. If this core dependency is deactivated, TeXcore will log a console warning and hover previews will fallback to standard text previews without viewport scrolling.


Troubleshooting Previews

If preview boxes fail to load or scroll incorrectly, consult the diagnostic table below:

Symptom Cause Solution
No preview modal opens Page Preview core plugin is toggled off. Toggle on Page Preview in Obsidian settings.
Formula text displays raw LaTeX MathJax rendering is disabled for suggestions. Toggle on Render Math in Suggestions.
Preview focuses the wrong line Malformed % id: eq-name or stale index cache. Touch-edit the note content to trigger a cache re-index.