Create a Search synonym custom Dictionary which can be maintained through Bookstack #4266

New Issue

OVERLORD · 2026-02-05T08:23:20+03:00

OVERLORD commented

2026-02-05 08:23:20 +03:00

Originally created by @adamreading on GitHub (Oct 10, 2023).

Describe the feature you'd like

Create a Page or Area where a list of specific search synonyms can be stored by editors / admin of Bookstack. This would then be referenced by the Bookstack search engines to return a wider search result including the aliases/synonyms.

These may be specific to the project or more general from analysing what is searched for. We have attached Google Analytics to our Bookstack instance and can clearly see people searching for phrases and words that are different in the pages. In some instances these words may appear on multiple pages and places so our current work around of trying to type various synonyms onto each individual page in "white text on white background" so that the search engine finds them, but they can't be seen, would be very long winded and time consuming throughout multiple books in similar topics.

For example we have topics on "Driver to Buy" at the end of a Lease - which is being searched for as D2B - we would have to edit about 200 places to reference this individually and also remember to add it every time a new page is written - but if the search engine could be told - D2B = "Driver To Buy" it would solve the issue.

Describe the benefits this would bring to existing BookStack users

I think that many Bookstack editors have specific Jargon / Industry Terminology or just general cases where in their books one Word or Phrase is used in the pages - but the user has a slightly different phrasing or word for the same thing - by analysing what is being searched for - we could save massive amounts of time - and provide a better user experience for Readers by ensuring they receive the most valid search results back.

Can the goal of this request already be achieved via other means?

Our current work around is to type various synonyms onto each individual page in "white text on white background" so that the search engine finds them, but they can't be seen, which is very long winded and time consuming throughout multiple books in similar topics.

Have you searched for an existing open/closed issue?

I have searched for existing issues and none cover my fundamental request

How long have you been using BookStack?

Under 3 months

Additional context

