CDR Tickets

Issue Number 4188
Summary Re-order items in right-click menu available in XMetaL
Created 2016-11-16 18:50:44
Issue Type Improvement
Submitted By Juthe, Robin (NIH/NCI) [E]
Assigned To Kline, Bob (NIH/NCI) [C]
Status Closed
Resolved 2017-02-15 15:58:35
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.198385
Description

We'd like to re-order the list of options available in the right-click menu that is available when working in XMetaL.

As a first step, , could you please provide a list of all available commands in the right-click menu so we can put them in a logical sequence? Thanks!

Comment entered 2016-11-18 09:50:15 by Juthe, Robin (NIH/NCI) [E]

Just wanted to add a comment that we discussed the possibility of moving the glossifier options (2 of them) from the right-click menu to icons.

Comment entered 2016-11-23 14:53:52 by Kline, Bob (NIH/NCI) [C]

Story point estimate is subject to change, as the decisions about toolbar buttons haven't yet been made.

Comment entered 2016-11-23 15:10:42 by Kline, Bob (NIH/NCI) [C]

Here is the requested list of available context menu items, in order of (possible) appearance. I think I remembered you saying you didn't want the logic in the code included, right?

  • Edit Element

  • Copy Document Link

  • Copy Fragment Link

  • Paste Document Link

  • Paste Fragment Link

  • Remove Public=No

  • Make Public=No

  • Open Link For Editing

  • Open Link Readonly

  • Insert Lead Org

  • Prot Update Person

  • New Current Org Status

  • Insert Grp POs

  • Retrieve Person Address

  • Change Site Statuses

  • Paste Org Address Elements

  • Extract PDQIndexing Block

  • Extract PDQAdminInfo Block

  • Glossify Document

  • Glossify Document (include all sections in markup)

  • Add Glossary Phrase

  • Retrieve Org Postal Address

  • Copy Fragment ID

  • Persons Linking to This Location

  • Remember Postal Address

  • Paste Fragment ID

  • Show Linked Object

  • Insert Diagnosis Links

  • Show CTGovProtocol Titles

  • Insert PDQIndexing Block

  • Insert PDQAdminInfo Block

  • Next Unlinked Org

  • Next Unlinked Person

  • Insert Comment

  • Insert ResponseToComment

  • Insert Type of Summary Change

  • Insert Current Date and Time

  • Find Private Use Unicode Characters

  • Split Intervention Block

  • Linked Fragment Docs Report

  • Edit Comment

  • Set Last Reviewed Date Attribute

  • Set Last Reviewed Status Attribute

  • View Comment

  • Spanish Link ID Swap

  • Apply Revision Level

  • Set Source to Advisory Board

  • Set Source to Editorial Board

Comment entered 2016-12-12 13:39:14 by Osei-Poku, William (NIH/NCI) [C]

I am not able to find where the following two macros are used in XMetal. Could you please point me to where they are used? Apart from the two below, I am able to find all the other macros in the context menus.

Edit Comment
View Comment

Comment entered 2016-12-12 18:07:49 by Kline, Bob (NIH/NCI) [C]

Looking at the code, it appears that those are available when you're in a Summary doc and inside one of the following elements:

  • ProtocolRef

  • ProtocolLink

  • CitationRef

  • CitationLink

I'm guessing that we provided a separate interface for those comments, since they're stored in attributes, and therefore not as convenient to edit using XMetaL's built-in interface.

Comment entered 2016-12-13 20:43:26 by Osei-Poku, William (NIH/NCI) [C]

Thanks. I was able to see the macros while in the above elements.

Comment entered 2016-12-20 15:19:47 by Juthe, Robin (NIH/NCI) [E]

I would like to discuss the possibility of moving the following macros to toolbar icons in our next CDR meeting:

  • Glossify document

  • Glossify document (include all sections in markup)

  • Find Private Use Unicode Characters

  • Insert Type of Summary Change

  • Linked Fragment Docs Report (move to icon and/or run from reports menu?)

Once we establish which (if any) macros will be removed from the right-click menu, I can propose a new sequence for the list.

Comment entered 2017-01-04 15:06:34 by Kline, Bob (NIH/NCI) [C]

I have moved this into the next iteration pending requirements.

Comment entered 2017-01-05 14:30:24 by Juthe, Robin (NIH/NCI) [E]

We agreed to move the following actions to icons:

Glossify document
Glossify document (include all sections in markup)
Find Private Use Unicode Characters
Insert Type of Summary Change
Linked Fragment Docs Report

William will specify which icons should be visible in which document types.

Comment entered 2017-01-05 17:45:48 by Juthe, Robin (NIH/NCI) [E]

