- oXygen-sdk - www.oxygenxml.com

oXygen 14.2 is here
by Radu Coravu 14 Feb '13

14 Feb '13

Hi everybody, I am happy to announce version 14.2 of oXygen XML Editor (and the corresponding Author Component Startup Project) is available from our website: http://www.oxygenxml.com A list of the new features can be found here: http://www.oxygenxml.com/index.html#new-version Here is the list of additional supported CSS extensions: http://www.oxygenxml.com/index.html#14.2Author_CSS_Extensions I consider the support for the @font-face CSS rule the most important one. It allows a developer for a certain document type/framework to distribute together with the CSS special true-type fonts which are dynamically loaded and used to render the XML in the Author mode. As usual we added lots of useful API: http://www.oxygenxml.com/index.html#14.2Extended_API I think that the major three API improvements are these ones: 1) Multiple Edit Modes (Text/Grid/Author) using the Author Component API This new API allows creation of Author Component editors having more than one editing mode. The Author Component Sample Project and online demos have been updated to create a component with Text and Author modes. 2) Using Workspace Access Plugins with the Author Component Added the possibility to use Workspace Access plugins with the Author Component. In this way, Workspace Access plugins which have already been created to work with the standalone editor (like the Acrolinx plugin) will work unchanged with the Author Component. 3) Identify the Context in Which a Browse CMS Operation is Invoked Every CMS integration plugin adds a special Browse CMS action using our API in all places where an URL can be chosen (dialogs for inserting images, references or content references). The new API added to the InputURLChooser interface allows the developer to know from which type of dialog the Browse CMS action gets called. Best Regards, Radu -- Radu Coravu <oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger http://www.oxygenxml.com

1 0

Add-on repository, and plugins in Scala
by Florent Georges 13 Feb '13

13 Feb '13

Hi, I've just tested using Scala for developing a plugin, and wrote a few lines as well on the new oXygen add-ons repository, and thought it might be interesting to some of you: http://fgeorges.blogspot.com/2013/02/oxygen-scala-and-plugin-repository.html Hope you enjoy. Regards, -- Florent Georges http://fgeorges.org/ http://h2oconsulting.be/

1 0

Question about making a custom InputURLChooser
by Jan Bevers 13 Feb '13

13 Feb '13

Hi I'm working on a custom InputURLChooser. When I click for example the insert image button I can see my custom url chooser in the list. But when I call the getResourceFilters() method I get back an empty array. >From this point of view my custom chooser doesn't know if it needs to filter for images/topics/... Is there any way to know where my custom chooser is called from (insert content reference, insert image, web link, cross reference...)? So I can make my chooser smart enough. Thanks in advance Jan Bevers | Developer | SDL | Content Management Technologies Division | +32 (0)15 400 970 | jbevers(a)sdl.com

2 1

Re: [oXygen-sdk] oXygen-sdk Digest, Vol 4, Issue 5
by Pascal Beutels 12 Feb '13

12 Feb '13

