DRAFT: Add documentation for how to use the table filtering section of scicat#13
Conversation
LAShemilt
left a comment
There was a problem hiding this comment.
Thanks so much for putting in the time to do this. There has been an initial start to the documentation on the dashboard but I think this goes further. It would be good to amalgamate the two docs.
I would say that the structure of this should be:
/docs/datasets/DashboardTableEditing.md
The current docs can be found here:
/docs/login/Dashboard.md
I would suggest that we keep the section on the Landing Page in /docs/login/Dashboard.md, but move the content on table filtering to /docs/datasets/DashboardTableEditing.md along with the new content on saving data.
|
@LAShemilt I've made adjustments to the structure and taken repeated elements out of each document to avoid confusion. I think separating the files is the way to go to ensure each element is clear for the users but let me know if you're not a fan of this. |
LAShemilt
left a comment
There was a problem hiding this comment.
Hi Nick, LGTM just some small changes to the wording and typos. Once applied this can be merged.
| - refresh the page | ||
| - enter into any record and then go back | ||
|
|
||
| Fortunately, SciCat has a built in way to make the layout persistent and the default. To make the table always filter to your selected columns, first apply the filters as shown above. Go back into the table menu and select the `save table settings` option.\ |
There was a problem hiding this comment.
| Fortunately, SciCat has a built in way to make the layout persistent and the default. To make the table always filter to your selected columns, first apply the filters as shown above. Go back into the table menu and select the `save table settings` option.\ | |
| SciCat has a built in way to make the layout persistent and the default. To make the table always filter to your selected columns, first apply the filters as shown above. Go back into the table menu and select the `save table settings` option.\ |
| ## Saving data from SciCat | ||
| The process of saving or exporting data from Scicat is simple, open the table menu, select `Save data`, choose the output you want.\ | ||
| \ | ||
| However there are a few important points to understand when saving data from SciCat. |
There was a problem hiding this comment.
| However there are a few important points to understand when saving data from SciCat. | |
| Descriptions of the saving behaviour for each of the formats are given below. |
|
|
||
| #### Saving to JSON | ||
| \ | ||
| The Json option will return you a lot more information as it will save all data related to the records being displayed on that page of the table. This option is very useful for metadata analysis and will provide all fields for each record in the Json format ready to be read/ingested by a program to perform analysis. |
There was a problem hiding this comment.
| The Json option will return you a lot more information as it will save all data related to the records being displayed on that page of the table. This option is very useful for metadata analysis and will provide all fields for each record in the Json format ready to be read/ingested by a program to perform analysis. | |
| The Json option will return you more information as it will save all data related to the records being displayed on that page of the table. This option is very useful for metadata analysis and will provide all fields for each record in the JSON format ready to be read/ingested by a program to perform analysis. |
|
|
||
| ### Saving only specific records | ||
| In SciCat there is also the ability to only save data for manually selected data. \ | ||
| This option works for both CSV and Json format to only return information about these selected records. However, the other aspects of each saving method still apply so CSV will return a snapshot of what you see, and Json will return all of the data related to just the selected records. |
There was a problem hiding this comment.
| This option works for both CSV and Json format to only return information about these selected records. However, the other aspects of each saving method still apply so CSV will return a snapshot of what you see, and Json will return all of the data related to just the selected records. | |
| This option works for both CSV and JSON format to only return information about these selected records. However, the other aspects of each saving method still apply so CSV will return a snapshot of what you see, and JSON will return all of the data related to just the selected records. |
This MR adds a documentation to for the Scicat table and column filtering as well as saving data. It is intended as a user guide on how to navigate and operate the filtering options along with information about what will return.