icatproject / topcat

GUI to work with multiple ICAT and IDS servers.
Other
1 stars 9 forks source link

Download type description: should be able to add formatted text #450

Closed dfq16044 closed 5 years ago

dfq16044 commented 5 years ago

We would like to add terms and conditions for the DLS restore node functionality before the users submit a cart. Currently, it is only one line of text, it will be good if we could add \n to distinguish the different lines.

brianritchie1312 commented 5 years ago

I think that the description text is added (by AngularJS) to the document content too late for any markup in it to be interpreted. I will look for alternatives, but I'm not certain that it will be possible to change this.

brianritchie1312 commented 5 years ago

I've created a branch and changed how the description is added. HTML markup within the description now seems to work - at least <br/> and <a href>. Other markup may not work well because of the location of the description within the page. I recommend that any links should have target="_blank" set to force them to appear in a new tab/window. Also, any quotes in the markup need to be escaped, as it's within a string value in a JSON structure. Markup errors may not be detected until the download type is selected in the dialog!

If you send me an example of what you want, I will see if it can be added.

dfq16044 commented 5 years ago

Thank you very much for your help,

Here is the original text: Diamond Light Source (DLS) Data Restore policy

  1. Data can be restored from icat.diamond.ac.uk to DLS file system. To achieve this, the user should pick “DLS restore” Download Access Method from the drop-down menu.

  2. Users will receive an email when data is available in the DLS file system. Data will be available in one of the following directory structure: /dls/staging/dls/$instrument/data/$year/$visit or /dls/staging/dls/$village/data/$proposal/$visit.

  3. The user, beamline staff and visit users will have full write/read access to the directory that has been created at DLS and containing the data requested in TopCat.

  4. No further archiving will take place.

  5. Users will have 15 days to process and transfer their data. After that period, data will be deleted from DLS filesystem. Information on when data will be deleted can be found at README/DATA_EXPIRATION_DATE file in the restored visit directory. It is the responsibility of the user to ensure that data has been transferred before deletion, processed data will not be archived.

  6. Diamond reserves the right to disable the DLS restore option in icat.diamond.ac.uk for essential system maintenance.

brianritchie1312 commented 5 years ago

It's possible (e.g. a simple HTML ordered list) but looks out of proportion with the rest of the dialog. Screenshot sent by email (cannot be added here). As it has to be a single-line string in topcat.json it will be fiddly to maintain.

dfq16044 commented 5 years ago

ok, I will see with Greg on Monday to see what he thinks