Hi, When Oxygen itself wants to retrieve the content of a certain resource, referenced in an XML file being opened (case 2.1/2.2/2.3 below), is there somewhere a reference to this 'parent' XML file we can access? Because we need some information (e.g. language) from that XML file. Regards, -Pascal ------------------------------ Message: 2 Date: Fri, 08 Feb 2013 15:36:53 +0200 From: Oxygen XML Editor Support <support(a)oxygenxml.com> Subject: Re: [oXygen-sdk] CMS integration: Resolving images To: oxygen-sdk(a)oxygenxml.com Message-ID: <5114FF75.9040804(a)oxygenxml.com> Content-Type: text/plain; charset=ISO-8859-1; format=flowed Hi Pascal, I will try to make a list of situation in which Oxygen requests the content for a certain URL (resource): 1) The user wants to open a topic in Oxygen (checked out and opened it or clicked on a link in an already opened topic). There is an useful callback in the WSEditorChangedListener: > WSEditorChangeListener().editorAboutToBeOpenedVeto(URL) which notifies you before Oxygen will request content for a certain URL in order to open it for editing. After this callback, Oxygen will call your custom protocol handler and request the content for that URL. 2) Oxygen itself wants to retrieve the content of a certain resource for an indirect reason: 2.1) Reference to an image. When the opened XML has a reference to an image, Oxygen will create an URL for the image reference and will ask your custom protocol handler for content. 2.2) Content reference, kind the same as for image, Oxygen will need to parse the target topic and retrieve content from the target element in order to show it in-place in the Author mode. 2.3) In Oxygen 14.2 xref's which point to topics will also display the title of the referenced topic in-place (somehow like a conref). So Oxygen will also request the content of the referenced topic in order to retrieve the target title text. Hope this helps. Regards, Radu Radu Coravu <oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger http://www.oxygenxml.com On 2/8/2013 3:06 PM, Pascal Beutels wrote: > Hi, > > In our custom protocol handler, how can we know that oXygen is > requesting for a referenced resource and not the DITA document (topic, ...) itself? > > Kind regards, > > -Pascal > > ------------------------------ > > Message: 2 > Date: Mon, 4 Feb 2013 08:25:33 -0000 > From: "Pascal Beutels" <pbeutels(a)sdl.com> > Subject: [oXygen-sdk] CMS integration: Resolving images > To: <oxygen-sdk(a)oxygenxml.com> > Message-ID: > > <D7B7EA2108156F42BEC04DEF9C75D66301303CDC(a)emeamail0304.global.sdl.corp > > > > Content-Type: text/plain; charset="us-ascii" > > Hi, > > > > We are creating a plugin for oXygen (14.1) for our DITA based repository. > > > > All the content is stored in our repository, also the images, .... > > When e.g. a topic contains an image element, it only contains the > unique > identifier: <image href="GUID-1BA7EFB7-FE54-4643-8AEA-6A2E6A92BD85" > placement="break"> > > > > What would be the best way to resolve this. Are there hooks foreseen > in oXygen we can use? Does oXygen require that this image is on the > file system (in other words does it expect a file path)? > > > > The same for internal links and conrefs. > > > > > > Kind regards, > > > > Pascal Beutels > > > > -------------- next part -------------- An HTML attachment was > scrubbed... > URL: > http://www.oxygenxml.com/pipermail/oxygen-sdk/attachments/20130204/8ce > e91de/a > ttachment-0001.html > > ------------------------------ > > Message: 3 > Date: Mon, 04 Feb 2013 11:11:10 +0200 > From: Oxygen XML Editor Support <support(a)oxygenxml.com> > Subject: Re: [oXygen-sdk] CMS integration: Resolving images > To: oxygen-sdk(a)oxygenxml.com > Message-ID: <510F7B2E.7000306(a)oxygenxml.com> > Content-Type: text/plain; charset=windows-1252; format=flowed > > Hi Pascal, > > Right now how exactly are you opening the XML files from the CMS? Did > you create a custom protocol or are you relying on WebDav? > > Oxygen works inside using Java URLs. > Usually references (to images, to links, conrefs) are converted to > URLs by using the URL of the current opened resource (topic). Then > Oxygen requests the content for these URLs to the URL protocol handler. > > Most (probably all known) CMS vendors who integrated with Oxygen took > this > approach: > >> http://www.oxygenxml.com/doc/ug-oxygen/index.html#tasks/howto-cms-plu >> g >> in.html > > Basically you use a plugin extension to define a custom URL protocol like: > > "sdl://...." > > Then you a Browse or "Check out" button on the application's toolbar > using a Workspace Access plugin extension. > The browse button will show the user your custom CMS browser and the > user will choose a resource. Then you call our API > (ro.sync.exml.workspace.api.Workspace.open(URL)) to open the resource > using your custom protocol, something like: > > "sdl://path/to/resource.dita" > > Oxygen will request content for that resource from your custom > protocol handler and your code will contact the CMS to obtain it. When > Oxygen will find relative resources (like the image > "GUID-1BA7EFB7-FE54-4643-8AEA-6A2E6A92BD85") it will consider them > relative to the opened XML file, will create for them an URL like: > > "sdl://path/to/GUID-1BA7EFB7-FE54-4643-8AEA-6A2E6A92BD85" > > and will call again your protocol handler to obtain the content for it. > > Your custom protocol handler also gets called to produce an output > stream if Oxygen wants to save the content of the edited resource. > > In dialogs in which the user needs to browse again the CMS to look for > a certain resource (like Insert Image, Insert Conref, Insert Cross > Reference) we have API which allows you to add a custom action for > browsing the CMS: > >> ro.sync.exml.workspace.api.standalone.ReferencesCustomizer.addInputUR >> L >> ChooserCustomizer(InputURLChooserCustomizer) > > This API is used in the sample Java class > "CustomWorkspaceAccessPluginExtension" present in our Plugins SDK as a > sample of Workspace Access plugin. > > Regards, > Radu > > Radu Coravu > <oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger > http://www.oxygenxml.com > > On 2/4/2013 10:25 AM, Pascal Beutels wrote: >> Hi, >> >> We are creating a plugin for oXygen (14.1) for our DITA based repository. >> >> All the content is stored in our repository, also the images, ?. >> >> When e.g. a topic contains an image element, it only contains the >> unique >> identifier: <image href="GUID-1BA7EFB7-FE54-4643-8AEA-6A2E6A92BD85" >> placement="break"> >> >> What would be the best way to resolve this. Are there hooks foreseen >> in oXygen we can use? Does oXygen require that this image is on the >> file system (in other words does it expect a file path)? >> >> The same for internal links and conrefs. >> >> Kind regards, >> >> Pascal Beutels >> >> >> >> _______________________________________________ >> oXygen-sdk mailing list >> oXygen-sdk(a)oxygenxml.com >> http://www.oxygenxml.com/mailman/listinfo/oxygen-sdk >> > > > ------------------------------ > > _______________________________________________ > oXygen-sdk mailing list > oXygen-sdk(a)oxygenxml.com > http://www.oxygenxml.com/mailman/listinfo/oxygen-sdk > > > End of oXygen-sdk Digest, Vol 4, Issue 2 > **************************************** > > > ------------------------------ > > Message: 2 > Date: Thu, 07 Feb 2013 13:48:01 +0200 > From: Oxygen XML Editor Support <support(a)oxygenxml.com> > Subject: Re: [oXygen-sdk] Overwriting or Extending the DITA framework > To: oxygen-sdk(a)oxygenxml.com > Message-ID: <51139471.2000809(a)oxygenxml.com> > Content-Type: text/plain; charset=ISO-8859-1; format=flowed > > Hi Pascal, > > I understand, then that MSI will probably install Oxygen standalone > (XML Editor, Author or Developer) + your plugins + maybe a modified > version of the DITA framework which will work with your modified DTDs. > > So when the user checks out a resource, it will actually be brought > down from the server to the local disk, right? > Even so, a resource has references to images or links to other > resources which are still on the CMS. > > So having a custom protocol (which either resolves the resource on > disk or downloads it from the CMS if not present on the local disk) > makes sense. The initial opened XML (which was already checked out) is > loaded using the custom protocol (but from the local disk). When > additional calls are made to your custom protocol handler to load > relative referenced resources which are not yet on disk (maybe a > referenced image or the user clicked a link in the topic to open the > target topic) you download from the CMS the topic and bring it locally. > > Regards, > Radu > > Radu Coravu > <oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger > http://www.oxygenxml.com > > On 2/7/2013 10:37 AM, Pascal Beutels wrote: >> Hi, >> >> Our final intent is to deliver an MSI that customers of our DITA >> repository can install so they can use oXygen xml editor to check >> ou/check > in/View/... >> documents from our repository. >> The documents are always downloaded to a (configurable) location on >> the local hard disk, so no WebDAV support. >> >> >> -Pascal >> >> -----Original Message----- >> From: oxygen-sdk-bounces(a)oxygenxml.com >> [mailto:oxygen-sdk-bounces@oxygenxml.com] On Behalf Of >> oxygen-sdk-request(a)oxygenxml.com >> Sent: maandag 4 februari 2013 19:00 >> To: oxygen-sdk(a)oxygenxml.com >> Subject: oXygen-sdk Digest, Vol 4, Issue 2 >> >> Send oXygen-sdk mailing list submissions to >> oxygen-sdk(a)oxygenxml.com >> >> To subscribe or unsubscribe via the World Wide Web, visit >> http://www.oxygenxml.com/mailman/listinfo/oxygen-sdk >> or, via email, send a message with subject or body 'help' to >> oxygen-sdk-request(a)oxygenxml.com >> >> You can reach the person managing the list at >> oxygen-sdk-owner(a)oxygenxml.com >> >> When replying, please edit your Subject line so it is more specific >> than > "Re: >> Contents of oXygen-sdk digest..." >> >> >> Today's Topics: >> >> 1. Re: Overwriting or Extending the DITA framework >> (Oxygen XML Editor Support) >> 2. CMS integration: Resolving images (Pascal Beutels) >> 3. Re: CMS integration: Resolving images (Oxygen XML Editor >> Support) >> >> >> --------------------------------------------------------------------- >> - >> >> Message: 1 >> Date: Mon, 04 Feb 2013 09:29:05 +0200 >> From: Oxygen XML Editor Support <support(a)oxygenxml.com> >> Subject: Re: [oXygen-sdk] Overwriting or Extending the DITA framework >> To: oxygen-sdk(a)oxygenxml.com >> Message-ID: <510F6341.2040003(a)oxygenxml.com> >> Content-Type: text/plain; charset=windows-1252; format=flowed >> >> Hi Pascal, >> >> What is your final intent? >> Do you want to distribute a plugin which can be installed into any >> Oxygen installation to allow validation and editing support for your >> slightly modified DITA content? >> >> We have some API like: >> >>> ro.sync.exml.workspace.api.util.XMLUtilAccess.addPriorityEntityResol >>> v >>> e >>> r(EntityResolver) >> >> which would allow you to return your own DTD content when certain >> DITA public IDs are resolved. This would work for validating and >> providing content completion for your type of documents. But the API >> does not allow you to see for which XML content the entity resolver >> was called because the catalog resolver is called from many parts of the editor. >> >> Usually this kind of customization is done by distributing a custom >> framework (which can be a copy of our DITA framework with some things >> changed). A custom framework can also be distributed like an addon >> together with the plugin. >> >>> These customizations also require special rendering in the Author >>> view, so >> we also need to extend the standard DITA css files. >> >> We do not (yet) have Java API which would allow you to add an >> additional CSS content for rendering a certain opened XML document. >> In Oxygen 14.2 (in a couple of weeks) we will add a special type of >> plugin extension which will allow you to add a StylesFilter >> (ro.sync.ecss.extensions.api.StylesFilter) >> >>> We can make the distinction between standard DITA and DITA files >>> coming from our repository, so we would like to do this without >>> changing the default behavior of DITA files not coming from our >>> repository >> >> You could create your own framework (document type) starting by >> copying our DITA document type. >> In the Preferences->"Document Type Association" page your document >> type would be placed before the usual DITA one (a document type has a >> priority field which can be increased). And your document type would >> have an association rule which would match only your type of XML >> documents (you can implement an interface >> "ro.sync.ecss.extensions.api.DocumentTypeCustomRuleMatcher" to create >> a > custom rule matcher). >> If you have a custom DITA document type, you can change the CSS and >> catalogs in it to suit your situation. >> >> Regards, >> Radu >> >> Radu Coravu >> <oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger >> http://www.oxygenxml.com >> >> On 2/1/2013 5:16 PM, Pascal Beutels wrote: >>> Hi, >>> >>> We are creating a plugin for oXygen (14.1) for our DITA based repository. >>> >>> We have some customizations (not specializations) on the DITA DTD?s, >>> but our DITA files contain the standard DITA public id?s. >>> >>> Is there a way to extend the oXygen DITA framework, so we can ?inject? >>> our catalog instead of the default DITA catalog? >>> >>> These customizations also require special rendering in the Author >>> view, so we also need to extend the standard DITA css files. >>> >>> We can make the distinction between standard DITA and DITA files >>> coming from our repository, so we would like to do this without >>> changing the default behavior of DITA files not coming from our >>> repository >>> >>> Kind regards, >>> >>> Pascal >>> >>> >>> >>> _______________________________________________ >>> oXygen-sdk mailing list >>> oXygen-sdk(a)oxygenxml.com >>> http://www.oxygenxml.com/mailman/listinfo/oxygen-sdk >>> >> >> >> ------------------------------ >> >> Message: 2 >> Date: Mon, 4 Feb 2013 08:25:33 -0000 >> From: "Pascal Beutels" <pbeutels(a)sdl.com> >> Subject: [oXygen-sdk] CMS integration: Resolving images >> To: <oxygen-sdk(a)oxygenxml.com> >> Message-ID: >> >> <D7B7EA2108156F42BEC04DEF9C75D66301303CDC(a)emeamail0304.global.sdl.cor >> p >>> >> >> Content-Type: text/plain; charset="us-ascii" >> >> Hi, >> >> >> >> We are creating a plugin for oXygen (14.1) for our DITA based repository. >> >> >> >> All the content is stored in our repository, also the images, .... >> >> When e.g. a topic contains an image element, it only contains the >> unique >> identifier: <image href="GUID-1BA7EFB7-FE54-4643-8AEA-6A2E6A92BD85" >> placement="break"> >> >> >> >> What would be the best way to resolve this. Are there hooks foreseen >> in oXygen we can use? Does oXygen require that this image is on the >> file system (in other words does it expect a file path)? >> >> >> >> The same for internal links and conrefs. >> >> >> >> >> >> Kind regards, >> >> >> >> Pascal Beutels >> >> >> >> -------------- next part -------------- An HTML attachment was >> scrubbed... >> URL: >> http://www.oxygenxml.com/pipermail/oxygen-sdk/attachments/20130204/8c >> e >> e91de/a >> ttachment-0001.html >> >> ------------------------------ >> >> Message: 3 >> Date: Mon, 04 Feb 2013 11:11:10 +0200 >> From: Oxygen XML Editor Support <support(a)oxygenxml.com> >> Subject: Re: [oXygen-sdk] CMS integration: Resolving images >> To: oxygen-sdk(a)oxygenxml.com >> Message-ID: <510F7B2E.7000306(a)oxygenxml.com> >> Content-Type: text/plain; charset=windows-1252; format=flowed >> >> Hi Pascal, >> >> Right now how exactly are you opening the XML files from the CMS? Did >> you create a custom protocol or are you relying on WebDav? >> >> Oxygen works inside using Java URLs. >> Usually references (to images, to links, conrefs) are converted to >> URLs by using the URL of the current opened resource (topic). Then >> Oxygen requests the content for these URLs to the URL protocol handler. >> >> Most (probably all known) CMS vendors who integrated with Oxygen took >> this >> approach: >> >>> http://www.oxygenxml.com/doc/ug-oxygen/index.html#tasks/howto-cms-pl >>> u >>> g >>> in.html >> >> Basically you use a plugin extension to define a custom URL protocol like: >> >> "sdl://...." >> >> Then you a Browse or "Check out" button on the application's toolbar >> using a Workspace Access plugin extension. >> The browse button will show the user your custom CMS browser and the >> user will choose a resource. Then you call our API >> (ro.sync.exml.workspace.api.Workspace.open(URL)) to open the resource >> using your custom protocol, something like: >> >> "sdl://path/to/resource.dita" >> >> Oxygen will request content for that resource from your custom >> protocol handler and your code will contact the CMS to obtain it. >> When Oxygen will find relative resources (like the image >> "GUID-1BA7EFB7-FE54-4643-8AEA-6A2E6A92BD85") it will consider them >> relative to the opened XML file, will create for them an URL like: >> >> "sdl://path/to/GUID-1BA7EFB7-FE54-4643-8AEA-6A2E6A92BD85" >> >> and will call again your protocol handler to obtain the content for it. >> >> Your custom protocol handler also gets called to produce an output >> stream if Oxygen wants to save the content of the edited resource. >> >> In dialogs in which the user needs to browse again the CMS to look >> for a certain resource (like Insert Image, Insert Conref, Insert >> Cross >> Reference) we have API which allows you to add a custom action for >> browsing the CMS: >> >>> ro.sync.exml.workspace.api.standalone.ReferencesCustomizer.addInputU >>> R >>> L >>> ChooserCustomizer(InputURLChooserCustomizer) >> >> This API is used in the sample Java class >> "CustomWorkspaceAccessPluginExtension" present in our Plugins SDK as >> a sample of Workspace Access plugin. >> >> Regards, >> Radu >> >> Radu Coravu >> <oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger >> http://www.oxygenxml.com >> >> On 2/4/2013 10:25 AM, Pascal Beutels wrote: >>> Hi, >>> >>> We are creating a plugin for oXygen (14.1) for our DITA based repository. >>> >>> All the content is stored in our repository, also the images, ?. >>> >>> When e.g. a topic contains an image element, it only contains the >>> unique >>> identifier: <image href="GUID-1BA7EFB7-FE54-4643-8AEA-6A2E6A92BD85" >>> placement="break"> >>> >>> What would be the best way to resolve this. Are there hooks foreseen >>> in oXygen we can use? Does oXygen require that this image is on the >>> file system (in other words does it expect a file path)? >>> >>> The same for internal links and conrefs. >>> >>> Kind regards, >>> >>> Pascal Beutels >>> >>> >>> >>> _______________________________________________ >>> oXygen-sdk mailing list >>> oXygen-sdk(a)oxygenxml.com >>> http://www.oxygenxml.com/mailman/listinfo/oxygen-sdk >>> >> >> >> ------------------------------ >> >> _______________________________________________ >> oXygen-sdk mailing list >> oXygen-sdk(a)oxygenxml.com >> http://www.oxygenxml.com/mailman/listinfo/oxygen-sdk >> >> >> End of oXygen-sdk Digest, Vol 4, Issue 2 >> **************************************** >> _______________________________________________ >> oXygen-sdk mailing list >> oXygen-sdk(a)oxygenxml.com >> http://www.oxygenxml.com/mailman/listinfo/oxygen-sdk >> > > > ------------------------------ > > _______________________________________________ > oXygen-sdk mailing list > oXygen-sdk(a)oxygenxml.com > http://www.oxygenxml.com/mailman/listinfo/oxygen-sdk > > > End of oXygen-sdk Digest, Vol 4, Issue 3 > **************************************** > _______________________________________________ > oXygen-sdk mailing list > oXygen-sdk(a)oxygenxml.com > http://www.oxygenxml.com/mailman/listinfo/oxygen-sdk > ------------------------------ _______________________________________________ oXygen-sdk mailing list oXygen-sdk(a)oxygenxml.com http://www.oxygenxml.com/mailman/listinfo/oxygen-sdk End of oXygen-sdk Digest, Vol 4, Issue 5 ****************************************

