VideosJSON Author Mode


Duration: 03:45

This video presents an overview of the visual editing support for JSON documents in Oxygen.


00:00:04Starting with Oxygen version 23.0, you can edit JSON documents in the Author  visual editing mode. This video demonstration  
00:00:14is meant to provide an overview of the visual  editing features that are now supported.  
00:00:22I will start by using one of the  JSON files from the Samples project.  
00:00:26Note that a framework is provided in Oxygen that  includes CSS files designed to render this type of  
00:00:31document in the visual editing mode. You can see  that I am able to switch to Author mode where I  
00:00:36can edit the document in a user friendly what  you see is what you get type of interface.  
00:00:42You can even use form controls to really make it  easy to input data, and when I save the document  
00:00:48or switch back to Text mode, it automatically  serializes the content in proper JSON format.  
00:00:56It is also possible to create  your own custom frameworks  
00:01:00and present them differently depending on the  content, as we have done with this document.  
00:01:10You can also edit JSON Schema documents in Author  mode. Again, I'm using a JSON Schema document that  
00:01:15can be found in the Samples project  and I'll switch to Author mode and  
00:01:22make some small modifications...  
00:01:28and it has some links to help me navigate  to various parts of the schema.  
00:01:35You can also edit OpenAPI documents  in the visual editing mode.  
00:01:40This is another document from  the Samples project and it is  
00:01:43part of a special framework that renders this  particular type of document in Author mode.  
00:01:53Oxygen also includes a built-in framework  for rendering any type of JSON document.  
00:01:58I'll use another sample file that is basically  a list of books ... and if I switch to Author mode,  
00:02:04you see that my document has a  generic default rendering.  
00:02:10If a JSON Schema is associated with the  document, that schema will be used for  
00:02:14content completion and validation. You can see that the content completion  
00:02:18window proposes properties and values that can  be inserted in a certain context ... validation  
00:02:24errors are automatically presented in the  editor ... and I can also use the validate  
00:02:30toolbar button to see the errors in the  results pane at the bottom of the editor.  
00:02:40Oxygen also supports using XPath  expressions to find properties  
00:02:43or values in the visual editing mode. I  can enter XPath queries using the XPath  
00:02:49toolbar ... you see that the results  are highlighted in the editor and  
00:02:53in the result pane ... or I can do the same  thing using the XPath builder side view.  
00:03:08I mentioned earlier that you can create  your own custom JSON framework.  
00:03:14For example, you could:  
00:03:15Add a rule to match the  "JSON" as the root local name  
00:03:20Add a rule to match the properties from  the first level of the JSON document  
00:03:25or Add a rule to match the associated schema.  
00:03:28Feel free to try the JSON visual editing support  using your own documents or any of the samples that are provided in Oxygen.
00:03:37 This concludes the  demonstration. As always, thank you for watching.

Use Oxygen Feedback to ask us anything about this video.