Skip to content

Latest commit

 

History

History
204 lines (150 loc) · 8.71 KB

README.md

File metadata and controls

204 lines (150 loc) · 8.71 KB
icon

GitHub release (latest by date including pre-releases) GitHub Release Date GitHub License GitHub last commit GitHub repo size hits GitHub all releases

简体中文 | English

SiYuan Webpage View

A plugin for SiYuan Note that allows you to browse web pages in a tab or new window like a browser.

PREVIEW

preview image

INTRODUCTION

Function Introduction

  • Open hyperlinks in SiYuan Note new tabs (desktop only)
  • Open hyperlinks in a new window
  • Open the SiYuan Note editor in a new window
  • Block reference context menu
  • Hyperlink context menu

Setting Introduction

After installing this plugin, click SiYuan Settings > Marketplace > Downloaded > Plugins > Web View (this plugin) > Settings button to open the plugin's settings panel.

  • General Settings

    • User-Agent field (User-Agent, UA)

      • This is an input field.

      • Default content: empty

      • For details on this field, please refer to User-Agent - HTTP | MDN.

      • Users can browse web pages using a custom UA to replace the default UA.

      • This option can only be used on desktop devices.

        • When opening hyperlinks in a tab
        • When opening hyperlinks in a new window

      • When the input field is empty, the default UA SiYuan/x.y.z https://b3log.org/siyuan Electron will be used.

        • x.y.z is the current version number of SiYuan.

    • Web Page Background

    • Reset Settings Options

      • This is a button.

      • Resets all settings options to their default settings.

      • After clicking this button, a confirmation dialog will pop up.

        • Clicking the confirmation dialog button will reset all options for this plugin to their default settings, and the current interface will be automatically refreshed.

  • Open in a Tab

    • General Settings

      • Enable

        • This is a switch.
        • Default status: on
        • Once turned on, it enables the feature to open hyperlinks in a tab.
        • Due to the security restrictions of the browser, this feature can only be used on desktop devices.

      • Editor Hyperlinks

        • This is a switch.
        • Default status: on
        • Only available when the Enable switch in the General Settings tab is turned on.
        • Once turned on, clicking on hyperlinks in the editor will open them in a new tab.

      • Other Hyperlinks

        • This is a switch.

        • Default status: on

        • Only available when the Enable switch in the General Settings tab is turned on.

        • Once turned on, clicking on hyperlinks outside of the editor will open them in a new tab.

          • For example, clicking on hyperlinks in the export preview page.

    • Hyperlink

      • Only available when the Enable switch in the General Settings tab is turned on.

      • List of active URL schemes

        • This is a group of switches.

        • Default status: all on

        • Only active network protocols can be opened in new tab.

          • Other protocols/inactive protocols can be opened with the default program.

      • List of active asset file paths

        • This is a group of switches.

        • Default status: all off

        • Only the resource files in the active path can be opened in new tab.

          • Other paths/inactive paths can be opened with the default program.

    • Shortcut Keys

      • This is a group of switches.
      • Default status: left mouse button single click
      • Only available when the Enable switch in the General Settings tab is turned on.
      • Configures the keyboard shortcut needed to open hyperlinks in a tab.

  • Open in a Window

    • General Settings

      • Enable

        • This is a switch.
        • Default status: on
        • Once turned on, it enables the feature to open hyperlinks in a new window.

      • Editor Hyperlinks

        • This is a switch.
        • Default status: on
        • Only available when the Enable switch in the General Settings tab is turned on.
        • Once turned on, clicking on hyperlinks in the editor with the middle mouse button will open them in a new window.

      • Other Hyperlinks

        • This is a switch.

        • Default status: off

        • Only available when the Enable switch in the General Settings tab is turned on.

        • Once turned on, clicking on hyperlinks outside of the editor with the middle mouse button will open them in a new window.

          • For example, clicking on hyperlinks in the export preview page.
          • The hyperlink will also be opened with the default browser.

    • Hyperlink

      • Only available when the Enable switch in the General Settings tab is turned on.

      • List of active URL schemes

        • This is a group of switches.

        • Default status: all on

        • Only active network protocols can be opened in new window.

          • Other protocols/inactive protocols can be opened with the default program.

      • List of active asset file paths

        • This is a group of switches.

        • Default status: all off

        • Only the resource files in the active path can be opened in new window.

          • Other paths/inactive paths can be opened with the default program.

    • Shortcut Keys

      • This is a group of switches.
      • Default status: middle mouse button click
      • Only available when the Enable switch in the General Settings tab is turned on.
      • Configures the keyboard shortcuts needed to open hyperlinks in a new window.

    • SiYuan Editor

      • Enable

        • This is a switch.

        • Default status: on

        • Once turned on, it enables the feature to open the SiYuan editor in a new window.

          • Clicking on elements in the SiYuan interface with the configured keyboard shortcut will open the SiYuan editor in a new window and jump to the corresponding position.

          • Clickable elements include:

            • Block: any block in the editor
            • Block Icon: the icon displayed when hovering over a block with the mouse
            • Block Reference: inline element block reference
            • Breadcrumb: each item in the breadcrumb
            • Document Title: the title area of the document
            • Outline: each item in the outline panel
            • Document Tree: each item in the document tree
            • Backlink Panel: each item in the backlink panel
            • Floating Preview Window: the title bar of the floating preview window.

      • Desktop Editor

        • This is a button.
        • Clicking it will open a desktop SiYuan editor in a new window.

      • Mobile Editor

        • This is a button.
        • Clicking it will open a mobile SiYuan editor in a new window.

      • Focus

        • This is a switch.
        • Default status: off
        • Once turned on, when the SiYuan editor is opened in a new window, the corresponding block will be focused.

      • Editor Type

        • This is a drop-down selector.
        • Default status: Mobile Editor
        • You can choose which type of SiYuan editor to open in a new window.

CHANGELOG

CHANGELOG.md