Re: [Tiki-devel] A default for the list of plugins, whose bodies should be indexed

On vendredi 6 janvier 2023 18 h 31 min 57 s EST Rick Sapir wrote:
> To provide additional flexibility, would it be useful to have this
> option on each plugin, that would override the global include/exclude list?
> 
> For example:
> 
> {DIV(searchable="y|n").....}
> 
> and the plugins noted by Volker could default to "y" (and the other
> plugins to "n").
> 
> And this would work as an override to the global include/exclude list.
> Just a thought....

Actually, that makes a LOT more sense to me than a global include/exclude list which I 
would think rarely makes sense globally except to exclude a buggy plugin that screws up 
indexing.

Volker's list illustrate the need for a default.  

And yes, as a first step indexing plugins that just modify output markup, and take plain 
text as a body makes a lot of sense.

But answering the question "do we want to index this by default" for a specific plugin type 
requires a bit more than that.

A) DO we want to index content from all instances of the plugin by default?

1- Yes (ex:  Any pure markup plugin (ex: PluginDiv, PluginMarkdown), any plugin that 
potentially nests other plugins (ex: PluginTabs) 
2- No (ex:  Probably any plugin that retrieves content elsewhere in Tiki or over the Net)
3- Never, even if the user requests it (ex:  PluginGoogleAnalytics[1], 
PluginWYSIWYG[2] (Plugin where neither the  data or output makes no sense to index), 
PluginRandominclude[3] (Plugins where the data is never specific to the page).

The reason I didn't put a "Always" is there is that I believe the user would expect the 
behaviour of searchable/notsearchable to be recursive.  Erroring-out if the plugin is 
"Never", but recursively not index if one passes "notsearchable" to a parent plugin in the 
page. Disabling indexing on specific content is something the user could want to do for a 
number of non-technical reasons.

B) WHAT do we want to index?

1- The body?  That the body of the plugin is expected to be raw text is a bit of an 
exception...  
2- The page output? Sometimes, but the output may depend on the user, or other 
context.  
3- Some different output? Likely to be the usual case (ex:  convert to plaintext, disable 
pagination, extract some summary data, etc., )


-- 
Benoit Grégoire 

--------
[1] https://doc.tiki.org/PluginGoogleAnalytics
[2] https://doc.tiki.org/PluginWYSIWYG
[3] https://doc.tiki.org/PluginRandominclude

_______________________________________________
TikiWiki-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/tikiwiki-devel