2 1

Re: [oXygen-sdk] CMS integration: Resolving images
by Pascal Beutels 08 Feb '13

08 Feb '13

Then we probably need a RelativeReferenceResolver for our protocol when inserting e.g. images? ------------------------------ Message: 2 Date: Mon, 4 Feb 2013 08:25:33 -0000 From: "Pascal Beutels" <pbeutels(a)sdl.com> Subject: [oXygen-sdk] CMS integration: Resolving images To: <oxygen-sdk(a)oxygenxml.com> Message-ID: <D7B7EA2108156F42BEC04DEF9C75D66301303CDC(a)emeamail0304.global.sdl.corp> Content-Type: text/plain; charset="us-ascii" Hi, We are creating a plugin for oXygen (14.1) for our DITA based repository. All the content is stored in our repository, also the images, .... When e.g. a topic contains an image element, it only contains the unique identifier: <image href="GUID-1BA7EFB7-FE54-4643-8AEA-6A2E6A92BD85" placement="break"> What would be the best way to resolve this. Are there hooks foreseen in oXygen we can use? Does oXygen require that this image is on the file system (in other words does it expect a file path)? The same for internal links and conrefs. Kind regards, Pascal Beutels

2 3

Re: [oXygen-sdk] Overwriting or Extending the DITA framework
by Pascal Beutels 07 Feb '13

