emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: "Sébastien Gendre" <seb@k-7.ch>
To: "emacs-orgmode@gnu.org" <emacs-orgmode@gnu.org>
Subject: Feature discussion: Search field and local search engine
Date: Wed, 23 Oct 2024 06:00:34 +0200	[thread overview]
Message-ID: <87a5ev31ul.fsf@k-7.ch> (raw)

[-- Attachment #1: Type: text/plain, Size: 2536 bytes --]

Hello every one,

* Context

At the beginning of September, I have started a discussion about adding
multiple new features to ox-html exporter. This discussion lead to also
discuss new features about org-mode itself.

To avoid the confusion of having multiples features discussed in the
same thread, following the suggestion of Ihor Radchenko, I will create a
separated thread for each discussed feature.

The original message can be found here:
https://list.orgmode.org/87frqbel30.fsf@localhost/



* Feature description and summary of previous discussion

The goal of this feature is to add, on a website generated with
org-publish, a local search engine.

The idea is to have a simple solution that can be easily enabled with an
org-publish option set to "t".

The search engine, it's search field and how the website is indexed is
gonna be implemented through a pluggable system. Like that, a user can
choose between different solutions. And if the chosen default solution
is no longer maintained, it's more easy to switch to another one.

The search field is gonna be included in a new section, present on each
web page. This section serve to website navigation, can be displayed at
top or side and will include:

- The exported website name and/or logo

- A website navigation menu (discussed in another thread I will create
  later)

- The search field



** Search engines

For now, the first search engine tested is PageFind:
https://pagefind.app/

Their was discussions about the risk of no longer maintained search
engine, that when Ihor Radchenko suggested the pluggable system.



* What's next on this feature ?

First, I opened this thread to discuss about how we want this search
engine feature to be.

In my next message of this thread, I will quotes remarks from Ihor
Radchenko, Max Nikulin and Orm Finnendahl to continue the discussion. I
will also include my replies.

When we have decided how this new feature should work, I will write some
patches to implement them. (I think I already sign the document for the
FSF).

Note that I'm on my last year as a student, so I'm may take some time to
reply to message and also write patches.


* And about the other features ?

How do you want to discuss the other features ?

One by one and only start to discuss the next one when the previous is
implemented ?

Or do you prefer I create new threads for each of themes in the next
days ?



Best regards

-------
Gendre Sébastien

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 849 bytes --]

             reply	other threads:[~2024-10-23  4:01 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-23  4:00 Sébastien Gendre [this message]
2024-10-23  5:22 ` Feature discussion: Search field and local search engine Sébastien Gendre
2024-10-23 17:32   ` Ihor Radchenko
2024-10-23 22:51     ` Sébastien Gendre
2024-10-24 17:11       ` Ihor Radchenko
2024-11-17 22:09         ` Sébastien Gendre
2024-11-23 16:19           ` Ihor Radchenko
2024-12-07 21:28             ` Sébastien Gendre
2024-12-08  9:24               ` Ihor Radchenko
2024-12-08 19:26     ` Björn Bidar
2024-10-23 17:37 ` Ihor Radchenko

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87a5ev31ul.fsf@k-7.ch \
    --to=seb@k-7.ch \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).