plugins: search is required + missing search implies

znai-charts/src/main/java/org/testingisdocumenting/znai/charts/ChartFenceBasePlugin.java

@@ -20,17 +20,28 @@
 import org.testingisdocumenting.znai.extensions.PluginParams;
 import org.testingisdocumenting.znai.extensions.PluginResult;
 import org.testingisdocumenting.znai.extensions.fence.FencePlugin;
+import org.testingisdocumenting.znai.search.SearchScore;
+import org.testingisdocumenting.znai.search.SearchText;
 
 import java.nio.file.Path;
+import java.util.List;
 
 public abstract class ChartFenceBasePlugin implements FencePlugin {
+    private String csvContent;
+
     abstract protected String type();
 
     @Override
     public PluginResult process(ComponentsRegistry componentsRegistry,
                                 Path markupPath,
                                 PluginParams pluginParams,
                                 String csvContent) {
+        this.csvContent = csvContent;
         return ChartPluginResult.create(pluginParams, type(), csvContent);
     }
+
+    @Override
+    public List<SearchText> textForSearch() {
+        return csvContent != null ? List.of(SearchScore.STANDARD.text(csvContent)) : List.of();
+    }
 }

znai-charts/src/main/java/org/testingisdocumenting/znai/charts/ChartIncludeBasePlugin.java

@@ -24,8 +24,11 @@
 import org.testingisdocumenting.znai.extensions.PluginResult;
 import org.testingisdocumenting.znai.extensions.include.IncludePlugin;
 import org.testingisdocumenting.znai.parser.ParserHandler;
+import org.testingisdocumenting.znai.search.SearchScore;
+import org.testingisdocumenting.znai.search.SearchText;
 
 import java.nio.file.Path;