07 Feb '13

Hi, Our final intent is to deliver an MSI that customers of our DITA repository can install so they can use oXygen xml editor to check ou/check in/View/... documents from our repository. The documents are always downloaded to a (configurable) location on the local hard disk, so no WebDAV support. -Pascal -----Original Message----- From: oxygen-sdk-bounces(a)oxygenxml.com [mailto:oxygen-sdk-bounces@oxygenxml.com] On Behalf Of oxygen-sdk-request(a)oxygenxml.com Sent: maandag 4 februari 2013 19:00 To: oxygen-sdk(a)oxygenxml.com Subject: oXygen-sdk Digest, Vol 4, Issue 2 Send oXygen-sdk mailing list submissions to oxygen-sdk(a)oxygenxml.com To subscribe or unsubscribe via the World Wide Web, visit http://www.oxygenxml.com/mailman/listinfo/oxygen-sdk or, via email, send a message with subject or body 'help' to oxygen-sdk-request(a)oxygenxml.com You can reach the person managing the list at oxygen-sdk-owner(a)oxygenxml.com When replying, please edit your Subject line so it is more specific than "Re: Contents of oXygen-sdk digest..." Today's Topics: 1. Re: Overwriting or Extending the DITA framework (Oxygen XML Editor Support) 2. CMS integration: Resolving images (Pascal Beutels) 3. Re: CMS integration: Resolving images (Oxygen XML Editor Support) ---------------------------------------------------------------------- Message: 1 Date: Mon, 04 Feb 2013 09:29:05 +0200 From: Oxygen XML Editor Support <support(a)oxygenxml.com> Subject: Re: [oXygen-sdk] Overwriting or Extending the DITA framework To: oxygen-sdk(a)oxygenxml.com Message-ID: <510F6341.2040003(a)oxygenxml.com> Content-Type: text/plain; charset=windows-1252; format=flowed Hi Pascal, What is your final intent? Do you want to distribute a plugin which can be installed into any Oxygen installation to allow validation and editing support for your slightly modified DITA content? We have some API like: > ro.sync.exml.workspace.api.util.XMLUtilAccess.addPriorityEntityResolve > r(EntityResolver) which would allow you to return your own DTD content when certain DITA public IDs are resolved. This would work for validating and providing content completion for your type of documents. But the API does not allow you to see for which XML content the entity resolver was called because the catalog resolver is called from many parts of the editor. Usually this kind of customization is done by distributing a custom framework (which can be a copy of our DITA framework with some things changed). A custom framework can also be distributed like an addon together with the plugin. > These customizations also require special rendering in the Author view, so we also need to extend the standard DITA css files. We do not (yet) have Java API which would allow you to add an additional CSS content for rendering a certain opened XML document. In Oxygen 14.2 (in a couple of weeks) we will add a special type of plugin extension which will allow you to add a StylesFilter (ro.sync.ecss.extensions.api.StylesFilter) > We can make the distinction between standard DITA and DITA files > coming from our repository, so we would like to do this without > changing the default behavior of DITA files not coming from our > repository You could create your own framework (document type) starting by copying our DITA document type. In the Preferences->"Document Type Association" page your document type would be placed before the usual DITA one (a document type has a priority field which can be increased). And your document type would have an association rule which would match only your type of XML documents (you can implement an interface "ro.sync.ecss.extensions.api.DocumentTypeCustomRuleMatcher" to create a custom rule matcher). If you have a custom DITA document type, you can change the CSS and catalogs in it to suit your situation. Regards, Radu Radu Coravu <oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger http://www.oxygenxml.com On 2/1/2013 5:16 PM, Pascal Beutels wrote: > Hi, > > We are creating a plugin for oXygen (14.1) for our DITA based repository. > > We have some customizations (not specializations) on the DITA DTD?s, > but our DITA files contain the standard DITA public id?s. > > Is there a way to extend the oXygen DITA framework, so we can ?inject? > our catalog instead of the default DITA catalog? > > These customizations also require special rendering in the Author > view, so we also need to extend the standard DITA css files. > > We can make the distinction between standard DITA and DITA files > coming from our repository, so we would like to do this without > changing the default behavior of DITA files not coming from our > repository > > Kind regards, > > Pascal > > > > _______________________________________________ > oXygen-sdk mailing list > oXygen-sdk(a)oxygenxml.com > http://www.oxygenxml.com/mailman/listinfo/oxygen-sdk > ------------------------------ Message: 2 Date: Mon, 4 Feb 2013 08:25:33 -0000 From: "Pascal Beutels" <pbeutels(a)sdl.com> Subject: [oXygen-sdk] CMS integration: Resolving images To: <oxygen-sdk(a)oxygenxml.com> Message-ID: <D7B7EA2108156F42BEC04DEF9C75D66301303CDC(a)emeamail0304.global.sdl.corp> Content-Type: text/plain; charset="us-ascii" Hi, We are creating a plugin for oXygen (14.1) for our DITA based repository. All the content is stored in our repository, also the images, .... When e.g. a topic contains an image element, it only contains the unique identifier: <image href="GUID-1BA7EFB7-FE54-4643-8AEA-6A2E6A92BD85" placement="break"> What would be the best way to resolve this. Are there hooks foreseen in oXygen we can use? Does oXygen require that this image is on the file system (in other words does it expect a file path)? The same for internal links and conrefs. Kind regards, Pascal Beutels