The closest thing I could find to this was someone asking for extra meta data adding into pages/books/shelves for users to find by Title Synonym - I think that my solution would also solve that closed request at the same time. ([Feature Request]: Library, book, page, chapter aliases #3175)

Originally created by @adamreading on GitHub (Oct 10, 2023). ### Describe the feature you'd like Create a Page or Area where a list of specific search synonyms can be stored by editors / admin of Bookstack. This would then be referenced by the Bookstack search engines to return a wider search result including the aliases/synonyms. These may be specific to the project or more general from analysing what is searched for. We have attached Google Analytics to our Bookstack instance and can clearly see people searching for phrases and words that are different in the pages. In some instances these words may appear on multiple pages and places so our current work around of trying to type various synonyms onto each individual page in "white text on white background" so that the search engine finds them, but they can't be seen, would be very long winded and time consuming throughout multiple books in similar topics. For example we have topics on "Driver to Buy" at the end of a Lease - which is being searched for as D2B - we would have to edit about 200 places to reference this individually and also remember to add it every time a new page is written - but if the search engine could be told - D2B = "Driver To Buy" it would solve the issue. ### Describe the benefits this would bring to existing BookStack users I think that many Bookstack editors have specific Jargon / Industry Terminology or just general cases where in their books one Word or Phrase is used in the pages - but the user has a slightly different phrasing or word for the same thing - by analysing what is being searched for - we could save massive amounts of time - and provide a better user experience for Readers by ensuring they receive the most valid search results back. ### Can the goal of this request already be achieved via other means? Our current work around is to type various synonyms onto each individual page in "white text on white background" so that the search engine finds them, but they can't be seen, which is very long winded and time consuming throughout multiple books in similar topics. ### Have you searched for an existing open/closed issue? - [X] I have searched for existing issues and none cover my fundamental request ### How long have you been using BookStack? Under 3 months ### Additional context The closest thing I could find to this was someone asking for extra meta data adding into pages/books/shelves for users to find by Title Synonym - I think that my solution would also solve that closed request at the same time. ([Feature Request]: Library, book, page, chapter aliases #3175)

OVERLORD added the 🔨 Feature Request label 2026-02-05 08:23:20 +03:00

OVERLORD commented

2026-02-05 08:23:23 +03:00

@RMurphy-Impact commented on GitHub (Nov 7, 2023):

This is just a different workaround that I've found is a bit cleaner, but it doesn't really provide any time savings: What I've been using for similar is adding an html comment at the very bottom of the source code of that page with a space separated list of terms that I want to be searchable, but that I don't want displayed on the page at all.

Again, not really a "solve", but might work if you have concerns about that white text on white background being displayed during export, dark mode, etc. This way the page will at least not render that text to the page, but the search will still find it.

@RMurphy-Impact commented on GitHub (Nov 7, 2023): This is just a different workaround that I've found is a bit cleaner, but it doesn't really provide any time savings: What I've been using for similar is adding an html comment at the very bottom of the source code of that page with a space separated list of terms that I want to be searchable, but that I don't want displayed on the page at all. <img width="145" alt="image" src="https://github.com/BookStackApp/BookStack/assets/125404819/c286a0e2-6035-45f7-b155-d7c78e5ef51e"> <img width="588" alt="image" src="https://github.com/BookStackApp/BookStack/assets/125404819/b9e1b905-c51d-488d-bfb9-78502adf5c06"> Again, not really a "solve", but might work if you have concerns about that white text on white background being displayed during export, dark mode, etc. This way the page will at least not render that text to the page, but the search will still find it.

OVERLORD commented

2026-02-05 08:23:27 +03:00

@adamreading commented on GitHub (Nov 8, 2023):

This is just a different workaround that I've found is a bit cleaner, but it doesn't really provide any time savings: What I've been using for similar is adding an html comment at the very bottom of the source code of that page with a space separated list of terms that I want to be searchable, but that I don't want displayed on the page at all.

Again, not really a "solve", but might work if you have concerns about that white text on white background being displayed during export, dark mode, etc. This way the page will at least not render that text to the page, but the search will still find it.

I have too many existing pages to spend the time on code - but I have created another sort of awkward workaround lol

This allows me to see what users search for in Analytics and then add a line to the Alias table here so that next time they search they get to this page - which then suggests what they should be searching for. It’s not very elegant though as a solution.

@adamreading commented on GitHub (Nov 8, 2023): > This is just a different workaround that I've found is a bit cleaner, but it doesn't really provide any time savings: What I've been using for similar is adding an html comment at the very bottom of the source code of that page with a space separated list of terms that I want to be searchable, but that I don't want displayed on the page at all. <img alt="image" width="145" src="https://user-images.githubusercontent.com/125404819/281121816-c286a0e2-6035-45f7-b155-d7c78e5ef51e.png"> <img alt="image" width="588" src="https://user-images.githubusercontent.com/125404819/281121934-b9e1b905-c51d-488d-bfb9-78502adf5c06.png"> > > Again, not really a "solve", but might work if you have concerns about that white text on white background being displayed during export, dark mode, etc. This way the page will at least not render that text to the page, but the search will still find it. I have too many existing pages to spend the time on code - but I have created another sort of awkward workaround lol ![IMG_0115](https://github.com/BookStackApp/BookStack/assets/4236780/d807d57b-b1cf-436c-ae32-ae909eef3767) This allows me to see what users search for in Analytics and then add a line to the Alias table here so that next time they search they get to this page - which then suggests what they should be searching for. It’s not very elegant though as a solution.

OVERLORD commented

2026-02-05 08:23:31 +03:00

@abulgatz commented on GitHub (Feb 4, 2024):

This would be great for IT and programming! M365 = O365 = Microsoft 365, iOS = iPhone, iPadOS = iPad, etc..

@abulgatz commented on GitHub (Feb 4, 2024): This would be great for IT and programming! M365 = O365 = Microsoft 365, iOS = iPhone, iPadOS = iPad, etc..

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#4266