ixbrl-viewer
ixbrl-viewer copied to clipboard
Non-numeric highlight toggle
What should we change and why?
Brainstorming here. Ram provided feedback suggesting the utility of an option to disable text block highlighting in review mode, leaving only the tagged and untagged numeric values highlighted. Could this be something exclusive to review mode, or maybe available across all modes? If it doesn't overcrowd the UI, perhaps we could even allow separate highlight toggling for numeric and non-numeric facts?
@austinmatherne-wk
I really appreciate the suggestion you've brought up, such as the possibility of enabling distinct toggles for highlighting numeric and non-numeric information.
In addition to that, I have a couple of suggestion regarding the highlighting in the Textblock section is as follows:
Currently, the background color is highlighted in green for all instances of Textblock/Numeric tagging. However, I have a couple of recommendations for improvement.
Recommendation 1: Introduce a new menu specifically for highlighting textblock tagging. Within this menu, I suggest implementing a label or placeholder for highlighting the tagging, instead of covering the entire background. Please refer to the example proposal below:
Current Rendering
Proposal
Recommendation 2: If the idea of having multiple menus within the review mode or for regular highlights is being considered, it might be beneficial to incorporate labels or placeholders within the textblock tagging. In that, Upon clicking the button, the respective block can be highlighted (if the user wishes to visualize the boundaries). This modification is motivated by the challenge of reviewing tagging and the difficulty users encounter when identifying issues.
Proceed with whichever option is possible and elegant. I absolutely adore the features we currently possess.
Could this be something exclusive to review mode, or maybe available across all modes? If it doesn't overcrowd the UI, perhaps we could even allow separate highlight toggling for numeric and non-numeric facts?
The easy thing to do would be to put options on the settings/language menu the control what gets highlighted when you turn "highlight XBRL elements" on, but I think the interaction between these options and the checkbox maybe unintuitive.
An alternative approach would be to introduce a "highlight settings" dialog, accessed via the menu. This would give us a bit more space to explain the effect of the options compared to putting them directly on the menu.
@paulwarren-wk
I would like to express my gratitude for your valuable suggestion and the detailed information you provided; it has proven to be immensely helpful. The idea of using distinct colors to differentiate between numeric and non-numeric facts is a sound one. However, it's worth noting that our "stringItemType", such as the example involving LIBOR tagging, also encompasses numeric elements alongside non-numeric ones. Our current focus is exclusively on textblock tagging. Thus, I propose the addition of a filter that allows users to select the element type as "textBlockItemType" and highlights relevant content accordingly. To enhance the visibility of untagged values for users attempting to run them, it is advisable to completely remove the background color of the text block. This will make it easier for users to perceive untagged numbers or facts within the block.
In terms of the highlighting, I recommend implementing a subtle visual cue, such as dotted lines in a light color, or the addition of a label like "Block Tagging" (for instance, "Export Table" -
).
Additionally, I have a further suggestion involving the introduction of a checkbox in the top header labeled "Textblock Elements." When users opt to activate this option, it will exclusively highlight Level 1 to 3 taggings. It is essential to emphasize that these highlights will be entirely contingent upon the element type being "textBlockItemType."
Thank you for your consideration, and I look forward to your feedback.