2 1

CMS integration: Resolving images
by Pascal Beutels 04 Feb '13

04 Feb '13

Hi, We are creating a plugin for oXygen (14.1) for our DITA based repository. All the content is stored in our repository, also the images, .... When e.g. a topic contains an image element, it only contains the unique identifier: <image href="GUID-1BA7EFB7-FE54-4643-8AEA-6A2E6A92BD85" placement="break"> What would be the best way to resolve this. Are there hooks foreseen in oXygen we can use? Does oXygen require that this image is on the file system (in other words does it expect a file path)? The same for internal links and conrefs. Kind regards, Pascal Beutels

2 1

Overwriting or Extending the DITA framework
by Pascal Beutels 04 Feb '13

04 Feb '13

Hi, We are creating a plugin for oXygen (14.1) for our DITA based repository. We have some customizations (not specializations) on the DITA DTD's, but our DITA files contain the standard DITA public id's. Is there a way to extend the oXygen DITA framework, so we can 'inject' our catalog instead of the default DITA catalog? These customizations also require special rendering in the Author view, so we also need to extend the standard DITA css files. We can make the distinction between standard DITA and DITA files coming from our repository, so we would like to do this without changing the default behavior of DITA files not coming from our repository Kind regards, Pascal

2 1

Installation location of oXygen on Windows.
by Pascal Beutels 30 Jan '13