Here's the updated preferred sequence. I've adjusted the sequence of the summary-related items in the full list and removed the items that we've moving to icons. I'm not sure if all of the protocol actions are still needed.

• Edit Element
• Copy Document Link
• Copy Fragment Link
• Paste Document Link
• Paste Fragment Link
• Remove Public=No
• Make Public=No
• Open Link For Editing
• Open Link Readonly
• Insert Lead Org
• Prot Update Person
• New Current Org Status
• Insert Grp POs
• Retrieve Person Address
• Change Site Statuses
• Paste Org Address Elements
• Extract PDQIndexing Block
• Extract PDQAdminInfo Block
• Add Glossary Phrase
• Retrieve Org Postal Address
• Copy Fragment ID
• Persons Linking to This Location
• Remember Postal Address
• Paste Fragment ID
• Show Linked Object
• Insert Diagnosis Links
• Show CTGovProtocol Titles
• Insert PDQIndexing Block
• Insert PDQAdminInfo Block
• Next Unlinked Org
• Next Unlinked Person
• Insert Comment
• Insert ResponseToComment
• Insert Current Date and Time
• Split Intervention Block
• Edit Comment
• Set Last Reviewed Date Attribute
• Set Last Reviewed Status Attribute
• View Comment
• Spanish Link ID Swap
• Set Source to Advisory Board
• Set Source to Editorial Board
• Apply Revision Level

Comment entered 2017-01-06 14:28:41 by Osei-Poku, William (NIH/NCI) [C]

William will specify which icons should be visible in which document types.

Glossify document - Summary
Glossify document (include all sections in markup) - Summary
Find Private Use Unicode Characters - Summary, DIS, DCS, CTGovProtocol, Terminology, Person, Organization, Citation, Glossary (GTN, GTC), Media, Miscellaneous Document.
Insert Type of Summary Change - Summary
Linked Fragment Docs Report - Summary, DIS, DCS, CTGovProtocol, Terminology, Person, Organization, Citation, Glossary (GTN, GTC), Media, Miscellaneous Document.

Comment entered 2017-01-13 12:01:36 by Kline, Bob (NIH/NCI) [C]

Implemented on DEV; please check to confirm that the buttons and context menus are as desired.

Comment entered 2017-01-31 17:23:24 by Osei-Poku, William (NIH/NCI) [C]

I reviewed these on DEV and the icons and the context menu items all appear to be okay. I am reviewing different document types and they all appear to show the correct icons and the menu items so far.

Comment entered 2017-01-31 17:46:15 by Osei-Poku, William (NIH/NCI) [C]

If it is not too much work, could you please include the CDR IDs of the documents in the spreadsheet?

Comment entered 2017-01-31 19:17:17 by Kline, Bob (NIH/NCI) [C]

Did this comment get attached to the wrong ticket?

Comment entered 2017-01-31 19:20:51 by Osei-Poku, William (NIH/NCI) [C]

Right. Wrong ticket.

Comment entered 2017-02-02 12:32:34 by Juthe, Robin (NIH/NCI) [E]

The right-click menu looks good to me so far - I'm still testing.

The Type of Change macro button appears to be the same icon as we have for "New section" - is there another option for the icon?

Comment entered 2017-02-09 12:15:00 by Kline, Bob (NIH/NCI) [C]

I have attached an image which shows all of the available icons. Please pick one (you'll probably want to zoom in to get a closer look at them).

Comment entered 2017-02-10 09:01:43 by Kline, Bob (NIH/NCI) [C]

Here's a page which might make it easier to look at the icons, as well as make it easier to communicate which one you want (I've added group names and row and column numbers):

http://cdr-dev.cancer.gov/cgi-bin/cdr/xmetal-icons.py

Comment entered 2017-02-10 09:28:01 by Juthe, Robin (NIH/NCI) [E]

Thanks! That's very helpful. How about row 2, column 5 in the Revisions table? (pencil, pad of paper, small blue arrow pointing down)

Comment entered 2017-02-10 10:42:36 by Kline, Bob (NIH/NCI) [C]

Done. I've put the icon picking tool on the admin menu for general reports, as I assume it will come in handy again in the future.

Comment entered 2017-02-10 16:36:01 by Juthe, Robin (NIH/NCI) [E]

This looks good on DEV to me, but I am only checking summaries. I'll let William mark this verified when he's ready since he's checking other doc types.

Comment entered 2017-02-14 17:17:36 by Osei-Poku, William (NIH/NCI) [C]

The Linked Frag Doc report icon works only when you're in a specific part of the document that appears to have fragments. If your cursor is placed in the metadata section of summary, for example, you get an error message. Since the report works at the document level, could we have the report run irrespective of where the cursor is placed at the time of running the report?

I should also add that because of the above issue, I am unable to run the report for Term documents and Media documents from the icons but I am able to do so through the admin menu.

