December 2012 - oXygen-sdk - www.oxygenxml.com

Setting a StylesFilter through the API
by Michael Anthony Smith 02 Jan '13

02 Jan '13

Hello, Is there a way of adding StylesFilter object to an arbitrary framework via the API, rather than having to manually configure it for each framework independently? If there is not a mechanism for adding StylesFilter object's already, possibly it could be added to the 'ExtensionBundle API class'; here the idea is that a third-party plugin/extension could add a StylesFilter to a 'styles filter chain' that is maintained by an extension bundle API. Alternatively, it might be appropriate to add this 'styles filter chain' idea to to one of the Editor[Page] API classes. The context for this query/request is included as a postscript to this email; this discusses how we have currently managed to get our StylesFilter to be used. If it were possible to add a StylesFilter to an arbitrary document through the 'WorkspacePlugin' API, I believe our 'merge conflict resolver' extension could be provided as an oXygen plugin (without the need for any user configuration of the oXygen preferences). Best regards, Anthony. PS: I am involved in a development of an oXygen extension/plugin that enables 'conflict resolving of merged documents'. Thanks to your previous help we are now able to highlight the 'merge updates/conflicts' between two processing instructions, enable them the available options to be selected, and the currently selected option to be edited. We still have to add some functionality such as 'the ability to accept currently selected content', but this should be straightforward (given what we have already got working). Currently we are using a mixture of oXygen's Author and Plugin SDK APIs, and a manual configuration of the 'document type association' in order to add our 'merge conflict' styling. The following screenshot shows how we are manually updating the DITA 'document type' to add this styling. -- -- ------------------------------------------------------------------------- Michael Anthony Smith, DeltaXML Ltd "Michael Anthony Smith, DeltaXML Ltd "Experts in Information Change"" T: +44 1684 869035 E: anthony.smith(a)deltaxml.com http://www.deltaxml.com Registered in England 02528681 Reg. Office: Monsell House, WR8 0QN, UK

2 1

Request to enable 'form based editing' from processing instructions
by Michael Anthony Smith 20 Dec '12

20 Dec '12

Hello, We would like to request an enhancement to the way in which 'form based editing' aspect of the css-styliong works. We are working on a merge conflict resolver using processing instructions so that validity can be checked during editing. Here is an example fragment of DITA: <p class="- topic/p ">allow intelligent resolution of conflicts in a <?dxml-merge-start text group="d2e150" mergeType="modify" ?> <dxml-merge-marker:marker xmlns:dxml-merge-marker="http://www.deltaxml.com/ns/dxml-merge-marker" /> <?dxml-merge text group="d2e150" chosen="true" deltaV2="base"?> Content Managment <?dxml-merge text group="d2e150" chosen="false" deltaV2="anna=ben=chris" <Content Management?> <?dxml-merge text group="d2e150" chosen="false" deltaV2="david" <Document Management?> <?dxml-merge-end text group="d2e150"?> System … </p> We have implemented a way of choosing between the three alternative options in Java, see below. When the user clicks on the conflict symbol the three alternatives are displayed. At the moment we believe that we need to use an element to enable the 'form based editing' control to be displayed. We have tried using elements like <ph />, which work in the above example, but do not work in all DITA contexts. In a StylesFilter if we are processing an element then it is possible to attach a 'form based editor' using the following code. props.put(InplaceEditorCSSConstants.PROPERTY_EDIT, "."); props.put(InplaceEditorCSSConstants.PROPERTY_RENDERER_CLASS_NAME, MergeAttributeChooserRenderer.class.getCanonicalName()); props.put(InplaceEditorCSSConstants.PROPERTY_SWING_EDITOR_CLASS_NAME, MergeAttributeChooserEditor.class.getCanonicalName()); This works for an element, but not a processing instruction. The AuthorInplaceContext elements allows us to get at the element that the style was attached to, as follows: AuthorNode authorNode= authorInplaceContext.getElem(); However, it would be nicer if we could get the nodes (specifically the processing instruction nodes). If this was possible, we would not need to introduce the dummy element in the above example, which introduces DITA validation errors. Best Regards, Anthony. -- -- ------------------------------------------------------------------------- Michael Anthony Smith, DeltaXML Ltd "Michael Anthony Smith, DeltaXML Ltd "Experts in Information Change"" T: +44 1684 869035 E: anthony.smith(a)deltaxml.com http://www.deltaxml.com Registered in England 02528681 Reg. Office: Monsell House, WR8 0QN, UK

2 1

Styling content between two processing instructions
by Michael Anthony Smith 20 Dec '12

20 Dec '12

Hello, In my last posting to this list, entitled "Request to enable 'form based editing' from processing instructions", we set out our use of processing instructions for merge conflict resolution. It would be nice if we could highlight the content between two of our processing instructions. So that the user could clearly see what 'content' was in consideration. It may be possible to do this using AuthorPersistentHighlight, but this appears to be linked with the <?oxy_custom_start?> and <?oxy_custom_end?> processing instructions. We could use these, but it would make our processing significantly more complicated (and our format less succinct). Previous discussion on this topic on the oxygen user mailing list, suggested that this was limitation of the AuthorPersistentHighlight approach (at least at that time). Is there anything that we have missed/new-developments that would allow highlighting content between arbitrary processing instructions. Best regards, Anthony. -- -- ------------------------------------------------------------------------- Michael Anthony Smith, DeltaXML Ltd "Michael Anthony Smith, DeltaXML Ltd "Experts in Information Change"" T: +44 1684 869035 E: anthony.smith(a)deltaxml.com http://www.deltaxml.com Registered in England 02528681 Reg. Office: Monsell House, WR8 0QN, UK

2 1