Presenting Validation Errors in JSON DocumentsEdit online
Validation errors in JSON documents are presented in various locations of the interface.
Validation Marker Locations
Validation issues are marked in the following locations:
- In the main editing pane, with the issue underlined in a color according to the type of issue.
- In the right-side vertical stripe, with a marker that is colored according to the type of issue.
Validation Marker Colors
The colors for each type of issue are as follows:
- Validation Errors [Red] - By default, the underline in the editing pane, the marker in the right vertical stripe, and the foreground color of the attribute in the Attributes view are colored in red.
- Validation Warnings [Yellow] - By default, the underline in the editing pane, the marker in the right vertical stripe, and the foreground color of the attribute in the Attributes view are colored in yellow.
- Validation Info [Blue] - By default, the underline in the editing pane, the marker in the right vertical stripe, and the foreground color of the attribute in the Attributes view are colored in blue.
Validation Markers in the Right-Side Stripe
Also, the stripe on the right side of the editor panel is designed to display
the issues found during the validation process and to help you locate them in the document.
The stripe contains the following:
- Upper Part of the Stripe
- A success indicator square will turn green if the validation is successful or only info messages are found, red if validation errors are found, or yellow if only validation warnings are found. More details about the issues are displayed in a tool tip when you hover over indicator square. If there are numerous problems, only the first three are presented in the tool tip.
- Middle Part of the Stripe
- Errors are depicted with red markers, warnings with yellow markers, and info message
with blue markers. If you want to limit the number of markers that are displayed, open the
Preferences dialog box , go to , and specify the desired limit in the Maximum number of validation highlights
option.
Clicking a marker will highlight the corresponding text area in the editor. The validation message is also displayed both in a tool tip (when hovering over the marker) and in the message area on the bottom of the application.
- Bottom Part of the Stripe
- Two navigation arrows (
) allow you to jump to
the next or previous issue. The same actions can be triggered from (Ctrl + Period
(Command + Period on OS X)) and (Ctrl + Comma
(Command + Comma on OS X)).
Hovering Over Validation Issues
Hovering over a validation issue presents a tooltip message with more details about the problem. Also, when hovering over an issue, pressing F2 will change the focus to the tooltip.
Details About Validation Issues
- Information about the issue is also displayed in the message area on the bottom of the
editor panel (clicking the
Document
checking options button opens the Document
Checking preferences page where you can configure some validation
options. - Status messages from every validation action are logged in the Console view (the Enable Oxygen consoles option must be selected in the View preferences page).
- If you want to see all the validation messages grouped in the Results
view, you should use the
Validate action from the toolbar or JSON
menu. This action also collects the
validation messages and displays them in the Problems view if
the validated file is in the current workspace or in a custom
Errors view if the validated file is outside the
workspace.