30 Jan '13

Hi, We are creating a plugin for oXygen (14.1, 32-bit, windows only for the moment) and want to install that plugin (and all the related files) in the plugins folder. In order to find the installation location of oXygen we found the following key: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\8531-1 278-6363-8538\InstallLocation Can we rely on this particular key? Does it change with a new version (minor, major) of oXygen? Kind regards, Pascal

2 1

User-configurable options for a plugin extension
by Koeser, Rebecca Sutton 18 Jan '13

18 Jan '13

I'm working on a plugin extension for standalone Oxygen that will have some user-configurable settings, and I was wondering if there is any standard way to handle that type of thing. In particular, it would be neat if there was a way for a plugin to define options to be listed in the global Preferences. My current plan is to build a simple dialog box that with the needed input fields and store the user's input in the workspace option storage, but I wanted to check before I implement it in case there is a better option available. I'd appreciate any suggestions or input. Thanks. ________________________________ This e-mail message (including any attachments) is for the sole use of the intended recipient(s) and may contain confidential and privileged information. If the reader of this message is not the intended recipient, you are hereby notified that any dissemination, distribution or copying of this message (including any attachments) is strictly prohibited. If you have received this message in error, please contact the sender by reply e-mail message and destroy all copies of the original message (including attachments).

3 3