Beekmark Documentation

Master bookmark management and clipboard functionality

System Overview

Beekmark is a desktop productivity tool designed to optimize user workflows by deeply integrating bookmark management with clipboard functionality. Its core design philosophy is to act as a persistent central information hub in the system tray, unifying the management of four data types—text, URLs, files, and folders—and providing instant "Open" or "Copy" actions. When running in the background, the application has a minimal resource footprint and a negligible impact on system performance.

System Requirements

  • Operating System: Windows 10, Windows 11

Core Concept: Dual-Mode Operation and Individual Overrides

All operations in Beekmark are built around "Open" and "Copy" actions, with a high degree of customization.

  • Open Mode (Launcher): In this mode, Beekmark functions as a quick launcher. Clicking an item in the tray menu directly executes its associated action (e.g., opening a URL, running a file, displaying text).
  • Copy Mode (Clipboard): In this mode, Beekmark functions as a clipboard manager. Clicking an item in the tray menu copies its predefined content (e.g., URL link, text content, the file/folder itself) to the system clipboard.

Behavior Customization

  1. Global Default Action: Users can define the global default click action (Open or Copy) in "Settings."
  2. Per-Bookmark Action: Each bookmark can have its own default click action, which overrides the global setting. For example, an office worker might set the global default to "Copy" for quickly grabbing standard email templates and client addresses. At the same time, they could individually set the action for a URL bookmark pointing to the company's internal portal and a folder bookmark for their "Reports" directory to "Open," achieving optimal handling for different tasks.
  3. Temporary Override: Regardless of the current default mode, users can temporarily perform the opposite action by holding down the Alt key while clicking.

Feature Details

Content Management (Main Interface)

Item Types

Beekmark supports the management of the following four core item types:

  • Text: Stores frequently used text snippets, code, notes, etc.
  • URL: Stores web links.
  • File: Stores a shortcut pointing to a single file.
  • Folder: Stores a shortcut pointing to a folder.

Adding Items

  • Single Addition: New items or groups can be created via the "Add Bookmark" or "Add Group" buttons on the main interface.
  • Batch Import:
    • From Clipboard: The system automatically parses content from the clipboard. Supported formats include: text, URLs, files, and folders. It then generates a preview list for the user to select from for import.
    • From Browser Favorites: Supports importing standard HTML-formatted bookmark files exported from major browsers (e.g., Chrome, Firefox, Edge). The system preserves the original folder hierarchy as much as possible during import.

Editing and Deleting

  • Right-clicking on an item provides access to a context menu for "Edit," "Delete," or "Duplicate" actions.
  • Edit: Modify the item's name, content, assigned group, privacy status, and its individual default click action.
  • Delete: Deleting a single item removes it directly. When deleting a group, a confirmation dialog is displayed; upon confirmation, the group and all its contained sub-items are permanently removed.

Organization and Sorting

  • Groups: Users can create groups to categorize items. Groups support infinite nesting and are rendered as corresponding submenus in the system tray menu.
  • Sorting: Items in the root directory and within groups can be reordered in the following ways:
    1. Directly via mouse drag-and-drop.
    2. Using the up/down movement buttons on the right side of the interface after selecting an item.
    Limitation: All sorting functionalities (both drag-and-drop and move buttons) are temporarily disabled when a search or filter is active.

Core Functionality

Search and Filtering

The top section of the main interface provides a powerful real-time filtering area:

  • Filter by Group: A dropdown menu to display only items from the selected group.
  • Filter by Type: A dropdown menu to display only items of the selected type.
  • Keyword Search: Entering text into the search box instantly filters items by matching their name and content fields.

Privacy Protection (Private Items)

  • The "Private Item" option can be checked when adding or editing an item.
  • When enabled, the content field of that item will be obfuscated with ****** in the main interface list.
  • This feature only affects the display in the main interface; "Open" and "Copy" operations from the system tray function identically to regular items.

Text Viewer

  • When an "Open" action is performed on a "Text" type item, a dedicated Text Viewer window is displayed.
  • This window supports an "Always on Top" feature, which is useful for referencing content while working on other tasks.

Data Management

Backup and Restore

  • Backup: Users can export the entire database (including all items and settings) to a backup file at any time.
  • Restore: When importing a backup file, two modes are available:
    1. Merge: Combines the data from the backup file with the current data. In case of an ID conflict, the existing data is preserved, and the corresponding item from the backup file is ignored.
    2. Full Replace: Completely erases all current data and then replaces it with the data from the backup file.

Application Settings

  • General:
    • Auto-start on Boot: Configure whether Beekmark starts with Windows.
    • Interface Language: Manually switch the display language.
    • Interface Theme: Switch between Light and Dark themes.
    • Clear Icon Cache: Clears the locally cached icons for files and folders. This is useful for refreshing incorrect or outdated icons and for freeing up disk space.
  • Behavior:
    • Default action for tray menu clicks: Set the global "Open" or "Copy" mode here.

Application Behavior

  • Window Management: Closing the main window only minimizes it to the system tray; the application continues to run in the background. To exit completely, right-click the system tray icon and select "Exit."