Home

The User Guide

image

Contents

1. Ww XML Tools gt Trang converter Converts the current document to a supported grammar language using the in tegrated Trang converter XML Tools gt Schema documentation A tool used to generate HTML documentation for an XML Schema document 31 Getting Started Y XML Tools gt WSDL SOAP Analyser Contains a SOAP analyser and sender for Web Services Description Language file types The Editor Pane The editor pane is where you edit your documents opened or created by the lt oXygen gt Eclipse plugin You know the document is associated with lt oXygen gt from the special icon displayed in the editor s title bar which has the same graphic pattern painted with different colors for different types of docu ments Table 3 4 Description of lt oXygen gt Editor Types The icon for XML documents The icon for XSL stylesheets The icon for XML Schema grammars The icon for Document Type Definition grammars The icon for RELAX NG full syntax grammars The icon for RELAX NG compact syntax grammars The icon for Namespace Routing Language grammars EEE EE 2 87 The icon for XQuery documents is m LE The icon for WSDL documents Figure 3 22 The Editor Pane 32 Getting Started MMUMX S i16 S AR t LB persanal dtd fea sonak 3 f personal xsd lz xml version 1 0 encoding UTF 2 SHOIDOLTYBPE personnel SYSTEM pberso al dtd gt 3 lt personne
2. oxygen LS DTD i Import From HTML Mew From Templates MRL Schema Relax M compact schema RNC Relax NG schema RNG Sample XML Project Stylesheet x5L boul Pid The available wizards are the following XML An XML wizard that creates sample XML document The Create an XML Document dialog enables definition of a XML Docu ment Prolog using the system identifier of a XML Schema DTD Relax NG full or compact syntax schema or NRL Namespace Routing Lan guage schema As not all XML documents are required to have a Prolog you may choose to skip this step by clicking OK If the prolog is required complete the fields as the following 22 Getting Started Figure 3 15 The Create an XML Document XML Schema Tab m Create new XML file Customize XML document v Use a DTD XML Schema Relax NG or NRL schema URL fle C projects eXml test ipo xsd e Document root purchaseOrder Namespace http www example com IPO Complete the dialog as follows Use a DTD XML Schema Relax When checked enables selection NG or NRL schema between DTD XML Schema Relax NG schema or NRL schema URL Specifies the location of an XML Schema Document XSD Document Root Populated from the elements defined in the specified XSD enables selec tion of the element to be used as document root Namespace Specifies the document namespace Figure 3 16 The Create an XML Document DTD T
3. The trace history catches all these events so you can see how the process evolved The red icon lines de note source nodes while the green icon lines denote stylesheet nodes Figure 5 9 The Trace History View Stack FE Trace Templates Node Set EXE XML XSLMode Attributes Resource document File C samples personal xml xslibemplate match File C samples personal xsl html File C samples personal xsl 2s element fname table File C samples personal xsl xs attribute name border File C samples personal xsl xslattribute mame baorder File Ci samples personal xsl tr File C samples personal xsl xsl message terminate no File C samples personal sl T 1 2 3 4 4 4 5 Table 5 6 Trace History details Column Description Depth Starts from O and represents the level of overlap ping for that node This is similar with the order number from stack at the moment the node was processed XML XSL Node Represents the node from the processed source or stylesheet document One particular node is the document root noted as document Every node has an arrow in front of it representing what action was performed on it entering or leaving Attributes Attributes of the node list of id value pairs Resource Resource file where the node is located Remarks 57 XSLT Debugger e Clicking a record highlights that node s location inside the
4. b PSas method c Built in Apache FOP as processor 6 Select the Output tab 7 In the Save As field enter the output file name relativ to the current directory YourFile Name ps or the path and output file name C FileDirectory YourFileName ps 8 Optionally uncheck the XHTML and XML check boxes in the Show As group 9 Click Transform Now The transformation is started TXT Output 1 Change directory to oxygen frameworks docbook xsl fo 2 Select docbook xs1 click Open The dialog closes 3 Select the FOP tab 4 Check the Perform FOP option The remaining options are enabled 5 Select the following options a XSLT result as input b TXT as method c Built in Apache FOP as processor 6 Select the Output tab 7 In the Save As field enter the output file name relativ to the current directory YourFile Name txt or the path and output file name C FileDirectory YourFileName txt 43 Transforming Documents 8 Optionally uncheck the XHTML and XML check boxes in the Show As group 9 Click Transform Now The transformation is started HTML Output 1 Change directory to oxygen frameworks docbook xsl html 2 Select docbook xs1 click Open The dialog closes 3 Select the FOP tab 4 Uncheck the Perform FOP option The FOP options are disabled 5 Select the Output tab 6 In the Save As field enter the output file name relativ to the current directory YourFile
5. DTD fle C samples personal dtd Change C XML Schema file C samplesipersonal xsd Change None XHTML transitional Formating objects Other XML Catalog The Tag Insight will offer only the XSL information Includes XHTML Transitional elements as substitutes for xsl element Includes Formating Objects elements as substitutes for xsl element Includes elements from a DTD file or a XML Schema file specified from a URL as substitutes for xsl element An XML catalog is a set of mappings between remote DTD and or XML Schema and or Relax NG files and local copies of these files When Internet access is not available or the connection is slow one or more XML catalogs can be added to the list in the dialog below and the local copies of the DTD and or XML Schema and or Relax NG files will be used during validation When you add delete an XML cata log to from the list of XML catalogs in the Options gt Preferences gt XML Catalog pane you must re start the application so that the changes take effect Figure 3 7 The XML Catalog pane 13 Getting Started XML Catalog Iv Use default catalog 3 plugins com axygenxml editor 5 0 frameworks catalng xml Prefer C system public XML Catalogs Changes in the catalogs list or the files refered by catalogs require restarting the application verbosity C debug C warn info C eror fatal Restore Defaults Apply If Use default catalog option is c
6. Syntax coloring for XML DTD Relax NG compact syntax Java C C PHP Perl etc Pretty printing of XML files Easy configuration for external FOPs Apply XSLT and FOP transformations XPath search and evaluation support Preview transformation results as XHTML or XML or in your browser Support for document templates to easily create and share documents Drag amp drop support XML project manager Tree view edit support for XML documents Batch validate selected files in project Configurable external tools Configurable actions key bindings Find and replace support allows regular expressions is All the usual editor capabilities cut copy paste find 1 Introduction XML aware handle multiple files replace windows management Associate extensions with lt oXygen gt on Windows Plugin support Mac OS X ready Print documents Import HTML documents Multidocument environment Model View Text transparency levels adjuster WSDL Support XQuery 1 0 support SVG Editor and Viewer XPath 2 0 support Debugger Backmapping support XSLT 2 0 full support About the lt oXygen gt Handbook This User Manual gives a complete overview of the lt oXygen gt XML Editor and describes the basic process of authoring management validation of structured mark up documents and their transformation to multiple target outputs Throughout this manual it is
7. oerte ME Tb pr err Rr ARRIERE ETE 7 Preferences ti 7 Global SIRVE SNR ENS SENE 7 Iu We 7 XML Catalog tecti es Erro epe eerie ipee tub Eme chee ee pte 13 XME Parser OptlOnS cies tede eee e ORE URS ase Siews sent a hao sees n eee de 14 XSLT Optlons ut E de teme e RI eed 15 Debut cer Semin es spase ptite oe teet reete obe P songs wae abe er Ten DP eoo Pe tubo Pr Operi eden 16 FO PrOCESSOLS ison asensi ae Eea a E O SA A EE E STE EERE EIE EE Re e ES ER i 17 Proxy Configuration 2 5 bete Ree e etae Pa e TEE 20 eun df iii 21 oXygen plugin wizards nre Rene ES EGR p T ooie e 21 The oXygen custom menu 2 20 0 eee cece cece cece eee em e Ie mH HII men he mee ee rene 28 PAIS nM 29 XME Tools Meni nes o esos O 30 The oXygen toolbar buttons csse He e mene 30 The Editor Pane ca fa gues Sey dace gy en ette detuvo i 32 Outhner Panel eR AU ee ER ee UL eU Ped 33 XML Document Overview i etos tero UR roe te thee eerte EEA IREE ARS RETR RS 34 Modification Follow up 2 0 0 0 cee cece cece cece cece cece mH HH Hem e mehreren 34 Document Tag Selection 5 ceteri mte ette reb e get rtorras tie 34 The oXygen 7 Text View sirsie re e EEs emplea bem impe dales 34 The oXygen XPath View 4e riter re Rente re ERI Ern Rees 35 4 Transforming Documents o decoro ocn tarea EE ETE cues sees EESE esie EEES 36 Transformation Scenar
8. 4 The Context node Vi West taa rifa dd 52 23 5 The XPath watch View as a NL e ia rs 53 5 6 The Breakpomlts View 2 dete reto pte et toe fe abs rei uge se pte plot tec Qee Feo gs Pp de oa 54 217 The Messages VIEW nest erian eia dda eget er ve ee EUR DER Eme Pee EE eee ESy SOR o Ye ns 55 3 6 The Stack a 56 3 9 The Trace History View eie eerte iple rene Ihe o desks aiii 57 5 10 The Templates View n pere eire Pope rociar EP Eyre E 58 S11 The Node Set VIEW esee reia drenar ici 59 3 12 The Variables view 2 petet tete EG DE E eto e Po eti bees 60 6 1 Tag ansight for WSDL odere peer teeoeepev d eoe popa peor extre te vod O Po ep vue o USERS 62 6 2 Vahdatmg a WSDE file i eee em et aia e RE tee pad 63 6 3 RIBIES EAT TP LEE 63 T XQuery Tag Insight e eere be Ud ee EP Ue bees 66 T2 X Query Vahdafion edicere tope eme teet tie bee est ea tigre ex Ore ee Sodio e ore pe esas 67 7 3 X Query Transformation eue em ee ep deed eu 67 vi List of Tables 3 1 XML Menu Options ce rh pet RP RD cha RE PREE ESIOS EERI soi SP ipe EIE 29 3 2 XML Tools Menu Options cece eee cece cece ee e em enm en He men me ehe hee Eee ke 30 3 3 Description of oXygen Toolbar Buttons eessse He 30 3 4 Description of oXygen Editor Types sess 32 541 Contextnode details eee er ede re duet rte Ug ee erre reete eat 53 25 2 X Watchidetalls O Ade TENE LE ER UE Eddie ede 54 23 Breakpo
9. 6 In the Save As field enter the output file name relativ to the current directory YourFile Name html or the path and output file name C FileDirectory YourFileName html a If your pictures are not located relative to the out location check the XHTML check box in the Show As group b Specify the path to the folder or URL where the pictures are located 7 Click Transform Now The transformation is started 45 Chapter 5 XSLT Debugger Overview The lt oXygen gt plugin adds two perspectives into Eclipse The first is the standard editing perspective that provides general features and functions for the development of XML documents and other program ming languages The second is the Debugger perspective The Debugger perspective is started by click ing the lt oXygen gt XSLT Debugger button located on the perspective toolbar or selecting the lt oXygen gt XSLT Debugger from Window gt Open Perspective gt Other To switch back to Editor per spective simply click the lt oXygen gt XML button that is adjacent to the lt oXygen gt XSLT Debugger button on the perspective toolbar or select lt oXygen gt XML from Window gt Open Perspective gt Other Users can toggle between Debugger and Editor modes as required by clicking either buttons This chapter explains the Debugger mode functionality which provides a rich set of features for devel opment testing and solving of XSL problems including Support for Saxon
10. Microsystems Users are advised that SyncRO Soft Ltd assumes no responsibility for er rors or omissions or for damages resulting from the use of lt oXygen gt and the aforesaid third party software Nor does SyncRO Soft Ltd assume any responsibility for licensing of the aforesaid software should the relevant vendors change their terms By us ing lt oXygen gt the user accepts responsibility to maintain any licenses required by SyncRO Soft Ltd or third party vendors Un less SyncRO Soft Ltd declares in writing that the lt oXygen gt license is inclusive of third party licensing Table of Contents T Introduction etre rias 1 A rd a T enews Eres Phe EPRRRERSS PERSE Pi Ed coe eR PR pug OEREIN 1 About the lt oXygen gt Handbook ressida eneee E nS AEE EES 2 2 Installation a Ree uu Deest prre SG D 3 Installation Requirements 2 oie ertet tette ore ET REP eee pe SEU Po P Ne PEE NSE 3 Platform Requirements n aoe N E N E emm eme He m enne hee eren 3 Operating System Tools and Environment Requirements esses 3 Installation Instructions ere esee eve eie eie e DD eed 4 Starting oXygen plugin conosco uicem perro Rite tr remet REPRE Pe eR REPAS 4 Obtaining and Installing an lt oXygen gt License see 4 Upgrading lt oX yeen gt iiss eerte te rH Eb REPRE Re ER ERES EET TER SEE SE EE AER UR Re pes 6 Uninstalling the oXygen plugin sssssese eme emere 6 3 Getting Started
11. RNG RNC DTD XSD using the Trang con verter e XML gt Associate schema Ctrl Shift S Displays the Templates dialog used to discover select and open a new document based on an existing tem plate document Template documents act as starting points that have pre defined properties such as file type prolog root element containers and even existing content e XML Apply transformation scenario Ctrl Shift T Apply to current document the scenario associated to it If no scenario is associated to the document the Configure transformation scenario action will be launched first e XML Configure transformation scenario Ctrl Shift C Open the scen ario configuration dialog containing all the scenarios that can be applied to the current document that is scenarios containing the URL of an XML doc ument if the current document is an XSL stylesheet or scenarios containing the URL of an XSL stylesheet for the rest of edited documents e XML Learn structure Ctrl Shift L Infer an internal DTD from the 29 Getting Started current document that can be used for content assistant when the document declares no DTD XML Schema or Relax NG schema XML Save structure Ctrl Shift S Save the learned document struc ture to an external dtd file e XML Format and indent Ctrl Shift F Apply format and indent ac cording to settings in Preferences gt lt oXygen gt gt Editor gt Format e XML XPath C
12. Viewer from Adobe http www adobe com products acrobat readstep html PostScript is the leading printing technology from Adobe http www adobe com 80 products postscript main html for high quality best in class printing solutions ranging from desktop devices to the most advanced digit al presses platemakers and large format image setters in the world Postscript files can be viewed using viewers such as GhostScript but are more commonly created as a prepress format Text files are Plain ASCII Text and can be opened in any text editor or word pro cessor XML stands for EXtensible Markup Language and is a W3C http www w3c org XML standard markup language much like HTML which was designed to describe data XML tags are not predefined in XML You must define your own tags XML uses a Document Type Definition DTD an XML Schema or a Relax NG schema to describe the data XML with a DTD XML Schema or Relax NG schema is designed to be self descriptive XML is not a re placement for HTML XML and HTML were designed with different goals e XML was designed to describe data and to focus on what data is HTML was designed to display data and to focus on how data looks HTML is about displaying information XML is about describing information XHTML stands for EXtensible HyperText Markup Language a W3C http www w3c org MarkUp standard XHTML is aimed to replace HTML While almost identical to HTML 4 01 XHTML is a stric
13. al iSereiv dd 1 ore Petite MeO dedpeef moneo Spleen sons A k l 7 cobshrert ra tr Ma JD zecipoe morkaz aca ample personal 6 bi A euo ds personis 6 e colette ura d aD eripee morkaz aca Serpe person f b nd wee T T Ed lt gt lt gt yaar Wrtaba rent Source document view XML Displays and allows editing of data or document oriented XML files documents Stylesheet document view XSL Displays and allows editing of XSL files stylesheets Output document view Displays the transformed output that results from the input of a selected document XML and selected stylesheet XSL to the transformer The result of transformation is dynamically written as the trans formation is processed Control view The control view provides functionality for configuration and control of debugging operations It also 47 XSLT Debugger provides a series of Information View types This pane is comprised of two parts e Control Toolbar Information View Control Toolbar The toolbar contains all actions needed in order to configure and control the debug process Items are described below from left to right as they appear in the toolbar Figure 5 2 Control Toolbar ELI 5 m m xsl template personal xsl Line 3 XML source selector XSL stylesheet select or XSLT engine selector To XSLT paramet Step into i Step over fh Step out iJ Ru
14. and Xalan XSLT engines Stepping capabilities step in step over step out run run to cursor run to end pause stop e Back mapping between every piece of output and style element source context who generate it e Breakpoints on both source and style documents e Call stack view on both source and style documents e Trace history on both source and style documents Support for XPath expression evaluation during debugging Step into imported included stylesheets as well as included source entities e Available templates and hits count e Variables view Dynamic output generation Layout An example of what the Debugger interface might look like is shown below This interface is comprised of four panes as follows 1 Source document view XML 2 Stylesheet document view XSL 3 Output View 4 Control view XML documents and XSL stylesheets that are opened in Editor perspective are automatically sorted into 46 XSLT Debugger the first two panes When multiple files of each type are opened the individual documents stylesheets are separated using the familiar tab management system of the Editor perspective Selecting a tab brings the document stylesheet into focus and enables editing without toggling back to the Editor perspective During debugging the current execution node is highlighted on both document XML and stylesheet XSL views Figure 5 1 Debugger Mode Interface ia o
15. assumed that you are proficient in the use of your operating system and the concepts related to structured mark up The lt oXygen gt XML Editor User Manual is comprised of the following parts e Chapter 1 Introduction Introduction you are reading it e Chapter 2 Installation Installation defines the platform and environment requirements of lt oXygen gt and instructions for application installation license installation starting lt oXygen gt up grade and uninstalling e Chapter 3 Getting Started Getting Started with the lt oXygen gt Interface provides general orienta tion explains concepts and defines functionality of the components that comprise the lt oXygen gt Graphic User Interface GUI e Chapter 4 Transforming Documents Transforming explains the considerations for transformation of structured sources to multiple target format and how to obtain maximum benefit Chapter 5 XSLT Debugger XSLT Debugger This chapter explains the Debugger modes function ality which provides a rich set of features for development testing and solving of XSL problems Chapter 6 WSDL Support WSDL Support This chapter explains the facilities offered by oXygen for WSDL support Chapter 7 XQuery Support XQuery Support This chapter explains the support offered by oXygen for editing validating and running XQuery expressions Feedback and input to the oXygen Handbook is welcom
16. is already in Debugger perspective and at least one document XML and one stylesheet XSL are already opened Some samples have been provided in order to get used with the XSLT debugging process They can be found in the samples debugger subdirectory of your oXygen installation When a debug process is running it is adviseable to stop the process before attempting to edit source documents or stylesheets Editing during an active debug process will result in inaccurate informations being displayed in the Information View During the debug process if the transformation engine reaches a node from a file that has not been opened this file will be opened into the corresponding pane and the node will be highlighted This is most likely to happen in the cases of XML entity files or XSL imported included files Errors encountered during debugging are reported on problems view At the end of debugging process only the content from the following views is preserved all other views are cleared e XPath watch view Messages view e Trace history view Templates view Procedure 5 1 Typical Debug Process 1 From Source document view XML select a source document 2 From Stylesheet document view XSL select a stylesheet document 3 From the Control Toolbar use the XML source selector control to select a source document 50 XSLT Debugger 4 From the Control Toolbar use the XSL stylesheet selector control to select a stylesh
17. list entry you should see the version number of the newest installed plugin If the previous version was 4 2 0 the list entry should now contain 5 0 0 Uninstalling the lt oXygen gt plugin Warning The following procedure will remove the lt oXygen gt plugin from your system It will not re move the Eclipse platform If you wish to uninstall Eclipse please see its uninstall instructions Procedure 2 4 Uninstall Procedure 1 Choose the menu option Help Software Update Manage Configuration and from the list of products select lt oXygen gt XML Editor and XSLT Debugger 2 From the right section of the displayed window choose Uninstall and accept the Eclipse restart after the uninstall procedure is complete Chapter 3 Getting Started This section provides an overview of the lt oXygen gt Graphic User Interface GUI It provides you with an explanation for each of the interface components and a short description of its purpose or usage The lt oXygen gt plugin GUI is integrated in the Eclipse platform by the following components The lt oXygen gt preferences e lt oXygen gt plugin wizards e The lt oXygen gt custom menu The lt oXygen gt toolbar buttons e The editor pane e The outline view The lt oXygen gt text view The oXygen XPath view Preferences Once oXygen is installed you may want to use the following preferences to customize oXygen for your requirements and
18. network environment Global Figure 3 1 The Global preferences I Check well Formedness on save Default Internet browser E Check well formedness on save If selected the lt oXygen gt plugin will perform a well formed check every time the user saves a document Default Internet browser The path to a web browser executable to be used to open XSLT or PDF transformation results Editor Getting Started Use these options to configure the visual aspect formatting parameters and behaviour of the content as sistant Aspect Figure 3 2 The Aspect pane Editor background Change Fonts Map to Text Font Customize Times New Roman 16 This 15 a text sample Line wrap Iv Highlight matching tag Change Fonts Use this option to select the font family and size used to display text in the editor Editor background color Use this option to set the background color of the editor Line Wrap This option will automatically wrap lines in edited documents Highlight matching tag This options enables highlight for the tag matching the one on which the caret is situated Format Figure 3 3 The Format pane Getting Started Indent Indent with tabs Indent size 4 Pretty print Format and indent the document on open Expand empty elements sort attributes Line width pretty print 100 Preserve space elements Strip space elements programlisting Remove Remove I
19. resource Only Saxon processor shows element attributes e Xalan processor shows the built in rules Templates view The xsl template is the basic element for stylesheets transformation This view shows all xsl template instructions used by the transformation By seeing the number of hits for each of the templates you get an idea of the stylesheet coverage by template rules with respect to the input source Figure 5 10 The Templates view Stack Trace His Templates _ Node Set Name Resource File C samples personal xsl t Built In Hperson texk a File Ci samples personal xsl Built In 1 n l 0 Built In n n Table 5 7 Templates details Column Description Match Match attribute of the xs1 template Hits Number of hits for the lt xsl template gt Shows how many times the XSLT processor used this particular template Priority Template priority as established by XSLT pro cessor Mode Mode attribute of the lt xsl template gt Name Name attribute of the lt xsl template gt Resource Resource file where template is located Remarks Clicking a record highlights that template definition inside resource e Saxon only shows the applied templates having at least one hit from the processor Xalan shows all defined templates with or without hits 58 XSLT Debugger e The template list is sorted descending on the number of hits Xalan shows th
20. EE TEES 51 Understanding Information Views sse Hee 52 6 WSDL Support nete rrr Speer e HD pre sabia eere ope rifa rra ir nicas 62 Web Services Description Language Overview sss 62 Editine WSDE files ert po Ee atte e rt idee p PO Dute brota a 62 Validatins WSDL TICS sss oct tete oett peret tette e Pte teo esee pe Sex avons ee So oy vett 62 Analysing and testing WSDL files sssssse He 63 JT X Query Suppott tri ironico deo OE wean sadeu e ETE eo das cta 66 XQuery OVerview 0 xv dade e UE ak eae See edes 66 Syntax Highlight and Content Completion esee 66 XQuery Valida oca A elie ye E UR MERE ER 67 Transforming XML Documents Using XQuery sse 67 List of Figures 2 1 Registration AAA rr e ret COR ERR IRR VR S EP ERE ERR ot 5 3 1 The Global preferences econ Enea te predi RR E Ri RR ve cds 7 32 The Aspect p he terri race o OE via ette pote E eite rte o yas potter 8 3 3 The Format pane miii ed creencia cerda 8 3 4 The Tag Insight Features pane ssessesese m II HII emen rere 10 3 5 The Tag Insight Default pane ee eere tette deni se oe e des he eb e A dass Aper a 12 3 6 The Tag Insight XSL paie sese io sie ates 13 3 7 Th XML Catalog pane asics sive rese eei ete retenta Ste Pr EP Sei pet Osee io epo Sedo io Pe te ori pb seas 13 3 8 The XML Parser Options panei soets oropesa cece cece cen e eH mH me mene mee rre E 15 3 9 The JAXP
21. L Menu Note Macintosh users should use the command key instead of the control key for all keyboard short cuts Table 3 1 XML Menu Options XML lt oXygen gt Window Help w Validate document Ctrl Shift v A Check document form crisshitaw XML Validate document Ctrl Shift V Validate the current edited RELAX NG validation Ctrl4Shift R document against its declared DTD or XML Schema EY NRL validation Ctrl Shift HN gt lt Clear validation markers crisshitex XML Check document form Ctrl Shift W Check that the current ed Convert with Trang Ctrl Shift ited document is well formed 3 Associate schema e XML RELAX NG validation Ctrl Shift R Select a RELAX NG Apply transformation scenario Ctrl Shift T A F Configure transformation scenario Ctrl4 Shift4C schema from the local filesystem and validate the current edited document against 1t a Learn structure Ctrl Shift L A Save d e XML gt NRL validation Ctrl Shift N Select a NRL schema from the local filesystem and validate the current edited document against it Hi XPath Ctrl Shift Add to templates Cti shift A e XML gt Clear validation markers Ctrl Shift K Clear the error markers 14 Check spelling Ctrl Shift Q added to the Problems view at the last validation of the current edited docu ment e XML Convert with Trang Ctrl Shift Convert the current edited doc ument to one of the formats
22. Name html or the path and output file name C FileDirectory YourFileName html a If your pictures are not located relative to the out location check the XHTML check box in the Show As group b Specify the path to the folder or URL where the pictures are located 7 Click Transform Now The transformation is started HTML Help Output 1 Change directory to oxygen frameworks docbook xsl htmlhelp 2 Select htmlhelp xs1 click Open The dialog closes 3 Set the XSLT parameter base dir it identifies the output directory If not specified the output dir ectory is system dependent 4 Select the FOP tab 5 Uncheck the Perform FOP option The FOP options are disabled 6 Click Transform Now The transformation is started JavaHelp Output 44 Transforming Documents 1 Change directory to oxygen frameworks docbook xsl javahelp 2 Select javahelp xs1 click Open The dialog closes 3 Set the XSLT parameter base dir it identifies the output directory If not specified the output dir ectory is system dependent 4 Select the FOP tab 5 Uncheck the Perform FOP option The FOP options are disabled 6 Click Transform Now The transformation is started XHTML Output 1 Change directory to oxygen frameworks docbook xsl xhtml 2 Select docbook xs1 click Open The dialog closes 3 Select the FOP tab 4 Uncheck the Perform FOP option The FOP options are disabled 5 Select the Output tab
23. X The lt oXygen gt User Guide SyncRO Soft Ltd Sean Wheller Ry The lt oXygen gt User Guide SyncRO Soft Ltd Sean Wheller Copyright O 2002 2004 SyncRO Soft Ltd All Rights Reserved Many of the designations used by manufacturers and sellers to distinguish their products are claimed as trademarks Where those designations appear in this book and SyncRO Soft Ltd was aware of a trademark claim the designations have been printed in caps or initial caps While every precaution has been taken in the preparation of this book the publisher assumes no responsibility for errors or omissions or for damages resulting from the use of the information contained herein Third party software components are distributed in the lt oXygen gt installation packages including the Java Runtime Environment JRE DocBook DTD and style sheets This product includes software developed by the Apache Software Foundation ht tp www apache org the Apache FOP Xerces XML Parser and Xalan XSLT These products are not the property of SyncRO Soft Ltd To the best knowledge of SyncRO Soft Ltd owners of the aforesaid products granted permission to copy distribute and or modify the software and its documents under the terms of the Apache Software License Version 1 1 Other packages are used under the GNU Lesser General Public License Users are advised that the JRE is provided as a free software but in accordance with the licensing requirements of Sun
24. XSLT Transformer option ne e a A ae eene hene herren 15 3 10 Debugger Settings secrete EEE ETES EEE NESK EEA REECE TE ERTER 16 3 11 The FO processors pane vsisi enter Rr oepa ei PENE rte re ERR EPEE ER oros 17 3 12 Configure the external processors HH eme ee eere 18 3 13 The Proxy Configuration Dialog 0c cece cence HH eere 20 3 14 The Colors pane ii etse p renrieli era pueri re gests rE EE eE 21 3 15 The Create an XML Document XML Schema Tab eee 23 3 16 The Create an XML Document DTD Tab sse 23 3 17 The Create an XML Document Relax NG Tab sese 24 3 18 The Create an XML Document NRL Tab see 25 3 19 Import HIMBE nn li Reo teer Reed 26 3 20 The Templates Dialog 1 2 metere eise ee eie quell eee dosel 27 3 21 The lt oXygen gt Toolbar Buttons ssoi rroi ai e HH ere 30 3 22 The Editor Pane OT 32 3 23 The Outliner Panel viii soree ie aireado sine 33 3 24 The lt oXyg n gt Text View dtr tete tte iii 34 3 25 The oXygen XPath View cotiecenieis emet tie tee ribera sce Pep eee eh ET ee erp enone 35 4 1 The Configure Transformation Dialog sesee Hm 38 4 2 Edit cascade stylesheets list dialog eses 40 5 1 Debugger Mode Interface violada eq ere Reps 47 2 2 Control Toolbar Rn corran ines soni ted E Ep EE E e ETE Epee 48 5 3 Output to Source Mappila s EE EE EEA E EE EEN EE NEET EES 51 5
25. Xygee XSLT Debugger parznnal xzl felipe Platfann Die Edt woes Seyth Prope Eum XO Wine thp Sle Flep po IM ZXIE y X Ow 3 Ole amp persons ad El Et personae El seite fie ners no es vwd asirelement prestar t aligir centec gt lt xplintrrcibura nape r cfont nae ver tent lanta ion ocerc amas l gt font nakre verdaza td uidrr 120 5cfc lt lizk nanager Dig Lomz 4xzi valua nf ze lt td gt lt font color 51 fpazasrs lt i doat lt tr gt 4perzon id twao worker xsl clemezt nae e 131 e1e rent ne Larr t ligr9 center lt Laml lyr Mor ker C Teotly lt Tom color block lt tdr lt Lont Habes tyver lt piveno Teo lt givea gt lt xelivalue of of lt td ujdrr 120 20o cf hame gt lt xelivalue of ae lt rd gt lt tant color ni lt wsati gt ucBilss ocrr aras l gt gt f font lt tr gt lt lizk nanager Dig Pozz lt xel eleme t gt pezsor x xsl clement tz aligr center person id thzcc worker X s21 tes glate n td font bane yeri n eec x ksLiscylestieer lt td u3drrp9 3120 7 F0 xfaedl y MWorkerc fw ily e hd gt 4 gt ic gt Tg Debugger 20 zs E 18 088 E Eu 0 rr mr 9 enseres ntes YMairh Context Fg treaipcet Pectager Pariabiet le DS trace Tarqiataa Mode Set Stack Problema mL Pocos me ire Sf Cx yucipua prorbapacelSurgial perional sad a 5 parson Ode wo mah tin D ecipos morkaz aca anle parer
26. Xygen gt plugin The lt oXygen gt plugin will be activated automatically by the Eclipse platform when you use one of the lt oXygen gt wizards to create an XML project or document when you open or create a document associ ated with lt oXygen gt or when accessing the lt oXygen gt Preferences Obtaining and Installing an lt oXygen gt License lt oXygen gt is not free software and requires a license in order to enable the application For demonstration and evaluation purposes a time limited license is available upon request from the lt oXygen gt Web Site http www oxygenxml com This license is supplied at no cost for a period of 30 days from date of issue During this period lt oXygen gt is fully functional enabling you to test all aspects of the application Thereafter the application is disabled and a permanent license must be purchased in order to use the application For special circumstances if a trial period of greater than 30 days is re quired please contact lt support oxygenxml com gt All licenses are obtained from lt oXygen gt Web Site http www oxygenxml com Installation Once you have obtained a license the installation procedure is as follows Procedure 2 2 License Installation 1 Save a backup copy of the message containing the new license file 2 Start the lt oXygen gt application 3 Copy to the clipboard the license text as explained in the message 4 If there is a new ins
27. ab 23 Getting Started Customize XML document ra Create new XML file Ey v Use a DTD XML Schema Relax NG or NRL schema XML schema OTD RNG RNC NRL SystemID llestexmllframeworks docbook dtdjdocbookx dtd Document root article PublicID JJOASIS JDTD DocBook XML Y4 3 EN Description The Article element is a general purpose container For articles The content model is both quite complex and rather loose in order to accommodate the wide range of possible Article structures Although changes to the Article element have been discussed on several occasions no better model has been presented An Article is composed of a header and a body The body may include a table of contents and multiple lists of tables Figures and so on before the main text of the article and may include a number of common end matter components at the Complete the dialog as follows Use a DTD XML Schema Relax NG or NRL schema System ID Document Root Public ID When checked enables selection between DTD XML Schema Relax NG schema or NRL schema Specifies the location of a Docu ment Type Definition DTD Populated from the elements defined in the specified DTD enables selec tion of the element to be used as document root Specifies the PUBLIC identifier de clared in the Prolog Figure 3 17 The Create an XML Document Relax NG Tab 24 Getting Started E cre
28. ameter e p Local parameter The values types of a variable are marked by icons explained below Possible Values a f O Boolean ABC String 123 Numeric NH Node set __ Tree fragment e Object uii Any Figure 5 12 The Variables view Pf VERSION Pf admon graphics Pi admon graphics ext P admon graphics path P admon style PL admon textlabel P annotate toc Pi appendix autolabel P author othername i Pi autatac label separ Table 5 9 Variables details ABC 1 64 1 123 0 0 ABC png ABC images ABC margin left 0 Sin margin right 0 5in 123 1 0 123 1 0 123 1 0 123 1 0 ABC 60 XSLT Debugger Column Description Name Name of the variable parameter Value Current value for the variable parameter Remarks Clicking a record highlights the variable definition line e Variable values could differ depending on the transformation engine used or stylesheet ver sion set e If the value of the variable is a node set or a tree fragment clicking on it causes the Node set view to be shown with corresponding set of values 61 Chapter 6 WSDL Support Web Services Description Language Overview Web Services Description Language WSDL is an XML format for describing network services as a set of endpoints operating on messages containing either document oriented or procedure oriented informa tion lt oXyg
29. ar will show Transformation in progress The transformation is successfully complete when the message XSL transformation successful displays If the transform fails the message XSL transformation failed is displayed as an error message in the Messages Panel The user can stop the transformation process at any point by pressing the Stop transformation button In this case the message displayed in the status bar will be Transformation stopped by user PDF Output 1 Change directory to oxygen frameworks docbook xsl fo 2 Select docbook xs1 click Open The dialog closes 3 Select the FOP tab 4 Check the Perform FOP option The remaining options are enabled 5 Select the following options a XSLT result as input b PDF as method c Built in Apache FOP as processor 6 Select the Output tab 7 In the Save As field enter the output file name relativ to the current directory YourFile Name pdf or the path and output file name C FileDirectory YourFileName pdf 8 Optionally uncheck the XHTML and XML check boxes in the Show As group 9 Click Transform Now The transformation is started 42 Transforming Documents PS Output 1 Change directory to oxygen frameworks docbook xsl fo 2 Select docbook xs1 click Open The dialog closes 3 Select the FOP tab 4 Check the Perform FOP option The remaining options are enabled 5 Select the following options a XSLT result as input
30. ate new XML file Customize XML document v Use a DTD XML Schema Relax NG or NRL schema XML schema DTD RNG RNC mL URL file C projects eXml test RelaxNG XML xsit rng 1 Document root stylesheet XML syntax C Compact syntax Complete the dialog as follows Use a DTD XML Schema Relax When checked enables selection NG or NRL schema between DTD XML Schema Relax NG schema or NRL schema URL Specifies the location of a Relax NG schema in XML or compact syntax RNG RNC XML syntax When checked the specified URL refers to a Relax NG schema in XML syntax It will be checked automatically if the user selects a document with the rng extension Compact syntax When checked the specified URL refers to a Relax NG schema in compact syntax It will be checked automatically if the user selects a document with the rnc extension Document Root Populated from the elements defined in the specified RNG or RNC docu ment enables selection of the ele ment to be used as document root Figure 3 18 The Create an XML Document NRL Tab 23 Getting Started NRL XSL XSD DTD WSDL XQuery Import from HTML m Create new XML file Customize XML document J Use a DTD XML Schema Relax NG or NRL schema XML schema DTD RNG RNC NRL URL file C projects eXml test RelaxNG NRL nrischema nrl E Complete the dialog as follows Use a DTD XML Schema Rel
31. ax When checked enables selection NG or NRL schema between DTD XML Schema Relax NG schema or NRL schema URL Specifies the location of a NRL schema NRL A NRL schema wizard that creates sample NRL schema document A stylesheet wizard that creates sample stylesheet document A schema wizard that creates sample XML schema document A schema wizard that creates sample RNG full syntax schema document A schema wizard that creates sample RNG compact syntax schema docu ment A DTD wizard that creates sample DTD document A WSDL wizard that creates sample WSDL document An XQuery wizard that creates sample XQuery document A wizard that imports HTML documents Import HTML files to XHTML 1 0 Transitional or Strict It results an XHTML file which contains a DOCTYPE declaration referring to the XHTML DTD definition on the Web and the parsed content of the impor ted file as XHTML Transitional or Strict depending on what radio button the user chose when performing the import operation Figure 3 19 Import HTML 26 Getting Started New from Templates G lt ES Create new XML document importing HTML document Import HTML 2 Import HTML Lacan ss el XHTML 1 0 Strict C XHTML 1 0 Transitional A wizard that creates document from templates Templates are documents containing a predefined structure They provide starting points on which to rapidly build new documents that repeat the same basic characte
32. cell to add and evaluate To delete an expression click on its Expression column and delete its content Press enter on cell to commit changes e If the expression result type is a Node Set you can click on it Value column and you will see on the right side its value see Node set view Breakpoints view Lists all breakpoints set on opened documents Once you set a breakpoint it is automatically added in this list Breakpoints can be set on both XML and XSL documents Figure 5 6 The Breakpoints view Variables swatch Context EE Breakpoints Messages Resource v Cisamplesipersonal xml CA 7 samples personal xrl w Cilsamplesipersonal xml CA Ci samples personal xsl CA Cisamples personal xsl w Ci samples personal xsl 54 XSLT Debugger Table 5 3 Breakpoints details Column Description Resource Resource file where the breakpoint is set Line Line number inside resource where the breakpoint 1s set Valid Breakpoint e Not all set breakpoints are valid For example if the breakpoint is set on one empty or com mented line or the line is not reached by the processor no template to match it line con taining only an end tag that breakpoint is invalid Clicking a record highlights the breakpoint line into the document Messages view xsl message instructions are one way to signal special situations encountered during transforma tion as well as a raw way of doing the
33. cription Name Name of source XML node Attributes Value Attributes or value of the XML node If attributes exist they are shown under the form of attrib uteName attributeValue otherwise the text content of the node is shown XPath watch view Shows XPath expressions to be evaluated during debugging Expressions are evaluated dynamically as the processor changes its source context Figure 5 5 The XPath watch view Mode Set 37 Npersonnel person preceding sibling Mode Setr15 Npersonnel personFollowing Mode Set 90 Npersonnel personancestor or self Mode Set 12 lasti 1 0 liperson positioni i floorilasti div 2 0 5 ar p Mode Sekiz position lasti true mid Mode Sekip personi Sid Mode Sett 53 XSLT Debugger Table 5 2 XWatch details Column Description Expression XPath expression to be evaluated should be XPath 1 0 or 2 0 compliant Value Result of XPath expression evaluation Value has a type see Possible Values in the section Variables view For Node Set results the number of nodes in the set is shown in parenthesis Remarks e Expressions reffering to variables names are not evaluated In case of an XPath error you get an Error line e The expression list is not deleted at the end of transformation it is preserved during ses sions To insert a new expression click the last line on the expression column and enter it Press enter on
34. d as images will be 39 Transforming Documents embedded within the output PDF or PS This option will therefore be disabled during FOP transformations The list of cascade stylesheets can be edited in the dialog opened by the button Cascade Stylesheets Figure 4 2 Edit cascade stylesheets list dialog E Edit cascade stylesheets list 4cFdu postFilter xsl oma Add Adds a stylesheet in the Cascade stylesheets list using a file browser dialog also you can type a macro in the file name field of the browser dialog The name of the stylesheet will be added in the list after the current selection New Opens a dialog in which you can type the name of a stylesheet The name is considerd relat ive to the URL of the current edited XML document You can use macros in the name of the stylesheet The name of the stylesheet will be added in the list after the current selection Remove Deletes the selected stylesheet from the Cascade stylesheets list Up Move the selected stylesheet up in the list Down Move the selected stylesheet down in the list In the fields reserved for input URL XSL URL or XML URL depending on scenario type header URL footer URL the URLs in the list of cascade stylesheets image base URL the user can use the fol lowing macros home the path of the user home 40 Transforming Documents cfdu current file directory url the path of the current edited document up to the na
35. debugging This view shows all lt xsl message gt calls ex ecuted by the XSLT processor during transformation Figure 5 7 The Messages view Variables swatch Breakpoints E Messages m Resource The first message no File C samples personal xsl The second message no File C samples personal x l The last message File C samples personal xsl Table 5 4 Messages details Column Description Message Message content Terminate Signals if processor will terminate the transforma tion or not once it encounters the message true false respectively Resource Resource file where xs1 message instruction is defined Remarks 55 XSLT Debugger e Clicking a record from the table highlights the lt xs1 message gt declaration line Stack view Shows the current execution stack of both source and style nodes During transformation two stacks are managed one of source nodes being processed and the other for stylesheet nodes being processed lt oXygen gt shows both node types into one common stack The source XML nodes are preceded by a red color icon while stylesheet nodes are preceded by a green color icon The advantage of this approach is that you can always see the source scope on which a stylesheet instruction is executed the last red color node on the stack The stack is oriented upside down Figure 5 8 The Stack view Eg stack Trace Li Mode Set NE O Fal AMIL XML X5LN
36. dependent formatter driven by XSL Formatting Objects FOP is implemented as a Java application that reads a formatting object tree and renders the resulting pages to a specified output Tip To include PNG images in the final PDF document you need the JIMI http java sun com products jimi or JAI http java sun com products java media jai librar ies For TIFF images you need the JAI http java sun com products java media jai library The JIMI and JAI libraries are not bundled with lt oXygen gt due to Sun s licensing Using them is as easy as downloading them and copying the necessary jar files required by the library doc umentation in the lib subdirectory of the lt oXygen gt installation directory This means Jimi ProClasses zip for JIMI and jai_core jar jai_codec jar and mlibwrapper_jai jar for JAI For the JAI package you also need to include the directory containing the native libraries mlib jai dll and mlib_jai_mmx dll on Windows in the PATH system variable The MacOS X version of the JAI library can be downloaded from ht tp www apple com downloads macosx apple java3dandjavaadvancedimagingupdate html In order to use it install the downloaded package 37 Transforming Documents Other FO processors can be configured in the Preferences gt FO Processors option for use in document transformation Transformation Scenarios Before transforming the current edited XML document in lt oXygen gt one must defi
37. e built in rules Node set view This view is always used in relation with Variables view and XPath watch view and shows a nodeset value Once you click a variable having as value a nodeset or tree fragment or an XPath expression eval uated to a nodeset in the above views the node set view gets updated with the respective value Figure 5 11 The Node Set view Stack Templates Fits Node Set m Attributes Value x UU D given Four al email Faurimoxwygenxml com E m Cs link manager Big Boss amp person id five worker contrz False A ha name amp Family Worker Table 5 8 Node set details Column Description Name Name of source XML node Attributes Value Attributes or text content Value of the XML node If attributes exist these are shown under the form of attributeName attributeValue other wise the text content of the node is shown Remarks e Incase of longer values for Value Attributes column content the interface shows three sus pension points at the end A more detailed value is available as tooltip Clicking a record highlights the location of that node into the source or stylesheet view Variables view During transformation variables and parameters play an important role lt oXygen gt uses the following icons to differentiate variables parameters 59 XSLT Debugger vi Global variable vy Local variable e py Global par
38. e lt oXygen gt XML Editor offers the following key features and benefits Multiplatform availability Windows Mac OS X Linux Solaris Can be used as standalone desktop application run through Java Web Start or as an Eclipse plugin Multilanguage support English German French Itali an and Japanese Non blocking operations you can perform validation and transformation operations in background Support for XML XSLT XML Schema Relax NG DTD NRL schemas WSDL and XQuery Ready to use FOP support to generate PDF or PS docu ments Validate XML Schemas Relax NG schemas DTDs NRL schemas WSDL XQuery and CSS Validate XML documents with XML Schemas Relax NG schemas DTDs or NRL schemas Outliner Bookmark support Support for editing remote files over FTP HTTP WebDAV and HTTPS WebDAV Experimental XInclude support Easy error tracking locate the error source by clicking on it Spell checking supporting English German and French including locals Generate HTML documentation from XML Schemas Conversions from DTD Relax NG schema or a set of documents to XML Schema DTD or Relax NG schema Support for document frameworks Docbook and TEI Context sensitive content assistant driven by XML Schema DTD or by the edited document structure XML Catalog support Unicode support New XML document wizards to easily create docu ments specifying a schema or a DTD
39. e and the way tags are nested Modification Follow up When editing the Outliner dynamically follows the modifications introduced by the user showing in the middle of the panel the node which is currently being modified This gives the user better insight on loc ation where in the document one is positioned and how the structure of the document is affected by one s modifications Document Tag Selection The Outliner can also be used to search for a specific tag s location and contents in the edited document Intuitively by selecting with the left mouse button the desired tag in the Outliner Panel the document is scrolled to the position of the selected tag Moreover the tag s contents are selected in the document making it easy to notice the part of the document contained by that specific tag and furthermore to easily copy and paste the tag s contents in other parts of the document or in other documents The lt oXygen gt Text View The oXygen text view is automatically showed in the views pane of the Eclipse window to display FO processor s info warning and error messages Figure 3 24 The oXygen Text View 34 Getting Started DIGITE tarted C Program Files Java jZre1 4 2 bin ja 4 INFO Using org apache xerces parsers SAzParse INFO FOP 0 20 5 INFO Using org apache xerces parsers S2ixParzae INFO building formatting object tree INFO setting up fonts ERROR Unknown enume
40. ed Chapter 2 Installation This section explains platform requirements and installation procedures It also provides instructions on how to obtain and apply an lt oXygen gt license how to perform upgrades and uninstall lt oXygen gt if re quired If you need help at any point during these procedures please send email to lt support oxygenxml com gt Caution If you want to execute lt oXygen gt with Java WebStart directly from lt oXygen gt Java WebStart page http www oxygenxml com javawebstart or your intranet server please configure your Java WebStart not to ask for desktop integration File gt Preferences Shortcuts otherwise it will show up a dialog in the same time with the lt oXygen gt license registration dialog leading to a blocking situation Installation Requirements Platform Requirements Minimum run time requirements are listed below Pentium Class Platform 128 MB of RAM e 80 MB free disk space Operating System Tools and Environment Require ments Operating System Windows All versions Mac OS minimum Mac OS X 10 0 UNIX Linux All versions flavors Tools Installation packages are supplied in compressed archives Ensure you have installed a suitable archive extraction utility with which to extract the archive Environment Prerequisites Prior to installation ensure that your installed Eclipse platform has at least the following Installation e Version 3 0 or h
41. eet 5 From the Control Toolbar use the XSLT engine selector control to select one of the available pro cessing engines 6 Configure the XSLT parameters Once set these parameters are preserved between debugging ses sions 7 Start the debugging using the active control buttons see Control view for description of control functions Note Initially only the two available Saxon XSLT Processors are active in the Debugger perspect ive If you select Xalan XSLT Processor an warning message is shown requiring Xalan version 2 5 1 To set Xalan 2 5 1 you need to copy xalanOxygen zip from oxygen lib and put it to the endorsed folder from your JRE JDK used for running Eclipse you can find it in Help gt About Eclipse Platform Configuration Details java endorsed dirs entry and restart Eclipse Output to Source Mapping Every section of the output it is generated by an XSL stylesheet element in the context of an XML source node During debugging it is important to know this mapping from output to source in order to quickly spot the templates with problems Some of the debugging capabilities for example Step in can be used for this purpose Using Step in you can see how output is generated and link it with the style element be ing executed in the current source context However this can become difficult on complex stylesheets that generates a large output Output to source mapping is a powerful feature that makes this mapping persis
42. en ario will have the Use xml stylesheet declaration checkbox set by default will use Saxon as trans formation engine will perform no FO processing and will store the result in a file with the same URL as the edited document except the extension which will be changed to html The name and path will be pre served because the output file name is specified in terms of two macros cfd and cfn Import Export Transformation Scenarios The option to Export Transformation Scenarios is used to store all the scenarios in a separate file a properties file In this file will also be saved the associations between document urls and scenarios The saved urls are absolute You can load the saved scenarios using Import Transformation Scenarios op tion All the imported scenarios will have added to the name the word import 41 Transforming Documents Example Transformation Scenarios The following examples use the DocBook XSL Stylesheets to illustrate how to configure lt oXygen gt for transformation to the various target formats The following steps are common to all the example procedures below 1 Set the editor focus to the document to be transformed 2 Select XML gt Configure transformation scenario Ctrl Shift C to open the Configure Trans formation dialog 3 Select the XSLT tab 4 Click the Browse for an input XSL file button The Open dialog is displayed Note During transformations the Editor Status B
43. en gt offers the following facilities for WSDL support Editing WSDL files e Validating WSDL files e Analysing and testing WSDL files Editing WSDL files The WSDL files contain information about the published services like the name the message types and the bindings The editor is offering a way to edit the WSDL files that is similar to editing XML the tag insight being driven by a mix of the WSDL and SOAP Schema To create a WSDL file use the File New and then choose WSDL file Figure 6 1 Tag insight for WSDL soap body use encaded namespacez httpalarcweb es ioutput Joperation JIbinding service name PlaceFindersample dac E documentation jale binding tns IPlaceFinderS E port L rifareweb esri cam servicesiv2 E snap address zist E soap binding E soapbody 1 soap fault Manr ora 2001XMLSchema E soap header w 12 www themindelectric camipa xsuimpar namespaces nm Jschemas xmlsaap argisoaap aysd camplexType namez Key Value Validating WSDL files 62 WSDL Support While editing the Web Services descriptors you can check their conformance to the WSDL and SOAP schema You do not need to specify the schema location for the WSDL standard namespaces In the fol lowing example you can see how the errors are reported Figure 6 2 Validating a WSDL file lt finput gt output name getYersion30ut gt z soap ibody use encoded name pj z output e lt soap addres
44. gt is connecting to the server The testing of a WSDL file is straight forward you just have to click on the WSDL analysis button then select the service the port and the operation The editor will generate the skeleton for the request You can edit the request eventually attach files to it and send it to the server Watch the server response in the response area 65 Chapter 7 XQuery Support XQuery Overview XQuery is the query language for XML The many benefits of XQuery include XQuery allows you to work in one common model no matter what type of data you re working with relational XML or object data XQuery is ideal for queries that must represent results as XML to query XML stored inside or out side the database and to span relational and XML sources XQuery allows you to create many different types of XML representations of the same data XQuery allows you to query both relational sources and XML sources and create one XML result XQuery is currently under development at the W3C lt oXygen gt XML Editor includes an XQuery editor featured with syntax highlight for XQuery documents code insight for XQuery functions operators and keywords XQuery validation and execution support for applying your queries on XML documents To create a new XQuery document you can select File gt New Ctrl N and when the New Document dialog appears select XQuery entry Syntax Highlight and Content Completion Once
45. hat are present in the used schema for the current element attribute or at tribute value Use DTD comments as annotation When checked lt oXygen gt will use all DTD comments as an notation Learn attributes values When checked lt oXygen gt will display a list with all attributes values learned from the current document Learn on open document When checked lt oXygen gt will automaticaly learn the document structure when the document is opened Default The URL of the default DTD XML Schema to be used when no grammar is specified in the edited doc ument Figure 3 5 The Tag Insight Default pane For the XML Files having no XML Schema or DTD specified use this File C samples personal dtd Change C XML Schema File C Jsamples personal xsd Change DTD Used to specify the full path location of the DTD file that will be used to initialize the Tag Insight assistant when a document does not define a DTD XML Schema Relax NG or NRL schema XML Schema Used to specify the full path location of the XML Schema file that will be used to ini tialize the Tag Insight assistant when a document does not define a DTD XML Schema Relax NG or NRL schema XSL These settings define what elements are suggested by the content assistant in addition to the XSL ones 12 Getting Started Figure 3 6 The Tag Insight XSL pane A5L Include elements declared in the schema None C XHTML Transitional C Formating Objects
46. hecked lt oXygen gt will use the built in catalogs for DocBook TEI and XHTML documents located in the frameworks subdirectory of the installation directory Otherwise lt oXygen gt will use the catalogs specified in the list The Prefer option is used to specify whether lt oXygen gt will try to resolve first the PUBLIC or SYS TEM reference using the specified XML catalogs If a PUBLIC reference is not mapped in any of the catalogs then a SYSTEM reference is looked up The verbosity level specifies the types of output messages displayed to standard output and can have one of the values debug warn info error and fatal XML Parser Options 14 Getting Started Figure 3 8 The XML Parser Options pane ZML Parser Options XML Parser Features v http fapache org xml features validationfschema v http apache arg xmlifeatures validation schema Full checking XML Parser Properties Use XML Schema for validation Enable Include processing Restore Defaults Apply http apache org xml features validation schema This option sets the schema feature to true http apache org xml features validation schema full checking This option sets the schema full checking feature to true Use XML Schema For Validation This option forces validation against a referred XML Schema even if the document includes a DTD declaration Enable XInclude processing if checked the XInclude support in lt oXygen gt
47. iate schema Ctrl Shift S Associates a schema with the current document O e w X XML gt Apply transformation scenario Ctrl Shift T Executes the transformation process using the config uration properties defined in the Configure transformation scenario dialog hi XML gt Configure transformation scenario Ctrl Shift C Displays the Configure transformation scenario dialog used to define properties for conversion of documents to multiple output targets Also enables saving of scenarios Each scenario can store a unique configuration ready to be used in the future g oa XML gt Learn structure Ctrl Shift L Reads the mark up structure of the current document so that it can be used for content assistance XML gt Save structure Ctrl Shift S Saves the learned document structure into an external dtd file TES XML gt Format and indent Ctrl Shift F Also referred to as Pretty print Format and indent performs layout functions to make mark up easier to read on screen and in print output Hi XML gt XPath Ctrl Shift Opens a dialog for entering and executing an XPath query against the current document XML gt Add to templates Ctrl Shift A Displays the Add templates dialog used to define the name by which the current document content will be recognized in the New from templates option ta XML gt Check spelling Ctrl Shift Q Starts checking the spelling of the current document
48. idation operation on the current document using a validating parser Returns an error result list in the lt oXygen gt Text View Mark up of current document is checked to conform with the specified DTD XML Schema or Relax NG schema rules I lt XML gt Check document form Ctrl Shift W Executes the well form check operation on the current docu ment using a non validating parser Returns an error result list in the lt oXygen gt Text View c XML gt Relax NG validation Ctrl Shift R Displays the Relax NG validation dialog used to select the Re lax NG schema and to execute the Validation operation on the current document The schema file can be either in Relax NG XML syntax or in Relax NG compact syntax In case of errors the validation returns an error result list in the oXygen Text View Ke XML gt NRL Validation Ctrl Shift N Displays the NRL Validation dialog used to select the NRL Namespace Routing Language schema and to execute the Validation operation on the current document In case of errors the validation returns an error result list in the lt oXygen gt Text View XML gt Clear validation markers Ctrl Shift K Clears the markers in the Problems view corresponding to errors obtained during the last validation of the current document XML gt Convert with Trang Ctrl Shift Converts the current document to a supported grammar language using the integrated Trang converter XML gt Assoc
49. iew e Variables view Right side Information View Classes Stack view Trace history view Templates view Node set view Working with Debugger This section explains the working process involving the use of Debugger perspective 49 XSLT Debugger Getting Started lt oXygen gt provides two perspectives Editor and Debugger lt oXygen gt starts by default in the Editor perspective Switching between Editor and Debugger perspectives is easy and can be done at any time during a working session even when no files have been opened To switch to Debugger perspective click the Eg button or select oXygen XSLT Debugger from Window gt Open Perspective gt Other Unlike Editor perspective Debugger perspective requires that at least one document XML and one stylesheet XSL are opened before the debug functionality and features become of any use These files can be opened while in Editor perspective before switching to Debugger perspective or directly from within the Debugger perspective You can switch back to Editor perspective by clicking the Editor button or select lt oXygen gt XML from Window gt Open Perspective gt Other When switching from Editor perspective to Debugger perspective the opened files are sorted by exten sion into the Source document view XML and Stylesheet document view XSL panes The Debug Process The debug procedure described below see Typical Debug Process assumes oXygen
50. igher e JRE 1 4 or higher Installation Instructions Prior to proceeding with the following instructions please ensure that your system complies with the prerequisites detailed in the installation requirements Procedure 2 1 Eclipse platform 1 Start Eclipse Choose the menu option Help Software Update Find and Install Select the check box Search for new features to install and press the Next button 2 From the dialog Update sites to visit press the button Add update site or New Remote Site 3 Enter oXygen XML Editor in the Name field and the value ht tp www oxygenxml com InstData Eclipse site xml into the URL field of the New Update Site dialog Press the OK button 4 Select the checkbox oXygen XML Editor and press the Next button 5 Select the new feature to install oXygen XML Editor and XSLT debugger and press the Next button in the following install pages You must accept the Eclipse restart 6 Paste the lt oXygen gt license information received in the registration email when prompted This will happen when you use one of the lt oXygen gt wizards to create an XML project or document when you open or create a document associated with oXygen or when accessing the oXygen Preferences 7 The lt oXygen gt plugin is installed correctly if you can create an XML project with an oXygen wizard File gt New Ctrl N gt lt oXygen gt XML Project Starting lt o
51. iguration dialog en ables this configuration If you are not sure whether your computer is required to use a Proxy server to connect to the Internet or the values required by the Proxy Configuration dialog please consult your Network Administrator Open the Proxy Configuration dialog by selecting Options gt Preferences gt Proxy Configuration Figure 3 13 The Proxy Configuration Dialog Proxy Configuration v Use proxy server Web proxy HTTP 123 456 789 222 Port ana User john_doe Password LI Mo proxy Far Complete the dialog as follows Use proxy server When checked enables oXygen to use the specified Proxy Server When unchecked Proxy Server is disabled Web Proxy HTTP The IP address or Fully Qualified Domain Name FQDN of the Proxy Serv er Port The TCP Port Number normally set to 80 or 8080 User The Name of the user if required Can be empty Password The Password for authentication Can be empty No proxy for Specify domains for which no proxy should be used SOCKS When checked enables SOCKS using the specified host and port for the serv er When unchecked SOCKS is disabled 20 Getting Started Host The SOCKS host you wish to connect to Port The SOCKS port you wish to connect to Colors lt oXygen gt supports Syntax Highlight for XML DTD Relax NG XML and Compact Syntax Java JavaScript XQuery C C PHP CSS Perl Properties SQL Shell and Batch docu
52. ink TETUE A x E Problems Y 1 error O warnings B infos Description Resource xQuery syntax error on line 7 of file fC samplesfxqu personal xquery Transforming XML Documents Using XQuery XQueries are very similar to the XSL stylesheets in the sense they both are capable of transforming an XML input into another format You can define transformation scenarios that specify the input URL the preview mode XML or XHTML The result can be saved and opened in the associated application You can even run a FO processor on the output of an XQuery The transformation scenarios may be shared between many XQuery files and are exported at the same time with the XSLT scenarios The Transformation Scenario Edit dialog is illustrated below The transformation performed can be based on the XML document specified in the Input field or if this field is empty the documents reffered from the query expression are used instead Figure 7 3 XQuery Transformation 67 XQuery Support personal ASLT Fo Processor Output Input File C samples xquervjPersonal persanal xml Parameters Append header and Footer 68
53. ios 2 1 rper re E ere REI Reb ORC nia ER ERE decis 38 Creating a Scenario etilo eer Rp hens 4l The detault Scenario idilio PU eterne 41 Import Export Transformation Scenarios seseeeee 4l Example Transformation Scenarios sees eee ene eren 42 O deeper reete oe emere e oor UP opi pe ERR Epor eode eo Sed Uio Pe v oe ipa ete n 42 PS Output ii er eno PEE E RE URS 43 TXT Outp t 4 m oreet petente sete cote eere euis 43 HTME Output 23 5 ret eere INS E SEET SEEE GOSEE TREERE ENE 44 HIML Help Output rr rrt rre rre Pret ERE oros 44 JavaHelp Output ere eret rnt ere vere eH See Ey E ERE SD ee eR Dt 44 XHTML Output sss 2 Itt eror E PR seanea se paid aes Relea EE IRE Dey 45 5 XSET Debugger stastie peres Ee te hene eln ensem ube desks UR eer EET eS evens 46 TAA C E 46 LayOUt italia ERE ER top et tinet everest esee mo dai rive uds 46 Source document view XML ssssssssesssseseseee ene eme e mener enne 47 Stylesheet document view XSL esses ee hee hene 47 Output document VIEW xe aoa eee Pere ey ee o CES 47 Control VISW 1 2 trente il tie otio us 47 Working with Deb gget ure eet epe US ROC er EIE THEE 49 Getting Started citado ostia to ori oe sgh neato eh tex Dee e vox oes e ve sesh ete ts 50 The Debug Process si oett re eer per ere doa weed odes EUR e ventas EST 50 Output to Source Mapping sess meme me he E E
54. is turned on XSLT Options Figure 3 9 The JAXP XSLT Transformer option 15 Getting Started ZSLT Options JAXP XSLT Transformer To use Your own transformer set Ehe value of the system property jawax xml transform TransfFormerFackary Value net sf saxon TransformerFactoryImpl Engine used for XSLT validation amp SLT 1 0 validate with xalan t XSLT 2 0 Validate with Saxon8B If you want to use an XSLT transformer different than the ones that ship with lt oXygen gt namely Apache Xalan and Saxon all you have to do is to specify the name of the transformer s factory class which lt oXygen gt will set as the value of the Java property javax xml transform TransformerFactory To perform an XSLT transformation with Saxon 7 for instance you have to place the Saxon 7 jar file in the lt oXygen gt libraries directory the lib subdirectory of the installation directory set net sf saxon TransformerFactoryImpl as the property value and select JAXP as the XSLT processor in the transformation scenario associated to the transformed XML document Value Allows the user to enter the name of the transformer factory Java class XSLT 1 0 Validate with Allows the user to set the XSLT Engine used for validation of XSL 1 0 documents XSLT 2 0 Validate with Allows the user to set the XSLT Engine used for validation of XSL 2 0 documents Debugger Settings Figure 3 10 Debugger Settings 16 Ge
55. l gt 4 lt person id Big Boss znare zfamily Bossc family zgiven Bigc given z name zemail chiefloxygenxml comz email lt link subordinates one worker two lt person gt lt person id one worker gt lt name gt lt family gt Worker lt family gt lt qiven One lt qiven gt lt name gt zemail onelloxygenxml caoamz email lt link manager Big Boss Outliner Panel The Outliner pane has the following available functions XML Document Overview e Modification Follow up e Document Tag Selection Figure 3 23 The Outliner Panel 33 Getting Started Hs Outline Q x translation translation comment Pause the debugging proc key Pause value en EN Pause value de DE Pause value fr FR Pause value it IT Pausa value ro RO Paura lt key gt translation translation lt comment gt Pause key value Pa lt value lt value lt value lt value lt value lt value iso en isc de gun AHE pea e 1s0 ro iso 3p value jp JP 4421b amp translation comment Select a source document m lt key gt lt translation gt translation m a T XML Document Overview The Outliner displays a general tag overview of the current edited XML Document It also shows the correct hierarchical dependencies between the tag elements making it easier for the user to be aware of the document s structur
56. me of the par ent directory as URL cfn current file name the name of the current edited document without extension and parent directory In the Save As field from the Output tab the user can use the following macros home cfd cfn cfd current file directory the path of the current edited document up to the name of the parent directory The macros defined here can also be used in the values set for the parameters of the transformation e g base dir Creating a Scenario Use the following procedure to create a scenario 1 Select XML gt Configure transformation scenario Ctrl Shift C to open the Configure Trans formation dialog 2 Click the Duplicate Scenario icon to the right of the top combo box to create a copy of the current Scenario 3 Double click in the Name field to select the exiting text 4 Type anew name 5 Click OK or Transform Now to save the Scenario The default scenario If one presses the Apply Transformation Scenario toolbar button currently there is no scenario associ ated with the edited document and the edited document contains a xml stylesheet processing instruc tion reffering to a XSLT stylesheet commonly used for display in Internet browsers then lt oXygen gt will prompt the user and offer him the option to associate the document with a built in default scenario containing in the XSL URL field the URL from the href attribute of the processing instruction This sc
57. ment v Learn attributes values This option enables Tag Insight feature When unchecked all Tag Insight features are disabled When inserting elements from the Tag Insight assistant both start and end tags are inserted When checked lt oXygen gt will insert automatically the required elements from the DTD or XML Schema When checked lt oXygen gt will insert automatically the optional elements from the DTD or XML Schema When checked lt oXygen gt will insert automatically the first Choice particle from the DTD or XML Schema When checked lt oXygen gt will insert automatically the required attributes from the DTD or XML Schema for an element inserted with the help of the Tag Insight assistant When checked lt oXygen gt will insert automatically any FIXED attributes from the DTD or XML Schema for an element inserted with the help of the Tag Insight assistant 11 Getting Started Show all entities When checked lt oXygen gt will display a list with all the internal and external entities declared in the current document when the user types the start character of an entity reference i e 42 Cursor position between tags When checked lt oXygen gt will set the cursor automatically beetween tags Even if the auto inserted elements have attributes that are not required the position of cursor can be forced between tags Show annotation When checked lt oXygen gt will display the annotations t
58. ments While lt oXygen gt provides a default color configuration for highlighting the tokens you may choose to cus tomize as required using the Colors dialog Figure 3 14 The Colors pane aj workbench ML Colors H Ant Build Order Text Help i Install Update Comment H Java J oxygen El Editor Quoted Yalue H Proxy Configuration Docky pe Syntax highlight Aposed value DTD Colors H RNC Colors Entity E XML iu ML Catalog l XML Parser Options ASL FO Processing instruction H Plug in Development El RunjDebug Equal Attribute name CONCA Open the Colors dialog by selecting Options gt Preferences gt Colors and choose one of the supported Document Types Each document type contains a set of Tokens When the Document Type is selected the associated tokens are listed Selecting a token displays the current color properties and enables you to modify them lt oXygen gt plugin wizards The lt oXygen gt plugin installs a series of Eclipse wizards for easy creation of new documents Using these wizards you let lt oXygen gt fill in details like the system ID or schema location of a new XML document the minimal markup of a Docbook article or the namespace declarations of a Relax NG schema 21 Getting Started You can access them from File gt New gt Other gt lt oXygen gt Ctrl N Select a wizard An XML wizard that creates sample XML File Wizards
59. mts details coil Ere ee EE E even 55 3 4 Messages AA eet pie etse pe Oo pe pe EE Ste Pe ope Ee Pepe EUR S bp tues 55 Dds Stack details a Nr re DR eite 56 23 6 Trace History detalls ient oe Oe teret Ret eet leer beaten Ee asd EAS re En eude 57 5 7 Templates details ciertas EREIEIPETR 58 5 8 Node set details riter Iter es EE TIRE re PreR REPE ER P SERERE IRR sey 59 5 9 Variables details ecce een dera ne 60 vii Chapter 1 Introduction Welcome to the lt oXygen gt XML Editor User Man ual This chapter provides an overview of lt oXygen gt s features and benefits and the organization of this book The lt oXygen gt XML Editor is a cross platform applicati mark up languages such as XML XSD XSL DTD on for document development using structured lt oXygen gt offers developers and authors a powerful Integrated Development Environment Based on proven Java technology the lt oXygen gt XML Editor s intuitive Graphical User Interface is easy to use and provides robust functionality for editing project management and validation of structured mark up sources Coupled with XSLT and FOP transformation technologies lt oXygen gt supports output to mul tiple target formats including PDF PS TXT HTML and XML lt oXygen gt is the XML Editor of choice for developers authors and integrators that demand high quality output with a flexible and robust single source structured mark up environment Key Features Th
60. n Run to cursor Ly Run to end Ly Pause il The selection represents the source document to be used as input by the trans formation engine The selection list is filled in with all opened files the XML ones being emphasized This gives you the possibility to use other file types as source The selection represents the stylesheet document to be used by the transforma tion engine The selection list is filled in with all opened files the XSL ones being emphasized Lists the available XSLT processors Saxon and Xalan Java see specifications XSLT parameters to be used by the transformation Starts the debugging process and runs until the next stylesheet node next step in transformation Executes the current stylesheet node including its sub elements and goes to next node in document order usually the next sibling of the current node Steps out to the parent node equivalent to the Step over on the parent Starts the debugging process and runs until the first breakpoint is encountered or until the end of transformation occurs if no breakpoints are encountered see Breakpoints view Starts the debugging process and runs until one of the following conditions oc cur the line of cursor is reached a valid breakpoint is reached or end of execu tion Runs the transformation until the end without taking into account any enabled breakpoints that might be set Interrupts the current transformation This i
61. nd devices JavaHelp is a free product and the binaries for JavaHelp are redistributable Many other target formats are possible these are the most popular The basic condition for transforma tion to any format is that your document is valid against a given DTD and that the XSLT XSL used for transformation is compatible with the DTD An XSL stylesheet specifies the presentation of a class of XML documents by describing how an in stance of the class is transformed into an output document by using special formatting vocabulary lt oXygen gt supports XSLT XPath version 1 0 using Saxon 6 5 3 Xalan and XSLT XPath 2 0 by using Saxon 8 1B The editor switches between the tag insight list of elements for the two standards automat ically by examining the version attribute of the stylesheet Also the validation is done in function of the stylesheet version XSL consists of three parts XSL Transformations XSLT is a language for transforming XML documents XML Path Language XPath is an expression language used by XSLT to access or refer parts of an XML document XPath is also used by the XML Linking specification XSL Formatting Objects XSL FO is an XML vocabulary for specifying formatting semantics The lt oXygen gt installation package is distributed with the Apache http www apache org FOP http xml apache org fop index html Formatting Objects Processor for rendering your XML docu ments to PDF FOP is a print and output in
62. ndent with tabs When checked enables Indent with tabs to sets the indent to a tab unit When unchecked Indent with tabs is disabled and the in dent will measure as many spaces as defined by the Indent size option Indent size Sets the number of spaces or the tab size that will equal a single indent The Indent can be spaces or a tab select the preference us ing the Indent With Tabs option If set to 4 one tab will equal 4 white spaces or 1 tab with size of 4 characters depending on which option was set in the Indent With Tabs option Format and indent the document on When checked the Format and indent the document on open op open eration will format and indent the document before open Expand empty elements When checked the Format and Indent operation will output empty elements with a separate closing tag ex lt a atrl v1 gt lt a gt When not checked the same operation will represent an empty element in a more compact form lt a atrl v1 gt Sort attributes When checked the Format and Indent operation will sort the at tributes of an element alphabetically When not checked the same operation will leave them in the same order as before applying the operation Getting Started Line width pretty print Preserve space elements Strip space elements Tag Insight Defines the point at which the Format and Indent Pretty Print function will perform line wrapping So if set to 100 Pretty Print will wrap lines a
63. ne a transformation scenario to apply to that document A scenario is a set of values for various parameters defining a trans formation It is not tied to any particular document but to a document type Scenarios that apply to XML files Such a scenario contains the location of an XSLT stylesheet that 1s applied on the edited XML document and other transform para meters Scenarios that apply to XSL files Such a scenario contains the location of an XML document that the edited XSL file is applied on and other transform parameters The Configure Scenario dialog is used to associate a scenario from the list of all scenarios with the ed ited document by selecting an entry from the list The dialog is opened by pressing the Configure Trans formation Scenario button on the toolbar of the document view Once selected the scenario will be ap plied with only one click on the Apply Transformation button on the same toolbar Pressing the Apply Transformation button before associating a scenario with the edited document will invoke first the Con figure Scenario dialog and then apply the selected scenario Open the Configure Transformation dialog by selecting XML gt Configure transformation scenario Ctrl Shift C Figure 4 1 The Configure Transformation Dialog 38 Transforming Documents Edit scenario Scenario Mame ser Guide eclipse en amp SLT Fo Processor Output SL URL file C projects exml docbookjxsl Fo pr
64. ode attributes Resource File C amples personal xml P vwsltemplate imatchz I File C amp amples personal xsl S html File C samples personal xsl vsl element mame Fable File C amp amples personal xsl B vaapply temp File C samples personal xsl person id Big Boss co File C samples personal xml B ve template imatch person File C Isamples personal xsl Table 5 5 Stack details Column Description Order number represents the depth of the node 0 is the stack base XML XSL Node Node from source or stylesheet document currently being processed One particular stack node is the document root noted as document Attributes Attributes of the node list of id value pairs Resource Resource file where the node is located Remarks Clicking a record from the stack highlights that node s location inside resource e Using Saxon the stylesheet elements are qualified with XSL proxy while on Xalan you only see their names example xsl template on Saxon and template on Xalan e Only Saxon processor shows element attributes e Xalan processor shows the built in rules 56 XSLT Debugger Trace history view Usually the XSLT processors signal the following events during transformation entering a source XML node e leaving a source XML node entering a stylesheet XSL node gu leaving a stylesheet XSL node
65. ofile docbaok xsl e Use xml stylesheet declaration Transformer Saxon Parameters Append header and Footer Cascade stylesheets 0 OK Cancel Complete the dialog as follows XSLT Tab Use the XSLT tab to specify an input XSL file to be used for the trans formation You can also add XSLT parameters and append header and footer URL s to be included in the transformation To apply a cascade of stylesheets the user can set the list of stylesheets applied after the stylesheet from the XSL URL field in the dialog displayed after press ing the Cascade Stylesheets button The user can choose between Xalan and Saxon when configuring the transformation Saxon is faster on Docbook stylesheets FOP Tab Use the FOP tab to enable disable use of FOP during a transformation FOP input may be provided from the XSLT output or the edited docu ment source lt oXygen gt is supplied with the Apache FOP but sup ports definition and use of any third party processor Default output method is set to use PDF but PS and TXT are also configured You may add and define any method supported by your FOP Output Tab Use the Output Tab to specify the output path where target output files will be saved When performing an XHTML transformation the relat ive path for image locations must be provided in order to ensure that image paths will be correctly resolved in order to be displayed in the output files When using FOP this is not require
66. rated value for property ERROR Error in relative align property value ERROR Unknown enumerated value for property wt d The lt oXygen gt XPath View The lt oXygen gt XPath view is automatically showed in the views pane of the Eclipse window to display XPath results Figure 3 25 The lt oXygen gt XPath View lt person id five worker znarie zfamily Workerc tfamilsy iven Fivez given fpersonnel 1 personne l 1 personnel i personnel i personnel i person personnel i1 person 65 name i1 diven 1 Five 35 Chapter 4 Transforming Documents XML is designed to store carry and exchange data not to display data When we want to view the data we must either have an XML compliant user agent or transform it to a format that can be read by other user agents This process is known as transformation Within the current version of lt oXygen gt you can transform your XML documents to the following formats without having to exit from the application For transformation to formats not listed simply in stall the tool chain required to perform the transformation and process the xml files created with lt oXygen gt in accordance with the processor instructions PDF PS TXT XML XHTML Adobe Portable Document Format PDF is a compact binary file format that can be viewed and printed by anyone anywhere across a broad range of hardware and soft ware using the free PDF
67. ristics lt oXygen gt installs a rich set of templates for a number of XML applications You may also create your own templates and share them with other users The Templates dialog enables you to select templates that have already been created in previous sessions or by other users Figure 3 20 The Templates Dialog 27 Getting Started C User defined C Documents and Settings dan S NC com o C From URL http www oxygenxml com resources 4 2jte Load Templates Docbook 4 2 Article Docbook 4 2 Article with XInclude Docbook 4 2 Book Docbook 4 2 Book with XInclude TEI P4 TEI Lite TEI Master TEI Master msDescription XHTML 1 0 Transitional XHTML 1 0 Strict Formatting Objects with RenderX extensions XML Project A wizard that creates a new XML Project The oXygen custom menu When the current editor window contains a document associated with oXygen a custom menu is ad ded to the Eclipse menu bar named after the document type XML A XML document is edited XSD A W3C XML Schema is edited DTD A Document Type Definition is edited XSL A XSL Stylesheet is edited RNG A Relax NG full syntax schema is edited RNC A Relax NG compact syntax schema is edited NRL A Namespace Routing Language schema is edited 28 Getting Started WSDL A Web Services Definition Language document is edited XQuery An XQuery document is edited The available menu actions are the following XM
68. s location http arcum lt foperation gt z hindincg Problems o6 Javadoc Declaration z errors 35 warnings 0 infos Filter matched 37 of 38 items Description 22 cve complex type 4 a Invalid content was Found startingwith element s Analysing and testing WSDL files After defining the descriptor you can check it to see if the defined messages are accepted by the Web Services server lt oXygen gt is providing two ways of testing one for the currently edited WSDL file and other for the remote WSDL files that are published on a web server Figure 6 3 WSDL Analyser 63 WSDL Support WSDL Services PlaceFinderSample w Ports IPlaceFinderSample v Operations getTypes vt http arcvveb esri com servicesv2 PlaceFinderS ample getTypes 1 lt SOAP ENV Envelope xmlns SOQAP EN v httpschemas xmlsns SOAP ENY Headerl gt SOAP ENY Body oy getrypes xmins ox httpalarceweb esri cammvz SOAP E GO AP ENV Body jd5 id id5 saapenc raatz D xsittype nss Keyvalue key xsi typne xsd string 7E key evalue si tipe xsd string Man Ll S Administrative Are fid i a lt idb id id6 soapencorool 0 xsitype z ns5 Keyvalue Iv lil gt In case of a remote file you must use the menu option WSDL SOAP Analyser In case of the edited document you can start the analyser from the first button of the tool bar The analyser fields are e The Li
69. s useful for long transformations Docbook for instance when you want to find out what point the transforma tion has reached The transformation can be resumed after 48 XSLT Debugger H Stop Ends the transformation process Show current Highlights the current execution nodes in both the document and stylesheet files This feature is useful when you lost the current selection context Current step info Shows information about the current node reached by the debugging process The details shown are Icon to show the action entering or leaving node e Node name e Resource file where the node is located Line number inside resource file where the node is located Information View The information view is comprised of two panes that are used to display various types of information that can be used to understand the transformation process For each information type there is a corres ponding tab While running a transformation relevant events are displayed in the various information views This enables the developer to obtain a clear view of the transformation progress Using the Debug controls developers can easily isolate parts of stylesheet therefore they may be understood and modified The information types include for a more detailed discussion on each information type see Understand ing Information Views Left side Information View Classes Context node view e XPath watch view e Breakpoints view Messages v
70. st of Services The list of services defined by the WSDL file The List of Ports The ports for the selected service The List of Operations The list of available operations for the selected service The Action URL This is not editable and it shows the script that serves the operation 64 WSDL Support e The SOAP Action This is not editable and identifies the action performed by the script e The Request Editor It allows you to compose the web service request When an action is selected lt oXygen gt tries to generate as much content as possible for the call skeleton Usually you just have to change few values in order for the request to be valid The tag insight is available for this editor and is driven by the schema that defines the type of the current message The Attachments List You can define a list of file s URLs to be attached to the request e The Response Area It presents the message received from the server in response to the Web Service request It may show also error messages The Errors List There may be situations in which the WSDL file is respecting the WSDL XML Schema but it fails to be valid for example in the case of a message that is defined by means of an element that is not found in the types section of the WSDL In such a case the errors will be listed here This list is presented only when there are errors e The Send Button Executes the request A status dialog is shown when lt oXygen
71. t FO instructions not supported by FOP Memory available to the built in If your FOP transformations fail with an Out of Memory error FOP select from this combo box a larger value for the amount of memory reserved for FOP transformations Configuration file for the built in You should specify here the path to a FOP configuration file ne FOP cessary for example to render to PDF using a special true type font a document containing Unicode content The users can configure the external processors for use with lt oXygen gt in the following dialog Figure 3 12 Configure the external processors 18 Getting Started The command line may contain the following macros method the FOP transformation method S fo the input FO file fout the output file Name The name that will be displayed in the list of available FOP processors on the FOP tab of the Transforming Configuration dialog Description The description of the FO processor displayed in the Preferences gt FO Pro cessors option Working directory The directory in which the intermediate and final results of the processing will be stored Command line The command line that will start the FO processor specific to each pro cessor 19 Getting Started Proxy Configuration Some networks use Proxy servers to provide Internet Services to LAN Clients Clients behind the Proxy may therefore only connect to the Internet via the Proxy Service The Proxy Conf
72. t the 100th space inclusive of white spaces tags and elements This list contains the names of the elements for which the con tained white spaces like blanks tabs and newlines are preserved by the Format and Indent operation exactly as before applying the operation This list contains the names of the elements for which contiguous white spaces like blanks tabs and newlines are merged by the Format and Indent operation into one blank The Tag Insight feature enables inline syntax lookup and Auto Completion of mark up elements and at tributes to streamline mark up and reduce errors while editing Features These settings define the operating mode of the content assistant Figure 3 4 The Tag Insight Features pane 10 Getting Started Workbench Ant Build Order Help Install Update Java JPrafiler osvgen Editor Default xL Proxy Configuration Syntax highlight xML XSL FO Plug in Development Run Debug Team Use Tag Insight Close the inserted element Add element content Add optional content Add first Choice particle Insert the required attributes Insert the fixed attributes Tag Insight Iv Use Tag Insight Use Tag Insight iw Close the inserted element i Add element cantent Add optional content Add First Choice particle Insert the required attributes Insert the Fixed attributes Show all entities Cursor position between tags Learn options W Learn on open docu
73. tall of the editor then it will display automatically the registration dialog when it is started In the case you already used the editor and obtained a new license use the menu option Help Register to make the registration dialog appear Figure 2 1 Registration Dialog oXygen XML Editor License Paste here the license text from the registration email Paste 5 Paste the license text in the registration dialog and press ok Installation Upgrading lt oXygen gt From time to time upgrade and patch versions of lt oXygen gt are released to provide enhancements that rectify problems improve functionality and the general efficiency of the application This section explains the procedure for upgrading lt oXygen gt while preserving any personal configura tion settings and customizations Procedure 2 3 Upgrade Procedure 1 Uninstall the lt oXygen gt plugin see Uninstall procedure 2 Follow the Installation instructions 3 Restart the Eclipse platform 4 Start the lt oXygen gt plugin to ensure that the application can start and that your license is recog nized by the upgrade installation 5 If you are upgrading to a major version for example from 4 2 to 5 0 then you will need to enter the new license text into the registration dialog that is shown when the application starts 6 Select Window gt Preferences gt Plug In Development gt Target Platform and next to the com oxygenxml editor
74. tent that is you can click on th text from the Output document view and the editor will select the XML source context and the XSL element that generated the text Figure 5 3 Output to Source Mapping 51 XSLT Debugger Lo personal xml 23 Fl ESipersenal xsl 3 O zemail oneBoxygenxml dq lt font name verdana s zl ink managers B ig Boz zxal arttr ibute name lt person gt lt i gt lt person id tuo workei lt xsl value of lt name gt se lect namer given text lt family gt Wor lt given gt Tiro lt o z name zemail twol lt link mana z person lt name gt zfamily Workerz famils lt font name verdana s zgiven Threec qgiven cel valu e 5 seglect g lt name gt lt font gt Understanding Information Views Detailed informations about the debugger status are provided using the information views Context node view The context node is a source node corresponding to the XSL expression being evaluated It is also called the context of execution The context node implicitly changes as the processor hits various steps at the point where XPath expressions are evaluated This node has the same value as evaluating dot XPath expression on XPath watch view Figure 5 4 The Context node view 52 XSLT Debugger Watch Ag Context Breakpoints Messages Variables Ol Attributes value id Big Boss contr False Table 5 1 Context node details Column Des
75. ter and cleaner version of HTML XHTML is HTML defined as an XML application All formatting during a transformation is provided under the control of an Extensible Stylesheet XSLT Specifying the appropriate XSLT enables transformation to the above formats and preparation of output files for specific user agent viewing applications including HTML HTML stands for Hyper Text Markup Language and is a W3C Standard http www w3c org MarkUp for the World Wide Web HTML is a text file contain ing small markup tags The markup tags tell the Web browser how to display the page An HTML file must have an htm or html file extension An HTML file can be created using a simple text editor 36 Transforming Documents HTML Help Microsoft HTML Help http msdn microsoft com library default asp url library en us htmlhelp html vsconH H1Start asp frame true is the standard help system for the Windows platform Authors can use HTML Help to create online help for a software application or to create content for a multimedia title or Web site Developers can use the HTML Help API to program a host application or hook up context sensitive help to an application JavaHelp JavaHelp software is a full featured platform independent extensible help system from Sun Microsystems http java sun com products javahelp index html that enables de velopers and authors to incorporate online help in applets components applications op erating systems a
76. trl Shift Execute a XPath query against the current document e XML Add to templates Ctrl Shift A Displays the Add Templates dialog used to define the name by which the template will be recognized in the New from templates option e XML Check spelling Ctrl Shift Q Start checking the spelling of cur rent document XML Tools Menu Table 3 2 XML Tools Menu Options xml tools Window Help Trang converter e XML Tools gt Trang converter Converts the current document to a suppor ted grammar language using the integrated Trang converter Schema documentation e XML Tools gt Schema documentation A tool used to generate HTML doc X Wsdl soap analyser umentation for an XML Schema document e XML Tools gt WSDL SOAP Analyser Contains a SOAP analyser and sender for Web Services Description Language file types The lt oXygen gt toolbar buttons The toolbar buttons added by the lt oXygen gt plugin provide easy access to common and frequently used functions Each icon is a button that acts as a shortcut to a related function Hold the pointer cursor over an icon to display a context label that will give you a hint as to its function Click an icon to use its func tion Figure 3 21 The lt oXygen gt Toolbar Buttons AMUYMXSF OVP ABEA DA Table 3 3 Description of lt oXygen gt Toolbar Buttons 30 Getting Started K XML gt Validate document Ctrl Shift V Executes the Val
77. tting Started Workbench Debugger Ant Build Order Help Inskall Lipdate H Java oaygen XSLT Debugger Editor Proxy Configuration v Infinite loop detection F Syntax highlight AML Maximum depth in templates stack 300 Debugger i FO processors XSLT Options El The following settings are available Infinite loop detection Set this option to receive notifications when an infinite loop oc curs during transformation Maximum depth in templates stack How many templates lt xs1 templates gt instructions can ap pear on the current stack This setting is used by the infinite loop detection FO processors Besides the built in formatting objects processor Apache FOP the user can use other external pro cessors oXygen has implemented an easy way to add XEP as external FO processor if the user has the XEP installed Figure 3 11 The FO processors pane 17 Getting Started FO processors v Enable the output of the built in FOF Memory available to the built in FOP 300 MB Configuration File Far the built in FOP E External FO processors Description MEP FO processor FO Processor from SEP Edit Remove m If you have XEP installed you can add it directly Browse amp Add Enable the output of the built in When checked all FOP output will be displayed in a results pane FOP at the bottom of the editor window including warning messages abou
78. you created the new document lt oXygen gt provides syntax highlight for keywords and all known XQuery functions and operators Also for these there is available a code insight component that can be activated by pressing Ctrl Space keys The functions and operators are presented together with a com ment about parameters and functionallity Figure 7 1 XQuery Tag Insight where exists flink manager and comp Breturn E exists 3 lt person ca gt 10 lt na Fruexists arg as item as xs boolean 11 lt fperson gt 12 Summary IF the value of arg is nat Ehe e 66 XQuery Support XQuery Validation With lt oXygen gt you can validate your documents before using them in your transformation scenarios The validation uses the Saxon 8 1B processor This is conformant to the XQuery Working Draft ht tp www w3 org TR xquery The processor is used in two cases validation of the expression and exe cution Although the execution implies a validation it is faster to syntactically check the expression without executing it The errors that occured in the document are presented in the messages view at the bottom of editor window with a full description message As with all error messages if you click on one entry the line where the error appeared is highlighted Figure 7 2 XQuery Validation for person in doc personal xml personnel perso let link person link where exists link fmanager and comparee 1

Download Pdf Manuals

image

Related Search

Related Contents

MAN 062B - PPA SYS 500  SERVICE MANUAL - Pdfstream.manualsonline.com    Trust 70W Notebook Power Adapter  User's guide - Astromatic.net  RP75819 ZuckerWG LB5 - Lidl Service Website  Corus User Manual  Manual do Utilizador do TruVision NVR 10  HXJ - 取扱説明書  LAMPE SOLAIRE – LAMPARA SOLAR - SOLAR LAMP  

Copyright © All rights reserved.
Failed to retrieve file