|
| 1 | +# 🔎 Fulltext search (fts-keywords.lst) |
| 2 | + |
| 3 | +- File is used for fulltext search (🔎) |
| 4 | +- It is located in language version subdir. |
| 5 | +- Each language has its own independent copy. |
| 6 | +- If file **exists, then it is turned on** the creation of fulltext index during publishing process. There are no more steps needed from side of help author. |
| 7 | +- Keep file empty |
| 8 | +- If you want to turn off the fulltext index, then delete this file. |
| 9 | + |
| 10 | +## Logic description in general |
| 11 | + |
| 12 | +In repository [fulltextSearchDBBuilder][FTSIndexing] there is stored all logic of fulltext index assembly process. It is bash script. |
| 13 | + |
| 14 | +For each one language independently there will be done these steps: |
| 15 | + |
| 16 | +1. Select files: \*.md;\*.htm;\*.html for indexing |
| 17 | +2. All content is converted to UTF-8 code page |
| 18 | +3. Missing files in [file list][Dfiles.lst] are attached to end of list without any backup heading |
| 19 | +4. All letters are converted to lowercase |
| 20 | +5. Letters are stripped of diacritics and special characters (e.g.: about:blank -> aboutblank) |
| 21 | +6. Words smaller than 3 letters are excluded from next processing |
| 22 | +7. There is counted sum of emerges of words in each of indexed document/chapter |
| 23 | +8. The documents are ordered by word count from highest to lowest for each word |
| 24 | +9. Two new files will be created: |
| 25 | + - fts-keywords.lst (words) |
| 26 | + - fts-keywords-files.lst (word to files interconnection list) |
| 27 | + Files follow the same structure as defined in [keywords][Dkeywords.lst] |
| 28 | + |
| 29 | +[FTSIndexing]: https://github.com/HelpViewer/fulltextSearchDBBuilder "Fulltext index assembly" |
| 30 | +[Dkeywords.lst]: mdata/keywords.lst.md "keywords.lst" |
| 31 | +[Dfiles.lst]: mdata/files.lst.md "files.lst" |
0 commit comments