Compendium Enrichment

[Muhsigbokz]

The Compendium Browser can be called via In-Line Tags with Setting written in the Tag

Examples

@AbilitiesBrowser[search:e|order:dir:desc]{Abilties with E, descending by name}

@EdgesBrowser[search:of|search:art]{Edges, searching for art of}

@EdgesBrowser[search:art of]{Edges, searching for art of, alternative}

@FeatsBrowser[class:arcanist|class:berserker|order:by:name]{Arcanist or Berserker features, sortby name}

@MovesBrowser[type:nuclear|category:special|search:e]{Nuclear Special Moves with e}

@PokeEdgesBrowser[source:homebrew]{Homebrew PokeEdges}

@SpeciesBrowser[source:ptr-core-dex-megas|types:not:dragon|abilities:logic:or|abilities:memory-wipe|abilities:cruelty|abilities:blaze|sky:min:1|swim:max:5]{Species from PTR Core Dex Mega Mon that are 1) not dragon type and 2) can gain either of a) memory whipe or b) cruelty or b) blaze and 4) have a) at least 1 sky and b) max 5 swim}

@SpeciesBrowser[source:ptr-core-dex-megas|types:not:dragon|abilities:logic:or|abilities:memory-wipe|abilities:cruelty|abilities:blaze|sky:min:1|swim:max:5]

renders to

Logic

• The name of a tab is parsed in the eventListener, at time of clicking. I there is no tab for name name, a warning is displayed and the browser is not opened.
• If the Browser can be opened, all settings for which there is no properly named setting give a warning, but the Browser opens
• Some things not handled fail silently, e.g. setting the order direction to order:dir:neitherAscNorDesc
• If the Browser fails to open, an Error is shown. I did not find a way to cause this, but I am sure some other user will manage to.

Syntax

as per /@([A-Z][a-z]+)Browser\[([|:_0-9a-zA-Z\- ]*)\](:?{(:?[^\[\]\{\}@]*)?})?/gim

@<tabNameUpperCase>Browser[<settings>]{<explicitDisplayText>} | @<tabNameUpperCase>Browser[<settings>]

• >tabNameUpperCase> can be Abilities, Capabilities, and such
• {<explicitDisplayText>} is optional, as seen in last the example above
  • if omitted, it will name the tab Name for the created anchor as well as the number of settings in it
• settings are are list of 0 or more <key>:<value> strings, concatinated by | such that
  • <key> refers to
  • the object key of a tabs filterData object after the layer of filter type. examples would be overland of speciesTab.filterData.sliders.overland. This is the case of any filter that is set via checkboxes, multiselects, sliders, selects
  • either order or search, as special cases compared to the previous
  • <value> refers mostly to a sluggified version of the value as displayed. it can also be further structured like min:1 for overland:min:1 - this depends on the type of input used for the given key

Misc Tech Details

