====== fuzzysearch Plugin ======

---- plugin ----
description: 
author     : dodotori @ dokuwiki forum
email      : dodotori @ dokuwiki forum
type       : 
lastupdate : 2025-09-28
compatible : Librarian
depends    : 
conflicts  : 
similar    : 
tags       : fuzzysearch, elastic search, search, autocomplete, link

downloadurl: https://github.com/edwardcodelab/fuzzysearch/zipball/main
bugtracker : https://github.com/edwardcodelab/fuzzysearch/issues
sourcerepo : https://github.com/edwardcodelab/fuzzysearch/
donationurl: 

screenshot_img : # URL to a screenshot of the plugin in action
----


===== Installation =====

Search and install the plugin using the [[plugin:extension|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|Bureaucracy]] plugin form


===== Syntax =====

==== Usage 1 ====

<code>~~FUZZYSEARCH~~</code>
  * 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 ====

<code>[[some word here]]</code>
  * 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|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
<code>
<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:
</code>
<code>
atomictpl:

====== @@title@@ ======
===== Content =====
@@content@@
===== Tag =====
{{tag>@@tag@@ }}

===== Links =====
@@link@@
===== Source =====
  * @@source@@

----
Date created: @DATE@
</code>
===== 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]//

{{rss>https://github.com/edwardcodelab/fuzzysearch/commits/main.atom date 8}}

=== 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]//