plugin:fuzzysearch
Table of Contents
fuzzysearch Plugin
Compatible with DokuWiki
- 2025-05-14 "Librarian" yes
- 2024-02-06 "Kaos" unknown
- 2023-04-04 "Jack Jackrum" unknown
- 2022-07-31 "Igor" unknown
Installation
Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.
Examples/Usage
- Adds a fuzzy search input (FUZZYSEARCH) using Fuse.js for typo-tolerant page searching and Obsidian-style link adding method [[word]] to initiate fuzzy search and allow easy link creation in Dokuwiki
- for security, the search result are shown to login user only
- it also work in Bureaucracy plugin form
Syntax
Usage 1
~~FUZZYSEARCH~~
- it create a textbox for fuzzysearch
- you can put it in header.txt or sidebar.txt
- it get the list of the pages from ajax call
Usage 2
[[some word here]]
- in editor text area, when you type link pattern like this
- it trigger fuzzy search with give you a drop down list to choose a page to link
- it give you an obsidian like experience
Usage 3
- use in bureaucracy plugin form
- The fuzzy search link can also be triggered when the syntax [[some text]] is completed in a Bureaucracy form textarea or textbox. It will display a dropdown of pages, allowing the user to select one to complete the internal wiki link.
examples: Atomic note-taking system
I use Bureaucracy plugin to create an atomic note taking form.
- Each note contains only one idea
- The notes are connected together by tag and links
- Each note should have at least 2 links
The atomic note Bureaucracy form
<form> action template "atomic:atomictpl" "atomic:atom_@@noteno@@_%Y%m%d" textbox title textarea content textbox tag =atomicnote textarea link textarea source =optional number "noteno"++ submit "Create Page" </form> The atomic note template - atomictpl:
atomictpl:
====== @@title@@ ======
===== Content =====
@@content@@
===== Tag =====
{{tag>@@tag@@ }}
===== Links =====
@@link@@
===== Source =====
* @@source@@
----
Date created: @DATE@
Configuration and Settings
The plugin provides several configuration options via the DokuWiki admin panel:
- Restrict to ACL: Enable to limit search results and link suggestions to pages the user has read access to (default: enabled). Disable to show all pages.
- Fuse Threshold: Fuzziness level for matches (0 = exact, 1 = very loose; default: 0.4).
- Fuse Limit: Maximum number of search results to display (default: 10).
Development
[downloadable blocks, development comments]
The source code of the plugin is available at GitHub: https://github.com/edwardcodelab/fuzzysearch.
Changelog
[preferable GitHub RSS feed or similar]
- Update plugin.info.txt (2025-03-14 03:26)
- Merge pull request #1 from edwardcodelab/v1.2 (2025-03-14 03:25)
- Add files via upload (2025-03-14 03:23)
- Add files via upload (2025-03-02 09:58)
- Initial commit (2025-03-02 09:57)
Known Bugs and Issues
[this section might not be needed in case of external bug manager, or use RSS feed]
ToDo/Wish List
[developers roadmap]
FAQ
[discussions should ideally be deleted and turned into FAQ entries along the way]
plugin/fuzzysearch.txt · Last modified: by dodotori