The enrichment of all(?) visible content is done with a custom enricher in CONFIG.TextEditor.enrichers. Apparently there is no doc for those, or at least none easily findable (https://foundryvtt.com/api/classes/client.TextEditor.html), but thanks to some guidance https://discord.com/channels/170995199584108546/722559135371231352/1192834854614737068 it seems very simple and handy - if you know about it, like it is always the case.

A single Event Listener takes care of all tabs.

During development, tagify caused some trouble. Specifically, see #593. Thats why that has been touched together this feature.

I am not aware of a similar thing done in this code so far. CompendiumBrowserInlineEnricher.listen both adds the enrichers to CONFIG.TextEditor.enrichers as well as the Event Listeners to the respective hooks. There are likely other ways to structure this, but this way all logic stay in one place, both for Enrichment and Compendium opening. Seems fine to me.

[Muhsigbokz]

Some features that could later be added:

• Have a button in the CompendiumBrowser that generates the @TabBrowser[]{} for the current filter
• Maybe other styling
• Better detection for non-applicable filter settings

[Muhsigbokz]

updated for 1fed3a7581546e08250c2b60dddc7d610125c372

The Compendium Browser can be called via In-Line Tags with Setting written in the Tag

Examples

@CompSearch[Abqweilities  e]{I render, but you cant open me}

@CompSearch[Abqweilities] This also can't be opened

@CompSearch[Abilities idontexist=12 order-dir=desc e]{My setting idontexist does not exist}

@CompSearch[Abilities order-by=name order-dir=desc e]{Abilties with E, descending by name}

@CompSearch[Edges of art]{Edges, searching for art of}

@CompSearch[Feats class=arcanist class=berserk order-by=name]{Arcanist or Berserker features, sortby name}

@CompSearch[Moves type=nuclear category=special e]{Nuclear Special Moves with e}

@CompSearch[PokeEdges source=homebrew]{Homebrew PokeEdges}

@CompSearch[Species source=ptr-core-dex-megas types=not-dragon abilities-logic=or abilities=memory-wipe abilities=cruelty abilities=blaze sky-min=1 swim-max=5]{Species from PTR Core Dex Mega Mon that are 1) not dragon type and 2) can gain either of a) memory whipe or b) cruelty or c) blaze and 4) have a) at least 1 sky and b) max 5 swim}

@CompSearch[Species source=ptr-core-dex-megas types=not-dragon abilities-logic=or abilities=memory-wipe abilities=cruelty abilities=blaze sky-min=1 swim-max=5]

renders to

Logic

• The name of a tab is parsed in the eventListener, at time of clicking. I there is no tab for name name, a warning is displayed and the browser is not opened.
• If the Browser can be opened, all settings for which there is no properly named setting give a warning, but the Browser opens
• Some things not handled fail silently, e.g. setting the order direction to order-dir=neitherAscNorDesc
• If the Browser fails to open, an Error is shown. I did not find a way to cause this, but I am sure some other user will manage to.

Syntax

as per /@CompSearch\[([A-Za-z]+) ?([0-9a-zA-Z\-= ]*)\](:?{(:?[^\[\]\{\}@]*)?})?/gim

@CompSearch[<tabNameUpperCase> <settings> <searchWords>]{<explicitDisplayText>} | @<tabNameUpperCase>Browser[<settings>]

• >tabNameUpperCase> can be Abilities, Capabilities, and such
• {<explicitDisplayText>} is optional, as seen in last the example above
  • if omitted, it will name the tab Name for the created anchor as well as the number of settings in it
• settings are are list of 0 or more <key>=<value> strings, with spaces in between
  • <key> refers to
  • the object key of a tabs filterData object after the layer of filter type. examples would be overland of speciesTab.filterData.sliders.overland. This is the case of any filter that is set via checkboxes, multiselects, sliders, selects
  • either order or search, as special cases compared to the previous
  • <value> refers mostly to a sluggified version of the value as displayed.

Special things:

• for sliders, use overland-min=1 and overland-max=6
• for multiselects, use type=not-poison and type-logic=or

Misc Tech Details

The enrichment of all(?) visible content is done with a custom enricher in CONFIG.TextEditor.enrichers. Apparently there is no doc for those, or at least none easily findable (https://foundryvtt.com/api/classes/client.TextEditor.html), but thanks to some guidance https://discord.com/channels/170995199584108546/722559135371231352/1192834854614737068 it seems very simple and handy - if you know about it, like it is always the case.

A single Event Listener takes care of all tabs.

During development, tagify caused some trouble. Specifically, see #593. Thats why that has been touched together this feature.

I am not aware of a similar thing done in this code so far. CompendiumBrowserInlineEnricher.listen both adds the enrichers to CONFIG.TextEditor.enrichers as well as the Event Listeners to the respective hooks. There are likely other ways to structure this, but this way all logic stay in one place, both for Enrichment and Compendium opening. Seems fine to me.