CDR0000720864
CDR0000739249

Comment entered 2017-02-14 17:35:55 by Osei-Poku, William (NIH/NCI) [C]

I see that the Find private use unicode character icon and the linked fragment doc icons are visible in documents types like Country and Mailer which were not identified to have them. They do not work in those document types so they shouldn't be visible.

Comment entered 2017-02-15 10:21:25 by Kline, Bob (NIH/NCI) [C]

Don't forget that if you want changes, you need to alter the status of the ticket.

It's going to be more difficult, error-prone, and harder to maintain to install toolbar icons to be used by almost every document type on each of the document-specific toolbars, so be sure you believe it's really worth it (and that you've convinced yourself that it's impossible for a user to paste Microsoft-specific characters into the other types of documents).

Comment entered 2017-02-15 10:23:54 by Kline, Bob (NIH/NCI) [C]

The Linked Frag Doc report icon works only when you're in a specific part of the document that appears to have fragments.

That's what the requirements told us to do.

https://tracker.nci.nih.gov/browse/OCECDR-2644

We would like to have the ability to run it from the right mouse when the user's cursor is positioned inside the appropriate fragment in the document.

The request was for the ability to get the report on links to a specific fragment of a document, not just to anywhere in the document.

Comment entered 2017-02-15 10:54:42 by Osei-Poku, William (NIH/NCI) [C]

Thanks for the info. It seems to me now that we shouldn't have removed this from the context menu. It would be more helpful in the context menu than on the toolbar.

Comment entered 2017-02-15 13:46:46 by Osei-Poku, William (NIH/NCI) [C]

Can you please explain this one further? I get the same results from the report regardless of the fragment I run the report on. I assumed from the explanation above that I would get different results depending on the part of the document (different fragments) I had my cursor when I ran the report.

Comment entered 2017-02-15 14:09:54 by Osei-Poku, William (NIH/NCI) [C]

We can keep the Find Private Use Unicode... report on all document types. I think that won't pose any problems. I will then suggest that we bring back the Linked Doc report back to the context menu. It seems that is the appropriate place to have it due to the requirement that you need to be within a specific frag ref to run it. Please, feel free to weigh in.

Comment entered 2017-02-15 14:16:33 by Juthe, Robin (NIH/NCI) [E]

It's fine with me to put the Linked Doc report back into the right-click menu. I suggest placing it near the top of the menu (between "Edit Element" and "Copy Document Link" in the list above) so that we don't inadvertently click it.

Comment entered 2017-02-15 14:28:35 by Kline, Bob (NIH/NCI) [C]

A bug was introduced during security tightening in response to an app scan. I've fixed the bug. Compare this version of the report with the more explicit version.

Comment entered 2017-02-15 15:00:36 by Osei-Poku, William (NIH/NCI) [C]

Thank you! I have a better understanding of how the report works now.

Comment entered 2017-02-15 15:57:17 by Kline, Bob (NIH/NCI) [C]

I have moved the report back to the context menu, using the location you suggested.

Comment entered 2017-02-15 17:32:50 by Osei-Poku, William (NIH/NCI) [C]

Verified.

Comment entered 2017-03-01 10:25:05 by Osei-Poku, William (NIH/NCI) [C]

1. Is there a reason why when I check out summary documents on QA, the summary metadata is preselected? I know this has happened in the past when users have accidentally deleted the metadata because of this but I can't remember the reason for this behavior.

2. For some reason, the Insert Type of Summary Change macro doesn't work for CDR0000445441. It works well for other summaries but for some strange reasons, it is always inserted in a table cell when you click on it. I thought that it was because the metadata was preselected when I opened the summary but I when I deselect the metadata section, it still doesn't work well for this particular summary. That is the reason for question 1 above.

Comment entered 2017-03-01 12:34:50 by Kline, Bob (NIH/NCI) [C]

I'm pretty sure the editor puts the selection in the first block of the document underneath the inserted CdrDocCtl block. I'm able to get the macro to put a TypeOfSummaryChange block in the right place, but I have to first put my cursor past the existing TypeOfSummaryChange blocks (otherwise, it might not find the place you want, particularly if there are Insertion or Deletion elements in the document – remember anything can go in one of those, and the software is looking for the first legal place after the cursor's current position where the element to be inserted is allowed to go). Might not have been a problem when the macro was on the right-click context menu, because that probably mentally cued the user to click where she wanted the new block.

Comment entered 2017-03-03 14:14:37 by Juthe, Robin (NIH/NCI) [E]

Verified on QA.

Attachments
File Name Posted User
xmetal_cdr_icons.jpg 2017-02-09 12:14:01 Kline, Bob (NIH/NCI) [C]

Elapsed: 0:00:00.001384