Sorting and grouping

[Schpidi]

It would be good if the list of notebooks could be pre-sorted and/or grouped in order to guide users.

Could we maybe add dedicated attributes like group and order to the generated notebooks.json reading the values from optional metadata fields in the notebooks themselves and use that in the page generation afterwards?

@santilland what are your thoughts? Are there any easy wins possible? Thanks.

[santilland]

In principle the extraction is done in action in each repository, so each of the scripts would need to be updated. It should not be too complicated i think.
At least the grouping should be no problem as it is the eox itemfilter. I am not sure if the itemfilter supports order though.

[Schpidi]

OK, sounds like grouping is the easy win to propose first then.

If I understand correctly this would mean to expand https://github.com/eoxhub-workspaces/example-viewer-template/blob/main/.github/workflows/generate_notebook_list.py to fetch and store a new attribute e.g. group for each notebook and add aggregateResults: "group" in https://github.com/eoxhub-workspaces/example-viewer-template/blob/main/index.html#L35 right?

[santilland]

So in theory the script tries to extract frontmatter information here https://github.com/eoxhub-workspaces/example-viewer-template/blob/main/.github/workflows/generate_notebook_list.py#L153
And it is added here https://github.com/eoxhub-workspaces/example-viewer-template/blob/main/.github/workflows/generate_notebook_list.py#L203C21-L203C38
So, not sure how easy it is to add frontmatter info to the notebook, but then you could add any information there without needing to change the script.
Then exactly you would change the aggregateResult to group by that property.

[santilland]

Ok, so i updated the python script to also fetch the metadata of the notebook as we described, and updated the client to use the latest itemfilter and added grouping to it.
The implementation is done in the template repository
https://github.com/eoxhub-workspaces/example-viewer-template
preview here:
https://eoxhub-workspaces.github.io/example-viewer-template/

so in principle one would just need to copy over these things into the wanted repositories.

There is still one issue that if any of the notebooks does not have the tags metadata, all notebooks will be listed at the end of the results, although it only shows 1 match. This should be fixed in this pull requests:
EOX-A/EOxElements#1962