Developers topics
Some concepts and ideas are discussed in detail, to give developers insight into how to implement this product.
- About the API
The API allows integrators to customize the XML editor. - API Access
By means of a script file you can access the API. - How to add symbols
You can add your own custom list of symbols to the menu choice in the user interface. - How to hide content using XSL parameters
You can hide part of the content in large documents to speed up your editor - How to load another document without restarting
Use the API to load a new HTML page from your cms without restarting the editor each time. - How to load from a pseudo protocol
In order to make use of XML content identified by a relative URI you need to use a pseudo protocol. - How to lookup values
Looking up values from external sources or the database that you are working with can be done through the use of a lookup editor. - How to use configuration to ensure a child element will not be wrapped in a paragraph.
A specific implementation use case that uses attributes of thenodeconfiguration element. - How to prevent structure changes
You can ensure that users can only edit specific parts of the document without changing schema and by using the API. - How to use the custom panel
A description of what is possible and how to add custom panels. - How to use events
Using events from the API is a great way to get more control over the XML, and to assist users in an even better way. - How to use transactions
- How to use the API
Using the API to manipulate the XML can be a very nice way to do more with your XML. - How to use transactions
Transactions are extremely useful for allowing you to build up more complex XML structures without having to worry about validity at all steps. Validation is only done at the end of the transaction. - How to use subCanvasMode
- How to work with PRE elements to preserve spaces
- How to work with XIncludes
- Best Practices- XML
Considerations to ensure better structure and compatibility. - Best Practices- XSD (schema)
A well defined XSD (schema) is key in determining whether the editor works with your XML. - Best Practices- HTML
A description of the concepts to consider for HTML in this XML editor. - XSLT best practices
Using XSLT the right way can speed up your editor experience and make sure that you an find elements easily. - Language Support
A listing of the supported languages for the UI and spell checker. - Lookup dialog
A lookup dialog is a HTML page dialog that can be configured to open for a simpleType. - The use of XPath in configuration
You can specify the target element or Xpath for the configuration by using the match attribute when using <x:nodeConfig>. - Using the API to manipulate the XML
- Using the DITA configuration files
SDL provides a pre-built DITA configuration as a guideline that can be changed to suit your DITA usage. - Using DOM mutation events
- XML and DOM API objects
When you load an XML document in this editor, you can access the document through the API.