summaryrefslogtreecommitdiff
path: root/searx/templates
AgeCommit message (Collapse)Author
2025-03-15[mod] migrate all key-value.html templates to KeyValue typeMarkus Heiser
The engines now all use KeyValue results and return the results in a EngineResults object. The sqlite engine can return MainResult results in addition to KeyValue results (based on engine's config in settings.yml), Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2025-03-15[mod] typification of SearXNG: add new result type KeyValueMarkus Heiser
This patch adds a new result type: KeyValue - Python class: searx/result_types/keyvalue.py - Jinja template: searx/templates/simple/result_templates/keyvalue.html - CSS (less) client/simple/src/less/result_types/keyvalue.less Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2025-02-28[fix] simple template - video.html fix button icon to icon_smallMarkus Heiser
BTW: Rename the manufacturer-specific name ``ion-icon`` of the icon set in SerXNG to ``sxng-icon-set`` --> The icon set can be assembled together as desired in the FE and should therefore not have a manufacturer-specific name in the style and template definitions. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2025-02-28[web-client] simple theme: refactor jinja_svg_catalog and cleanup icon namesMarkus Heiser
This patch implements the template generation of the template: searx/templates/simple/icons.html by the way the icon set (the icon names) has been normalized: film-outline --> film magnet-outline --> magnet .. warning --> alert Some missing (categorie) icons had been added. Some of the ionicons are not suitable for a dark theme, we fixed the svg manually in src/svg/ionicons: - https://github.com/searxng/searxng/pull/4284#issuecomment-2680550342 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2025-02-17[fix] Fix improper import of corrections.htmlDuckxz
2025-02-09[mod] improve description of the prefernces URL in the "COOKIES" tabMarkus Heiser
Closes: https://github.com/searxng/searxng/issues/4272 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2025-01-29[mod] rudimentary implementation of a MainResult typeMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2025-01-28[refactor] typification of SearXNG (initial) / result items (part 1)Markus Heiser
Typification of SearXNG ======================= This patch introduces the typing of the results. The why and how is described in the documentation, please generate the documentation .. $ make docs.clean docs.live and read the following articles in the "Developer documentation": - result types --> http://0.0.0.0:8000/dev/result_types/index.html The result types are available from the `searx.result_types` module. The following have been implemented so far: - base result type: `searx.result_type.Result` --> http://0.0.0.0:8000/dev/result_types/base_result.html - answer results --> http://0.0.0.0:8000/dev/result_types/answer.html including the type for translations (inspired by #3925). For all other types (which still need to be set up in subsequent PRs), template documentation has been created for the transition period. Doc of the fields used in Templates =================================== The template documentation is the basis for the typing and is the first complete documentation of the results (needed for engine development). It is the "working paper" (the plan) with which further typifications can be implemented in subsequent PRs. - https://github.com/searxng/searxng/issues/357 Answer Templates ================ With the new (sub) types for `Answer`, the templates for the answers have also been revised, `Translation` are now displayed with collapsible entries (inspired by #3925). !en-de dog Plugins & Answerer ================== The implementation for `Plugin` and `Answer` has been revised, see documentation: - Plugin: http://0.0.0.0:8000/dev/plugins/index.html - Answerer: http://0.0.0.0:8000/dev/answerers/index.html With `AnswerStorage` and `AnswerStorage` to manage those items (in follow up PRs, `ArticleStorage`, `InfoStorage` and .. will be implemented) Autocomplete ============ The autocompletion had a bug where the results from `Answer` had not been shown in the past. To test activate autocompletion and try search terms for which we have answerers - statistics: type `min 1 2 3` .. in the completion list you should find an entry like `[de] min(1, 2, 3) = 1` - random: type `random uuid` .. in the completion list, the first item is a random UUID Extended Types ============== SearXNG extends e.g. the request and response types of flask and httpx, a module has been set up for type extensions: - Extended Types --> http://0.0.0.0:8000/dev/extended_types.html Unit-Tests ========== The unit tests have been completely revised. In the previous implementation, the runtime (the global variables such as `searx.settings`) was not initialized before each test, so the runtime environment with which a test ran was always determined by the tests that ran before it. This was also the reason why we sometimes had to observe non-deterministic errors in the tests in the past: - https://github.com/searxng/searxng/issues/2988 is one example for the Runtime issues, with non-deterministic behavior .. - https://github.com/searxng/searxng/pull/3650 - https://github.com/searxng/searxng/pull/3654 - https://github.com/searxng/searxng/pull/3642#issuecomment-2226884469 - https://github.com/searxng/searxng/pull/3746#issuecomment-2300965005 Why msgspec.Struct ================== We have already discussed typing based on e.g. `TypeDict` or `dataclass` in the past: - https://github.com/searxng/searxng/pull/1562/files - https://gist.github.com/dalf/972eb05e7a9bee161487132a7de244d2 - https://github.com/searxng/searxng/pull/1412/files - https://github.com/searxng/searxng/pull/1356 In my opinion, TypeDict is unsuitable because the objects are still dictionaries and not instances of classes / the `dataclass` are classes but ... The `msgspec.Struct` combine the advantages of typing, runtime behaviour and also offer the option of (fast) serializing (incl. type check) the objects. Currently not possible but conceivable with `msgspec`: Outsourcing the engines into separate processes, what possibilities this opens up in the future is left to the imagination! Internally, we have already defined that it is desirable to decouple the development of the engines from the development of the SearXNG core / The serialization of the `Result` objects is a prerequisite for this. HINT: The threads listed above were the template for this PR, even though the implementation here is based on msgspec. They should also be an inspiration for the following PRs of typification, as the models and implementations can provide a good direction. Why just one commit? ==================== I tried to create several (thematically separated) commits, but gave up at some point ... there are too many things to tackle at once / The comprehensibility of the commits would not be improved by a thematic separation. On the contrary, we would have to make multiple changes at the same places and the goal of a change would be vaguely recognizable in the fog of the commits. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2025-01-28[refactor] translation engines: common interfaceBnyro
2025-01-20[mod] add swipe events to the image gallery (gesture control)Markus Heiser
Adds [1] to the searxng.min.js and horizontal swipe events to the image gallery. [1] https://www.npmjs.com/package/swiped-events Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-12-16[chore] cleanupZhijie He
2024-12-16[enh] add `engine-` prefix, replace blank space to `-`Zhijie He
2024-12-16[fix]: fix engine name may break some css style, contains "right", "left", ↵Zhijie He
"center"
2024-12-01[build] /staticMarkus Heiser
2024-12-01[feat] search: add url formatting preferenceBnyro
2024-11-29[feat] search: shift/ctrl click a category to select multiple categoriesBnyro
2024-11-25[mod] add CSS (LESS) to xsl style to view rss in browserMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-11-25[refactor] <type> element isn't a part of the RSS 2.0 spec [1]Markus Heiser
[1] https://cyber.harvard.edu/rss/rss.html Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-11-25[feat] rss: add xsl style to view rss in browserBnyro
2024-11-25[chore] rss: rename from searx to SearXNGBnyro
2024-11-24[chore] *: fix typos detected by typos-cliBnyro
2024-10-26[build] /staticMarkus Heiser
2024-10-16[build] /staticmrpaulblack
2024-10-05[mod] favicons: simplify RTL in template & CSSMarkus Heiser
Comes from a sughgestion in: - https://github.com/searxng/searxng/pull/3727#issuecomment-2388998803 Suggested-by: Bnyro <bnyro@tutanota.com> Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-10-05[mod] Revision of the favicon solutionMarkus Heiser
All favicons implementations have been documented and moved to the Python package: searx.favicons There is a configuration (based on Pydantic) for the favicons and all its components: searx.favicons.config A solution for caching favicons has been implemented: searx.favicon.cache If the favicon is already in the cache, the returned URL is a data URL [1] (something like `data:image/png;base64,...`). By generating a data url from the FaviconCache, additional HTTP roundtripps via the favicon_proxy are saved: favicons.proxy.favicon_url The favicon proxy service now sets a HTTP header "Cache-Control: max-age=...": favicons.proxy.favicon_proxy The resolvers now also provide the mime type (data, mime): searx.favicon.resolvers [1] https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-10-05[feat] add favicons to result urlsBrock Vojkovic
2024-10-03[refactor] simple theme: *.less - replace hardcoded colorsBnyro
Closes: https://github.com/searxng/searxng/issues/3842
2024-10-03[feat] simple theme: pure black theme styleBnyro
2024-09-21[fix] simple template: drop useless ``aria-labelledby`` attributesMarkus
This patch removes the ``aria-labelledby`` attributes for which there is no tag with the corresponding ID. Reported-by: @glanham-jr https://github.com/searxng/searxng/issues/3793#issuecomment-2351689483 Signed-off-by: Markus <markus@venom.fritz.box>
2024-09-21[fix] simple template: macro checkbox_onoff_reversedMarkus
In its previous implementation, the macro ``checkbox_onoff_reversed`` always created an ``aria-labelledby`` attribute, even if there was no descriptive tag with the generated ID (used as the value of the ``aria-labelledby``). Before this patch, the Nu-HTML-Checker [1] reported 255 issues of this type:: The aria-labelledby attribute must point to an element in the same document. (255) [1] https://validator.w3.org/nu/ Signed-off-by: Markus <markus@venom.fritz.box>
2024-09-21[fix] simple template: add ID to elements used for aria-labelledbyMarkus
The ``aria-labelledby`` [1] attribute identifies the element that labels the element it is applied to. The templates ``infinite_scroll.html`` and ``search_on_category_select.html`` define a ``aria-labelledby`` at the <input> tag but miss the id in the <div> with the description. [1] https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-labelledby Signed-off-by: Markus <markus@venom.fritz.box>
2024-09-21[fix] Removes ``/>`` ending tags for void HTML elementsMarkus
continuation of commit: 0b832f19b Signed-off-by: Markus <markus@venom.fritz.box>
2024-09-15[fix] Removes ``/>`` ending tags for void HTML elementsGrant Lanham
Removes ``/>`` ending tags for void elements [1] and replaces them with ``>``. Part of the larger cleanup to cleanup invalid HTML throughout the codebase [2]. [1] https://html.spec.whatwg.org/multipage/syntax.html#void-elements [2] https://github.com/searxng/searxng/issues/3793
2024-09-14[fix] search: crash when no engines are used to searchBnyro
2024-09-03[mod] enable calculator and allow plugin on public instancesMarkus Heiser
Remove quirks that prevented the Calculator from being used on public instances. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-09-03[feat] results: show response timesGenericMale
2024-08-28[fix] search: don't show categories without active engineGenericMale
2024-07-28[fix] fix issues in the language menue introduced by PR #3645Markus Heiser
In my review of [1] I tried to reformat the template code of the language menue whereby I have made two mistakes. - default language was added twice - in the 'Auto-detect' item a hard coded `[auto]` was implemented where the `search_language` variable was needed. [1] https://github.com/searxng/searxng/issues/3645 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-07-27[feat] videos template: support for view countBnyro
2024-07-27[fix] products template: don't quote html tags in result.contentMarkus Heiser
The result.content field is *safe* HTML, tags to highlight search terms are intended. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-07-14[mod] UX: flush flag icon to right in language select option valuesGrant Lanham
If the flag icon is first, it prevents easily searching the select list on the keyboard. By moving the icon fully to the right, this will enable a user to search the select list. Closes: https://github.com/searxng/searxng/issues/3645
2024-06-15[perf] torrents.html, files.html: don't parse and re-format filesizeBnyro
2024-05-16[mod] simple theme: drop img_src from default resultsMarkus Heiser
The use of img_src AND thumbnail in the default results makes no sense (only a thumbnail is needed). In the current state this is rather confusing, because img_src is displayed like a thumbnail (small) and thumbnail is displayed like an image (large). Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-05-15[mod] package.html template: additional links (a python dict)Daniel Kukula
- Closes: https://github.com/searxng/searxng/issues/3456
2024-05-09[feat] plugins: new calculator pluginBnyro
2024-05-04[fix] respect user preferences to open links in new tab for short answersYaksh Bariya
Previously only result urls were set to open in new tab by default, this should make the behaviour consistent. Also adds the missing rel="noreferrer" to the anchor tag. Although this should not be needed as long as the `referrer-policy: no-referrer` header is set, it's always nice to play safer than to have to say sorry. For example some reverse proxy configurations might strip off unwhitelisted headers in which case it's nice to have this set.
2024-04-27improve "search existing issues from github" linkJinyuan Huang
2024-04-27[feat] preferences: button to enable/disable all enginesBnyro
2024-04-27[fix] ionic.io/ionicons - add back missing class="ionicon"Markus Heiser
Seems to me svg2jinja added the class in the past .. but no longer in new builds / this patch adds the class back by using addAttributesToSVGElement [1]. To test this patch use: $ ./manage themes.simple $ cat searx/templates/simple/icons.html and check `class="ionicon"` is in the outer `<svg ..>` tags. [1] https://svgo.dev/docs/plugins/add-attributes-to-svg-elements/ [2] https://ionic.io/ionicons Closes: https://github.com/searxng/searxng/issues/3383 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-04-18[feat] template: add apple-touch-icon in html headermrpaulblack
* this makes it possible to add SearXNG to iOS devices homescreen with a proper icon