+import java.util.List;
 import java.util.stream.Stream;
 
 abstract public class ChartIncludeBasePlugin implements IncludePlugin {
@@ -39,6 +42,7 @@ abstract public class ChartIncludeBasePlugin implements IncludePlugin {
     protected static String COLUMNS = "columns";
 
     private Path fullPath;
+    private String csvContent;
 
     abstract protected String type();
 
@@ -58,7 +62,7 @@ public PluginParamsDefinition parameters() {
     @Override
     public PluginResult process(ComponentsRegistry componentsRegistry, ParserHandler parserHandler, Path markupPath, PluginParams pluginParams) {
         fullPath = componentsRegistry.resourceResolver().fullPath(pluginParams.getFreeParam());
-        String csvContent = componentsRegistry.resourceResolver().textContent(fullPath);
+        csvContent = componentsRegistry.resourceResolver().textContent(fullPath);
 
         return ChartPluginResult.create(pluginParams, type(), csvContent);
     }
@@ -67,4 +71,9 @@ public PluginResult process(ComponentsRegistry componentsRegistry, ParserHandler
     public Stream<AuxiliaryFile> auxiliaryFiles(ComponentsRegistry componentsRegistry) {
         return Stream.of(AuxiliaryFile.builtTime(fullPath));
     }
+
+    @Override
+    public List<SearchText> textForSearch() {
+        return csvContent != null ? List.of(SearchScore.STANDARD.text(csvContent)) : List.of();
+    }
 }

znai-core/src/main/java/org/testingisdocumenting/znai/extensions/Plugin.java

@@ -22,6 +22,7 @@
 import org.testingisdocumenting.znai.search.SearchText;
 
 import java.nio.file.Path;
+import java.util.List;
 import java.util.stream.Stream;
 
 public interface Plugin {
@@ -44,9 +45,7 @@ default Stream<AuxiliaryFile> auxiliaryFiles(ComponentsRegistry componentsRegist
         return Stream.empty();
     }
 
-    default SearchText textForSearch() {
-        return null;
-    }
+    List<SearchText> textForSearch();
 
     default String markdownRepresentation() {
         return "";

znai-core/src/main/java/org/testingisdocumenting/znai/extensions/TrackingFencePlugin.java

@@ -22,6 +22,7 @@
 import org.testingisdocumenting.znai.search.SearchText;
 
 import java.nio.file.Path;
+import java.util.List;
 import java.util.stream.Stream;
 
 public class TrackingFencePlugin implements FencePlugin {
@@ -65,7 +66,7 @@ public Stream<AuxiliaryFile> auxiliaryFiles(ComponentsRegistry componentsRegistr
     }
 
     @Override
-    public SearchText textForSearch() {
+    public List<SearchText> textForSearch() {
         return delegate.textForSearch();
     }
 

znai-core/src/main/java/org/testingisdocumenting/znai/extensions/TrackingIncludePlugin.java

@@ -23,6 +23,7 @@
 import org.testingisdocumenting.znai.search.SearchText;
 
 import java.nio.file.Path;
+import java.util.List;
 import java.util.stream.Stream;
 
 public class TrackingIncludePlugin implements IncludePlugin {
@@ -45,7 +46,7 @@ public Stream<AuxiliaryFile> auxiliaryFiles(ComponentsRegistry componentsRegistr
     }
 
     @Override
-    public SearchText textForSearch() {
+    public List<SearchText> textForSearch() {
         return delegate.textForSearch();
     }
 

znai-core/src/main/java/org/testingisdocumenting/znai/extensions/TrackingInlineCodePlugin.java

@@ -22,6 +22,7 @@
 import org.testingisdocumenting.znai.search.SearchText;
 
 import java.nio.file.Path;
+import java.util.List;
 import java.util.stream.Stream;
 
 public class TrackingInlineCodePlugin implements InlinedCodePlugin {
@@ -49,7 +50,7 @@ public Stream<AuxiliaryFile> auxiliaryFiles(ComponentsRegistry componentsRegistr
     }
 
     @Override
-    public SearchText textForSearch() {
+    public List<SearchText> textForSearch() {
         return delegate.textForSearch();
     }
 

znai-core/src/main/java/org/testingisdocumenting/znai/extensions/api/ApiParametersFencePlugin.java

@@ -26,6 +26,7 @@
 import org.testingisdocumenting.znai.search.SearchText;
 
 import java.nio.file.Path;
+import java.util.List;
 
 public class ApiParametersFencePlugin implements FencePlugin {
     private ApiParameters apiParameters;
@@ -55,7 +56,7 @@ public PluginResult process(ComponentsRegistry componentsRegistry, Path markupPa
     }
 
     @Override
-    public SearchText textForSearch() {
-        return SearchScore.STANDARD.text(apiParameters.combinedTextForSearch());
+    public List<SearchText> textForSearch() {
+        return List.of(SearchScore.STANDARD.text(apiParameters.combinedTextForSearch()));
     }
 }

znai-core/src/main/java/org/testingisdocumenting/znai/extensions/api/ApiParametersIncludePlugin.java

@@ -19,16 +19,17 @@
 
 import org.testingisdocumenting.znai.core.AuxiliaryFile;
 import org.testingisdocumenting.znai.core.ComponentsRegistry;
-import org.testingisdocumenting.znai.extensions.PluginParamsDefinition;
-import org.testingisdocumenting.znai.resources.ResourcesResolver;
 import org.testingisdocumenting.znai.extensions.PluginParams;
+import org.testingisdocumenting.znai.extensions.PluginParamsDefinition;
 import org.testingisdocumenting.znai.extensions.PluginResult;
 import org.testingisdocumenting.znai.extensions.include.IncludePlugin;
 import org.testingisdocumenting.znai.parser.ParserHandler;
+import org.testingisdocumenting.znai.resources.ResourcesResolver;
 import org.testingisdocumenting.znai.search.SearchScore;
 import org.testingisdocumenting.znai.search.SearchText;
 
 import java.nio.file.Path;
+import java.util.List;
 import java.util.stream.Stream;
 
 public class ApiParametersIncludePlugin implements IncludePlugin {
@@ -69,7 +70,7 @@ public Stream<AuxiliaryFile> auxiliaryFiles(ComponentsRegistry componentsRegistr
     }
 
     @Override
-    public SearchText textForSearch() {
-        return SearchScore.STANDARD.text(apiParameters.combinedTextForSearch());
+    public List<SearchText> textForSearch() {
+        return List.of(SearchScore.STANDARD.text(apiParameters.combinedTextForSearch()));
     }
 }

znai-core/src/main/java/org/testingisdocumenting/znai/extensions/attention/AttentionSignFencePluginBase.java

@@ -29,6 +29,7 @@
 import org.testingisdocumenting.znai.search.SearchText;
 
 import java.nio.file.Path;
+import java.util.List;
 import java.util.Map;
 import java.util.stream.Stream;
 
@@ -66,8 +67,8 @@ public Stream<AuxiliaryFile> auxiliaryFiles(ComponentsRegistry componentsRegistr
     }
 
     @Override
-    public SearchText textForSearch() {
-        return SearchScore.STANDARD.text(parserResult.getAllText());
+    public List<SearchText> textForSearch() {
+        return List.of(SearchScore.STANDARD.text(parserResult.getAllText()));
     }
 
 }

znai-core/src/main/java/org/testingisdocumenting/znai/extensions/file/FileIncludePlugin.java

@@ -20,7 +20,10 @@
 import org.testingisdocumenting.znai.codesnippets.CodeSnippetsProps;
 import org.testingisdocumenting.znai.core.AuxiliaryFile;
 import org.testingisdocumenting.znai.core.ComponentsRegistry;
-import org.testingisdocumenting.znai.extensions.*;
+import org.testingisdocumenting.znai.extensions.PluginParamType;
+import org.testingisdocumenting.znai.extensions.PluginParams;
+import org.testingisdocumenting.znai.extensions.PluginParamsDefinition;
+import org.testingisdocumenting.znai.extensions.PluginResult;
 import org.testingisdocumenting.znai.extensions.features.PluginFeatureList;
 import org.testingisdocumenting.znai.extensions.include.IncludePlugin;
 import org.testingisdocumenting.znai.parser.ParserHandler;
@@ -29,6 +32,7 @@
 import org.testingisdocumenting.znai.search.SearchText;
 
 import java.nio.file.Path;
+import java.util.List;
 import java.util.Map;
 import java.util.stream.Stream;
 
@@ -92,8 +96,8 @@ public Stream<AuxiliaryFile> auxiliaryFiles(ComponentsRegistry componentsRegistr
     }
 
     @Override
-    public SearchText textForSearch() {
-        return SearchScore.HIGH.text(contentProvider.snippetContent());
+    public List<SearchText> textForSearch() {
+        return List.of(SearchScore.HIGH.text(contentProvider.snippetContent()));
     }
 
     @Override

znai-core/src/main/java/org/testingisdocumenting/znai/extensions/file/FileInlinedCodePlugin.java

@@ -29,6 +29,7 @@
 
 import java.nio.file.Path;
 import java.util.Collections;
+import java.util.List;
 import java.util.stream.Stream;
 
 public class FileInlinedCodePlugin implements InlinedCodePlugin {
@@ -64,7 +65,7 @@ public Stream<AuxiliaryFile> auxiliaryFiles(ComponentsRegistry componentsRegistr
     }
 
     @Override
-    public SearchText textForSearch() {
-        return SearchScore.STANDARD.text(text);
+    public List<SearchText> textForSearch() {
+        return List.of(SearchScore.STANDARD.text(text));
     }
 }

znai-core/src/main/java/org/testingisdocumenting/znai/extensions/html/IframeIncludePlugin.java

@@ -23,10 +23,12 @@
 import org.testingisdocumenting.znai.extensions.include.IncludePlugin;
 import org.testingisdocumenting.znai.parser.ParserHandler;
 import org.testingisdocumenting.znai.parser.docelement.DocElement;
+import org.testingisdocumenting.znai.search.SearchText;
 import org.testingisdocumenting.znai.utils.UrlUtils;
 
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.List;
 import java.util.UUID;
 import java.util.stream.Stream;
 
@@ -72,4 +74,9 @@ public Stream<AuxiliaryFile> auxiliaryFiles(ComponentsRegistry componentsRegistr
     private String generatePreviewMarker() {
         return UUID.randomUUID().toString();
     }
+
+    @Override
+    public List<SearchText> textForSearch() {
+        return List.of();
+    }
 }

znai-core/src/main/java/org/testingisdocumenting/znai/extensions/inlinedcode/IdentifierInlinedCodePlugin.java

@@ -101,7 +101,7 @@ public Stream<AuxiliaryFile> auxiliaryFiles(ComponentsRegistry componentsRegistr
     }
 
     @Override
-    public SearchText textForSearch() {
-        return SearchScore.STANDARD.text(identifier);
+    public List<SearchText> textForSearch() {
+        return List.of(SearchScore.STANDARD.text(identifier));
     }
 }

znai-core/src/main/java/org/testingisdocumenting/znai/extensions/json/JsonBasePlugin.java

@@ -31,6 +31,7 @@
 import org.testingisdocumenting.znai.parser.table.CsvTableParser;
 import org.testingisdocumenting.znai.parser.table.MarkupTableData;
 import org.testingisdocumenting.znai.resources.ResourcesResolver;
+import org.testingisdocumenting.znai.search.SearchText;
 import org.testingisdocumenting.znai.utils.JsonUtils;
 
 import java.nio.file.Path;
@@ -284,4 +285,10 @@ private Map<String, List<Map<String, Object>>> convertMarkdownToDocElements(Mark
     private static Set<String> buildPaths(Object json) {
         return new JsonPaths(json).getPaths();
     }
+
+    @Override
+    public List<SearchText> textForSearch() {
+        // TODO implement
+        return List.of();
+    }
 }

znai-core/src/main/java/org/testingisdocumenting/znai/extensions/latex/LatexFencePlugin.java

@@ -26,6 +26,7 @@
 
 import java.nio.file.Path;
 import java.util.Collections;
+import java.util.List;
 
 public class LatexFencePlugin implements FencePlugin {
     public static final String ID = "latex";
@@ -49,7 +50,7 @@ public PluginResult process(ComponentsRegistry componentsRegistry, Path markupPa
     }
 
     @Override
-    public SearchText textForSearch() {
-        return SearchScore.STANDARD.text(this.content);
+    public List<SearchText> textForSearch() {
+        return List.of(SearchScore.STANDARD.text(this.content));
     }
 }

znai-core/src/main/java/org/testingisdocumenting/znai/extensions/latex/LatexInlinedCodePlugin.java

@@ -21,12 +21,16 @@
 import org.testingisdocumenting.znai.extensions.PluginResult;
 import org.testingisdocumenting.znai.extensions.inlinedcode.InlinedCodePlugin;
 import org.testingisdocumenting.znai.parser.docelement.DocElement;
+import org.testingisdocumenting.znai.search.SearchScore;
+import org.testingisdocumenting.znai.search.SearchText;
 
 import java.nio.file.Path;
+import java.util.List;
 
 public class LatexInlinedCodePlugin implements InlinedCodePlugin {
     public static final String ID = "latex";
     public static final String SRC_KEY = "src";
+    private String latex;
 
     @Override
     public String id() {
@@ -40,7 +44,12 @@ public InlinedCodePlugin create() {
 
     @Override
     public PluginResult process(ComponentsRegistry componentsRegistry, Path markupPath, PluginParams pluginParams) {
-        String latex = pluginParams.getOpts().getRequiredString(SRC_KEY);
+        latex = pluginParams.getOpts().getRequiredString(SRC_KEY);
         return PluginResult.docElement(new DocElement("InlinedLatex", "latex", latex));
     }
+
+    @Override
+    public List<SearchText> textForSearch() {
+        return latex != null ? List.of(SearchScore.STANDARD.text(latex)) : List.of();
+    }
 }

znai-core/src/main/java/org/testingisdocumenting/znai/extensions/meta/MetaIncludePlugin.java

@@ -21,8 +21,10 @@
 import org.testingisdocumenting.znai.extensions.PluginResult;
 import org.testingisdocumenting.znai.extensions.include.IncludePlugin;
 import org.testingisdocumenting.znai.parser.ParserHandler;
+import org.testingisdocumenting.znai.search.SearchText;
 
 import java.nio.file.Path;
+import java.util.List;
 
 public class MetaIncludePlugin implements IncludePlugin {
     public static final String ID = "meta";
@@ -44,4 +46,9 @@ public PluginResult process(ComponentsRegistry componentsRegistry,
                                 PluginParams pluginParams) {
         return PluginResult.docElement("Meta", pluginParams.getOpts().toMap());
     }
+
+    @Override
+    public List<SearchText> textForSearch() {
+        return List.of();
+    }
 }