Skip to content

Commit

Permalink
Added pre-set species support to gene search.
Browse files Browse the repository at this point in the history
Subsequently the version was bumped to 1.2.0.
  • Loading branch information
alancleary committed Nov 17, 2023
1 parent d27dae0 commit a7db3d5
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions gene-search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,27 @@
This is the requirements doc for the LIS gene search to be implemented on the LIS Jekyll web site.

## Specification version
Version: 1.1.1
Version: 1.2.0

<details>

A draft of this specification was completed in March 2023. Based on initial implementation of the spec and review of that implementation [issue #128](https://github.com/legumeinfo/web-components/issues/128), additional changes were made to better handle pagination and back-navigation from the modal linkouts results window.

After another round of review in mid-July 2023, the intermediate output was changed from vertical layout of the results for each gene to a tabular layout per gene, based on this rationale from Alan (Aug 4, lis-developers discussion thread): </i>"... the generic paginated search class the component is based on draws results using a table, but the gene search component overrides this to draw results as a list. While the list is aesthetically pleasing, it can only be configured by forking the repository and modifying the code, whereas the table can be configured at run-time, i.e. no forking necessary."</i>
After another round of review in mid-July 2023, the intermediate output was changed from vertical layout of the results for each gene to a tabular layout per gene, based on this rationale from Alan (Aug 4, lis-developers discussion thread): <i>"... the generic paginated search class the component is based on draws results using a table, but the gene search component overrides this to draw results as a list. While the list is aesthetically pleasing, it can only be configured by forking the repository and modifying the code, whereas the table can be configured at run-time, i.e. no forking necessary."</i>

Initial public release of this web component at legumeinfo.org was on August 9. Code for this spec-1.1 release is [documented here](https://legumeinfo.github.io/web-components/classes/user_components.LisGeneSearchElement.html).

The history above predates a versioning system for these website-ui specs. In September 2023, semantic versioning was added, with 1.1.0 being used in this spec to reflect the first production release of this gene-search web component -- subversion .1 indicating that significant changes were made in June-July after review of the initial implementation in March.
The history above predates a versioning system for these website-ui specs. In September 2023, semantic versioning was added, with 1.1.0 being used in this spec to reflect the first production release of this gene-search web component -- minor version 1 indicating that significant changes were made in June-July after review of the initial implementation in March.

September 19: update spec version to 1.1.1 -- the minor version increment reflecting that the Gene search field should be parameterizable in the web component, to allow fixing the genus to e.g. Arachis or Glycine, for use at a genus-specific site or context.
September 19: update spec version to 1.1.1 -- the minor version increment reflecting that the Gene search field should be parameterizable in the web component, to allow fixing the genus to e.g. Arachis or Glycine, for use at a genus-specific site or context. **Note: This was a new feature and should have bumped the version to 1.2.0.**

November 17: similar to the September 19 update, the spec was updated to allow the species parameter to also be parameterizable. As such, the spec version was incremented to 1.2.0.
</details>

## Input

- genus (selector with "any" on top). In single-genus contexts (e.g. PeanutBase or SoyBase), allow this value to be pre-set.
- species (selector populated if genus specified, otherwise only "any")
- Species (selector populated if genus specified, otherwise only "any" - unless pre-set to some value, e.g. max)
- strain (selector populated if species specified, otherwise only "any")
- gene identifier (text input)
- gene description (text input)
Expand Down

0 comments on commit a7db3d5

Please sign in to comment.