Equation Citator v1.3.7 Documentation
    Preparing search index...

    CHANGELOG 1.3.X

    Version 1.3.0

    Version 1.3.0 - New features, Refactors, Main improvements and User friendly improvements.

    🐛 Bug Fixes :

    • Fix bug #70, the auto-numbering behavior is now fixed.

    ⭐ New Features :

    • Brand New Settings Tab with grouped settings and sub-panels, which make setting more convenient than before. No more annoying scrolling.
    • Citation for figures (from feature #7 by Alicecomma) are now supported, titles, numbers and descriptions.
    • Citations for Callout, We can add tables to callout to make a citation to it. This feature also gives you flexibility to cite tables, text pieces and even theorems (quote all tables in callout to cite it).
    • Add PDF export support for figures and callouts.
    • Add Equations Manage Panels, Allowing you to retrieve all citations of specific equations, and also jump to their locations
      • Outline View, filter and collapse : Both List view and outline view are supported.
      • Drag-and Drop to citation : You can now drag-and-drop equation from equations manage panel to cite it.
      • Support the cross-file citations by dragging
      • Prompt when drag no-tag equations
      • Dynamic Update panel when change file and type in editor
      • interactive : support double-click jump and ctrl + double-click (new panel+jump)

    🏗️ Refactors :

    • For settings part, refactor code and split it into mutlitple modules.

    🚀Enhancements & improvements :

    • Add enhancement #50, better behavior for relocating cursor after auto-number equations.
    • When jump to equations in another panel now check if there already a panel of this file, and jump in this panel if there is.
    • Now debugging mode configurations will be saved after restarting Obsidian, so you needn’t toggle debug mode every time.
    • Remake a brand-new and more concise tutorial.
    • Remake Readme file to be more friendly and concise. Also add a Chinese translation of Readme.

    Version 1.3.1

    Version 1.3.1 - some new features, Refactors, bug fixes and many enhancements.

    ⭐ New Features :

    🐛 Bug Fixes :

    • Fix bug #78, now equation panel can correctly refreshed when firstly open equations manage panel.
    • Fix bug #89, drag-drop will correctly recognize current footnote

    🚀Enhancements :

    • Add Eslint obsidian plugin for better code check before submitting, run npm run check before submitting PR
    • Add lock button #88 into equations manage panel
    • Add enhancement #81, add show headings only panel, so in outline view, we can just use it as outline panel.
    • Optimize renderImageCaptions function, now it will not parse Markdown every time when fast typing.
    • Add enhancement #91, stop auto-numbering when theres content after equation block.
    • Add colorful callout support #88
    • Add render title and description in figure preview option in settings tab.
    • Remove Continuous Citation Delimiter from advanced settings.
    • Remove precise width and height settings for equation widgets, use multiple sizes instead.
    • Remove settings for display widget style, and now the style of widgets will automatically change according to the theme applied.

    🏗️ Refactors For review :

    • Change fetch to requestUrl for fetching equations
    • Fixed async & await functions
    • Remove unicode in quoteRegex
    • change console.log to console.debug
    • removed unnecessary assertions
    • use then to replace await in eventListener to avoid ts error
    • fixed some incorrect debugger.error
    • fixed UI text case
    • rafactor style settings, fix style managers, remove style settings code from hoverpopover.

    Version 1.3.2

    Version 1.3.2 - some new features, enhancements, refactors and bug fixes.

    ⭐ New Features :

    • Add feature #104, add a button to forbid equation panel to be refreshed.
    • Add feature #105. Add a settings in auto-numbering settings tab, only number equations already with tags.
      • Correct the behavior when insert equation with tags into specific file (only count the number before cursor).
    • Add feature #107, show only tagged equations in equations manage panel.
    • Fixed bugs in heading collapse hehavior in equations manage panel, now it behavior correctly after chevron clicked to change collapsed state.
    • Add List view in settings tab for search purpose.

    🚀Enhancements :

    • Use MathJax to render equations instead of MarkdownRenderer (in PR #108), improve performance greately.
    • Remove Lock to current file button, now Disable-Refresh do all the job.

      • New behavior : Disable-Refresh will diable the change of file and equations, but will still refresh if :

        1. View mode changed (from outline to list) or other view selections (like sort mode, filter options, etc)

        2. search query changed

      • This design is more user friendly, and also during refresh process, there would no file reading, which improves performance on large markdown files.

    • Add setting buttons for some default state of equation panel when opened.

    🏗️ Refactors :

    • Fix bugs mentioned in PR #7298
      • Change README title banner image.
      • Change innerHTML to .empty()
      • for every TargetElCompoponent, now it create in constructor and reuse it.
      • replace app.vault.modify() by app.vault.process()
      • Change UI text to sentence case
        • Settings tab
        • Equation panel
        • other pages
      • Avoid render title on settings tab
      • Avoid “Settings” in settings tab
      • Remove check updates button
      • Refactor section headings creation to use new Settings().setName().setTitle()
    • Refactored the rendering function for equation Manage Panel to improve readability and maintainability.

    🐛 Bug Fixes :

    • Fix bug #112, equations now correctly auto-numbered when auto number equations in quotes is enabled.

    • Fix bug #74, retain better equation written format after auto-numbering.

    • Fix issue #113, remove .github in gitignore file, and then add CI workflow.

    • Fix bug #110, PDF won’t be parsed for equation display.

    • Fix the bug that change widget size settings don’t take effect.

    • Fix bug #119, Cross file jump and citation now work correctly when equation panel locks refresh.

    • Fix bug #118, when file is firstly opened, the panel should be rendered correctly.

    • Fix bug #126.

      1. when put text to make illegal equaion at the last equation position, the auto-numbering will stop.

      2. corrected the line number information shown in notice.

      3. detect single-line illegal equation.

      4. For some case, the code block is counted in, which leads to incorrect line number information. Now fixed.

    Version 1.3.3

    Version 1.3.3 - bug fixes, new features and enhancements.

    Important Update summaries :

    • Excalidraw support is now available in figure citation preview!
    • Auto complete for figure and callout citations is now available!
    • Auto-number and rename tags for figures are now available!
    • Mobile support is now available!

    Settings Updates :

    • We refactored the variable name quoteCitationPrefixes to calloutCitationPrefixes for clarity. So your current settings for callout citation prefix will be restored. Be sure to re-set the settings for callout citation prefix in settings tab to make the callout citation work.

    ⭐ New Features :

    • Autocomplete for figure citation and callout citations.
      • Auto complete supports 2 modes : including rich mode and compact mode (Check Settings > Advanced > Show full preview in autocomplete).
      • For compact mode, hover on the autocomplete item will show the preview of the figure or callout. (Check Settings > Advanced > Show preview on hover on autocomplete item)
    • Rename tags for figures.
    • Autonumber tags for figures.
      • Following figure citations should be updated after auto-numbering or renaming tags.
    • Add Feature #140, filter for boxed equations in equation manage panel.
      • Command for box current equation.
    • Add Feature #143, now we support Excalidraw in figure citation.
    • Figure citaion format can now cite section preview.
    • Add support for mobile devices, also passed test on android devices.

    🐛 Bug Fixes :

    • fix bug #136, add tag for multi-line equation in callout now work correctly.
    • fix glitch #137, when the equation panel file and current active file is different, It will create a new window and jump to correct position.
    • fix bug #135, when edit the file at location before some folded titles, it will not unfold now.
    • fig bug #141, nested callouts now can be displayed correctly in callout citation preview.
    • fix bug #142, now the figures in callout will be correctly recognized and rendered in preview.

    🚀 enhancements :

    • fix the reorder button location style in settings tab.

    • add command insert figure citation for inserting figure citation quickly.

    • now hovering on Citation superscript for callouts and figures will show the file links.

    • ❌ Stop supporting the caption for web link figure, and add why we not support it to Quickstart tutorial.

    • Now the plugin passed tests on emulator on desktop (this.app.emulateMobile(true);), also changed the manifest.json to support mobile platform.

    🏗️ refactors :

    • refactored autocomplete suggest to add support for figure and callout citations.
    • refactored drag and drop handler in equation panel for better code structure and readability.
    • refactored the equation panel file, extract the outline view renderer to a separate file.
    • rename other settings in categorical settings tab to others (Obsidian plugin rule)
    • added normalizePath() to clean up the path throughout the plugin (Obsidian plugin rule)
    • refactor the auto-number function part for better code structure, reuse in figure auto-numbering and scalability.
    • remove node assert calls for mobile support
    • fixed lots of sonar issues for better code quality.
    • Change MarkdownfileProcessor callback function to sync function.

    Version 1.3.4

    Version 1.3.4 - Multi-Platform Support, bug fixes and improvements.

    Breaking Update Changes :

    • Now we use a configurable math renderer, we changed default renderer to a slow one for better stability, but you can still use the fast one by Settings > Display (Categorical) > Equation Panel > Use fast math renderer in equation panel.

    ✈️ Full-Cross-Platform Support :

    • Test this plugin on Linux and Mac platform (thanks to my friend @Tiddlefox)

    ⭐ New Features :

    • right-click to copy equations (both in equation panel and editor popover).
    • Show figures and callouts in the equation panel, not only equations.
      • Better Style + interaction for figure and callout items in the panel.
      • correct render for section view (better store at cache).

    🐛 Fixed Bugs :

    • fix bug #153, the collapse all button were combined into one and can work correctly now.
    • refactor collapsedHeadings to parsedCollapsedHeadings to prevent collapse state from growing indefinitely when switching between files.
    • Fix bug #152, line number information will refresh after editing the file before some headings.
    • Add data-line reassign mechanism for viewStateEqual case. So the line-number information still refresh correctly when editing at middle at pure-text files.
    • fix issue #151, add css to make up for style change in obsidian 1.12.4
    • Fix all new sonar issues for better code quality.
    • (Critical) Fix critical #157, by default we use slow but more stable obsidian build-in renderer. But MathJax is still available by Settings > Display (Categorical) > Equation Panel > Use fast math renderer in equation panel.

    📖 Documentation :

    • Add settings usage | equation panel button usage | rich auto complete mode in tutorial.
    • Updated Chinese translation for readme
    • Remade readme file for full feature introduction.

    🔩 Improvements

    • Rename auto-number xxx in quotes to auto-number xxx in callouts for better clarity (issue #154).
    • Remove basePath=. in manifest.json for further compatibility.
    • Simplify Auto numbering in some of setting options to Auto number
    • Improved auto-number logging : different tips on different autonumber types.
    • when click ‘open equation panel’ button will also reveal it in right panel.
    • Better PDF export configs : optional captions and descriptions in PDF export for image

    Version 1.3.5

    Bug fixes, improvements on PDF export function, added :

    1. Major support for the webpage notes export. (NPM package + batch export with metadata)
    2. Major Chinese UI translation supports. (Including settings, commands, and tooltips)
    3. Website-hosted documentation for all tutorials, changelogs and API documentations.

    ✨ New features :

    • Added feature #168, the available citation type will be auto-completed when the ref{} is empty.
    • Added markdown rendering support for both image caption and description (see PR #171)
    • Added full pdf support for markdown rendering result for image caption and description.
    • Added support for web-note rendering: provide metadata injection option to the pdf, which retains the metadata for the figures. It will also add detailed citation data to the
    • Added better spacing for the image export of PDF, preventing images to become crowd in many cases
    • Added batch markdown export command Sync repository to the website notes folder to sync the entire repository to the target website notes folder.
    • Added sync files/folders to the website notes folder options to the file explorer, Added sync current file to website notes folder command.
    • Added Option Render image captions and descriptions in settingsTab for the rendering of image captions/descriptions
    • Added #179, now drag
    • Added support for Chinese translation for all the UI of the SettingsTab options, Tooltips and Commands (Check PR #176)

    🔩 Improvements :

    • Adjusted the style of figure preview widget for better width limit, now checking the figure preview widget does not need horizontal scrolling.
    • Added caption and description for Excalidraw/markdwon sections in preview widget.

    📖 Documetations :

    • Migrated the tutorials, Change logs and the API documentations to a Webpage version.
    • Support citation preview/jump at the webpage building process.
    • Build the npm package for easy web note integration (https://www.npmjs.com/package/@friedparrot/equation-citator)
    • Refine the documentation, split tutorials/changelogs into several parts, and added some other useful techniques.
    • Added full Chinese translation for tutorials and Change logs.

    🐛 Fixed Bugs :

    • fixed #162, viewState refresh correctly when switch files
    • fixed #169, the colon is forced to be added in the citation prefix
    • fixed #163, when switch between files, the initial fold state will be stored.
    • fixed #164, code blocks now render correctly in callouts.
    • fixed critical #173, the PDF export can work correctly at the case some disturbing dollars are put inline.
    • fixed #172, when export without meta-data, the image width are still kept.
    • fixed #175, add recognition for native svg element of excalidraw when adding the caption and description for figures
    • fixed #177, the caption and description is rendered by markdown grammar in options part.
    • fixed #178, widget size will be preserved after the obsidian is reloaded or restarted.
    • fixed #180, ctrl + right-click behavior is now correct for callouts in manage panel.

    🏗️ refactors :

    • refactored and shortened pdf export code part
    • refactored getEquationAtCursor and function in box current equations
    • refactored figure citation wrapper function
    • refactored the figure caption extension part for better mainability
    • resolved sonar issues to make sure that the code quality gate is passed after pushing to main branch.

    Version 1.3.6 - 1.3.7

    Fixed the review issues

    Make sure the quality of the “Review” part is excellent in obsidian plugins.

    Resolved Obsidian reivew state issues :

    • resolved npm run check issues after re-enabling all the rules
    • Use ‘activeDocument’ instead of ‘document’ for popout window compatibility.
    • Unsafe assignment of an error or any typed value
    • Use ‘window.setTimeout()’ instead of ‘activeWindow.setTimeout()’. Timer functions should use ‘window’.
    • Use ‘window.clearTimeout()’ instead of ‘clearTimeout()’ for popout window compatibility.
    • Use ‘window.clearInterval()’ instead of ‘clearInterval()’ for popout window compatibility.
    • Avoid using ‘globalThis’. Use ‘window’ or ‘activeWindow’ for popout window compatibility.
    • Do not import Node.js built-in module “node:path”/“node:fs/promises”. Node.js APIs are not available on mobile. Use a dynamic import() or require() guarded by Platform.isDesktop instead.
    • Use ‘.instanceOf(HTMLElement)’ instead of ‘instanceof HTMLElement’ for cross-window safe type checking.
    • README contains unfilled placeholder text
    • Removed vulnerability advisory denpendence (now all dependences are dev dependences)
    • Uses document.createElement instead of Obsidian’s createEl helpers

    🚢 If you want following features, you can request it in issue page :

    1. Check citations of equations, figures and tables in equation manage panel.

    On This Page
    Version 1.3.0Version 1.3.1Version 1.3.2Version 1.3.3Version 1.3.4Version 1.3.5Version 1.3.6 - 1.3.7🚢 If you want following features, you can request it in issue page :