asam-ev / asam-project-guide

(WIP!) Project Guide for ASAM OpenX standards
Mozilla Public License 2.0
2 stars 0 forks source link

HTML includes (doxygen, EA) also searchable #134

Closed philipwindecker closed 2 years ago

philipwindecker commented 2 years ago

The goal is to find a solution where included HTML content can be searched by the Antora search function.

A topic of note: what happens if the included content also consists of more than one file?

philipwindecker commented 2 years ago

Any solution where the content is included on the HTML end (e.g. through iframe) will NOT be able to be searched directly. The reason is that the search function uses a pre-generated index. This index only considers content found in the adoc files by default.

The solution now has to be that either the search function is changed (to also go through all files included after the fact) or to include the content directly. Note also that the current search function is not very powerful in regards to generating a useful index, particularly for large pages.

philipwindecker commented 2 years ago

Info: Any solution that will have to implement individual features, like going through the included files, will most likely have to be adapted if the search engine is replaced. This means that the decision on whether to stick with the current search engine (lunr) or to switch to something else has to come first.

philipwindecker commented 2 years ago

Doxygen (transformed) input can be searched directly through the Antora search function.

philipwindecker commented 2 years ago

EA is now also integrated and searchable

philipwindecker commented 2 years ago

Issue is now closed. Search function could be better, but this can be exchanged for Antora in general without impacting this topic.