Home

XML Author 11.2 User Manual for Eclipse

1. if node getType AuthorNode NODE_TYPE_ELEMENT AuthorElement element AuthorElement node if ref equals element getLocalName AttrValue attrValue element getAttribute location if attrValue null String attrStringVal attrValue getValue ERYIA URL absoluteUrl new URL new URL systemID authorAccess correctURL attrStringVal InputSource inputSource entityResolver resolveEntity null absoluteUrl toString if inputSource null inputSource new InputSource absoluteUrl toString XMLReader xmlReader authorAccess newNonValidatingXMLReader xmlReader setEntityResolver entityResolver saxSource new SAXSource xmlReader inputSource catch MalformedURLException e logger error e e catch SAXException e 197 Author Developer Guide logger error e e catch IOException e logger error e return saxSource The method get Re ferenceUniqueIDshould return an unique identifier for the node reference The unique identi fier is used to avoid resolving the references recursively It takes as argument an AuthorNode that represents the node with the reference In the implementation the unique identifier is the value of the location attribute from the ref element public String getDisplayName AuthorNode node String displayNam ref fragment
2. if node getType AuthorNode NODE_TYPE_ELEMENT AuthorElement element AuthorElement node if ref equals element getLocalName AttrValue attrValue element getAttribute location if attrValue null displayName attrValue getValue return displayName The method getReferenceSystemIDshould return the systemID of the referred content It takes as arguments an AuthorNode that represents the node with the reference and the AuthorAccess with access methods to the Author data model In the implementation you use the value of the location attribute from the ref element and resolve it relatively to the XML base URL of the node public String getReferenceSystemID AuthorNode node AuthorAccess authorAccess String systemID null if node getType AuthorNode NODE_TYPE_ELEMENT AuthorElement element AuthorElement node if ref equals element getLocalName AttrValue attrValue element getAttribute location if attrValue null String attrStringVal attrValue getValue try URL absoluteUrl new URL node getXMLBaseURL authorAccess correctURL attrStringVal systemID absoluteUrl toString catch MalformedURLException e logger error e j3 198 Author Developer Guide return systemID The complete source code of the implementation is found in the Example F
3. The two table information providers are not reused for different tables The methods are called for each table in the document so new instances should be provided every time Read more about the cell span and column width information providers in Configuring a Table Cell Span Provider and Configuring a Table Column Width Provider sections If the functionality related to one of the previous extension point does not need to be modified then the developed ExtensionsBundle should not override the corresponding method and leave the default base implementation to return null Package the compiled class into a jar file Copy the jar file into the frameworks sdf directory Add the jar file to the Author class path 186 Author Developer Guide 6 The complete source code of the SDFExtensionsBundle the Java Files section Register the Java class by clicking on the Extensions tab Press the Choose button and select from the displayed dialog the name of the class SDFExtensionsBundle implementation is found in the Example Files Listings Implementing an Author Extension State Listener The ro sync ecss extensions api AuthorExte when the Author extension where the listener is defined is activated or deactivated in the Document Type detection process import ro sy import ro sy public class AuthorExte Au Au Au private private private nc ecss exte nc ecss exte SDFAuthorEx
4. The lt oXygen gt custom menu When the current editor window contains a document associated with lt oXygen gt a custom menu is added to the Eclipse menu bar named after the document type XML XSL XSD RNG RNC Schematron DTD FO WSDL XQuery HTML CSS 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 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 documents This pane has three different modes of displaying and editing the content of a document available as different tabs at the bottom left margin of the editor panel text editor grid editor CSS based tagless editor Navigating between them is as easy as pressing Ctrl Page Up for switching to the next tab to the left and Ctrl Page Down for switching to the next tab to the right 11 Getting started The Outline view The outline view has the following functions XML document overview outliner filters modification follow up doc ument structure change document tag selection Figure 3 2 The Outline View
5. else throw new AuthorOperationException Cannot find th lement representing the table see ro sync ecss extensions api AuthorTableColumnWidthProvider getCellWidth 37 ro sync ecss extensions api node AuthorElement int int public List lt WidthRepresentation gt getCellWidth AuthorElement cellEl int colSpan List lt WidthRepresentation gt toReturn null int size colWidthSpecs size if size gt colNumberStart amp amp size gt colNumberStart colSpan toReturn new ArrayList lt WidthRepresentation gt colSpan for int i colNumberStart i lt colNumberStart colSpan i Add the column widths toReturn add colWidthSpecs get i return toReturn ment int colNumberStar pk see x ro sync ecss extensions api AuthorTableColumnWidthProvider getTableWidth java lang St public WidthRepresentation getTableWidth String tableCellsTagName WidthRepresentation toReturn null if tableElement null amp amp td equals tableCellsTagName AttrValue widthAttr tableElement getAttribute width if widthAttr null String width widthAttr getValue if width null toReturn new WidthRepresentation width true return toReturn 256 Author Developer Guide pk see ro sync ecss extensions api AuthorTableColumnWidth
6. A detailed presentation of the schema manager filter can be found in Configuring a Content completion handler section The lt oXygen gt Author supports link based navigation between documents and document sections Therefor if the document contains elements defined as links to other elements for example links based on the id attributes the extension should provide the means to find the referred content To do this an implementation of the ro sync ecss extensions api link ElementLocatorProvider interface should be returned by the createElementLocatorProvider method Each time an element pointed by a link needs to be located the method is invoked public ElementLocatorProvider createElementLocatorProvider return new DefaultElementLocatorProvider The section that explains how to implement an element locator provider is Configuring a Link target element finder The drag and drop functionality can be extended by implementing the ro sync exml editor xmledit or pageauthor AuthorDnDListener interface Relevant methods from the listener are invoked when the mouse is dragged moved over or exits the author editor page when the drop action changes and when the drop occurs Each method receives the DropTargetEvent containing information about the drag and drop operation The drag and drop extensions are available on Author page for both lt oXygen gt Eclipse plugin and standalone application The Text page c
7. Important There are a couple of modifications made to the DITA OT framework which will be overwritten if you choose to copy the new DITA OT version over the bundled one The DTD s in the framework have been enriched with documentation for each element If you overwrite you will lose the documentation which is usually shown when hovering an element or in the Model View The IDIOM FO Plugin comes pre installed in the bundled DITA OT framework Several build files from the IDIOM plugin have been modified to allow transformation using the lt oXygen gt Apache Built in FOP libraries and usage of the lt oXygen gt classpath while transforming Increasing the memory for the Ant process You can give custom JVM Arguments to the ANT process See here for more details 102 Author for DITA Resolving topic references through an XML catalog If you customized your map to refer topics using URI s instead of local paths or you have URI content references in your DITA topic files and you want to resolve the URIs with an XML catalog when the DITA map is transformed then you have to add the catalog to lt oXygen gt The DITA Maps Manager view will solve the displayed topic refs through the added XML catalog and also the DITA map transformations for PDF output for XHTML output etc will solve the URI references through the added XML catalog DITA specializations support Integration of a DITA specialization A DITA specialization in
8. 174 Author Developer Guide String map getArgumentValue ARG_SQL int caretPosition authorAccess getCaretOffset try authorAccess insertXMLFragment getFragment jdbcDriver connection user password sql caretPosition catch SQLException e throw new AuthorOperationException The operation failed due to the following database error getMessage e catch ClassNotFoundException e throw new AuthorOperationException The JDBC database driver was not found Tried to load jdbcDriver e The get Fragment method loads the JDBC driver connects to the database and extracts the data The result is a table element from the http www oxygenxml com sample document at ion namespace The header element contains the names of the SQL columns All the text from the XML fragment is escaped This means that the lt and amp characters are replaced with the amp It and amp amp character entities to ensure the fragment is well formed private String getFragment String jdbcDriver String connectionURL String user String password String sql throws SQLException ClassNotFoundException Properties pr new Properties pr put characterEncoding UTF8 pr put useUnicode TRUE pr put user user pr put password password Loads the database driver Class forName jdbcDriver Opens the
9. Connection Name DB2 Connection Data Source DB2 Datasource x Connection details URL idbc db2 10 0 0 16 50000 SAMPLE retrie User db2int2 Password eeeeeee 4 Go to Preferences gt Data Sources In the Connections panel click the New button Enter a unique name for this connection and select one of the previously configured DB2 data sources from the Data Source combo box Fill in the Connection Details URL URL to the installed IBM DB2 engine User User name to access the IBM DB2 database engine Password Password to access the IBM DB2 engine Click OK How to Configure a JDBC ODBC Connection 1 2 Go to Preferences gt Data Sources In the Connections panel click the New button Enter a unique name for this connection and select one of the previously configured Generic JDBC data sources from the Data Source combo box Fill in the Connection Details URL URL to the configured ODBC source User User name to access the configured ODBC source Password Password to access the configured ODBC source Click OK 314 Working with Databases How to Configure a Microsoft SQL Server Connection l 2 4 Go to Preferences gt Data Sources In the Connections panel click the New button Enter a unique name for this connection and select one of the previously configured SQLServer data sources from the Data Source combo box Fill in the Connection Details URL URL to
10. Column widths specifications private List lt WidthRepresentation gt colWidthSpecs new ArrayList lt WidthRepresentation gt j The tabl lement private AuthorElement tableElement see ro sync ecss extensions api AuthorTableColumnWidthProvider commitColumnWidthModificat ro sync ecss extensions api AuthorDocumentController ro sync ecss extensions api WidthRepresentation java lang String XA A A F gt 254 Author Developer Guide public void commitColumnWidthModifications AuthorDocumentController authorDocumentControll WidthRepresentation colWidths String tableCellsTagName throws AuthorOperationException if td equals tableCellsTagName if colWidths null amp amp tableElement null if colsStartOffset gt 0 amp amp colsEndOffset gt 0 amp amp colsStartOffset lt colsEndOffset authorDocumentController delete colsStartOffset colsEndOffset String xmlFragment createXMLFragment colWidths int offset i AuthorElement header tableElement getElementsByLocalName header if header null amp amp header length gt 0 Insert the cols elements before the header element offset header 0 getStartOffset if offset 1 throw new AuthorOperationException No valid offset to insert the columns width specification authorDocumentController insertXMLFragment
11. in documents based on the schema the Content Completion assistant offers the list of values 30 Editing documents Figure 4 10 Content Completion assistant element values in Relax NG documents lt root gt lt enumValues Elem gt k enumvalues Elem gt lt froot gt valuel h value2 h value3 If only one element name must be displayed by the content assistant then the assistant is not displayed any more but this only option is automatically inserted in the document at the current cursor position If the schema for the edited document defines attributes of type ID and IDREF the content assistant will display for IDREF attributes a list of all the ID values already present in the document for an easy insertion of a valid ID value at the cursor position in the document This is available for documents that use DTD XML Schema and Relax NG schema Also values of all the xml id attributes are treated as ID attributes and collected and displayed by the content completion assistant as possible values for anyURI attributes defined in the schema of the edited document This works only for XML Schema and Relax NG schemas For documents that use an XML Schema or Relax NG schema the content assistant offers proposals for attributes and elements values that have as type an enumeration of tokens Also if a default value or a fixed value is defined in the XML Schema used in validation for an attribute or element then that value is
12. Use this option to set the background color of the editor and also of the Diff Files editors Use this option to set the background color for the content completion window Use this option to set the foreground color for the content completion window Use this option to set the background color for the window containing document ation for the content completion elements Use this option to set the foreground color for the window containing document ation for the content completion elements This option will do a soft wrap of long lines that is automatically wrap lines in edited documents When this option is checked line folding will be disabled This option enables highlight for the tag matching the one on which the caret is situated If checked it enables folding when a new editor is opened If Enable folding when opening a new editor is checked you can specify the minimum number of lines for folding If you modify this value you ll notice the changes when you open reopen the editor The Pages preferences panel is opened from menu Window gt Preferences gt oXygen gt Editor gt Pages and allows you to select the initial page for an editor The mode in which a file was edited in the previous session is saved and will be used when the application is restarted and the file reopened 354 Configuring the application Figure 17 7 The lt oXygen gt Pages preferences panel Pages e gt y Allow Docu
13. fragmentBuffer append lt td gt fragmentBuffer append xmlEscape metaData getColumnName 1 fragmentBuffer append lt td gt fragmentBuffer append lt header gt Creates the table content whil resultSet next fragmentBuffer append lt tr gt for int i 1 i lt columnCount i fragmentBuffer append lt td gt fragmentBuffer append xmlEscape resultSet getObject 1 fragmentBuffer append lt td gt fragmentBuffer append lt tr gt fragmentBuffer append lt table gt Cleanup resultSet close statement close connection close return fragmentBuffer toString Some of the values from the database table may contain characters that must be escaped in XML to ensure the fragment is well formed param object The object from the database return The escaped string representation AX A A F KF gt Se private String xmlEscape Object object String str String valueOf object return str replaceAll s amp amp replaceAll lt amp 1lt SDFExtensionsBundle java package simple documentation framework 241 Author Developer Guide B H peo peo feo peo peo peo H H H H H H H H H H H 3333333333333333333 pu port ro sync contentcompletion xml Sche port ro sync ecss extensions api port ro sync ecss extensions
14. Data Source JDBC ODEC Bridge Connection details URL jdbc odbc ODBCTest User Password Name Allows you to name the new connection Data Source Select data source defined in the Data Source Drivers dialog Depending upon the selected Data Source you can set some of the following parameters in the Connection details area URL User Password Host Port XML DB URI Database Collection Environment home directory Verbosity The URL used to connect Provide the database user Provide the database password Provide the host address Provide a port to connect Provide the database URI to connect Provide the initial database Select one of the available collections for the specified data source Specify the home directory for a Berkeley database Set the verbosity level for a Berkeley database Edit Opens the Connection dialog allowing you to edit the selected connection See above the specifications for the Connection dialog Delete Deletes the selected connection Download links for database drivers You can find below the locations where you have to go to get the drivers necessary for accessing databases in lt oXygen gt 401 Configuring the application Berkeley DB XML database IBM DB2 Pure XML database eXist database MarkLogic database Microsoft SQL Server 2005 2008 database Oracle 11g database PostgreSQL 8 3 database RainingData Tig
15. Figure 13 4 The Table Explorer View Hi Table Explorer 3 1 E Eis DEPARTMENT_ID NUMBER DEPARTMENT_NAME VARCHAR2 MANAGER_ID NUMB A CS O A El 1 20 Marketing 201 25 30 Purchasing 114 3 40 Human Resources 203 4 50 Shipping 121 5 60 IT 103 wl n Ruble Nalatian ona J lt gt BONUS DEPT EMP DEPARTMENTS 3 You can sort the content of a table by one of its columns by clicking on its column header Note the following The first column is an index does not belong to the table structure e Every column header contains the field name and its data type The primary key columns are marked with this symbol A 319 Working with Databases e Multiple tables are presented in a tabbed manner For performance issues you can set the maximum number of cells that will be displayed in the Table Explorer view the Limit the number of cells field from the Data Sources Preferences page If a table having more cells than the value set in lt oXygen gt s options is displayed in the Table Explorer view a warning dialog will inform you that the table is only partially shown p gt Note A custom validator cannot be applied on files loaded through an lt oXygen gt custom protocol plugin developed independently and added to lt oXygen gt after installation This applies also on columns of type XML You will be notified if the value you have entered in a cell is not
16. Outline X lt 2 a z T zo m personnel Al person Big Boss name O far Insert before Insert after email Edit attributes link giv email o p n ink Ga I Toggle Comment person or name fy Copy O far Y cut O giv Delete email link Bi amp Expand all 2 0 person ty Collapse All name email two oxygenxml com link Big Boss o email three oxygenxml com link Big Boss Iv E The lt oXygen gt Text view The lt oXygen gt Text view is automatically showed in the views pane of the Eclipse window to display text output from XSLT transformations FO processor s info warning and error messages It contains a tab for each file with text results displayed in the view Figure 3 3 The Text View Text 23 gt Browser Problems Console Results Ax lt sales gt A lt product id 1 gt lt productName gt Wave Runner XLTS00 lt productName gt lt productSpec gt 120 HP 1000 cc lt productSpec gt lt mrq gt 180 lt mrq gt Select All lt ytd gt 18 87 up lt ytd gt Copy lt margin gt 5 lt margin gt lt product gt X Clear lt product id 2 gt om m di ee XQuery xml products xquery 3 XSL xml personal xml XSL xml sales xml The lt oXygen gt Browser view The lt oXygen gt Browser view is automatically showed in the views pane of the Eclipse window to display H
17. family Boss e oe lt person id Big Boss gt ii lt name gt perst lt family gt Boss lt family gt 2 0 n lt given gt Big lt given gt lt name gt given One email one oxygenxml com link Big Boss person two worker person three worker name email three oxygenxml com link Big Boss person four worker person five worker XML Document Overview The Outline view 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 structure and the way tags are nested The Expand all and Collapse all items of the popup menu available on the outline tree enlarge or reduce the set of nodes of the edited document currently visible in the view The tree expansion action is a faster alternative to mouse clicks on the plus signs of the tree when one wants to access quickly a node deeply nested in the hierarchy of document nodes When a large number of nodes become expanded and the document structure is not clear any more the collapsing action clears the view quickly by reducing the depth of the expanded nodes to only one child of the currently selected node Outliner filters Show comments Processing Instruc Show Hide Comments and Processing instructions in the outliner tions Show text Show Hide additional text content for the displayed ele
18. ALL line height normal lt number gt lt length gt lt percentage gt in herit list style image ALL list style position ALL list style type disc circle square decimal lower roman up per roman lower latin upper latin lower alpha upper alpha none inherit lower greek armenian georgian list style list style type inherit list style position II list style image margin right margin left lt margin width gt inherit margin top margin bottom lt margin width gt inherit margin lt margin width gt inherit max height ALL max width lt length gt lt percentage gt none inherit supported for block level and replaced elements e g images tables table cells min height ALL min width lt length gt lt percentage gt inherit supported for block level and replaced elements e g images tables table cells outline color ALL outline style ALL outline width ALL outline ALL overflow ALL padding top padding right padding lt padding width gt inherit bottom padding left padding lt padding width gt inherit position ALL 213 Author Developer Guide Name Supported Values Not Supported Values quotes ALL right ALL table layout auto fixed inherit text align l
19. Defines a top level complex type Complex Type Definitions provide For i Constraining element information items by providing Attribute Declarations governing the appearance and content of attributes Constraining element information item children to be empty or to conform to a specified element only or mixed content model or else constraining the character information item children to conform to a specified simple type definition x The Attributes panel The Attributes panel presents all the possible attributes of the current element and allows to insert attributes in the current element or change the value of the attributes already used in the element The attributes already present in the document are painted with a bold font Clicking on the Value column of a table row will start editing the value of the attribute from the selected row If the possible values of the attribute are specified as list in the schema associated with the edited document the Value column works as a combo box where you can select one of the possible values to be inserted in the document The attributes table is sortable 3 sorting orders being available by clicking on the columns names Thus the table s contents can be sorted in ascending order in descending order or in a custom order where the used attributes are placed at the beginning of the table as they appear in the element followed by the rest of the allowed elements as they are declared in the
20. MSXML 3 0 4 0 MSXML NET NET 1 0 NET 2 0 Note Known problem file paths containing spaces are not handled correctly in the LIBXML processor For example the built in XML catalog files of the predefined document types DocBook TEI DITA etc are not handled by LIBXML if lt oXygen gt is installed in the default location on Windows C Program Files be cause the built in XML catalog files are stored in the frameworks subdirectory of the installation directory which in this case contains at least a space character MSXML 3 0 4 0 http msdn microsoft com xml is available only on Windows 2000 Windows NT and Windows XP platforms It can be used for transformation lt oXygen gt use the Microsoft XML parser through its command line tool msxsl exe http msdn microsoft com library default asp url library en us dnxml html msxs asp Because msxsl exe is only a wrapper Microsoft Core XML Services MSXML must be installed on the computer otherwise you get an corresponding warning You can get the latest Microsoft XML parser from Microsoft web site http www microsoft com down loads details aspx FamilyId 3 144B72B B4F2 46DA B4B6 C5D7485F2B42 amp display lang en http www microsoft com downloads details aspx FamilyId 3144B72B B4F2 46DA B4B6 C5D7485F2B424displaylang en MSXML NET http msdn microsoft com xml is available only on Windows NT4 Windows 2000 and Windows XP platforms It can be used for transformation
21. Selecting the Rename current prefix in all document option the application will apply the change on the entire document To apply the action also inside attribute values one must check the Rename also attribute values that start with the same prefix checkbox context menu of current editor XML Refactoring Split element 2 Split the element from the caret position in two identical elements The caret must be inside the element context menu of current editor XML Refactoring Join elements 5 Cmd Alt F on Mac OS Joins the left and the right elements relative to the current caret position The elements must have the same name attributes and attributes values context menu of current editor XML Refactoring Delete element tags 2 Alt Shift Cmd Alt on Mac OS Deletes the start tag and end tag of the current element 59 Editing documents Smart editing Closing tag auto expansion If you want to insert content into an auto closing tag like lt tag gt deleting the character saves some keystrokes by inserting a separate closing tag automatically and placing the cursor between the start and end tags lt tag gt lt tag gt Auto rename matching tag When you edit the name of the start tag lt oXygen gt will mirror edit the name of the matching end tag This feature can be controlled from the Content Com pletion option page Auto breaking the edited line The Hard line wrap option breaks the edited line automatically whe
22. The default catalog is stored in frameworksDir docbook 5 0 catalog xml Transformation Scenarios The following default transformation scenarios are available DocBook HTML transforms a DocBook document into HTML document e DocBook PDF transforms a DocBook document into a PDF document using the Apache FOP engine e DocBook HTML chunk transforms a DocBook document in multiple HTML documents The DocBook Targetset document type This document type is provided to edit or create a targetset file which is used to resolve cross references with olinks 112 Predefined document types Association rules A file is considered to be a DocBook Targetset document when the root name is targetset Schema DocBook Targetset documents use a DTD and schema located in frameworks docbook xsl common targetdatabase dtd where frameworks is a subdirectory of the lt oXygen gt install directory Author extensions Templates A default template is available for DocBook Targetset It is stored in frameworksDir docbook templates Targetset folder and can be used for easily creating a targetset This template is available when creating new documents from templates Docbook Targetset Map New Targetset Map The DITA Topics document type The Darwin Information Typing Architecture DITA is an XML based architecture for authoring producing and delivering technical information It divides content into small self con
23. append width width getWidthRepresentation null amp amp ns length gt 0 append xmlns ns t append gt return fragment toString Exception No valid offset to insert the columns width speci offset widthRepresentations URB 202 Author Developer Guide The following three methods are used to determine what type of column width specifications the table column width provider support In our case all types of specifications are allowed public boolean isAcceptingFixedColumnWidths String tableCellsTagName return true public boolean isAcceptingPercentageColumnWidths String tableCellsTagName return true public boolean isAcceptingProportionalColumnWidths String tableCellsTagName return true The complete source code of the implementation is found in the Example Files Listings the Java Files section In the listing below the XML document contains the table element lt table width 300 gt lt customcol width 50 0px gt lt customcol width 1 gt lt customcol width 2 gt lt customcol width 20 gt lt header gt lt td gt Cl lt td gt lt td gt C2 lt td gt lt td gt C3 lt td gt lt td gt C4 lt td gt lt header gt lt tr gt td gt cs 1 rs 1 lt td gt td gt cs 1 rs 1 lt td gt td row_span 2 gt cs 1 rs 2 lt td gt td row_span 3 gt cs 1 rs 3 lt td gt lt td gt cs 1 rs
24. private Stack currentElementIndexStack new Stack The number of elements in xpointer path wr private int xpointerPathDepth If true then the XPointer path starts with an element ID 264 Author Developer Guide ay private boolean startWithElementID false The depth of the current element in document AS private int startElementDepth 0 Depth in document in the last endElement event e private int endElementDepth 0 pk lement Set in nal incremented in startElement The index in parent of the previous iterated xl private int lastIndexInParent Element pk Constructor param idVerifier Verifies if an given attribute is of type ID param link The link that gives the element position throws ElementLocatorException When the link format is not supported xx public XPointerElementLocator IDTypeVerifier idVerifier String link throws ElementLocatorException super link this idVerifier idVerifier link link substring element length link length 1 StringTokenizer stringTokenizer new StringTokenizer link xpointerPath new String stringTokenizer countTokens int i 0 while stringTokenizer hasMoreTokens xpointerPath i stringTokenizer nextToken boolean invalidFormat false Empty xpointer compone
25. t characterFragment nException e return handleTyping Exception e getMessage Invalid typing event e getMessa Implementing the AuthorSchemaAwareEditingHandler gives the possibility to handle other events like the keyboard delete event at the given offset using Delete or Backspace keys delete element tags delete selection join elements or paste fragment The complete source code of the implementation is found in the Example Files Listings the Java Files section Configuring a Content c ompletion handler You can filter or contribute to items offered for content completion by implementing the ro sync contentcom pletion xml SchemaManagerFilter interface import java util List import ro sync contentcompletion xml CIAttribute import ro sync contentcompletion xml CIElement import ro sync contentcompletion xml CIValue import ro sync contentcompletion xml Context import ro sync contentcompletion xml SchemaManagerFilter import ro sync contentcompletion xml WhatAttributesCanGoHereContext import ro sync contentcompletion xml WhatElementsCanGoHereContext import ro sync contentcompletion xml WhatPossibleValuesHasAttributeContext public class SDFSchemaManagerFilter implements SchemaManagerFilter 189 t String valueo0f characterF Author Developer Guide You can implement the various callbacks of
26. thorListener thorMouseLis thorCaretLis nsions api Author tensionStateListe nsionStateListener sdfAuthorDocumen tener sdfMouseLis nsionStateListener implementation is notified nsions api AuthorAccess ExtensionStatelistener ner implements tListener tener tener sdfCaretLis tener private OptionListener sdfOptionListener The activation event received by this listener when the rules of the Document Type Association match a document opened in the Author editor page should be used to perform custom initializations and to register listeners like ro sync ecss extensions api AuthorListener thorMouseListener orro sync ecss extensions api AuthorCaretListener ro sync ecss extensions api Au public void activated AuthorAccess authorAccess Get the value of the option String option authorAccess getOptionsStorage getOption sdf custom option key Use the option for some initializations Add an option listener authorAccess getOptionsStorage addOptionListener sdfOptionListener Add author document listeners sdfAuthorDocumentListener new SDFAuthorListener authorAccess getDocumentController addAuthorListener sdfAuthorDocumentListener Add mouse listener sdfMouseListener new SDFAuthorMouseListener authorAccess getEditorAccess addAuthorMouseListener sdfMouseListener Add caret listener sdfCaretListener
27. 350 Configuring the application Fonts The Fonts preferences panel is opened from menu Window gt Preferences gt Author Fonts Figure 17 4 The Fonts preferences panel Fonts IE v Text Map to text font O Customize Courier New 10 Author Author default font Times New Roman 14 This is a text sample Schema Schema default Font SansSerif 11 This is a text sample Restore Defaults Apply Text Use this section to customize the font used in text based editors There are two options e Map to text font the font used is the same as the one set in General Appearance Colors and Fonts for the basic text editor e Customize allows you to choose a specific font Author Allows you to specify a font to be used in the Author mode Document Type Association The Document Type Association preferences panel is opened from menu Window gt Preferences gt Author Document Type Association 351 Configuring the application Figure 17 5 Document Type Association preferences panel Document Type Association so PO Change frameworks Document Type Associations directory location User role Developer x Document type Enabled Storage Namespace Root local name Filename PublicID DITA Y External DITA Map Y External DITAVAL Y External F 4 DocBook 4 Y External Rule book k Rule article a Rule x OASIS Rule chapter y gt b DocBook 5 A External Docbook Targetse
28. Au thor XML XSLT FO XQuery XSLT MSXML NET Figure 17 44 The MSXML NET preferences panel MSXML NET qi V Enable XInclude processing Validate documents during parse phase 7 Do not resolve external definitions during parse phase Strip non significant whitespaces Show time information Forces ASCII output encoding F Allow multiple output documents Use named URI resolver class Assembly Filename for URI resolver class Be Assembly GAC name For URI resolver class E X OC List of extension object class name PO Use specified EXSLT assembly PO Credential loading source xml Credential loading stylesheet PO The options of the MSXML NET processor are the same as the ones available in the command line for the MSXML NET processor http www xmllab net Products nxslt tabid 62 Default aspx Enable XInclude processing If checked XInclude references will be resolved when MSXML NET is used as transformer in the transformation scenario Validate documents during parse If checked and either the source or style sheet document has a DTD or schema phase against which its content should be checked validation is performed Do not resolve external definitions By default MSXML NET resolves external definitions such as DTD external during parse phase subsets or external entity references when parsing source XML document and stylesheet document Using this option you can disable this behaviour Note that it may affect also t
29. Chapter 11 Querying documents Running XPath expressions What is XPath XPath is a language for addressing specific parts of an XML document XPath like the Document Object Model DOM models an XML document as a tree of nodes An XPath expression is a mechanism for navigating through and selecting nodes from the XML document An XPath expression is in a way analogous to a Structured Query Language SQL query used to select records from a database XPath models an XML document as a tree of nodes There are different types of nodes including element nodes at tribute nodes and text nodes XPath defines a way to compute a string value for each type of node XPath defines a library of standard functions for working with strings numbers and Boolean expressions Examples child Select all children of the root node mame Select all elements having the name name descendants of the current node catalog cd price gt 10 80 Selects all the cd elements that have a price element with a value larger than 10 80 To find out more about XPath the following URL is recommended http www w3 org TR xpath lt oXygen gt s XPath console To use XPath effectively requires at least an understanding of the XPath Core Function Library http www w3 org TR xpath corelib If you have this knowledge the lt oXygen gt XPath expression field part of the current editor toolbar can be used to aid you in XML document development In lt oXygen gt
30. E bibliolist E biblioref E blockquote E calloutlist E caution E citation E citerefentry fad Caret Before After Presents a list of all defined elements that you can insert in your document All elements from a sequence are presented but the invalid proposals which cannot be inserted in the current context are grayed out The upper part of the view features a combo box that contains the current element s ordered ancestors Selecting a new element in this combo box will update the list of the allowed elements in Before and After tabs Three tabs present information relative to the caret location e Caret shows a list of all the elements allowed at the current caret location Double clicking any of the listed elements will insert that element at the caret position e Before shows a list of all elements that can be inserted before the element selected in the combo box Double clicking any of the listed elements will insert that element before the element at the caret position e After shows a list of all elements that can be inserted after the element selected in the combo box Double clicking any of the listed elements will insert that element after the element at the caret position Double clicking an element name in the list surrounds the current selection in the editor panel with the start tags and end tags of the element If there is no selection just an empty element is inserted in the edito
31. Family gi iven Famil personal xml fog personal xsd 2s lt family gt Boss lt family gt fe personal xsl TA Sct LA novconal erhan wml 8 lt email gt chiefloxygenxml com lt email gt ate Model view 3 Attributes view 9 lt link subordinates one worker two worker three worker four worke 10 lt person gt SES 11 lt person id one worker gt e lt name 12 lt name gt Content element only 13 lt family gt Worker lt family gt 14 lt given gt One lt given gt 15 lt name gt odet Family given given Family 16 lt email gt onefoxygenxml com lt email gt 17 lt link manager Big Boss gt pp the person Family and given name 18 lt person gt 19 lt person id two worker gt PE out gt 20 lt name gt pun 21 lt family gt Worker lt family gt v l l SES lt Di personnel A en aes E 0 person Big Boss 111 AAs XPath ES Text Results WSDL SOAP analyser Problems Schema Components Editor properties XSLT Input j name ipersonnel 1 person 1 id Big Boss contr false family Boss ele pate oe oe corir fake e I chi k personnel 1 person 3 id two worker contr false e ag Baraca E th personnel 1 person 4 id three worker contr false IK ONE worker two worker three wt 11 personnel 1 person 5 id four worker contr false fal 2 neon ane marker personnel 1 person 6 id five worker contr false i XPath successful U 0061 Writable Insert Bi dd
32. Iris topic topic 1 lt p id iris para gt lt b gt p iris para href conc image image id 200 300 species o Use topic use takes its name fr to the vide varie many species As is also very vide to all lt b gt Iris lt b closely related g for irises is lt b gt widely known as lt Conref topic 1firis para Conrefend In the URL chooser you can choose the file from which you want to reuse content Depending on the Target type filter you will see a tree of elements which can be referred which have id s For each element the XML content is shown in the preview area The Conref value is computed automatically for the selected tree element After pressing OK an element with the same name as the target element and having the attribute conref with the value specified in the Conref value field will be inserted at caret position According to the DITA 1 2 specification the conre fend attribute can be used to specify content reference ranges This is a very useful feature when referencing multiple consecutive steps or list items If you use multiple contiguous sibling selection the conrefend value will also be set to the value of the last selected ID path Oxygen will present the entire referenced range as read only content 42 Insert Content Key Reference inserts a content key reference at the caret position As stated in the DITA 1 2 specification the conkeyre f attribute provides a mechanism for reuse of
33. Press the Add button from the Rules section Using the newly displayed dialog you add a new rule that matches documents with the root from the namespace http www oxy genxml com sample documentation The root name file name or PublicID are not relevant A document matches a rule when it fulfills the conditions imposed by each field of the rule 154 Author Developer Guide Java API Rules implemented in Java Namespace Root local name File name Public ID Java class the namespace of the root element declared in the XML documents of the current document type A value of ANY_VALUE matches any namespace in an XML document Value may contain wildcards and editor vari ables Multiple values separated by comma are accepted The local name of the root element of the XML documents of the current document type A value of ANY_VALUE matches any local name of the root element Value may contain wildcards and editor variables Multiple values separated by comma are accepted The file name of the XML documents of the current document type A value of ANY_VALUE matches any file name Value may contain wild cards and editor variables Multiple values separated by comma are accepted The public ID of the XML documents of the current document type for a document validated against a DTD A value of ANY_VALUE matches any public ID Value may contain wildcards and editor variables Multiple valu
34. attr targetdoc Display Tag Markers lt oXygen gt Author allows you to choose whether tag markers of an element should never be presented or the current Display mode should be respected This is especially useful when working with before and after pseudo elements in which case the element range is already visually defined so the tag markers are redundant The property is named display tags Its possible values are e none Tags markers must not be presented regardless of the current Display mode e default The tag markers will be created depending on the current Display mode e inherit The value of the property is inherited from an ancestor element display tags Value none default inherit Initial default Applies to all nodes comments elements CDATA etc Inherited false Media all Note display tags is anon standard property and is recognized only by lt oXygen gt Author 222 Author Developer Guide Example 8 10 Docbook Para elements In this example the para element from Docbook is using an before and after element so you don t want its tag markers to be visible para beforel content 1 para after content para display tags none display block margin 0 5em 0 lt oXygen gt Custom CSS functions In lt oXygen gt Author there are implemented a few lt oXygen gt specific custom CSS functions Imbricated custom functions are also supported
35. bundled with lt oXygen gt XML Author links are marked with an icon representing a chain link 4 When hovering with the mouse pointer over the marker the mouse pointer will change to indicate that the link can be followed and a tooltip will present the destination location Clicking on a followable link will result in the referred resource being opened in an editor The same effect can be obtained by using the action Open file at caret when the caret is in a fol lowable link element To position the cursor at the beginning or at the end of the document you can use Ctrl Home and Ctrl End respectively Displaying the markup In Author view the amount of displayed markup can be controlled using the following dedicated actions il Full Tags with Attributes displays full name tags with attributes for both block level as well as in line level elements Full Tags displays full name tags without attributes for both block level as well as in line level elements gt Block Tags displays full name tags for block level elements and simple tags without names for in line level elements gt Inline Tags displays full name tags for in line level elements while block level elements are not displayed gt 4 Partial Tags displays simple tags without names for in line level elements while block level elements are not displayed No Tags none of the tags is displayed This is the most compact mode The default tags display mode
36. lt oXygen gt performs XSLT transformations and validations using NET Framework s XSLT implementation System Xml Xsl XsITransform class through the nxslt http www tkachenko com dotnet nxslt html command line utility The nxslt version included in lt oXygen gt is 1 6 You should have the NET Framework version 1 0 already installed on your system oth erwise you get this warning MSXML NET requires NET Framework version 1 0 to be installed Exit code 128 You can get the NET Framework version 1 0 from Microsoft web site http www mi crosoft com downloads details aspx FamilyID d7158dee a83f 4e21 b05a 009d06457787 amp displaylang en http www microsoft com downloads details aspx FamilyID d7 158dee a83f 4e2 1 b05a 009d06457787 amp displaylang en A transformer based on the System Xml 1 0 library available in the NET 1 0 and NET 1 1 frameworks from Microsoft http msdn microsoft com xml It is available only on Windows You should have the NET Framework version 1 0 or 1 1 already installed on your system otherwise you get this warning MSXML NET requires INET Framework version 1 0 to be installed Exit code 128 You can get the NET Framework version 1 0 from Microsoft web site http www mi crosoft com downloads details aspx FamilyID d7158dee a83f 4e21 b05a 009d06457787 amp displaylang en http www microsoft com downloads details aspx FamilyID d7 158dee a83f 4e2 1 b05a 009d06457787 amp displaylang en A transfo
37. lt td gt The lt i gt generate id lt i gt function returns a string that uniquely identifies the node in the argument node set that is first in document order lt td gt lt tr gt lt table gt lt section gt lt section gt lt section gt lt title gt Documentation frameworks lt title gt lt para gt One of the most important documentation frameworks is Docbook lt para gt lt image href http www xmlhack com images docbook gif gt lt para gt The other is the topic oriented DITA promoted by OASIS lt para gt lt image href http www oasis open org images standards oasis_standard jpg gt lt section gt lt book gt XSL Files sdf xsl lt xml version 1 0 encoding UTF 8 gt lt xsl stylesheet xmlns xsl http www w3 org 1999 XSL Transform version 2 0 232 Author Developer Guide xpath default namespace http www oxygenxml com sample documentation gt lt xsl template match gt lt html gt lt xsl apply templates gt lt html gt lt xsl template gt lt xsl template match section gt lt xsl apply templates gt lt xsl template gt lt xsl template match image gt lt img src href gt lt xsl template gt lt xsl template match para gt lt p gt lt xsl apply templates gt lt p gt lt xsl template gt lt xsl template match abs def xmlns abs http www oxygenxml com sample documentation abstracts gt
38. lt xs complexType name paragraphType mixed true gt lt xs choice minOccurs 0 maxOccurs unbounded gt lt xs element name b gt lt xs element name i gt lt xs choice gt lt xs complexType gt The image element has an attribute with a reference to the file containing image data lt xs element name image gt lt xs complexType gt lt xs attribute name href type xs anyURI use required gt lt xs complexType gt lt xs element gt The table contains a header row and then a sequence of rows t r elements each of them containing the cells Each cell has the same content as the paragraphs lt xs element name table gt lt xs complexType gt lt xs sequence gt 143 Author Developer Guide lt xs element name header gt lt xs complexType gt lt xs sequence gt lt xs element name td maxOccurs unbounded type doc paragraphType gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name tr maxOccurs unbounded gt lt xs complexType gt lt xs sequence gt lt xs element name td type doc tdType maxOccurs unbounded gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs complexType name tdType gt lt xs complexContent gt lt xs extension base doc paragraphType gt lt xs attribute name row_span type xs integer gt lt xs attribute name colum
39. lt xs element name customcol maxOccurs unbounded gt lt xs complexType gt lt xs attribute name width type xs string gt lt xs complexType gt lt xs element gt lt xs element name header gt lt xs complexType gt lt xs sequence gt lt xs element name td maxOccurs unbounded type doc paragraphType gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name tr maxOccurs unbounded gt lt xs complexType gt lt xs sequence gt lt xs element name td type doc tdType maxOccurs unbounded gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs sequence gt lt xs attribute name width type xs string gt lt xs complexType gt 227 Author Developer Guide lt xs element gt lt xs complexType name tdType gt lt xs complexContent gt lt xs extension base doc paragraphType gt lt xs attribute name row_span type xs integer gt lt xs attribute name column_span type xs integer gt lt xs extension gt lt xs complexContent gt lt xs complexType gt lt xs schema gt abs xsd lt xml version 1 0 encoding UTF 8 gt lt xs schema xmlns xs http www w3 org 2001 XMLSchema targetNamespace http www oxygenxml com sample documentation abstracts gt lt xs element name def type xs string gt lt xs schema gt CSS Files sdf css Element from another namespace namespace abs
40. new ArgumentDescriptor ARG_JDBC_DRIVER ArgumentDescriptor TYPE_STRING The name of the Java class that is the JDBC driver new ArgumentDescriptor ARG_CONNECTION ArgumentDescriptor TYPE_STRING The database URL connection string new ArgumentDescriptor ARG_USER ArgumentDescriptor TYPE_STRING The name of the database user new ArgumentDescriptor ARG_PASSWORD ArgumentDescriptor TYPE_STRING The database password new ArgumentDescriptor ARG_SQL ArgumentDescriptor TYPE_STRING The SQL statement to be executed y return args These names types and descriptions will be listed in the Arguments table when the operation is configured When the operation is invoked the implementation of the doOperat ion method extracts the arguments forwards them to the method that connects to the database and generates the XML fragment The XML fragment is then inserted at the caret position public void doOperation AuthorAccess authorAccess ArgumentsMap map throws IllegalArgumentException AuthorOperationException Collects the arguments String jdbcDriver String map getArgumentValue ARG_JDBC_DRIVER String connection String map getArgumentValue ARG_CONNECTION String user String map getArgumentValue ARG_USER String password String map getArgumentValue ARG_PASSWORD String sql
41. www oxygenxml com doc ug oxygenEclipse native xml database support htmifconfigure exist datasource The eXist database server versions supported by lt oXygen gt are 1 0 1 1 1 2 2 1 2 4 1 2 5 1 3 and 1 4 1 Goto Preferences gt Data Sources In the Data Sources panel click the New button 2 Enter a unique name for this data source and select eXist from the driver type combo box 3 Press the Add button to add the following eXist specific files which are located in the eXist installation root dir ectory e exist jar lib core xmldb jar lib core xmlrpc client 3 1 1 jar lib core xmlrpc common 3 1 1 jar lib core ws commons util 1 0 2 jar 4 Click OK to finish the data source configuration How to configure a MarkLogic datasource The latest instructions on how to configure MarkLogic support in lt oXygen gt can be found on our website http www oxygenxml com doc ug ox y genEclipse native xm database support html configure marklogic datasource 1 Goto Preferences gt Data Sources In the Data Sources panel click the New button 2 Enter a unique name for this data source and select MarkLogic from the driver type combo box 3 Add the following MarkLogic specific file xcc jar In the Download links for database drivers section there are listed the URLs from where to download the drivers necessary for accessing MarkLogic databases in lt oXygen gt 4 Click OK to finish the data source configuration How t
42. 2 0 functions in the attributes path select context subject test depending on the Schematron options that are set in Preferences If the Saxon 6 5 namespace xmIns saxon http icl com saxon or the Saxon 9 namespace is declared in the Schematron schema xmlIns saxon http saxon sf net the content completion displays also the XSLT Saxon extension functions as in the following figure 31 Editing documents Figure 4 11 XSLT extension functions in Schematron schemas documents lt sch rule context t Type Doubles p gt lt sch assert test t P fiyroot arg A saxon column number node as node as xs integer you re playing doubles fo root a F This function returns the column number of a selected divisible by 2 lt sch a foround arg fo round half to even arg within the XML document or external entity that conta lt sch assert test t P fo round half to even arg precision If the argument is supplied it must be a node if the ar tiTeams nbrTeams fo saxon base6 4Binary to ocketsf in is omitted the context item is used in which case the q a f h A item must be a node If line and column numbers are nd of participants must e saxon base64Binary to string fin encoding maintained for the current document the Function ret lt sch rule gt lt sch rule context t Parti To ensure that line and column numbers are maintained pea ciar fo saxon compile query query I letter ell
43. Allow formatting embedded CSS If checked the CSS content embedded in XML will be formated when the XML content is formated JavaScript The JavaScript Format preferences panel is opened from menu Window Preferences gt Author Editor Format JavaS cript Figure 17 17 The JavaScript Format preferences panel JavaScript C Start curly brace on new line Preserve empty lines Allow formating embedded JavaScript Start curly brace on new line If true opening curly braces will start on a new line Preserve empty lines If true empty lines in the JavaScript code will be preserved Allow formatting embedded JavaS If checked the JavaScript content embedded in XML will be formated when cript the XML content is formated Content Completion The Content Completion feature enables inline syntax lookup and Auto Completion of mark up elements and attributes to streamline mark up and reduce errors while editing These settings define the operating mode of the content assistant The Content Completion preferences panel is opened from menu Window Preferences gt Author Editor Content Completion 368 Configuring the application Figure 17 18 The Content Completion preferences panel Content Completion Auto close the last opened tag Automatically rename matching tag Use content completion Use content completion Recently used entries Show recently used items Close the inserted element Case sensitiv
44. Authoring in the tagless editor Manage Tracked Changes This is a way to find and manage all changes in the current document Figure 5 26 Manage Tracked Changes Manage Tracked Changes Description Inserted by marius Mon Nov 30 10 20 23 EET 2009 Made some small modifications to the description Previous Accept All Reject All The dialog offers the following actions Next Find the next change in the document Previous Find the previous change in the document Accept Accept the current change Reject Reject the current change Accept All Accept all changes in the document Reject All Reject all changes in the document The dialog is not modal and it is reconfigured after switching between the dialog and one of the opened editors 84 Chapter 6 Author for DITA Creating DITA maps and topics The basic building block for DITA information is the DITA topic DITA provides the following topic types e Concept For general conceptual information such as a description of a product or feature e Task For procedural information such as how to use a dialog e Reference For reference information You can organize topics into a DITA map or bookmap A map is a hierarchy of topics A bookmap supports also book divisions such as chapters and book lists such as indexes Maps do not contain the content of topics but only references to them These are known as topic references Usually the maps and bookmaps are sav
45. Build target Additional arguments Ant Home O Custom Java Home O Custom Default D workspace exXmlttools ant Default C Program Files Javaljdk1 6 0_10 jre JVM Arguments Xmx256m Libraries 4 You have several parameters that you can specify here Custom build file Build target Additional arguments Ant Home Java Home JVM Arguments If you use a custom DITA OT build file you can specify the path to the customized build file If empty the build xml file from the dita dir directory configured in the Parameters tab will be used You can specify a build target to the build file By default no target is necessary and the default init target is used You can specify additional command line arguments to be passed to the ANT trans formation like verbose You can specify a custom ANT installation to run the DITA Map transformation By default it is the ANT installation bundled with lt oXygen gt You can specify a custom Java Virtual Machine to run the ANT transformation By default it is the Java Virtual Machine used by lt oXygen gt This parameter allows you to set specific parameters to the Java Virtual Machine used by ANT By default it is set to Xmx2 56m which means the transformation process is allowed to use 256 megabytes of memory 98 Author for DITA Libraries The Output tab Example 6 1 Increasing the memory for the ANT process Sometimes when perf
46. C Sort attributes Preserve line breaks in attributes _ Add space before slash in empty elements C Break line before attribute s name Indent inline elements Preserve space elements Default space elements Mixed content elements xsl text address literallayout programlisting screen synopsis pre xd pre codeblock menblario Remove Remove Remove Schema aware Format and indent Indent Indent when typing in preserve space elements Indent on paste sections with number of lines less than 300 Preserve empty lines When checked the Format and Indent operation will preserve all empty lines found in the document on which the pretty print operation os applied Preserve text as it is If checked the Format and Indent Pretty Print function will preserve text nodes as they are without removing or adding any whitespace Preserve line breaks in attributes If checked the Format and Indent Pretty Print function will preserve the line breaks found in attributes When this option is checked Break long lines option will be disabled Break long attributes If checked the Format and Indent Pretty Print function will break long at tributes Indent inline elements If checked the inline elements will be broken and indented on separate lines if there are whitespace to the left and they follow another element start or end tag Expand empty elements When checked the Format and Indent oper
47. Configuring an Extensions Bundle Starting with lt oXygen gt 10 3 version a single bundle was introduced acting as a provider for all other extensions The individual extensions can still be set and if present they take precedence over the single provider but this practice is being discouraged and the single provider should be used instead The extensions bundle is represented by the ro sync ecss extensions api ExtensionsBundle class The provided implementation of the ExtensionsBundle is instantiated when the rules of the Document Type As sociation defined for the custom framework match a document opened in the editor Therefor references to objects which need to be persistent throughout the application running session must not be kept in the bundle because the next detection event can result in creating another ExtensionsBundle instance l Create a new Java project in your IDE Create the 1 ib directory in the Java project directory and copy in it the oxygen jar file from the oXygen_in stallation_directory lib directory Create the class simple documentation framework SDFExtensionsBundle which must extend the abstract class ro sync ecss extensions api ExtensionsBundle public class SDFExtensionsBundle extends ExtensionsBundle A Document Type ID and a short description should be defined first by implementing the methods get Docu ment TypeID and getDescription The Document Type ID is used to
48. Documents 20and 20S5ettings bogdan Application 20Data com oxygenxml File C Documents gt 20and 20Settings bogdan Application 20Data com oxygenxml lt E Drivers found 3 311 Working with Databases 3 4 Press the Add button to add the following IBM DB2 specific files e db2jcc jar e db2jcc_license_cisuz jar e db2jcc_license_cu jar In the Download links for database drivers section there are listed the URLs from where to download the drivers necessary for accessing IBM DB2 databases in lt oXygen gt You can manually manage the Driver Files using Add Remove Detect and Stop detection buttons Select the most suited Driver class Click OK to finish the data source configuration How to configure a Generic JDBC Data Source lt oXygen gt s default configuration already contains a generic JDBC data source called JDBC ODBC Bridge 1 2 3 4 Go to Preferences gt Data Sources In the Data Sources panel click the New button Enter a unique name for this data source and select Generic JDBC from the driver type combo box Click the Add button and find the driver file on your file system You can manage the Driver Files using Add Remove Detect and Stop detection buttons Select the most suited Driver class Click OK to finish the data source configuration How to configure a Microsoft SQL Server Data Source 1 2 4 ay Go to Preferences gt
49. Eclipse should display an entry com oxygenxml author 11 1 0 in the list available from Window Preferences Plug in Development Target Platform Procedure 2 4 Eclipse 3 4 plugin installation the zip archive method 1 Download http www oxygenxml com download html the zip archive with the plugin 2 Unzip the downloaded zip archive in the dropins subdirectory of the Eclipse install directory 3 Restart Eclipse Eclipse should display an entry com oxygenxml author 11 1 0 in the list available from Window gt Preferences gt Plug in Development gt Target Platform Starting lt oXygen gt XML Author plugin The lt oXygen gt XML Author 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 associated with lt oXygen gt or when accessing the lt oXygen gt Preferences Obtaining and registering a license key The lt oXygen gt XML Author 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 http www oxygenxml com register html web site This license is supplied at no cost for a period of 30 days from date of issue During this period the lt oXygen gt XML Author is fully functional enabling you to test all aspects of the application Thereafter the
50. For each change the author name and the modification time are preserved The changes are stored in the document as processing instructions and they do not interfere with validating and transforming it Managing changes You can review the changes made by you or other authors and then accept or reject them using the Track Changes A vy xy Y toolbar buttons ESPA or the similar actions from the Edit menu Track Changes Enable or disable track changes for the current document Accept Change s Accept the change located at the caret position or if a selection is available accept changes in the entire selected range For an insert change this means keeping the inserted text and for a delete change this means removing the content from the document The action is also available in the Author page contextual menu Reject Change s Reject the change located at the caret position or if a selection is available reject changes in the entire selected range For an insert change this means removing the inserted text and for a delete change this preserving the original content from the document The action is also available in the Author page contextual menu Comment Change You can decide to add additional comments to an already existing change The additional description will appear on the tooltip when hovering the change and in the Manage Tracked Changes dialog when navigating changes The action is also available in the Author page contextual menu 83
51. Grid or Author Both approaches will be discussed in the following sections Simple Customization Tutorial XML Schema Let s consider the following XML Schema test_report xsd defining a report with results of a testing session The report consists of a title few lines describing the test suite that was run and a list of test results each with a name and a boolean value indicating if the test passed or failed lt xml version 1 0 encoding UTF 8 gt lt XS schema xmlns xs http www w3 org 2001 XMLSchema gt lt xs element name report gt lt xs complexType gt lt xs sequence gt lt xs element ref title gt lt xs element ref description gt lt xs element ref results gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name title type xs string gt lt xs element name description gt lt xs complexType gt lt xs sequence maxOccurs unbounded gt lt xs element name line gt lt xs complexType mixed true gt lt xs sequence minOccurs 0 maxOccurs unbounded gt lt xs element name important type xs string gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name results gt lt xs complexType gt lt xs sequence maxOccurs unbounded gt lt xs element name entry gt lt xs complexType gt lt xs sequence gt lt xs element name t
52. Large Documents Let s consider the case of documenting a large project It is likely to be several people involved The resulting document can be few megabytes in size How to deal with this amount of data in such a way the work parallelism would not be affected Fortunately XML provides a solution for this It can be created a master document with references to the other document parts containing the document sections The users can edit individually the sections then apply FOP or XSLT over the master and obtain the result files let say PDF or HTML Two conditions must be fulfilled e The master should declare the DTD to be used and the external entities the sections A sample document is lt xml version 1 0 encoding UTF 8 gt lt DOCTYPE book SYSTEM xml docbookx dtd lt ENTITY testing SYSTEM testing xml gt gt lt book gt lt chapter gt At a certain point in the master document there can be inserted the section testing xml entity Ktesting e The document containing the section must not define again the DTD lt section gt here comes the section content lt section gt Note won The indicated DTD and the element names section chapter are used here only for illustrating the inclusion mechanism You can use any DTD and element names you need 50 Editing documents When splitting a large document and including the separate parts in the m
53. Note Preserve empty lines Preserve text as it is Preserve line breaks in attributes Break long attributes Indent when typing in preserve space elements don t apply when switching from Author to Text page Whitespaces This panel displays the special whitespace characters of Unicode Any character that is checked in this panel is considered whitespace that can be normalized in an XML document The whitespaces are normalized when the action Format and Indent is applied or when you switch from Text mode to Author mode or from Author mode to Text mode The characters with the codes 9 10 13 and 32 are always in the group of whitespace characters that must be normalized so they are always enabled in this panel Figure 17 15 The Whitespaces preferences panel Whitespaces e En Hex Character name Character block U 0 CHARACTER TABULATION Basic Latin U 0 LF Basic Latin U 0 CR Basic Latin U 0 SPACE Basic Latin O U 0 NEXT LINE NEL Latin 1 Supplement U 0 NO BREAK SPACE Latin 1 Supplement O U l OGHAM SPACE MARK Ogham U 1 MONGOLIAN VOWEL SEPAR Mongolian a U 2 EN Quad General Punctuation U 2 EM Quad General Punctuation U 2 EN SPACE General Punctuation U 2 EM SPACE General Punctuation U 2 THREE PER EM SPACE General Punctuation U 2 FOUR PER EM SPACE General Punctuation U 2 S
54. Organizing the Framework Files First create a new folder called sdf from Simple Documentation Framework in oXygen_installation_dir ectory frameworks This folder will be used to store all files related to the documentation framework The following folder structure will be created oxygen frameworks sdf schema css 4 Important The frameworks directory is the container where all the oXygen framework customizations are located Each subdirectory contains files related to a specific type of XML documents schemas catalogs stylesheets CSSs etc Distributing a framework means delivering a framework directory 4 Important It is assumed that you have the right to create files and folder inside the oXygen installation directory If you do not have this right you will have to install another copy of the program in a folder you have access to the home 153 Author Developer Guide directory for instance or your desktop You can download the all platforms distribution from the oXygen website and extract it in the chosen folder To test your framework distribution you will need to copy it in the frameworks directory of the newly installed application and start oXygen by running the provided start up script files You should copy the created schema files abs xsd and sdf xsd sdf xsd being the master schema to the schema directory and the CSS file sdf css to the css directory Association Rules You must spe
55. This section presents the procedure used to configure a Documentum CMS data source and connection in the Data Source Explorer To connect to a Documentum Content Server repository you need to configure a data source and a connection How to configure a Documentum CMS data source To configure a Documentum CMS data source you need the Documentum Foundation Services Software Development Kit DFS SDK The DFS SDK can be found in the Documentum CMS server installation kit or it can be downloaded from EMC Community Network https developer content emc com downloads documentum_ucf_dfs htm The DFS SDK comes as an archive named emc dfs sdk 6 5 zip 1 Goto Preferences gt Data Sources In the Data Sources panel click the New button 2 Enter a unique name for this data source and select Documentum CMS from the driver type combo box 3 Press the Choose DFS SDK Folder button and select the folder where you have unpacked the DFS SDK archive file emc dfs sdk 6 5 zip If you have indicated the correct folder the following jar files will be added o the list 333 Content Management System CMS Integration lib java emc bpm services remote jar lib java emc ci services remote jar lib java emc collaboration services remote jar lib java emc dfs rt remote jar lib java emc dfs services remote jar lib java emc dfs tools jar lib java emc search services remote jar lib java ucf client ucf installer jar lib java commons
56. VI W perriso reee siae s53 dsbssssrseerga cap S EEEE Aoo Seeugseesbevsseeeieng EEROR E ns 12 The lt oXygen gt Browser VIEW ocios euisess kussies unero yo eeoa eE Vae EE EENE rE URETT Ena Ees est 12 The lt oXygen gt XPath Results View orppesa terori a E T ae 13 Supported editor types ressos re o EE E E REE EEEE E WA EE EE E ETE rE 13 lt oXygen gt Database perspective sissi ssovsassscseseasssvsacass cosavapeeecsogpeesdessseoeessssedawess ESPERE PITIE ESES 13 4 Editing documents vocacion ti EE EES EEEE S eii 16 Working with Unicode cecilia dt E E E E E le Er E TEE AEE 16 Opening and saving Unicode documents ocococcnnconnconnconnconncnnncnnncnnrnnnronnrnn nono ronnocnnccnnccnnconncinncos 16 Opening and closing documents srkidean voces oe vedcdegsdbetensssvoon see seovssgdesSeseusdbeeersgseansasesoteedsendeaes 16 Creating new documents 2 2 55i yeccsisa e nE ces te eocues EKE OE E gd eeda ls T EE ES EE ane ees 17 lt oXy gen gt plugin Wizards sisisi desig sok r ea aaa a Eaa Soe TaI EE E EE aS 17 Creating Documents based on Templates oooocooccnccnnccnnccnnconnconnconnconnconnconncnnnconornnrnnnronose 22 Saving documents ksss ene ona ON 22 Opening and Saving Remote Documents via FTP SFTP 0 0 0 e eee c nec ce cece cena een eeneeennees 22 Changing file permissions on a remote FTP server cee cece eee ceeeceeece teen secu cece eens eeneeees 24 WebDAV cover FIT TPS eh rae h a dani dada noni indir ade 25 Openi
57. across all operating systems In you can work with documents in one of the perspectives Editor perspective Editing of documents is supported by specialized and synchronized editors and views lt oXygen gt Database perspective Multiple connections to both relational databases and native XML ones can be managed at the same time in this perspective database browsing SQL execution XQuery execution and data export to XML lt oXygen gt XML perspective The lt oXygen gt XML perspective is used for editing the content of your documents As majority of the work process centers around the Editor panel other panels can be hidden from view using the expand and collapse controls located on the divider bars This perspective organizes the workspace in the following panels 10 Getting started Figure 3 1 lt oXygen gt XML perspective oXygen XML personal xml Eclipse SDK QuE File Edit Navigate Search Project XML tools XML Run Window Help H HSolsSe MIVYAX OF ORK AAFA Sta OC gt amp B E Eo tS Navigator 3 fo personal xml 3 fe personal dtd E amp y 1 lt xml version 1 0 encoding UTF 8 gt am H E xhtml 2 lt DOCTYPE personnel SYSTEM personal dtd gt 3 xquery 3 gt lt personnel gt fe personal dtd 45 lt person id Big Boss gt The content of element type nami fo l xrnl 5 lt nbme gt match
58. allowing you to express navigation or table of contents hierarchies as well as implying rela tionships between the containing topicref and its children You can set the collection type of a container topicref to determine how its children are related to each other You can also express relationships among topicref s using group and table structures using topicgroup and reltable Relationships end up expressed as links in the output with each participant in a relationship having links to the other participants by default A reference to a topic file may be inserted both from the toolbar action and the contextual node actions The same dialog can be used to insert references to maps or links to non dita files like pdf s Figure 6 2 Insert Topic Reference Dialog Insert Topic Reference bo copyright xml Select fe gardenia xml URL file D Eclipse test samples dita flowers t fe fed index xml Target Gerbera topic topic 1 y La introduction xml bi Element name topicref iv fed iris xml fe flac xml Attributes fed salvia xml fo snowdrop xml fe Flowers ditamap C Navigation title fet Flowers2 ditamap 3 garage 5 it book Format gt learning gt docbook HE fo Collection type gt import S jsp E makhmal Keyref Href topics gerbera xml Type Scope Keys File filter All Files Insert and close By
59. attrValue null displayName attrValue getValue return displayName Resolve the references of the node The returning SAXSource will be used for creating the referred content using the parser and source inside it param node The clone of the node param systemID The system ID of the node with references AA A A F F gt 259 Author Developer Guide param authorAccess The author access implementation param entityResolver Th ntity resolver that can be used to resolve lt ul gt lt li gt Resources that are already opened in editor For this case the InputSource will contains the editor content lt li gt lt li gt Resources resolved through XML catalog lt li gt lt ul gt return The SAX source including the parser and the parser s input source A A CACA ACA CACA public SAXSource resolveReference AuthorNode node String systemID AuthorAccess authorAccess EntityResolver entityResolver SAXSource saxSource null if node getType AuthorNode NODE_TYPE_ELEMENT AuthorElement element AuthorElement node if ref equals element getLocalName AttrValue attrValue element getAttribute location if attrValue null String attrStringVal attrValue getValue try URL absoluteUrl new URL new URL systemID authorAccess correctURL attrStringVal In
60. classes gt 171 Author Developer Guide lt include name gt lt fileset gt lt jar gt lt target gt lt project gt Copy the sdf jar file into the frameworks sdf directory Add the sdf jar to the Author class path To do this Open the options Document Type Dialog select SDF and press the Edit button Select the Classpath tab in the lower part of the dialog Press the Add button In the displayed dialog enter the location of the jar file relative to the lt oXygen gt frameworks directory Let s create now the action which will use the defined operation Click on the Actions label The icon files are lImage1 6 gif for the menu item and adltmage2 0 gif for the toolbar and are already available Place these files in the frameworks sdf directory Define the action properties ID An unique identifier for the action Use insert_image Name The name of the action Use Insert image Menu access key Use the i letter Description Enter the text Inserts an image Toolbar icon Enter here frameworks sdf Image20 gif Menu icon Enter here frameworks sdf Image16 gif Shortcut key You will use Ctrl Shift i Now let s set up the operation You are adding images only if the current element is a section book or article XPath expression Set the value to local name section or local name book or local name article Invoke operation In this case you will use the Java opera
61. equals tableCellsTagName AttrValue widthAttr tableElement getAttribute width if widthAttr null String width widthAttr getValue if width null toReturn new WidthRepresentation width true return toReturn public List lt WidthRepresentation gt getCellWidth AuthorElement cellElement int colNumberSta int colSpan List lt WidthRepresentation gt toReturn null int size colWidthSpecs size if size gt colNumberStart amp amp size gt colNumberStart colSpan toReturn new ArrayList lt WidthRepresentation gt colSpan for int i colNumberStart i lt colNumberStart colSpan i Add the column widths toReturn add colWidthSpecs get i return toReturn The methods commit TableWidthModificationand commitColumnWidthModifications are used for committing changes made to the width of the table or its columns when using the mouse drag gestures public void commitTableWidthModification AuthorDocumentController authorDocumentControlle int newTableWidth String tableCellsTagName throws AuthorOperationException if td equals tableCellsTagName if newTableWidth gt 0 if tableElement null 201 Author Developer Guide String newWidth String value0f newTableWidth authorDocumentController setAttribute width new AttrValue newWidth tableElement else throw new AuthorOperationException Cannot
62. http www oxygenxml com sample documentation abstracts abs def font family monospace font size smaller abs def before content Definition color gray Vertical flow book section para title image ref display block Horizontal flow b i display inline 228 Author Developer Guide section margin left lem margin top lem section foldable true not foldable child title link href beforel display inline link attr href content Click to open attr href Title rendering title font size 2 4em font weight bold x title font size 2 0em E ke taitlel font size 1 6em RO KS Baie bef font size 1 2em book articlel counter reset sect book gt section article gt section counter increment sect book gt section gt title before article gt section gt title beforel content Section counter sect Inlines rendering b font weight bold font style italic 229 Author Developer Guide Table rendering table display table border 1lpx solid navy margin lem max width 1000px min width 150px table width width attr width length tr header display table row header background color silver color inherit td display table cell border 1lpx solid navy padding lem image display block content attr href url margin lef
63. let the default implementation take place or reject the edit entirely by throwing an InvalidEditException package simple documentation framework extensions 188 Author Developer Guide pk Specific editing support Handles typing and paste public class SDFSchemaAwarel Typing events can be handled using the h for SDF documents events inside section and tables EditingHandler implements AuthorSchemaAware andleTyping method For example the SDF SchemaAwarel EditingHandler Editing Handler checks if the schema is not a learned one was loaded successfully and Smart Paste is active If these conditions are met the event will be handled see ro sync ecss extensions api AuthorSchemaAwarel public boolean handleTyping throws InvalidEditException boolean handleTyping false EditingHandlertfthandleTyping int int offset char ch AuthorAccess authorAccess AuthorSchemaManager authorSchemaManager authorAccess getDocumentController getAuthor if authorSchemaManager isLearnSchema amp amp authorSchemaManager hasLoadingErrors amp amp authorSchemaManager getAuthorSchemaAwareOptions isEnableSmartTyping try AuthorDocumentFragmen authorAccess getDocumentController createNewDocumentTextFragmen handleTyping handleInsertionEvent offset new AuthorDocumentFragment catch AuthorOperatio throw new InvalidEdit
64. lt p gt lt u gt lt xsl apply templates gt lt u gt lt p gt lt xsl template gt lt xsl template match title gt lt h1 gt lt xsl apply templates gt lt h1 gt lt xsl template gt lt xsl template match b gt lt b gt lt xsl apply templates gt lt b gt lt xsl template gt lt xsl template match i gt lt i gt lt xsl apply templates gt lt i gt lt xsl template gt lt xsl template match table gt lt table frame box border l1px gt lt xsl apply templates gt lt table gt lt xsl template gt lt xsl template match header gt lt tr gt lt xsl apply templates gt lt tr gt lt xsl template gt lt xsl template match tr gt 233 Author Developer Guide lt tr gt lt tr lt xsl apply templates gt gt lt xsl template gt lt xsl template match td gt lt xsl lt td gt lt xsl apply templates gt lt td gt template gt lt xsl template match header header td gt lt xsl lt th gt lt th lt xsl apply templates gt gt template gt lt xsl stylesheet gt Java Files InsertImageOperation java package simple documentation framework por por por por por por por por B H peo pepe H He H 83383838833 383 por por por por por por por por por H H H H feo peo peo H H 333333333 mpor mpor mpor mpor mpor H H H H H public class InsertImageOp
65. rt ro rt ro rt ro ic class TableColumnWidt sync sync sync sync sync ecss ecss ecss ecss ecss X X X X X tensions api tensions api tensions api tensions api tensions api AuthorAccess AuthorOperation mentation framework TableColumnWidthProvider This class must extensions api AuthorTableColumnWidthProvider interface Exception AuthorTableColumnWidthProvider WidthRepresenta node AuthorElement hProvider implements AuthorTableColumnWidthProvider information by analyzing the table element public void init AuthorElement tableElement this tabl thorElement hildren or int i 0 1 Element colChild Au if f colc Author if 1 colss if i cols GI De colc ndoffset L Element tableElement colChildr 1 tion Element that represents the XML t able element In our case Le element In such cases you must collect the span mentsByLocalName Customcol colChildren n tableElement getE null amp amp colChildren length gt 0 length i tartOffset termine the AttrValue colWidthA String colWidth if colWidthA colWidth Add Width spans over colWidthSpecs add hildren le colChild get colChildren i colChild getStartOffset ngth 1 EndOffset width t
66. valid elements and attrib utes If checked only ele ments or attributes form the content completion proposals list can be inser ted in the document through content comple tion Warn on invalid content when per A warning message will be forming action displayed when performing an action that will result in invalid content Available options e Delete Element Tags If checked when the Delete Element Tags action will result in an invalid content a warning message will be displayed in which the user is asked if the opera tion should continue Join Elements If checked when the Join Elements action will result in an in valid content a warming message will be displayed in which the user is asked 1f the operation should continue If the Schema Aware Editing is On or Custom all actions that can generate invalid content will be forwarded first toward AuthorSchemaAwareEditingHandler Track Changes The Author Track Changes preferences panel is opened from menu Window Preferences gt Author Editor Au thor Track Changes 362 Configuring the application Figure 17 11 The lt oXygen gt Track Changes preferences panel Track Changes ey vw Author John Doe Inserted content color O Auto Custom Deleted content color O Auto Custom Author The name of the user who performs the changes when Change Tracking is active for a given editor This information will be associated with each
67. xmlFragment offset pk Creates the XML fragment representing the column specifications param widthRepresentations return The XML fragment as a string f private String createXMLFragment WidthRepresentation widthRepresentations StringBuffer fragment new StringBuffer String ns tableElement getNamespace for int i 0 i lt widthRepresentations length i WidthRepresentation width widthRepresentations i fragment append lt customcol String strRepresentation width getWidthRepresentation if strRepresentation null fragment append width width getWidthRepresentation if ns null amp amp ns length gt 0 fragment append xmlns ns X fragment append gt return fragment toString see ro sync ecss extensions api AuthorTableColumnWidthProvider commitTableWidthModificat k ro sync ecss extensions api AuthorDocumentController int java lang String sy 255 Author Developer Guide public void commitTableWidthModification AuthorDocumentController authorDocumentController int newTableWidth String tableCellsTagName throws AuthorOperationException if td equals tableCellsTagName if newTableWidth gt 0 if tableElement null String newWidth String valueOf newTableWidth authorDocumentController setAttribute width new AttrValue newWidth tableElement
68. 100 Author for DITA The system property com oxygenxml xep location was set to point to the XEP executable file for the platform eg xep bat on Windows XEP was installed in the rameworks dita DITA OT demo fo lib directory of the lt oXygen gt installation directory Antenna House The Antenna House http www antennahouse com AH v5 or XSL v4 Formatter processor You can add it very easy from here If you select Antenna House in the combo and Antenna House was already installed in lt oXygen gt you can see the detected installation path appear under the combo Antenna House is considered as installed if it was detected from one of the following sources Environment variable set by Antenna House installation the newest installation version will be used v5 being preferred over v4 Antenna House was added as an external FO Processor in the lt oXygen gt preferences See here i Tip The DITA OT contributors recommend the use of the IDIOM FO Plugin to transform DITA Maps to PDF as opposed to using the standard PDF target in the DITA OT framework As IDIOM is also bundled with lt oXygen gt the PDF 2 IDIOM FO Plugin output format should be your first choice in transforming your map to PDF If you do not have a commercial license for XEP or Antenna House you can transform using the Apache FO Processor Set a font for PDF output generated with Apache FOP When a DITA map is transformed to PDF using the Apache FO
69. Author Developer Guide public void doOperation AuthorAccess authorAccess ArgumentsMap arguments throws IllegalArgumentException AuthorOperationException JFrame oxygenFrame JFrame authorAccess getParentFrame String href displayURLDialog oxygenFrame if href length 0 Creates the image XML fragment String imageFragment lt image xmlns http www oxygenxml com sample documentation href href gt Inserts this fragment at the caret position int caretPosition authorAccess getCaretOffset authorAccess insertXMLFragment imageFragment caretPosition pk Has no arguments return null public ArgumentDescriptor getArguments return null pk return A description of the operation public String getDescription return Inserts an image element Asks the user for a URL reference The complete source code of this operation is found in the Example Files Listings the Java Files section Important Make sure you always specify the namespace of the inserted fragments Package the compiled class into a jar file An example of an ANT script that packages the classes directory content into a jar archive named sdf jar is listed below lt xml version 1 0 encoding UTF 8 gt lt project name project default dist gt lt target name dist gt lt jar destfile sdf jar basedir classes gt lt fileset dir
70. DTD for Content Completion and document validation In addition to being useful for quick creation of a DTD that will be capable of providing an initialization source for the Content Completion assistant This feature can also be used to produce DTDs for documents containing personal or custom element types When it is opened a document that does not specify a schema lt oXygen gt automatically learns the document structure and uses it for Content Completion To disable this feature uncheck the checkbox Learn on open document from Preferences 28 Editing documents Procedure 4 4 To create a DTD 1 Open the structured document from which a DTD will be created 2 Select menu XML gt Learn Structure Ctrl Shift L to read the mark up structure of the current document so that it can be saved as a DTD using the Save Structure option lt oXygen gt will learn the document structure when finished displaying words Learn Complete in the Message Pane of the Editor Status bar 3 Select menu Document XML Document Save Structure Ctrl Shift S to display the Save Structure dialog used to name and create DTD documents learnt by the Learn Structure function Note The resulting DTD is only valid for documents containing the elements and structures defined by the document used as the input for creating the DTD If new element types or structures are defined in a document they must be added to the DTD in order for successful validatio
71. EXTENSIONS sorsi eea O 112 TEMPLE Suse eevee Sethe eet va ee ges ae tears eA peau See fee as eed I epee eee 112 Catalonia ida aeyu thee ds wudawdedous E EE sewed haadewes test 112 Transformation Scenarios serere reen mea rieien EET ER EE E EE E n ra 112 The DocBook Targetsetd c ment typen respeten e E R EE NE ORNE EE ORS EASE 112 ASSOCIATION TUNES Cart A A A A a 113 A O ON des 113 Author Extensions a A A da ice 113 NA 113 The DITA Topics document PER od ie 113 ASSOCIATION rule Seia Me cduesedonk goatee ntacnsenstheedauesaesedons dondabuadantsyedhae ain edneeeieva ssantuensarcouedhe 113 RN 113 Author EXTENSIONS 3 55 devs e sess e e lorca tt fent inner ide danesa ea wanes 113 A a E Na Si Se ev uh ila a asad ait 120 vi lt oXygen gt XML Author 11 2 User Manual for Eclipse CatalO gs dessdneneanss voor rad pontiac dee 120 Transformation CenNariOS ssrin o a E aa A rn nn nn nn nr rro nr nro a aE SHEESH EES 120 The DURA MAP document ty pens es joes ss5a eta ve E n aee aE ds ner q ree dos R I Ea 120 Association TUNES ii beeen ested iaa 121 SCHEMA irese A ce nosey cide uated den Boene Cotes de wel ee ste eaten Non oes be anes dened Mode encase E 121 Author extensions ose 5si de oes ed bess Loa a A dels oad Celeb Seed vealed vicios 121 TEMPlAares ws sce esheets ede lis 122 Catalogs inti A o 122 Transformation Scenarios piesen ni ec cece cece ee E A E pa aE A onp Ea 122 The XHTME document type irei a E nE E eb aves E aE E E du
72. F find replace Author editor 74 Find All Elements dialog 344 FO document type 134 association rules 135 Author extensions 135 transformation scenarios 135 schema 135 G Getting started 10 help 10 perspectives 10 database 13 editor 10 supported types of documents 10 grid editor 269 add nodes 272 bidirectional text 275 clear column content 272 copy paste 273 414 Index drag and drop 273 duplicate nodes 272 insert table row 272 inserting table column 272 layouts grid vs tree 270 navigation 270 collapse all 271 collapse children 271 collapse others 271 expand all 271 expand children 271 refresh layout 272 sort table column 271 start editing a cell value 272 stop editing a cell value 272 Installation Eclipse Update Site method Eclipse 3 3 3 Update Site method Eclipse 3 4 3 zip archive method Eclipse 3 3 3 zip archive method Eclipse 3 4 4 environment 2 requirements 2 L License floating concurrent license 5 floating license server 6 license server installed as Windows service 7 register a license key 4 registration code 8 release floating license 8 unregister license key 8 M MathML document type 128 association rules 129 schema 129 templates 129 Microsoft Office OOXML document type 129 association rules 129 schema 130 N Native XML databases NXD 321 data sources configuration 321 Berkeley DB XML 321 Documentum xDb X H
73. FR ERR_INDEX_OWNER VARCHAR FX ERR_INDEX_NAME VARCHAR ED ERR_TIMESTAMP DATE FB ERR_TEXTKEY VARCHAR ED ERR_TEXT VARCHAR ES CTX_INDEX_OBJECTS E CTX_INDEX_PARTITIONS H E CTX_INDEX_SET_INDEXES El CTX_INDEX_SETS E CTX_INDEX_SUB_LEXER_YALUES The following objects are displayed by the Data Source Explorer view Connection B Catalog XML Schema Repository amp XML Schema Component 92 Schema El Table El System Table Table Column The following actions are available in the view s toolbar gt The gt Filters button opens the Data Sources Table FiltersPreferences page allowing you to decide which table types will be displayed in the Data Source Explorer view The Configure Database Sources button opens the Data Sources preferences page where you can configure both data sources and connections Below you can find a description of the contextual menu actions available on the Data Source Explorer levels Please note that you can also open an XML schema component in the editor by double clicking it To view the content of a table in the Table Explorer view double click one of its fields 317 Working with Databases Actions available at connection level Refresh performs a refresh of the selected node s subtree e Configure Database Sources opens the Data Sourcespreferences page where you can configure both data sources and connections Actions available at cata
74. Microsoft website http www microsoft com down loads details aspx FamilyID 99b2 1b65 e98f 4a6 1 b8 11 199 12601 fdc9 amp dis playlang en and use it for configuring an SQL Server data source Download the Oracle 11g JDBC driver called ojdbc5 jar from the Oracle website http www oracle com technology software tech java sqlj_jdbc index html http www oracle com technology software tech java sqlj_jdbc index html and use it for configuring an Oracle data source Download the PostgreSQL 8 3 JDBC driver called postgresql 8 3 603 jdbc3 jar from the PostgreSQL website http jdbc postgresql org download html and use 1t for configuring a PostgreSQL data source Copy the jar files from the TigerLogic JDK lib directory from the server side to the lt oXygen gt install directory as described in the procedure for configuring a TigerLogic data source Copy the jar files from the SDK TaminoAPI4J lib subdirectory of the Tamino database install directory to the lt oXygen gt install directory as described in the procedure for configuring a Tamino data source Copy the jar files from the Documentum xDb X Hive DB database install directory to the lt oXygen gt install directory as described in the procedure for configuring an XHive data source A MySQL driver file is included in the Oxygen kit The installer creates the file mysql jar in the folder Oxygen install folder 1ib When creating a new data source select the type Generic JDBC and
75. Procedure 4 5 Create an lt oXygen gt XML project 1 Select File gt New gt gt Other Ctrl N or press the New toolbar button The New wizard is displayed which contains the list entry XML Project 2 Select XML Project in the list of document types and click the Next button 3 Type a name for the new project and click the Next button 4 Select other Eclipse projects that you want to reference in the new project and click the Finish button The files are organized in a XML project usually as a collection of folders They are created and deleted with the usual Eclipse actions The currently selected files associated to the lt oXygen gt pluginin the Package Explorer view can be validated against a schema of type Schematron XML Schema Relax NG NRL NVDL or a combination of the later with Schematron with one of the actions Validate and Validate With available on the Batch Validation submenu of the right click menu of the Package Explorer view This together with the logical folder support of the project allows you to group your files and validate them very easily 51 Editing documents The currently selected files associated to the lt oXygen gt pluginin the Package Explorer view can be transformed in one action with one of the actions Apply Transformation Configure Transformation and Transform with available on the Transformation submenu of the right click menu of the Package Explorer view This together wit
76. SLIB avalon framework 4 2 0 jar SLIB xercesImpl jar set CMD SCMD org apache fop fonts apps TTFReader set FONT_DIR C Windows Fonts S CMD SFONT_DIR Arialuni ttf Arialuni xml The FONT_DIR can be different on your system Make sure it points to the correct font directory If java executable is not in the PATH you will have to specify the full path for java Execute the script On Linux and Mac OS X you have to use sh ttfConvert sh from the command line Note If Oxygen was installed by an administrator user and now it is used by a standard user who does not have write permission in the Oxygen installation folder for example on Windows Vista or Linux then the output location of the font metrics file should be a directory where the user has write permission for example SCMD SFONT_DIR Arialuni ttf C temp_dir Arialuni xml If the font has bold and italic variants you will have to convert those also For this you can modify the script by adding two more lines SCMD SFONT_DIR Arialuni Bold ttf Arialuni Bold xml SCMD SFONT_DIR Arialuni Italic ttf Arialuni Italic xml In our case the font Arial Unicode MS is not having a Bold and Italic variant so you will leave the script unchanged Register font to FOP configuration Create a file and name it for example fopConfiguration xml lt fop version 1 0 gt lt base gt file C path to FOP font metrics files lt base gt lt source resolution gt 72 lt source re
77. Signatures can be applied to any digital content data object including XML see W3C Recommendation XML Signature Syntax and Processing http www w3 org TR xmldsig core An XML Signature may be applied to the content of one or more resources e Enveloped or enveloping signatures are over data within the same XML document as the signature e Detached signatures are over data external to the signature element the signature is detached from the content it signs This definition typically applies to separate data objects but it also includes the instance where the Signature and data object reside within the same XML document but are sibling elements The XML Signature is a method of associating a key with referenced data it does not normatively specify how keys are associated with persons or institutions nor the meaning of the data being referenced and signed The original data is not actually signed instead the signature is applied to the output of a chain of canonicalization and transformation algorithms which are applied to the data in a designated sequence This system provides the flex ibility to accommodate whatever normalization or desired preprocessing of the data that might be required or desired before subjecting it to being signed To canonicalize something means to put it in a standard format that everyone generally uses Because the signature is dependent on the content it is signing a signature produced from a not can
78. Surround with last lt tag gt oa Alt Shift Cmd Alt on Mac OS Selected Text in the editor is marked with start and end tags of the last Surround in action context menu of current editor XML Refactoring Rename element Alt Shift R Cmd Alt R on Mac OS The element from the caret position and the elements that have the same name as the current element can be renamed according with the options from the Rename dialog context menu of current editor XML Refactoring Rename prefix da The prefix of the element from the caret position and the elements that have the same prefix as the current element can be renamed according with the options from the Rename dialog Selecting the Rename current element prefix option the application will recursively traverse the current element and all its children For example to change the xmlns p1 ns 1 association existing in the current element to xmins p5 ns1 just select this option and press OK If the association xmlns pl ns1 is applied on the parent of the current element then lt oXygen gt will introduce a new declaration xmlns p5 ns1 in the current element and will change the prefix from pl to pS If p5 is already associated in the current element with another namespace let s say ns5 then a dialog showing the conflict will be displayed Pressing the OK button the prefix will be modified from p1 to p5 without inserting a new declaration xmIns p5 ns1 On Cancel no modification is made
79. The naming convention used under Java does not always correspond to the common names used by the Unicode standard For instance while in XML you will use encoding UTF 8 in Java the same encoding has the name UTF8 Opening and closing documents As with most editing applications lt oXygen gt XML Author lets you open existing documents save your changes and close them as required 16 Editing documents Creating new documents lt oXygen gt plugin wizards The New wizard only creates a skeleton document containing the document prolog a root element and possibly other child elements depending on the options specific for each schema type Use the following procedure to create documents 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 Procedure 4 1 Creating new documents l Select File gt New gt gt Other Ctrl N or press the T New toolbar button is displayed which contains the supported Document Types XML CSS File 2 Select a document type then click Next For example if XML was selected the Create an XML Document wizard is started 3 Type aname for the new document and press Next 4 The Create an XML Document dialog enables definitio
80. Type The type of the new document default is dm_document Format The document content type format e Import Imports local files folders in the selected cabinet folder from the repository Add Files Shows a file browse dialog and allows you to select files to add to the list Add Folders Shows a folder browse dialog that allows you to select folders to add to the list The subfolders will be added recursively Edit Shows a dialog where you can change the properties of the selected file folder from the list Remove Removes the selected files folders from the list e Rename Changes the name of the selected cabinet folder e Copy Copies the selected folder to a different location in the tree available only upon folders This action can also be performed with drag and drop while holding the Ctrl key pressed e Move Moves the selected folder to a different location in the tree available only upon folders This action can also be performed with drag and drop X Delete Deletes the selected cabinet folder from the repository The following options are available Folder s Allows you to delete only the selected folder or to delete recursively the folder and all subfolders and objects Version s Allows you to specify what versions of the resources will be deleted Virtual document s Here you can specify what happens when virtual documents are encountered They can be either deleted either by themselves or together with their descen
81. W3C XML Schema 1 1 one This can be configured in Preferences Besides the above list lt oXygen gt supports the following processors Xsltproc libxslt Libxslt http xmlsoft org XSLT is the XSLT C library developed for the Gnome project Libxslt is based on libxml2 the XML C library developed for the Gnome project It also implements most of the EXSLT set of processor portable extensions functions and some of Saxon s evaluate and expressions extensions The libxm12 version included in lt oXy gen gt is 2 7 6 and the libxslt version is 1 1 26 lt oXygen gt uses Libxslt through its command line tool Xsltproc The XSLT processor is included into the distribution kit of the stand alone version for Windows and Mac OS X Because there are differences between different Linux distributions on Linux you must install Libxs t on your machine as a separate application and set the PATH variable to contain the Xsltproc executable If you do not have the Libxslt library already installed you should copy the following files from lt oXygen gt stand alone installation directory to root of the com oxygenxml ed itor_11 1 0 plugin e Windows xsltproc exe zlib1 d11 1ibxs1t d11 1ibxm12 d11 libexslt dll iconv dll e Linux xsltproc libexslt so 0 libxslt so 1 1ibxsml2 s0 2 e MacOSX xsltproc mac libexslt libxslt libxml The Xsltproc processor can be configured from the XSLTPROC options page 298 Transforming documents
82. after Next Tag Ctrl Close Bracket Moves the cursor to the end of the next tag e contextual menu of current editor gt Go after Previous Tag Ctrl Open Bracket Moves the cursor to the end of the previous tag XML Associate XSLT CSS Stylesheet E Inserts an xml stylesheet processing instruction at the beginning of the document referencing either an XSLT or a CSS file depending on the user selection Either reference is useful for rendering the document in a Web browser when the action Open in browser is executed Referencing the XSLT file is also useful for automatic detection of the transformation stylesheet when there is no scenario associated with the current document 58 Editing documents When associating the CSS the user can also specify the title and if the stylesheet is an alternate one Setting a Title for the CSS makes it the author s preferred stylesheet Checking the Alternate checkbox makes the CSS an alternate stylesheet oXygen Author fully implements the W3C recommendation regarding Associating Style Sheets with XML docu ments For more information see http www w3 org TR xml stylesheet http www w3 org TR REC html40 present styles html h 14 3 2 XML Refactoring actions context menu of current editor XML Refactoring Surround with tag Da Alt Shift E Cmd Alt E on Mac OS Selected Text in the editor is marked with the specified start and end tags context menu of current editor XML Refactoring
83. also blocks But any block that contains inline boxes is arranging its children in a horizontal flow That is why the paragraph lines are also blocks but the traditional bold and italic sections are represented as inline boxes The CSS allows us to specify that some elements are displayed as tables In CSS a table is a complex structure and consists of rows and cells The table element must have children that have table row style Similarly the row elements must contain elements with table cell style To make it easy to understand the following section describes the way each element from the above schema is formatted using a CSS file Please note that this is just one from an infinite number of possibilities of formatting the content report This element is the root element of the report document It should be rendered as a box that contains all other elements To achieve this the display type is set to block Additionally some margins are set for 1t The CSS rule that matches this element is report display block margin lem title The title of the report Usually titles have a larger font The block display should also be used the next elements will be placed below it and change its font to double the size of the normal text title display block 138 Author Developer Guide description line important results entry test_name passed font size 2em This element contains several lines of
84. amount of memory reserved for FOP transform ations Configuration file for the built in You should specify here the path to a FOP configuration file necessary for ex FOP ample to render to PDF using a special true type font a document containing Unicode content Generates PDF A 1b output When selected PDF A 1b output is generated 393 Configuring the application Note All fonts have to be embedded even the implicit ones More information about configuring metrics files for the embedded fonts can be found in Add a font to the built in FOP S Note You cannot use the lt filterList gt key in the configuration file FOP will generate the following error The Filter key is prohibited when PDF A 1 is active The users can configure the external processors for use with lt oXygen gt in the following dialog Figure 17 46 The external FO processor configuration dialog FO Processor Name XEP FO processor Description FO Processor from XEP Output Encoding Default encoding Error Encoding Default encoding Working directory Command line D XEP 3 8 1 xep bat fo fo method out E E 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 Processors option Output Encoding The encoding used for the ou
85. and an editor variables selector to simplify setting a file path as value to a parameter The Filters tab In the Scenario Filters Tab you can add filters to remove certain content elements from the generated output 96 Author for DITA Figure 6 7 Edit Filters tab Edit DITA Scenario Scenario Name hierarchy XHTML Type XHTML Parameters Filters Advanced Output O Use DITAVAL file Exclude from output all elements with any of the Following attributes Attribute name Value audience expert lt m A bila You have two ways in which to define filters Use DITAVAL file If you already have a DITAVAL file associated with the transformed map you can specify the path to it and it will be used when filtering content You can find out more about constructing a DITAVAL file in the DITA OT Documentation http docs oasis open org dita v1 1 CDO1 langspec common about ditaval html Exclude from output all elements You can configure a simple list of attribute name value pairs which when with any of the following attributes present on an element in the input will remove it from output The Advanced tab In the Advanced Tab you can specify advanced options for the transformation 97 Author for DITA Figure 6 8 Advanced settings tab Edit DITA Scenario Scenario Name DITA Map XHTML Type XHTML Parameters Filters Advanced Custom build File
86. another element if you hold the mouse pointer towards the upper or lower part of the targeted element A marker will indicate whether the drop will be performed before or after the target element If you hold down the CTRL key the performed operation will be copy instead of move The drag and drop action in the Outline view can be disabled and enabled from the Preferences dialog The popup menu of the Outline tree Figure 4 26 Popup menu of the Outline tree B Outline 3 ill Sige pi MY O article http docbook org ns docbook info secti title Inline Markup and Images pare Append child gt PaltjoxXygen amp gt pare Insert before gt info 0 figu Insert after subtitle pare Edit attributes title 0 pare titleabbrew 3 0 secti gt Toggle Comment pea title para Heal Copy item X Cut 9 para Delete kot i s col 4 Expand All f opecs 0 para Collapse All 0 table hsides TT The Append Child Insert Before and Insert After submenus of the outline tree popup menu allow to quickly insert new tags in the document at the place of the element currently selected in the Outline tree The Append Child submenu lists the names of all the elements which are allowed by the schema associated with the current document as child of the current element The Insert Before and Insert After submenus of the Outline tree popup menu list the elements which are allowed by the schema associated
87. api port ro sync ecss extensions api port ro sync ecss extensions api Aut port ro sync ecss extensions api At Aut Aut maManagerFilter tributesValueEditor horExtensionStateLis horReferenc thorSchemaAwareEditin horTableCell Resolver tener 7 gHandler SpanProvider port ro sync ecss extensions api AuthorTableColumnWidthProvider port ro sync ecss extensions api ExtensionsBundle port ro sync ecss extensions api StylesFilter port ro sync ecss extensions api link ElementLocatorProvider port ro sync ecss extensions commons DefaultElementLocatorProvider port simple documentation framework extensions SDFAttributesValueEditor port simple documentation framework extensions SDFAuthorExtensionStateListener port simple documentation framework extensions SDFReferencesResolver port simple documentation framework extensions SDFSchemaAwareEditingHandler port simple documentation framework extensions SDFSchemaManagerFilter port simple documentation framework extensions SDFStylesFilter port simple documentation framework extensions TableCellSpanProvider port simple documentation framework extensions TableColumnWidthProvider Simple Document Framework extension bundle blic class SDFExtensionsBundle extends ExtensionsBundle Editor for attributes values at public AttributesValueEdit
88. archive backup op tions are considered default options for backup in the Archive Backup dialog Show archive backup dialog Archive types table No backup Single file backup Incremental backup Perform no backup of the archive before save This means that the file will be saved directly in the archive without any additional precautions Before any operation which modifies the archive 1s performed the archive contents will be duplic ated The duplicate file name will be origin alArchiveFileName bak and will be saved in the same directory Before each operation which modifies the archive is performed the archive contents will be duplic ated The duplicate file names will be origin alArchiveFileName bak dupNo and the files will be saved in the same directory Check this if you want to be notified for backup when modifying in archives The last backup option you chose will always be used as the default one This table contains all known archive extensions mapped to known archive formats You can edit the table to modify existing mappings or add your own extensions to the list of known archive extensions Figure 17 56 Edit the Archive extension mappings Archive Example odf odg zip Extensions docx pptx xlsx dotx docm dotm pptm Type zip ia Description Office Open XML OOXML You can map a list of extensions to an archive type supported in lt oXygen gt M Important Y
89. are by default copied on the new element but if those attributes are IDs you sometimes want to avoid creating validation errors in the editor Implementing the following method you can decide whether an attribute should be copied or not during the split Check if the attribute specified by QName can be considered as a valid attribute to copy when the element is split param attrQName The attribute qualified name 207 Author Developer Guide param element Th lement return true if the attribute should be copied when Split is performed y boolean copyAttributeOnSplit String attrQName AuthorElement element i Tip The ro sync ecss extensions commons id DefaultU niqueAttributesRecognizer class is an implementation of the interface which can be extended by your customization to provide easy assignation of IDs in your framework You can also check out the DITA and Docbook implementations of ro sync ecss exten sions api UniqueAttributesRecognizer to see how they were implemented and connected to the extensions bundle Customizing the default CSS of a document type The easiest way of customizing the default CSS stylesheet of a document type is to create a new CSS stylesheet in the same folder as the customized one import the customized CSS stylesheet and set the new stylesheet as the default CSS of the document type For example let us customize the default CSS for DITA documents by changing the
90. article section para a m Table showing different values for the column and row span when no span provider is specified x vis Text Grid Author When the above implementation is configured the table has the correct layout 206 Author Developer Guide Figure 8 28 Cells spanning multiple rows and columns document article section para a Table showing different values for the column and row span 419x Text Grid Author Configuring an Unique Attributes Recognizer The ro sync ecss extensions api UniqueAttributesRecognizer interface can be implemented if you want to provide for your framework the following features Automatic ID generation You can automatically generate unique IDs for newly inserted elements Imple mentations are already available for the DITA and Docbook frameworks The following methods can be implemented to accomplish this pk Assign unique IDs between a start and an end offset in the document param startOffset Start offset param endOffset End offset ey void assignUniquelDs int startOffset int endOffset pk return true if auto Ey boolean isAutoIDGenerationActive Avoiding copying unique attributes You can split the current block element by pressing the Enter key and then when Split is called inside an ele choosing Split This is a very useful way to create new paragraphs All attrib ment utes
91. attributeValues Override public List lt CIAttribute gt filterAttributes List lt CIAttribute gt attributes WhatAttributesCanGoHereContext context If the element from the current context is the table element add the attribute named frame to the list of default content completion proposals ContextElement contextElement context getParentElement if table equals contextElement getQName CIAttribute frameAttribute new ClIAttribute frameAttribute setName frame frameAttribute setRequired false frameAttribute setFixed false frameAttribute setDefaultValue void attributes add frameAttribute return attributes Override public List lt CIValue gt filterElementValues List lt CIValue gt elementValues Context context return elementValues Override public List lt CIElement gt filterElements List lt CIElement gt elements WhatElementsCanGoHereContext context 244 Author Developer Guide header nts iterator If the element from the current context is the element remove the td element from completion proposals and add the th element ContextElement contextElement context get if header equals contextElement getQName for Iterator lt CIElement gt iterator eleme iterator hasNext CIElement element iterator
92. background color of the task and topic elements to red First you create a new CSS stylesheet called my_dita css in the folder frameworks dita css_classed where the default stylesheet called dita css is located frameworks is the subfolder frameworks of the Oxygen XML Editor The new stylesheet my_dita css contains import dita css task topic background color red To set the new stylesheet as the default CSS stylesheet for DITA documents first open the Document Type Association preferences panel from menu Options gt Preferences Document Type Association Select the DITA document type and start editing it by pressing the Edit button The user role must be set to Developer otherwise a warning is displayed and a duplicate copy of the DITA document type is created and edited This check makes sure that regular content authors who just edit the content of XML documents do not accidentally modify the document type In the Author tab of the document type edit dialog change the URI of the default CSS stylesheet from frame works dita css_classed dita css to frameworks dita css_classed my_dita css Figure 8 29 Set the location of the default CSS stylesheet Schema Classpath Author Templates Catalogs Transformation Extensions EE AAEN CSS URI Title Alternate Actions __ frameworks dita css_classed dita css DITA default Ino Menu EAS Hide colspec Contextual menu Toolbar 9 x 9 Tf the
93. be disabled from the Content Completion Annotations preferences panel When checked placeholders will be displayed for empty elements to make them clearly visible If checked all errors reported during layout creation will be presented in the Errors view If checked a block range indicator will be shown in a stripe located in the left side of the editor When checked comments from the documents edited in Author mode will be hidden When checked processing instructions from the documents edited in Author mode will be hidden When checked doctype sections from the documents edited in Author mode will be hidden 357 Configuring the application Show very large images Display referred content e g entit ies XInclude DITA conref etc Highlight caret proximity elements Format and indent Quick up down navigation Tags display mode Tags background color Tags foreground color Schema aware If unchecked images larger than 6 megapixels 24MB uncompressed will not be loaded and displayed in Author mode Please be aware that this option is unchecked by default because of the large amounts of application memory that images of high resolution can occupy As a result an OutOfMemory error could occur which would practically make lt oXygen gt unusable without a restart of the entire application When checked the references entities XInclude DITA conref etc will also display the content of the resourc
94. by the image element The location of the image file is represented by the value of the href attribute In the Java implementation you will show a dialog with a text field in which the user can enter a full URL or he can browse for a local file 1 Create a new Java project in your IDE Create the directory 1ib in the Java project directory and copy init the oxygen jar file from the oXygen_in stallation_directory lib directory The oxygen jar contains the Java interfaces you have to im plement and the API needed to access the Author features 2 Create the class simple documentation framework InsertImageOperation This class must implement the ro sync ecss extensions api AuthorOperation interface The interface defines three methods doOperation getArguments and getDescription 1 The doOperation method is invoked when the action is performed either by pressing the toolbar button selecting the menu item or through the shortcut It takes as arguments an object of type AuthorAccess and a map or argument names and values 2 The getArguments method is used by lt oXygen gt when the action is configured it returns the list of argu ments name and type that are accepted by the operation 3 The getDescription method is also used by lt oXygen gt when the operation is configured and its return value describes what the operation does Here is the implementation of these three methods pk Performs the operation 170
95. ca eeca rene sean een eenneenees 67 Elements VIEW wrony ae e e a sueecsgs Sedgnasrevaadspawed otenseeae pede sed rca 68 Attributes VIEW fos ss bese anh eee A Gab ea EE ee Baht Oe 68 Entities VIEW 5 scwosncthac sent dawnstonssongeue a E E E has alitas 70 The Author editor soron ain E E E E E ube sees Sit E EE E E in 71 Navigating the document content oocooccocnncnocnncnoconcnoroncnoroncnnroncnoroncnnroncnnroncnnroncnnronenarones 71 Displaying the Markup orro eioen a id dic s 72 BOOKMARKS an ee e E A E AE NE ES 72 Position information tooltip 2 0 0 0 eee ceceeceeeneceeeneeeeeeeeeeeeeeeeeeaeeeeaeeeeaeeeeaeeeeaeeeraeenes 72 Displaying referred content esasen tena esn EE ENE E sewer dees EENE eerste se weneesy 74 Finding and replacing text oooiononorononorononoronornrono rn roo EEEE rn ron rn ron rn nono rro E E 74 Contextual Menu meesoenpoto its lo ia th we elebeevb aacngebedeb seed ce deny canst vee seagebegawseryesnaase 74 Editing XML in lt oXygen gt Author 0 eee cece cence a eeca seca ceca cena eens eens eeneeeeeeeeeeeees 76 Editing the XML Markup estrellitas tito mess EENS Sumsespeteesuspe ase 76 Editing the XME contents is bis 78 Table Ja yout and resizing ssc 028s ageven sence seks noia NAE E dangaveea nesses egeeel deny 79 DOCBOOK EA in da tated tab ioe ieee date 79 HTM olor o ENTE ANE E EE ESY 79 DITA E II E 80 Refreshingithe Content osien aa rita teen gee E a droit adobe end 80 Validation and error presenting oocco
96. can be configured in the Author options page However if the document opened in Author editor does not have an associated CSS stylesheet then the Full Tags mode will be used Block level elements are those elements of the source document that are formatted visually as blocks e g paragraphs while the inline level elements are distributed in lines e g emphasizing pieces of text within a paragraph in line images etc The graphical format of the elements is controlled from the CSS sources via the display property Bookmarks A position in a document can be marked with a bookmark Later the cursor can go quickly to the marked position with a keyboard shortcut or with a menu item This is useful for easy navigation in a large document or for working on more than one document at a moment when the cursor must move between several marked positions A bookmark can be placed with one of the menu items available on the menu Edit Bookmarks Create or with the menu item Edit Bookmarks gt Bookmarks Quick Creation F9 or with the keyboard shortcuts associated with these menu items and visible on the menu Edit Bookmarks A bookmark can be removed when a new bookmark is placed in the same position as an old one or with the action Edit gt Bookmarks gt Remove All The cursor can go to a bookmark with one of the actions available on the menu Edit Bookmarks gt Go to Position information tooltip When the caret is positioned inside a new
97. caret position is between the two adjacent elements Also joining two elements can be done by pressing the Delete or Backspace keys and the caret is positioned between the boundaries of these two elements e Surround with Tag selected text in the editor is marked with the specified tag e Surround with lt Tag name gt selected text in the editor is marked with start and end tags of the last Surround with Tag action e Rename Element the element from the caret position and the elements that have the same name as the current element can be renamed according with the options from the Rename dialog e Delete Element Tags deletes the tags of the closest element that contains the caret s position This operation is also executed if the start or end tags of an element are deleted by pressing the Delete or Backspace keys e Insert Entity allows the user to insert a predefined entity or a character entity Surrogate character entities range x 10000 to x10FFFF are also accepted Character entities can be entered in one of the following forms e lt decimal value gt e g 65 e amp lt decimal value gt e g amp 65 e x lt hexadecimal value gt e g x41 amp x lt hexadecimal value gt e g amp X41 e Open File at Cursor opens in a new editor panel the file with the name under the current position of the caret in the current document If the file does not exist at the specified location the error dialo
98. configuration is described in section Validating Documents 80 Authoring in the tagless editor Figure 5 24 Error presenting in lt oXygen gt Author editor Here are some useful links regarding XML E Xerces Attribute name must be declared for element type para vhttp Awww xml com4 v Text Grid Author 2 0 Problems 3 Results o 1 error O warnings O infos Description Resource Path tE Errors 1 item Xerces Attribute name must be declared for element type para sample xml sample samples docbook A fragment with a validation error or warning will be marked in the editor panel by underlining the error region with a red color The same will happen for a validation warning only the color will be yellow instead of red Status messages from every validation action are logged into the Console view Whitespace handling There are several major aspects of white space handling in the lt oXygen gt Author editor when opening documents or switching to Author mode saving documents or switching from Author mode to another one and editing documents Open documents When deciding if the white spaces from a text node are to be preserved normalized or stripped the following rules apply e If the text node is inside an element context where the xml space preserve is set then the white spaces are preserved e If the CSS property white space is set to pre for the nod
99. css gt lt report xmlns xsi http ww w3 org 2001 XMLSchema instance xsi noNamespaceSchemaLocation test_report xsd gt lt title gt Test report title lt title gt lt description gt lt line gt This is the report lt descr lt result lt en lt e lt en lt e lt resul lt report gt lt important gt description lt important gt lt line gt iption gt s gt try gt lt test_name gt Sample test1 lt test_name gt lt passed gt true lt passed gt ntry gt try gt lt test_name gt Sample test2 lt test_name gt lt passed gt true lt passed gt ntry gt ts gt 141 Author Developer Guide The processing instruction xm1 stylesheet associates the CSS stylesheet to the XML file The href pseudo attribute contains the URI reference to the stylesheet file In our case the CSS is in the same directory as the XML file The next step is to place the XSD file and the CSS file on a web server and modify the template to use the HTTP URLs like this lt xml version 1 0 encoding UTF 8 gt lt xml stylesheet type text css href http www mysite com reports test_report css gt lt report xmlns xsi http ww w3 org 2001 XMLSchema instance xsi noNamespaceSchemaLocation http www mysite com reports test_report xsd gt lt title gt Test report title lt title gt lt description gt The alternative is to create an archive containing the test_report xml test_report css and test_r
100. database_host gt lt data base_port gt lt database_name gt The SQL expression used in the example is SELECT userID email FROM users but it can be any valid SELECT expression which can be applied to the database Add the action to the toolbar using the Toolbar panel 177 Author Developer Guide Figure 8 17 Java Operation Arguments Setup Operations local name section When this XPath expression is true invoke operation simple documentation framework QueryDatabaseOperation with the arguments Name Description Type Value jdbc_driver The name of the Jav String org git mm mysql Driver connection The database URL co String jdbe mysql 10 0 0 16 3306 camera user The name of the dat String dbuser password The database passw String Serer sql The SQL statement t String SELECT id site pageRank status 1 Operation priority To test the action you can open the sdf xml sample place the caret inside a section between two para elements for instance Press the BCreate Report button from the toolbar You can see below the toolbar with the action button and sample table inserted by the Clients Report action Figure 8 18 Table Content Extracted from the Database document article section Here I have the list of clients that are using the XML documenta framewor Author c X book mia s a Po to the database and collects the list
101. des py end dest bevaepenteeeds 303 Whats XPath noss oii A DA Sek Up ee ae ee a 303 lt oXyeen gt s XPath console cocineta ein leed each paueaseutawela E E ES 303 12 sWorking with Archives is erin en e eo A ts 308 Using files directly trom archives doctrina tii 308 Browsing and modifying archives Structure coooconccnnccnnocnncnnncnnncnnccnnconnconncrnnccnnconnconncnnncnnncnnnnnurenass 308 Editing Mles Srom archives aqvososoaii deve saees seek desased been eywathee dee tar ee nigh eae debates E E dep AAEE R S dss 309 13 Working with Databases A E AE E EEA es 311 Relational Database Support irosen asee yee a AS doe EA E OREA nales rio pensadas 311 Configuring Database Data Sources 20 0 0 0 cece cece ence nece ence ence eeeeeeseeeeaeeeaeeeaeeaaeeaeceueceneeennees 311 How to configure an IBM DB2 Data Source ooccoccnnccnnccnncnnccnnccnnconnconnccnnconnconnconncnnncnnnss 311 How to configure a Generic JDBC Data Source oocooocnnccnnccnnccnncnnncnnccnnconnccnnccnnccnnconacinicos 312 How to configure a Microsoft SQL Server Data Source 0 0 0 0 cece cece ce eece ee ceeeeeeeeeeeeaees 312 How to configure a MySQL Data Source oooccccccnncnnccnnccnnconnccnnccnncnnnconnconncnnncnnnrnnncnnronoss 312 xi lt oXygen gt XML Author 11 2 User Manual for Eclipse How to configure an Oracle 11g Data Source coooconocnnccnnccnncnnocnnocnnccnnconnccnncconconnconacinicos 313 How to configure a PostgreSQL 8 3 Data Source oocooocccccnccn
102. document container Xml documents are stored as individual nodes in the container That is each record in the underlying database contains a single leaf node its attributes and attribute values if any and its text nodes if any BDB XML also keeps the information it needs to reassemble the document from the individual nodes stored in the underlying databases This is the default and preferred container type The container contains entire documents the doc uments are stored without any manipulation of line breaks or whitespace Allow validation If checked it causes documents to be validated when they are loaded into the container The default behavior is to not validate documents Index nodes If checked it causes indices for the container to return nodes rather than documents The default is to index at the document level This property has no meaning if the container type is whole document container Actions available at container level Refresh performs a refresh of the selected node s subtree 2 Add Resource adds a new XML resource to the selected container Rename allows you to specify a new name for the selected container X Delete removes the selected container from the database tree Edit indices allows you to edit the indices for the selected container e Specifying the granularity e Document granularity is good for retrieving large documents 328 Working with Databases e Node granular
103. e E id ave a 47 AME Document Overview vesiesteen a a cuusdenssyettaen cheat sbhceed Ea 48 Cutliner at Ere i A A E O ee ee idk Ga ee 48 Modification FOMOW sUp rssi eea ap we cnepheea des hy A PESE VEERE ds 49 Document Structure Change moois R TE E E EE E r rro rro E E a E RT 49 The popup menu of the Outline tree oooccoocnnccnnccnnnnnnconocnnccnnconnccnnccnnccnncnnnoos 49 Document Tas Selection ein aere a ti SEA EEE R EE 50 Grouping documents in XML projects ssessssseesseeesreerrsresrrrerrrrrrsrrerrsrrsrrererrerrsrreersrrerreeesrt 50 Large Documents tii SA TE 50 Creating an included partis a seieren hee dee e Ea ANE REEE EN 51 Creating a New Project aiseee A N TEA EA AE sta pees 51 Including document parts with XInclude oocooocnnncnnccnnccnncnnccnnccnnconnconnccnncnnnconncrnncnnarnnncnnnnnoss 52 Working wath XM Catalof Sree a e e Di EN TS 54 Formatting and indenting documents pretty print oooconocnnccnnccnncnnncnnoconccnnconnconnccnnconnconncnnncnnnss 55 Viewing stat s information ia a ass 57 MI A OS 57 EGIb ACHONS Nidia A A AS A A ibi 57 Select actions 035 52h sri aero de Wee E sh em gentaacnetonecae deus saeesyebdaesacwangessceugdas dabas 57 SONDI EATA n KON i KEA E E A A A 58 AME doc ment actions csee a a EE TER AATE IRE REE 58 XML Refactoring Actions eps ae ie SRRA 59 Smart A hos bousdasceyelhas 4 va snescews tna lave guee tive shes A uadaestuvh fee dospdeemuencthee dee 60 Syntax highlight depending on namespace
104. editor variables displayed at the bottom of the dialog frameworks home cfd etc can be used in the values of the parameters to make the value independent of the location of the XSLT stylesheet or the XML document The value of a parameter can be entered at runtime if a value ask user message param type default value is used as value of parameter in the Configure parameters dialog ask message only the message displayed for the user is specified ask message generic default message will be displayed for the user the type is not specified the default 1s string the default value will be default ask message password message will be displayed for the user the characters typed will be replaced with a circle character e ask message password default same as above default value will be default e fask message url message will be displayed for the user the type of parameter will be URL ask message url default same as above default value will be default Additional XSLT Stylesheets The list of additional XSLT stylesheets can be edited in the dialog opened by the button Additional XSLT Stylesheets Add Adds a stylesheet in the Additional XSLT stylesheets list using a file browser dialog also you can type an editor variable in the file name field of the browser dialog The name of the stylesheet will be added in the list after the current s
105. element 3 xs comples Typal Wes all 1 xs element 1 ill Ixs schema 1 xs element 3 xs complexType 1 xs all 1 xs element 2 ref given xsischema 1 xs element 4 name Family type xs string E Note XPath 2 0 basic queries are executed using Saxon 9 PE engine XPath 2 0 schema aware queries are executed using Saxon EE engine 305 Querying documents The popup menu of the history list of the XPath dialog contains the action Remove for removing the selected expression from the history list Example 11 1 XPath Utilization with DocBook DTD The example is taken from a DocBook book based on the DocBook XML DTD The book contains a number of chapters DocBook defines that chapters as have a lt chapter gt start tag and matching lt chapter gt end tag to close the element To return all the chapter nodes of the book enter chapter into the XPath expression field then Enter This will return all the chapter nodes of the DocBook book in the Message Panel If your book has six chapters their will be six records in the result list Each record when clicked will locate and highlight the chapter and all sibling nodes contained between the start and end tags of the chapter If you used XPath to query for all example nodes contained in the section 2 node of a DocBook XML document you would use the following XPath expression chapter sect1 sect2 example If an example node is found in any section 2 node a result wil
106. element its namespace will be declared bind it to the abs prefix and then write a CSS rule namespace abs http www oxygenxml com sample documentation abstracts abs def font family monospace font size smaller abs def before content Definition color gray 149 Author Developer Guide Styling images The CSS 2 1 does not specify how an element can be rendered as an image To overpass this limitation lt oXygen gt Author supports a CSS Level 3 extension allowing to load image data from an URL The URL of the image must be specified by one of the element attributes and it is resolved through the catalogs specified in lt oXygen gt S Note lt oXygen gt Author recognizes the following image file formats JPEG GIF PNG and SVG The oXygen Author for Eclipse does not render the SVG files image display block content attr href url margin left 2em Our image element has the required attribute href of type xs anyURI The href attribute contains an image location so the rendered content is obtained by using the function attr href url Important The first argument is the name of the attribute pointing to the image file The second argument of the attr function specifies the type of the content If the type has the ur1 value then lt oXygen gt identifies the content as being an image If the type is missing then the content will be the text representing the attribute value Imp
107. entry like lt system systemId urn oasis names tc dita xsd topic xsd 1 1 uri topic xsd gt An XML Catalog file can be created quickly in lt oXygen gt starting from the two XML Catalog document templates called OASIS XML Catalog 1 0 and OASIS XML Catalog 1 1 and available in the document templates dialog User preferences related to XML Catalogs can be configured from Window Preferences 0Xygen XML XML Catalog 54 topic xsd 1 Editing documents Formatting and indenting documents pretty print In structured markup languages the whitespace between elements that is created by use of the Space bar Tab or multiple line breaks insertion from use of the Enter is not recognized by the parsing tools Often this means that when structured markup documents are opened they are arranged as one long unbroken line what seems to be a single paragraph While this is perfectly acceptable practice it makes editing difficult and increases the likelihood of errors being intro duced It also makes the identification of exact error positions difficult Formatting and Indenting also called Pretty Print enables such documents to be neatly arranged in a manner that is consistent and promotes easier reading on screen and in print output Pretty print is in no way associated with the layout or formatting that will be used in the transformed document This layout and formatting is supplied by the XSL stylesheet specified at the tim
108. expressed in pixels relative to the viewing device The value must be interpreted as a size expressed in millimeters The value must be interpreted as a size expressed in centimeters The value must be interpreted as a size expressed in inches 1 inch is equal to 2 54 centimeters The value must be interpreted as a size expressed in points The points used by CSS2 are equal to 1 72th of an inch The value must be interpreted as a size expressed in picas 1 pica is equal to 12 points This argument specifies a value that is used by default if the attribute value is missing This argument is optional 217 Author Developer Guide Example 8 7 Usage samples for the attr function Consider the following XML instance lt sample gt lt para bg_color AAAAFF gt Blue paragraph lt para gt lt para bg_color red gt Red paragraph lt para gt lt para bg_color red font_size 2 gt Red paragraph with large font lt para gt lt para bg_color 00AA00 font_size 0 8 space 4 gt Green paragraph with small font and margin lt para gt lt sample gt The para elements have bg_color attributes with RGB color values like AAAAFF You can use the attr function to change the elements appearance in the editor based on the value of this attribute background color attr bg_color color The attribute ont_si ze represents the font size in em units You can use this value to change the style of the element font size attr
109. extensions api node AuthorNode pk Resolver for content referred by elements named ref with a location attribute ky 258 Author Developer Guide public class ReferencesResolver implements AuthorReferenceResolver Logger for logging wy private static Logger logger Logger getLogger ReferencesResolver class getName pk Verifies if the handler considers the node to have references param node The node to be analyzed return lt code gt true lt code gt if it is has references 2 public boolean hasReferences AuthorNode node boolean hasReferences false if node getType AuthorNode NODE_TYPE_ELEMENT AuthorElement element AuthorElement node if ref equals element getLocalName AttrValue attrValue element getAttribute location hasReferences attrValue null return hasReferences pk Returns the name of the node that contains th xpanded referred content param node The node that contains references return The display name of the node ed public String getDisplayName AuthorNode node String displayNam ref fragment if node getType AuthorNode NODE_TYPE_ELEMENT AuthorElement element AuthorElement node if ref equals element getLocalName AttrValue attrValue element getAttribute location if
110. find th lement representing the table public void commitColumnWidthModifications AuthorDocumentController authorDocumentControll O amp amp colsStartOffset lt colsEndOffse throws AuthorOperationExcept t A WidthRepresentation colWidths String tableCellsTagName if td equals tableCellsTagName if colWidths null amp amp tableElement null if colsStartOffset gt 0 amp amp colsEndOffset gt authorDocumentController delete colsStartOffset colsEndOffset String xmlFragment createXMLFragment colWidths int offset 1 AuthorElement header tableElement getElementsByLocalName header if header null amp amp header length gt 0 Insert the cols elements before the header element offset header 0 getStartOffset if offset 1 throw new AuthorOperation authorDocumentController i private String createXMLFragment WidthRepresentation StringBuffer fragment nsertXMLFragment xmlFragment new StringBuffer String ns tabl for int i WidthRepresentation width t append lt customcol String strRepresentation trRepresentation fragment fragmen if s VE ns fragment fragmen Element i lt widt getNamespace hRepresentations length i widthRepresentations i 0 width getWidthRepresentation null
111. from templates MathML Equation Simple MathML template file The Microsoft Office OOXML document type Office Open XML also referred to as OOXML or OpenXML is a free and open Ecma http www ecma international org publications standards Ecma 376 htm international standard document format and a proposed ISO IEC standard for representing spreadsheets charts presentations and word processing documents OOXML uses a file package conforming to the Open Packaging Convention This format uses the ZIP file format and contains the individual files that form the basis of the document In addition to Office markup the package can also include embedded files such as images videos or other documents lt oXygen gt offers support for editing transforming and validating documents composing the OOXML package directly through the archive support Figure 7 6 Editing OOXML packages in lt oXygen gt EB Microsoft 20Word 20Document docx 3 EH Microsoft Word Document docx A B E _rels 3 docProps 3 3 word fo document xml 3 lt xml version 1 0 encoding UTF 8 standali lt widocument xmins ve http schemas openxml rn schemas microsoft com offic ttp schemas openxmlformats o xmlns m http schemas openxmlformats o pe j gt Text Grid Author Association rules A file is considered to be an OOXML document when it has one of the following namespaces http schemas openxmlformats org wordproce
112. from the list you must sometimes reopen the current edited files which use the modified catalog so that the changes take full effect 382 Configuring the application XML Parser The XML Parser preferences panel is opened from menu Window gt Preferences gt Author XML XML Parser Figure 17 33 The XML Parser preferences panel XML Parser XML Parser Features XML Parser Properties XInclude Options Enable Include processing Base URI fix up Language fix up RELAX NG C Check feasibly valid Check ID IDREF Schematron Schematron XPath Yersion 1 0 2 0 150 Schematron C Optimize visit no attributes C allow Foreign elements allow Foreign eS v http fapache org xml features walidationfschema full checking http fapache org xml features honour all schemalocations Ignore the DTD for validation if a schema is specified use Saxon EE schema aware for xslt2 query binding http apache org xml features valid ation schema full checking http apache org xml features hon our all schema location Ignore the DTD for validation if a schema is specified Enable XInclude processing Base URI fix up This option sets the schema full checking feature to true This option sets the honour all schema location feature to true This means all the schemas that are imported for a specific namespace are used to compose the validation model If this is false only the first schema import is ta
113. has child nodes You can click this sign to display the children The expand collapse actions can be also invoked by pressing the NumPad PLUS and NumPad MINUS keys A set of expand collapse actions can be accessed from the submenu Expand Collapse of the contextual menu Expand All Action Expands the selection and all its children Collapse All Action Collapses the selection and all its children eS Expand Children Action Expands all the children of the selection but not the selection Collapse Children Action Collapses all the children of the selection but not the selection Collapse Others Collapses all the siblings of the current selection but not the selection Specific Grid Actions In order to access these actions you can click the column header and choose from the contextual menu the item Table Sorting a Table Column You can sort the table by a specific column The sorting can be either ascending or descending The icons for this pair of actions are HA The sorting result depends on the data type of the column content and it can be different in case of number numerical sorting or text information alphabetical sorting The editor analyses automatically the content and decides what type of sorting to apply If there is present a mixed set of values in the column a dialog will be displayed allowing to choose the desired type between numerical and alphabetical 271 Grid Editor Inserting a row in a
114. has the following actions Set NULL sets the content of the cell to null This action is disabled for columns that cannot be null ZL Insert row inserts an empty row in the table Duplicate row makes a copy of the selected row and adds it in the Table Explorer view You should note that the new row will not be inserted in the database table until all conflicts are solved Commit row commits the selected row 320 Working with Databases X Delete row deletes the selected row e Copy copies the content of the cell e Paste performs paste in the selected cell Some of the above actions are also available on the Table Explorer toolbar _JExport to XML opens the Export Criteria dialog Refresh performs a refresh of the selected node s subtree LInsert row inserts an empty row in the table Duplicate row makes a copy of the selected row and adds it in the Table Explorer view You should note that the new row will not be inserted in the database table until all conflicts are solved Commit row commits the selected row X Delete row deletes the selected row Native XML Database NXD Support Native XML databases have an XML based internal model and their fundamental unit of storage is XML lt oXygen gt offers support for Berkeley DB XML eXist MarkLogic Software AG Tamino Raining Data TigerLogic Documentum xDb X Hive DB and Oracle XML DB Configuring Database Data Sources This
115. hyphen are also accepted When checked a word formed by concatenating a registered prefix and a legal word is accepted For example if mini is a registered prefix accepts mini computer When checked accepts any word ending with registered file extensions e g wow myfile txt index html etc When checked the acronyms are not reported as errors when checking the doc ument A list of XPath expressions for the elements that will be ignored by spell checking Only a small subset of XPath expressions are supported that is only the and separators and the wildcard An example of XPath expression a b The Document Checking preferences panel is opened from menu Window gt Preferences gt Author Editor Document Checking Figure 17 28 Document Checking preferences panel Document Checking Validate as you type Delay after the last key event s Clear validation markers on close A 1 Maximum number of problems reported per document 100 378 Configuring the application Validate as you type Validation of edited document is executed as the document is modified by editing in lt oXygen gt Delay after the last key event s The period of keyboard inactivity which starts a new validation in seconds Maximum number of errors reported If there are many validation errors the process of marking them in the document per document is long You should limit the maximum number of r
116. in editor variables and custom editor variables for parameterizing a file path XSLT FO XQuery The XSLT FO XQuery preferences panel is opened from menu Window Preferences Au thor XML XSLT FO XQuery Figure 17 37 The XSLT FO X Query preferences panel XSLT FO XQuery or C Create transformation temporary files in system temporary directory Check the option Create transformation temporary files in system temporary directory when creating transformation temporary files in the same folder as the source of the transformation breaks the transformation for example the transformation processes all the files located in the same folder as the source of the transformation which will include the temporary files which you probably do not want XSLT The XSLT preferences panel is opened from menu Window gt Preferences gt Author XML XSLT FO XQuery XSLT Figure 17 38 The XSLT preferences panel JAXP XSLT Transformer To use your own transformer set the value of the system property javax xml transform TransformerFactory Value Engine used for XSLT validation Scenario transformer takes precedence XSLT 1 0 Validate with Saxon6 5 5 XSLT 2 0 Validate with Saxon9B v 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 wi
117. is changed depending on the depth of the element while the font weight property remains unchanged no other rule is overwriting it It s useful to have before the title a constant text indicating that it refers to a section This text can include also the current section number The before and after pseudo elements will be used plus the CSS counters First declare a counter named sect for each book or article The counter is set to zero at the beginning of each such element book article counter reset sect The sect counter is incremented with each section that is the a direct child of a book or an article element book gt section article gt section counter increment sect The static text that will prefix the section title is composed of the constant Section followed by the decimal value of the sect counter and a dot book gt section gt title before article gt section gt title beforel content Section counter sect To make the documents easy to read you add a margin to the sections In this way the higher nesting level the larger the left side indent The margin is expressed relatively to the parent bounds section margin left lem margin top lem 146 Author Developer Guide Figure 8 3 A sample of nested sections and their titles document book section title My Technical Book Section 1 XML Definition Extensible Markup Language In this section of
118. lib directory of your project 301 Transforming documents e Implement the ro sync xml transformer xproc api XProcTransformerInterface according with the API that you can find in the xprocAPI zip e Create a new java archive jar from the classes you created e Create a new engine xml file according with the engine dtd file The attributes of the engine tag have the following meanings 1 Ze 6 7 name The name of the XProc engine description A short description of the XProc engine Class The complete name of the class that implements ro sync xml transformer xproc api XProc TransformerInterface version The version of this integration engineVersion The version of the integrated engine vendor The name of the vendor implementor supportsValidation true if the engine supports validation false otherwise The engine tag has only one child runt ime The runt ime tag contains several library elements who s at tribute name contains the relative or absolute location of the libraries necessary to run this integration e Create a new folder with the name of the integration in the oXygenInstallDir 1lib xproc and put there the engine xml and all the libraries necessary to run properly the new integration The Javadoc documentation of the XProc API is available for download in the following zip file xprocAPI zip http www oxygenxml com InstData Editor Developer xprocAPI zip 302
119. lt td gt lt header gt lt tr gt lt td gt lt td gt lt tr gt lt table gt lt section gt lt book gt The Article xml file lt xml version 1 0 encoding UTF 8 gt lt article xmlns http www oxygenxml com sample documentation xmlns xsi http www w3 org 2001 XMLSchema instance gt lt title gt lt title gt lt section gt lt title gt lt title gt lt para gt lt para gt lt para gt lt para gt lt section gt lt article gt You can also use editor variables in the template files content and they will be expanded when the files are opened Open the Document Type dialog for the SDF framework and click on the Templates tab Enter in the Templates directory text field the value frameworksDir sdf templates As you already seen before it is recommended that all the file references made from a Document Type Association to be relative to the frameworksDir directory Binding a Document Type Association to an absolute file e g C some_dir templates makes the association difficult to share between users 179 Author Developer Guide To test the templates settings press the File New menu item to display the New dialog The names of the two templates are prefixed with the name of the Document Type Association in our case SDF Selecting one of them should create a new XML file with the content specified in the template file Configuring XML Catalogs You can add cat
120. lt figure gt or lt inlinemediaob ject gt element depending on the current context The following graphical formats are supported GIF JPG JPEG BMP PNG SVG AA as kc Insert Content Reference inserts a content reference at the caret position The DITA conref attribute provides a mechanism for reuse of content fragments The conref attribute stores a reference to another element and is processed to replace the referencing element with the referenced element The element containing the content reference acts as a placeholder for the referenced element The identifier for the referenced element must be either absolute or resolvable in the context of the referencing element See here http docs oasis open org dita v1 0 archspec conref html for more details lt oXygen gt will display the referred content of a DITA conref if it can resolve it to a valid resource If you use URI s instead of local paths and you have a catalog used in the DITA OT transformation you can add the catalog to lt oXygen gt and if the URI s can be resolved the referred content will be displayed A content reference is inserted with the action Insert a DITA Content Reference available on the toolbar Author custom actions and on the menu DITA Insert 116 Predefined document types Figure 7 4 Insert Content Reference Dialog Insert Content Reference URL bamples dita flowers topicsjiris xml er Target type al ix
121. lt oXygen gt XML Author 11 2 User Manual for Eclipse SyncRO Soft Ltd lt oXygen gt XML Author 11 2 User Manual for Eclipse SyncRO Soft Ltd Copyright O 2002 2009 SyncRO Soft Ltd All Rights Reserved lt oXygen gt XML Author User Manual Copyright O 2009 Syncro Soft SRL AU rights reserved No parts of this work may be reproduced in any form or by any means graphic electronic or mechanical including photocopying recording taping or information storage and retrieval systems without the written permission of the publisher Products that are referred to in this document may be either trademarks and or registered trademarks of the respective owners The publisher and the author make no claim to these trademarks While every precaution has been taken in the preparation of this document the publisher and the author assume no responsibility for errors or omissions or for damages resulting from the use of information contained in this document or from the use of programs and source code that may accompany it In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused directly or indirectly by this document 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 b
122. lt oXygen gt supports any XML catalog file that conforms to one of e the OASIS XML Catalogs Committee Specification v1 1 http www oasis open org committees download php 14809 xml catalogs html e the OASIS Technical Resolution 9401 1997 http www oasis open org specs a401 htm including the plain text flavor described in that resolution The version 1 1 of the OASIS XML Catalog specification introduces the possibility to map a system ID a public ID or a URI to a local copy using only a suffix of the ID or URI used in the actual document This is done using the new catalog element s system Su f fi x http www oasis open org committees download php 14809 xml catalogs html s systemsuffix and uriSuffix http www oasis open org committees download php 14809 xml catalogs html s urisuffix An XML catalog can be used also to map a W3C XML Schema specified with an URN in the xsi schemaLocation at tribute of an XML document to a local copy of the schema For example if the XML document specifies the schema with lt topic xmlns xsi http www w3 org 2001 XMLSchema instance xsi noNamespaceSchemaLocation urn oasis names tc dita xsd Inside an XML Schema if an xs import statement specifies only the namespace attribute without the schemaLocation attribute lt oXygen gt will try to resolve the specified namespace URI through one of the XML catalogs configured in Preferences the URN can be resolved to a local schema file with a catalog
123. lt oXygen gt will insert automatically the optional elements from the DTD or XML Schema or RELAX NG schema This option is applied also in the Author mode of the XML editor When checked lt oXygen gt will insert automatically the first Choice particle from the DTD or XML Schema or RELAX NG schema This option is applied also in the Author mode of the XML editor When it is checked the search in the content completion window when you type a character is case sensitive a and A are different characters This option is applied also in the Author mode of the XML editor 369 Configuring the application Cursor position between tags Show all entities Insert the required attributes Insert the fixed attributes Show recently used items Maximum number of recent items shown Learn attributes values Learn on open document Learn words Dynamic Abbrevi ations available on CTRL SPACE Annotations When checked lt oXygen gt will set the cursor automatically between tags Even if the auto inserted elements have attributes that are not required the position of cursor can be forced between tags 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 amp When checked lt oXygen gt will insert automatically the required attributes from the DTD or XML Schema for an e
124. mplements AuthorSchemaAware http www oxygenxml co EditingHandler m sample documentati 245 Author Developer Guide SDF table element name f private static final String SDF_TABLE table SDF table row name uf private static final String SDF_TABLE_ROW tr SDF table cell name wf private static final String SDF_TABLE_CELL td SDF section element name f private static final String SECTION section SDF para element name af protected static final String PARA para pk SDF title element name xf protected static final String TITLE title see ro sync ecss extensions api AuthorSchemaAwareEditingHandler handleDelete int int ro sync ecss extensions api AuthorAccess boolean Ef public boolean handleDelete int offset int deleteType AuthorAccess authorAccess boolean wordLevel throws InvalidEditException Not handled return false pk see ro sync ecss extensions api AuthorSchemaAwareEditingHandlerfhandleDeleteElementTags ro sync ecss extensions api node AuthorNode ro sync ecss extensions api AuthorAcces Y public boolean handleDeleteElementTags AuthorNode nodeToUnwrap AuthorAccess authorAcces throws InvalidEditException Not handled return false see ro sync ecss extensions api AuthorSchemaAwareEditingHandl
125. new SDFAuthorCaretListener authorAccess getEditorAccess addAuthorCaretListener sdfCaretListener Other custom initializations 187 Author Developer Guide The authorAccess parameter received by the activated method can be used to gain access to Author specific actions and informations related to components like the editor document workspace tables change tracking a s o If options specific to the custom developed Author extension need to be stored or retrieved a reference to the Op tionsStorage can be obtained by calling the yetOptionsStorage method from the author access The same object can be used to register OptionListener listeners An option listener is registered in relation with an option key and will be notified about the value changes of that option An AuthorListener can be used if events related to the Author document modifications are of interest The listener can be added to the AuthorDocumentController A reference to the document controller is returned by the getDocumentController method from the author access The document controller can also be used to perform operations involving document modifications To provide access to Author editor component related functionality and informations the author access has a reference to the AuthorEditorAccess that can be obtained when calling the getEditorAccess method At this level AuthorMouseListener and AuthorCaretListener can be added which will be notified
126. of client michael test oxy ro mary test oxy ro Text Grid Author dbx Configuring New File Templates You will create a set of document templates that the content authors will use as starting points for creating new Simple Document Framework books and articles Each of the Document Type Associations can point to a directory usually named templates containing the file templates All the files that are found here are considered templates for the respective document type The template name is taken from the name of the file and the template kind is detected from the file extension Create the templates directory into the frameworks SDF directory The directory tree for the documentation framework is now 178 Author Developer Guide oxygen frameworks sdf schema css templates Now let s create in this templates directory two files one for the book template and another for the article template The Book xml file lt xml version 1 0 encoding UTF 8 gt lt book xmlns http www oxygenxml com sample documentation xmlns xsi http www w3 org 2001 XMLSchema instance xmlns abs http www oxygenxml com sample documentation abstracts gt lt title gt Book Template Title lt title gt lt section gt lt title gt Section Title lt title gt lt abs def gt lt para gt This content is copyrighted lt para gt lt table gt lt header gt lt td gt Company lt td gt lt td gt Date
127. of type ID public class DefaultElementLocatorProvider implements ElementLocatorProvider Logger for logging private static Logger logger Logger getLogger DefaultElementLocatorProvider class getName j see ro sync ecss extensions api link ElementLocatorProvider getElementLocator ro sync ecss extensions api link IDTypeVerifier E java lang String ay public ElementLocator getElementLocator IDTypeVerifier idVerifier String link ElementLocator elementLocator null try if link startsWith element xpointer element scheme elementLocator new XPointerElementLocator idVerifier link else Locate link element by ID elementLocator new IDElementLocator idVerifier link catch ElementLocatorException e logger warn Exception when creat lement locator for link link Cause e e return elementLocator see ro sync ecss extensions api Extension getDescription ee public String getDescription return Default implementation for locating element The following cases are covered xinclude e and ID based links XPointerElementLocator java package ro sync ecss extensions commons s based on a given link n lement scheme 263 Author Developer Guide import java util Stack import java util StringTokenizer import org apache log4
128. offered in the content completion window Tf the edited document is not associated with a schema explicitly using the usual mechanisms for associating a DTD or XML Schema with a document or using a processing instruction introduced by the Associate schema action the content assistant will extract the elements presented in the pop up window from the default schema If the schema for the document is of type XML Schema Relax NG full syntax NVDL or DTD and it contains element attributes or attributes values annotations these will be presented when the content completion window is displayed if the option Show annotations is enabled Also the annotation is presented in a small tooltip window displayed automatically when the mouse hovers over an element or attribute annotated in the associated schema of the edited document In an XML Schema annotations are put in an lt xs annotation gt element lt xs annotation gt lt xs documentation gt Description of the element lt xs documentation gt lt xs annotation gt If the current element attribute in the edited document does not have an annotation in the schema and that schema is of the type XML Schema lt oXygen gt seeks an annotation in the type definition of the element attribute or if no an notation is found there in the parent type definition of that definition etc When editing a Schematron schema the content completion assistant displays XSLT 1 0 functions and optionally XSLT
129. option on the command line Senigesere EOS a count fo saxon compile stylesheet stylesheet v Name elements in lt sch Z a gt ue returned is dependent on informati attribute lt sch assert arser For an element node lt sch rule gt In a Relax NG schema any element outside the Relax NG namespace http relaxng org ns structure 1 0 is handled as annotation and the text content is displayed in the annotation window together with the content completion window For NVDL schemas annotations for the elements attributes in the referred schemas XML Schema RNG etc are presented Figure 4 12 Schema annotations displayed at Content Completion lt start gt lt element name startElem gt lt element gt lt ref name startElementRef gt lt choice gt lt start gt lt define name startElementRef b lt define gt This attribute specifies how multiple definitions of a pattern combine named pattern or start pattern should be combined The datatypeLibrary possible values are choice and interleave When the combine ns attribute is specified and set to choice multiple definitions of a pattern are combined in a choice pattern When the combine attribute is specified and set to interleave multiple definitions of a pattern are combined in an interleave pattern Note that it s forbidden to specify more than one define with the same name and no combine attribute or multiple defines with different values
130. option with the same name set in the user preferences The advanced options include two options that are not available globally in the user preferences the initial XSLT template and the initial XSLT mode of the transformation They are Saxon specific options that allow imposing the name of the first XSLT template that starts the XSLT transformation or the initial mode of transformation 281 Transforming documents Figure 10 3 The advanced options of Saxon HE PE EE Saxon EE 9 2 0 2 Advanced options Initial mode and template Template Saxon HE PE EE options C version warnings not noww DTD based validation of the source file v C Line numbering 1 Recoverable errors Recover with warnings w1 Strip whitespaces Ignore signorable Optimization level 10 v Saxon PE EE options C Disable calls on extension functions noext Saxon EE specific options x Validation of the source file Lax schema validation wlax Validation errors in the result tree treated as warnings vw OY The advanced options specific for Saxon PE EE are Initial mode Initial template Use a configuration file Disable calls on extension functions Version warnings DTD based validation of the source file Line numbering Handling of recoverable stylesheet errors Strip whitespaces Specifies to the transformer the initial templ
131. performed change Inserted content color Auto Automatically assign colors for the insert changes based on the Author name Custom Use a custom color for all insert changes regardless of the Author name Deleted content color Auto Automatically assign colors for the delete changes based on the Author name Custom Use a custom color for all delete changes regardless of the Author name Messages Figure 17 12 The Author s Messages preferences panel Messages C Show author page warning C Show warning when switching to Developer Role Show author page warning When checked a warning dialog will be displayed when switching to Author mode The warning reminds you that the whitespaces from the text content are evaluated according to the value of the CSS white space property associated to the enclosing elements Show warning when switching to When checked a warning dialog will be displayed when choosing to switch to Developer Role developer role in the Document Type Association page Format The Format preferences panel is opened from menu Window gt Preferences gt Author Editor Format 363 Configuring the application Figure 17 13 The Format preferences panel Format Py Indent Detect indent on open Indent size Hard line wrap Limit to Line width Format and Indent Indent on enter Enable smart enter Format and Indent C Detect line width on open C Format and indent the document on op
132. pin xal an exe o out t xml xsl O 397 Configuring the application Engine type Name Description Output Encoding Error Encoding Working directory Command line Data Sources Combo box allowing you to choose the transformer type There are two options XSLT engines and XQuery engines The name of the transformer displayed in the dialog for editing transformation scenarios Text description of the transformer The encoding of the characters sent to the output stream of the transformer The encoding of the characters sent to the error stream of the transformer The start directory of the transformer executable program The following editor variables are available for making the path to the working directory independent of the input XML file e homeDir the user home directory in the operating system e c a the path to the directory of the current file e pad the path to the directory of the current project e S oxygenInstallDir the lt oXygen gt install directory The command line that must be executed by lt oXygen gt to perform a transformation with the engine The following editor variables are available for making the items of the com mand line the transformer executable the input files independent of the input XML file e S xml the XML input document as a file path e S xmlu the XML input document as a URL e xs1 the XSL XQuery input document as a fil
133. referred location link href beforel display inline link attr href content Click to open attr href Note If you plan to use IDs as references for links the value of the link property should start with a sharp sign This will ensure that the default link target reference finder implementation will work and clicking on the link will send you to the indicated location in the document For more details about the link target reference finder read the section Configuring a Link target reference finder Example 8 1 IDs as references for links link linkend before display inline link attr linkend content Click to open attr linkend Third Step The Association After creating the XML Schema and the CSS stylesheet for the documents that will be edited a distributable framework package can be created for content authors 152 Author Developer Guide Figure 8 6 The Document Type Dialog Document type Name SDF Description A Simple Documentation Framework Storage Internal O External Rules Namespace Root local name File name Public ID Jaya class 39 x Schema Classpath Author Templates Catalogs Transformation Extensions The schema defined here is used only if there is no schema detected in the XML file Schema type xm Schema x Schema URI 4 frameworks sdfisdF xsd w t C Initial page
134. same document the user switches to another page or the editor is closed A complete description and implementation of an ro sync ecss extensions api AuthorExtensionStateListener can be found in the Imple menting an Author Extension State Listener 184 Author Developer Guide If Schema Aware mode is active in Oxygen all actions that can generate invalid content will be redirected toward the AuthorSchemaAwareEditingHandler The handler can either resolve a specific case let the default implementation take place or reject the edit entirely by throwing an InvalidEditException The actions that are forwarded to this handler include typing delete or paste See the Implementing an Author Schema Aware Editing Handler section for more details about this handler Customizations of the content completion proposals are permitted by creating a schema manager filter extension The interface that declares the methods used for content completion proposals filtering is ro sync content completion xml SchemaManagerFilter The filter can be applied on elements attributes or on their values Responsible for creating the content completion filter is the method createSchemaManagerFilter Anew SchemaManagerFilter will be created each time a document matches the rules defined by the Document Type Association which contains the filter declaration public SchemaManagerFilter createSchemaManagerFilter return new SDFSchemaManagerFilter
135. scenario 3 Click in the Name field and type a new name 4 Click OK or Transform Now to save the scenario Transformation Scenarios view The list of transformation scenarios may be easier to manage for some users as a list presented in a dockable and floating view called Transformation Scenarios 288 Transforming documents Figure 10 7 The Scenarios view amp Transformation Scenarios 3 5 OB Baxa a E XML transformation with XSLT E XML transformation with XQUERY k DITA OT transformation DITA XHTML DITA PDF Idiom FO Plugin DITA Map XHTML DITA Map PDF Idiom FO Plugin test_lang XHTML 3 XSLT transformation personal E XProc transformation gt E XQUERY transformation Execute XQuery Execute XQuery v11 0 Execute XQuery v11 1 E SQL transformation Execute SQL gt Apply New Duplicate Q Edit X Remove Show current editor scenarios gt Type filter text The actions available on the right click menu allow the same operations as in the dialog Configure Transformation Scenario creating editing executing duplicating and removing a transformation scenario XSL FO processors The lt oXygen gt installation package is distributed with the Apache FOP http xml apache org fop index html Formatting Objects Processor for rendering your XML documents to PDF FOP is a print and output independent formatter driven by XSL Formatting Objects FOP is implemen
136. script language JavaScript type text javascript gt var javawsInstalled 0 var javawsl2Installed 0 var javaws142Installed 0 isIE false if navigator mimeTypes amp amp navigator mimeTypes length x navigator mimeTypes application x Java 3jnlp file if x javawsInstalled 1 javawsl2Installed 1 javaws142Installed 1 55 Editing documents else isIE true lt script gt this code can be enclosed in an XML comment to make the document well formed before applying the Format and Indent action lt script language JavaScript type text javascript gt lt var javawsInstalled 0 var javawsl2Installed 0 var javaws142Installed 0 isIE false if navigator mimeTypes amp amp navigator mimeTypes length x navigator mimeTypes application x Jjava 3jnlp file if x javawsInstalled 1 javawsl2Installed 1 javaws142Installed 1 else isIE true gt lt script gt To change the indenting of the current selected text see the action Indent selection For user preferences related to formatting and indenting like Detect indent on open and Indent on paste see the corres ponding Preferences panel XML elements can be excepted from the reformatting performed by the pretty print operation by including them in the Preserve space elements XPath list That means that when the Format and Indent pretty print action encoun
137. sdf schema sdf xsd We should use the frame works editor variable in the schema URI path instead of a full path in order to be valid for different lt oXygen gt installations M Important The frameworks variable is expanded at the validation time into the absolute location of the directory containing the frameworks Author CSS Settings Select the Author tab from the Document Type edit dialog By clicking on the CSS label in the right part of the tab the list of associated CSSs is shown 157 Author Developer Guide Here you can also specify how should the CSSs defined in the document type be treated when there are CSSs specified in the document with xm1 stylesheet processing instructions The CSSs from the document can either replace the CSSs defined in the document type association or merge with them Add the URI of the CSS file sdf css you already defined You should use the frameworks editor variable in the file path Figure 8 8 CSS settings dialog 3 css a URI frameworks sdf css sdf css gt IS Title _ Alternate The Title text field refers to a symbolic name for the stylesheet When adding several stylesheets with different titles to a Document Type association the content author can select what CSS will be used for editing from the Author CSS Alternatives toolbar This combo box from the toolbar is also populated in case your XML document refers CSSs directly using x
138. section presents a set of procedures describing how to configure NXD data sources How to configure a Berkeley DB XML datasource The latest instructions on how to configure Berkeley DB XML support in lt oXygen gt can be found on our website http www oxygenxml com doc ug oxygenEclipse native xml database support html configure berkeley datasource lt oXygen gt supports Berkeley DB XML versions 2 3 10 2 4 13 amp 2 4 16 The following directory definitions shall apply OXY_DIR lt oXygen gt installation root directory for example on Windows C Program Files Oxygen 11 2 DBXML_DIR Berkeley DB XML database root directory for example on Windows C Program Files Sleepycat Software Berkeley DB XML lt version gt DBXML_LIBRARY_DIR usually on Mac and Unix is DBXML_DIR lib and on Windows is DBXML_DIR bin 1 Go to Preferences gt Data Sources In the Data Sources panel click the New button 2 Enter a unique name for this data source and select Berkeley DBXML from the driver type combo box 3 Press the Add button to add the following Berkeley DB specific files e db jar check for it into DBXML_DIR lib or DBXML_DIR ar 321 Working with Databases e dbxml jar check for it into DBXML_DIR lib or DBXML_DIR jar 4 Click OK to finish the data source configuration How to configure an eXist datasource The latest instructions on how to configure eXist support in lt oXygen gt can be found on our website http
139. so for using the private key and passphrase you have to remove the password from the dialog used to browse the server repository and leave only the user name The private key file and the passphrase must be set in the SFTP user preferences S Note WebDAV access is available only if you check the Enable the HTTP WebDAV protocols option from Window gt Preferences oXygen Network Configuration page The proxy settings set in Window gt Preferences Gen eral Network Connections are valid also in the lt oXygen gt plugin that is if an HTTP proxy server a SOCKS proxy server or a list with excepted host names is set there any HTTP WebDAV connection made with the lt oXygen gt plugin will take into consideration these settings To open the remote files choose from the main menu File gt Open URL The displayed dialog is composed of sev eral parts 23 Editing documents e The editable combo box in which it can be specified directly the URL to be opened or saved i URLs that can be directly opened You can type in here an URL like ftp anonymous some site home test xml if the file is accessible through anonymous FTP This combo box is also displaying the current selection when the user changes selection by browsing the tree of folders and files on the server e The Identification section contains the access credentials If you want to browse for a file on a server you have to specify the user and password This i
140. support in lt oXygen gt Author CSS 2 1 features Supported selectors The following CSS level 2 1 selectors are supported by the lt oXygen gt Author 209 Author Developer Guide Table 8 3 Supported CSS 2 1 selectors Expression Name Description Example Universal selector Matches any element E Type selector Matches any E element i e an element with the local name E EF Descendant selector Matches any F element that is a descendant of an E element E gt F Child selectors Matches any F element that is a child of an element E E first child The first child pseudo class Matches element E when E is the first child of its parent E lang c The lang pseudo class Matches element of type E if it is in human language c the document language specifies how language is determined E F Adjacent selector Matches any F element immediately preceded by a sibling element E E foo Attribute selector Matches any E element with the foo attribute set whatever the value E foo warning Attribute selector Matches any E element whose foo attribute value is exactly equal to warning E foo warning Attribute selector Matches any E element whose foo attribute value is a list of space separated values one of which is exactly equal to warning E langl en Attribute selector Matches any E element whose lang attribute has a hyphen sep arated list of values begin
141. the dita dir parameter to your custom DITA OT install ation directory Also in the Advanced tab the Libraries button you have to add e thedost jar and resolver jar libraries as file paths that point to the libraries from your custom DITA OT installation directory e the installation directory of your custom DITA OT and the 1 ib subdirectory of that installation directory as directory paths Using your custom build file You can specify a custom build file to be used in DITA OT ANT transformations by editing the transformation scenario that you are using and in the Advanced tab change the Custom build file path to point to the custom build file Customizing the lt oXygen gt Ant tool The ANT 1 7 tool which comes with lt oXygen gt is located in the INSTALLATION_DIRECTORY tools ant directory Any additional libraries for ANT must be copied to the lt oXygen gt ANT 1 ib directory Example 6 3 Enabling JavaScript in ANT build files If you are using Java 1 6 to run lt oXygen gt the ANT tool should need to additional libraries to process JavaScript in build files If you are using Java 1 5 you have to copy the bsf jar http jakarta apache org bsf and js jar http www mozilla org rhino download html libraries in the lt oXygen gt ANT 11 b directory Upgrading to a new version of DITA OT The DITA OT framework bundled in lt oXygen gt is located in the INSTALLATION_DIRECTORY frame works dita DITA OT directory
142. the book I will explain different XIML applications Section 2 Accessing XML data XSLT Definition DExtensible stylesheet language transformation XSLT is a language for transforming XML documents into other XML documents 4 A list of XSL elements and what they do Text Grid Author In the above screenshot you can see a sample XML document rendered by the CSS stylesheet The selection avoids the text that is generated by the CSS content property This happens because the CSS generated text is not present in the XML document and is just a visual aid Styling the table Element There are standard CSS properties used to indicate what elements are tables table rows and table cells What CSS is missing is the possibility to indicate the cell spanning lt oXygen gt Author offers support for adding an extension to solve this problem This will be presented in the next chapters The table in this example is a simple one The header must be formatted in a different way than the ordinary rows so it will have a background color table display table border 1px solid navy margin lem max width 1000px min width 150px table width width attr width length tr header display table row header background color silver color inherit td display table cell border 1px solid navy 147 Author Developer Guide padding lem Note Children elements with block o
143. the content of cell from current caret position with that of the cell above it Note that this action works only if both cells have the same column span ElJoin Cell Below joins the content of cell from current caret position with that of the cell below it Note that this action works only if both cells have the same column span E Split Cell To The Left splits the cell from current caret position in two inserting a new empty table cell to the left Note that this action works only if the current cell spans over more than one column The column span of the source cell will be decreased with one at Split Cell To The Right splits the cell from current caret position in two inserting a new empty table cell to the right Note that this action works only if the current cell spans over more than one column The column span of the source cell will be decreased with one 110 Predefined document types La e Split Cell Above splits the cell from current caret position in two inserting a new empty table cell above Note that this action works only if the current cell spans over more than one row The row span of the source cell will be decreased with one E Split Cell Below splits the cell from current caret position in two inserting a new empty table cell below Note that this action works only if the current cell spans over more than one row The row span of the source cell will be decreased with one Note DocBook
144. the given context is null then the given list of content completion elements con global elements return elements The elements or attributes values can be filtered using the filterElementValues or filterAttributeValues methods The complete source code of the SDF SchemaManagerFilter implementation is found in the Example Files Listings the Java Files section Configuring a Link target element finder The link target reference finder represents the support for finding references from links which indicate specific elements inside an XML document This support will only be available if a schema is associated with the document type If you do not define a custom link target reference finder the DefaultElement LocatorProvider implement ation will be used by default The interface which should be implemented for a custom link target reference finder is ro sync ecss extensions api link ElementLocatorProvider As an alternative the ro sync ecss extensions commons DefaultElementLocatorProvider implementation can also be extended The used ElementLocatorProvider will be queried for an ElementLocator when a link location must be determined when user clicks on a link Then to find the corresponding linked element the obtained Element Loc ator will be queried for each element from the document The DefaultElementLocatorProvider implementation The DefaultElementLocatorProvider implementation offers su
145. the relevant vendors change their terms By using lt oXygen gt XML Author the user accepts responsibility to maintain any licenses required by SyncRO Soft Ltd or third party vendors unless SyncRO Soft Ltd declares in writing that the lt oXygen gt XML Author license is inclusive of third party licensing Printed November 2009 Table of Contents o O SO 1 Key Features and BES A ads 1 2 Installation aro ino rales votes ASEE costed a EEES AEU EEE PARARE 2 Installation Requirements ai er 2 Platform Requirements usina tii E N E EE E E A Paso ease R 2 Operating System Tools and Environment Requirements occooccnnconnconnconnconncnnncnncnnnrnnncnnccnncinnicnno 2 Operating Systemessd sais ci oes ads EE vend Gees E E EATE as EES PESADES chugs IE PESO ES VS AERE E 2 A O EESE 2 Environment Prerequisites indicios ratero artes do pais ia iron Unas pode egos 2 Installation Instructions 2 25 sses cebs AO Ed qa isis 3 Starting lt oXygen gt XML Author plugin 6 ccc cccces 3 ssecdsesesecnsagsvesee ess sceeesdgeecseess secs esisedeassasevenagseesbanes 4 Obtaining and registering a license key 0 2 0 0 cece cece ceee cece cece cece ceca cen eeeeeeeeeeeceeeeaeeeaeeeaeeea sean sean eeaes 4 Named User license registration vasos conos ni sith aora bet a E E pos otros sos 4 How floating concurrent licenses work oooococcnoccconococononocononocononocononoconororo nono ro nroronaroconanoronos 5 How to install the lt oXygen
146. the resources Refresh performs a refresh of the selected node es Properties displays the properties of the current file in a dialog like the following 332 Chapter 14 Content Management System CMS Integration Documentum CMS Support lt oXygen gt provides support for browsing and managing Documentum repositories in the Data Source Explorer You can easily create new resources on the repository copy or move them using the actions or the drag and drop support edit and transform the documents in the editor The operations that can be performed on repository resources are described in the Documentum CMS actions section lt oXygen gt supports Documentum CMS version 6 5 and above with Documentum Foundation Services 6 5 or later installed Note The Documentum CMS support is available only in the Enterprise version Warning It is recommended to use the latest 1 5 x or 1 6 x java version It si possible that the Documentum CMS support will not work properly if you use other java versions Warning Please note that at the time of this implementation there is a problem in the UCF Client implementation for MAC OS X which prevents you from viewing or editing XML documents from the repository The UCF Client is the component responsible for file transfer between the repository and the local machine This component is deployed automatically from the server How to configure Documentum CMS support
147. they are not visible in the editor If he edits documents conforming to one of the predefined types he does not need to configure anything as the predefined document types are already configured when the application is installed Otherwise he must plug the configuration of the document type into the application This is as easy as unzipping an archive directly in the frameworks subfolder of the application s install folder In case the edited XML document does not belong to one of the document types set up in Preferences you can specify the CSSs to be used by inserting an xml stylesheet processing instructions You can insert the processing instruction by editing the document or by using the 54 Associate XSLT CSS stylesheet action The syntax of such a processing instruction is lt xml stylesheet type text css media media type title title href URL alternate yes no gt You can read more about associating a CSS to a document the syntax and the use of the xml stylesheet processing in struction in the section Author CSS Settings When the document has no CSS association or the referred stylesheet files cannot be loaded a default one will be used A warning message will also be displayed at the beginning of the document presenting the reason why the CSS cannot be loaded Note In general it is recommended to associate a CSS while in Text mode so that the whitespace normalization rules specified in the stylesheets will be prope
148. thorOptionsSal1 2 xml start the lt oXygen gt standalone distribution and the Eclipse settings will be automat ically imported Reset Global Options To reset all custom user settings of the application that are stored in a local file not in the project to the installation defaults go to Window Preferences gt Author Reset Global Options The list of transformation scenarios will be reset to the default scenarios Scenarios Management You can import export and reset the scenarios stored in the global options The action Window gt Preferences oXygen Scenarios Management L Import Global Transformation Scenarios loads a properties file with scenarios 408 Configuring the application The action Window gt Preferences oXygen Scenarios Management H Export Global Transformation scenarios stores all the scenarios in a separate properties file The action Window gt Preferences oXygen Scenarios Management Import Global Validation Scenarios loads a properties file with scenarios The action Window gt Preferences oXygen Scenarios Management el Export Global Validation scenarios stores all the scenarios in a separate properties file The option to Export Transformation Validation Scenarios is used to store all the scenarios in a separate file a prop erties file In this file will also be saved the associations between document URLs and scenarios The saved URLs are absolute You can lo
149. uniquely identify the current framework Such an ID must be provided especially if options related to the framework need to be persistently stored and re trieved between sessions public String getDocumentTypelD return Simple Document Framework document type public String getDescription return A custom extensions bundle used for the Simple Document Framework document type In order to be notified about the activation of the custom Author extension in relation with an opened document an ro sync ecss extensions api AuthorExtensionStateListener should be implemented The activation and deactivation events received by this listener should be used to perform custom initializations and to register remove listeners like ro sync ecss extensions api AuthorListener ro sync ecss extensions api AuthorMouseListener or ro sync ecss exten sions api AuthorCaretListener The custom author extension state listener should be provided by implementing the method createAuthorExtensionStateListener Listener createAuthorExtensionStateListener xtensionStateListener public AuthorExtensionSta return new SDFAuthor Gr fI The AuthorExtensionStateListener is instantiated and notified about the activation of the framework when the rules of the Document Type Association match a document opened in the Author editor page The listener is notified about the deactivation when another framework is activated for the
150. unprefixed ele ments used in the XPath console Associates prefixes to namespaces These mappings are useful when applying an XPath in XPath console and you don t have to define these mappings for each document separately The New button creates an editable prefix namespace mapping 396 Configuring the application The Remove button deletes the selected mapping Custom Engines One can configure transformation engines other than the ones which come with the lt oXygen gt distribution Such an external engine can be used for XSLT XQuery transformations within lt oXygen gt in the Editor perspective and is available in the list of engines in the dialog for editing transformation scenarios The Custom Engines preferences panel is opened from menu Window Preferences Au thor XML XSLT FO XQuery Custom Engines Figure 17 48 Configuration of custom transformation engines Custom engines Gee Sablotron The Sablotron transformer Transformiix The Mozilla transformer New Edit Delete The following parameters can be configured for a custom engine Figure 17 49 Parameters of a custom transformation engine Command line X Engine type XSLT Name Xalan Description C language version of Apache Xalan Output Encoding Default encoding x Error Encoding Default encoding ix Working directory 2 Command line D projects externalTransfor mers xalanc
151. valid and thus it cannot be updated e If the content of the edited cell does not belong to the data type of the column an Information dialog will appear notifying you that the value you have inserted cannot be converted to the SQL type of that field For example in the above figure DEPARTMENT_ID contains NUMBER values If a character or string was inserted you would get the error message that a String value cannot be converted to the requested SQL type NUMBER If the constraints of the database are not met like primary key constraints for example an Information dialog will appear notifying you of the reason the database has not been updated For example if you d try to set the primary key DEPARTMENT_ID for the second record in the table to 10 also you would get the following message Figure 13 5 Duplicate entry for primary key ES z 1 EX OD DEPARTMENT_ID NUMBER DEPARTMENT_NAME VARCHAR2 MANAGER_ID NUMB LOCATION_ID NUMB Al 0 10 ini j 171 1 20 57 181 o Error HE 3 40 24 4 50 Error ORA 00001 unique constraint HR DEPT_ID_PK violated 151 5 60 141 6 70 Location SQL Query 271 E 30 251 8 90 171 9 100 E E 171 10 110 171 11 120 ea pra 17112 lt a gt BONUS DEPT EMP DEPARTMENTS 3 The usual edit actions Cut Copy Paste Select All Undo Redo are available in the popup menu of the edited cell The contextual menu available on every cell
152. value if this diction ary is available When these attributes are missing the language used is controlled by the two radio buttons The two options are to Use the default language or Do not check the spelling 377 Configuring the application XML spell checking in Case sensitive Ignore mixed case words Ignore words with digits Ignore Duplicates Ignore URL Check punctuation Allow compounds words Allow general prefixes Allow file extensions Ignore acronyms Ignore elements Document Checking These options allow the user to specify if the spell checker will be enabled inside Comments Attribute values Text and CDATA sections When checked spell checking reports capitalization errors for example a word that starts with lowercase after etc or i e When checked operations do not check words containing case mixing e g SpellChecker When checked the Spell Checker does not check words containing digits e g b2b When checked the Spell Checker does not signal two successive identical words as an error When checked ignores words looking like URL or file names e g www oxygenxml com or c boot ini When checked punctuation checking is enabled misplaced white space and wrong sequences like a dot following a comma are detected When checked all words formed by concatenating two legal words with an hyphen are accepted If the language allows it two words concatenated without
153. when the Allow only insertion of valid elements and attributes schema aware option is enabled Entities view This view displays a list with all entities declared in the current document as well as built in ones Double clicking one of the entities will insert it at the current cursor position Figure 5 8 The Entities View 5 Entities 3 Name gt amp apos quot a oxy amp ltjoXygen amp gt author amp ltjoXygen amp gt XML A swnClient Syncro SVN Client oxygenMajorYersion 10 oxygenMinorYersion 10 3 authorMajorVersion 10 authorMinorYersion 10 3 e is EA 70 Authoring in the tagless editor The Author editor In order to view the XML file in Author view the XML document must be associated with a CSS file that defines the way the XML file is rendered The document can be edited as text the XML markup being hidden by default Navigating the document content Fast navigating the document content can be done using the Tab Shift Tab for advancing forward backwards The caret will be moved to the next previous editable position Entities and hidden elements will be skipped A left hand side stripe paints a vertical thin light blue bar indicating the vertical span of the element found at caret position Also a top stripe called breadcrumb indicates the path from document root to the current element Figure 5 9 Top stripe in Editor view book chapter secti sect2 sect3 para figure title T
154. your system is enough to copy it in the Fonts directory Generate font metrics file Generate a FOP font metrics file from the TrueType font file This example reads the Windows Arial Unicode MS file and generates an arialuni xml font metrics file in the current directory FOP includes an utility application for this task I assume you have opened a terminal or command line console and changed the working directory to the oxygen install directory The FOP files are stored in the lib subdirectory of the Oxygen install directory Create the following script file in the Oxygen installation directory The relative paths specified in the following script file are relative to the Oxygen installation directory so if you decide to create it in other directory you have to adapt the file paths For the Mac OS X tt fConvert sh 290 Transforming documents bin sh export LIB lib export CMD java cp SLIB fop jar SLIB avalon framework 4 2 0 jar SLIB xercesImpl jar export CMD SCMD org apache fop fonts apps TTFReader export FONT_DIR Library Fonts SCMD SFONT_DIR Arialuni ttf Arialuni xml For Linux tt fConvert sh bin sh export LIB lib export CMD java cp SLIB fop jar SLIB avalon framework 4 2 0 jar SLIB xercesImpl jar export CMD SCMD org apache fop fonts apps TTFReader export FONT_DIR Library Fonts SCMD SFONT_DIR Arialuni ttf Arialuni xml For Windows tt Convert bat set LIB lib set CMD java cp SLIB fop jar
155. 0 coe ceeeceec nec en cece cece cena cen eeeeeeeneeeeeeeeeaeeeaeeeges 331 Actions available at folder level ooooconoccncccnoconcconocnnocnncnnncnnocnnccnnconnccnnccnnconnconncnnnss 332 Achons availablesat file level nosocomio ista tii traider 332 14 Content Management System CMS Integration ooocccoccnnccnnconncnnncnnncnnncnncnnnronncnnccnnccnnccnncnnnconncnnncnnnss 333 Documentum CMS SUpPPOLt csres5 64 costar n vedey ssi sonessteseetivsby eam EEE E o NEE RSE 333 How to configure Documentum CMS support e cece cece cece cece eeea cece eeaeeeaeeeneeeneeeeeeee es 333 xii lt oXygen gt XML Author 11 2 User Manual for Eclipse How to configure a Documentum CMS data source ooococonococonococononocononocononoconacoronanonos 333 How to configure a Documentum CMS connection oococcnoccccnoccconococononoconococononoconanorononos 334 Documentum CMS action occidentales Uaaedneoeteons 334 Actions available On connection ooccoccncnoconcnnconcnnconccnconccncononncononnrononncononnronaroconanarinicos 335 Actions available on cabinets folders oooocooonoconcnocononocononocononncononocononocononoronaroronanoronos 335 Actions available on resources ocooccoccoconcnnconccncnncnncnnconcnnconcnnccncrnroncnnroncrnroncnnroncnaroncnns 336 DITA transformations on DITA content from Documentum ooccocccnccnnccnncconcnnncnnncnnncnnnonnnnnannnnos 338 15 Digital SIAM A A AA E do 339 OVERVIEW O RN 339 Canontcali
156. 1 first Jhon A last Doe tr id 10002 first Mark A last Ewing Y tr id 10003 first Dave last Flint Al hal gt You can switch between the two modes using the contextual menu Grid mode Tree mode Navigating the grid When you open a document first in the grid tab the document is collapsed so that it shows just the root element and its attributes The grid disposition of the node names and values are very similar to a web form or a dialog The same set of key shortcuts used to select dialog components are used in the grid For instance moving to the next editable value in a table row is done using the TAB key Moving to the previous cell employs the SHIFT TAB key Changing a value assumes pressing the ENTER key or start typing directly the new value and when the editing is finished pressing ENTER again to commit the data into the document The arrows and the PAGE UP DOWN keys can be used for navigation By pressing SHIFT while using these keys you can create a selection zone To add other nodes that are not close to this zone you can use the mouse and the CTRL COMMAND on Mac OS X key The following key combination may be used to scroll the grid e CTRL UP Scrolls the grid upwards 270 Grid Editor CTRL DOWN Scrolls the grid downwards e CTRL LEFT Scrolls the grid to the left e CTRL RIGHT Scrolls the grid to the right A left arrow sign displayed to the left of the node name indicates that this node
157. 1 gt lt x root xmlns x nsp gt lt x item id dty2 gt gent lt x item id dty3 gt lt x root gt Example 8 3 Default namespaces If there is a default namespace declared in the document and the document fragment does not declare a namespace the elements from the fragment are considered to be in no namespace For instance the fragment lt item id dty2 gt lt item id dty3 gt Inserted in the document lt xml version 1 0 encoding UTF 8 gt lt root xmlns nsp gt lt root gt Gives the result document lt xml version 1 0 encoding UTF 8 gt lt root xmlns nsp gt lt item xmlns id dty2 gt lt item xmlns id dty3 gt lt root gt 168 Author Developer Guide insertLocation insertPosition An XPath expression that is relative to the current node It selects the reference node for the fragment insertion One of the three constants Inside After or Before showing where the insertion is made relative to the reference node selected by the insertLocation Inside has the meaning of the first child of the reference node The arguments of SurroundWithFragmentOperation fragment The XML fragment that will surround the selection Example 8 4 Surrounding with a fragment Let s consider the fragment lt F gt lt A gt lt A gt lt B gt lt C gt lt C gt lt B gt lt F gt And the document lt doc gt lt X gt lt X gt lt Y gt l
158. 1 lt td gt lt td gt cs 1 rs 1 lt td gt lt tr gt lt tr gt lt td column_span 3 gt cs 3 rs 1 lt td gt lt tr gt lt table gt When no table column width provider is specified the table has the following layout 203 Author Developer Guide Figure 8 25 Table layout when no column width provider is specified When the above implementation is configured the table has the correct layout Figure 8 26 Columns with custom widths Configuring a Table Cell Span Provider In the documentation framework the table element can have cells that span over multiple columns and rows As explained in the Styling the Table Element section which describes the CSS properties needed for defining a table you need to indicate lt oXygen gt Author a method to determine the cell spanning If you use the cell element attributes rowspan and colspan or rows and cols lt oXygen gt can determine the cell spanning automatically In our example the td element uses the attributes row_span and column_span that are not recognized by default You will need to implement a Java extension class for defining the cell spanning Create the class simple documentation framework TableCellSpanProvider This class must implement the ro sync ecss extensions api AuthorTableCellSpanProvider interface import ro sync ecss extensions api AuthorTableCellSpanProvider import ro sync ecss extensions api node AttrValue import ro sync e
159. 3 Logger import ro sync ecss extensions api link Attr import ro sync ecss extensions api link ElementLocator import ro sync ecss extensions api link ElementLocatorException import ro sync ecss extensions api link IDTypeVerifier a ACA F ACA F FF F F FF F E SS Element locator for links that have the one of the following pattern lt ul gt lt li gt element elementID locate the element with the same id lt li gt lt li gt element 1 2 5 A child sequence appearing alone identifies an element by means of stepwise navigation which is directed by a sequence of integers separated by slashes each integer n locates the nth child element of the previously located element lt li gt lt li gt element elementID 3 4 A child sequence appearing after an NCName identifies an element by means of stepwise navigation starting from the element located by the given name lt 1li gt lt ul gt public class XPointerElementLocator extends ElementLocator pk Logger for logging ay private static Logger logger Logger getLogger XPointerElementLocator class getName pk Verifies if a given attribute is of a type ID we private IDTypeVerifier idVerifier XPointer path the path to locate the linked element a private String xpointerPath pk The stack with indexes in parent of the current iterated elements
160. 4842 8157 034d1le7cf3a3 amp displayLang en http www microsoft com downloads Thank You aspx familyId 262d25e3 f589 4842 8 157 034d1e7cf3a3 amp displayLang en Note There is no integrated XML Catalog support for MSXML 3 0 4 0 and NET processors Configuring custom XSLT processors One can configure other XSLT transformation engines than the ones which come with the lt oXygen gt distribution Such an external engine can be used for XSLT transformations within lt oXygen gt in the Editor perspective and is available in the list of engines in the dialog for editing transformation scenarios The output messages of a custom processor are displayed in an output view at the bottom of the lt oXygen gt window If an output message follows the format of an lt oXygen gt linked message then a click on the message in the output view highlights the location of the message in an editor panel containing the file referred in the message Configuring the XSLT processor extensions paths The Xalan and Saxon processors support the use of extension elements and extension functions Unlike a literal result element which the stylesheet simply transfers to the result tree an extension element performs an action The extension is usually used because the xslt stylesheet fails in providing adequate functions to the user for accomplishing a more complex task Samples on how to use extensions can be found at e for Xalan http xml apache org xal
161. 5 resources 336 configuration 333 connection 334 data source 333 E EAD document type 135 association rules 135 Author extensions 135 templates 135 schema 135 edit 16 archives 309 change user interface language 62 close documents 26 create new documents 17 file properties 26 open and close documents 16 open current document in Web browser 26 open read only files 63 open remote documents FTP SFTP WebDAV 22 save documents 22 Unicode documents 16 Unicode support 16 Editing CSS stylesheets 61 content completion 61 folding 62 format and indent pretty print 62 other editing actions 62 Outline view 61 validation 61 Editing XML documents 27 associate a schema to a document 27 adding a processing instruction 27 learning a document structure 28 setting a default schema 27 document navigation 46 folding 46 outline view 47 editor specific actions 57 document actions 58 edit actions 57 refactoring actions 59 select actions 57 smart editing 60 source actions 38 syntax highlight depending on namespace prefix 60 formatting and indenting documents pretty print 55 grouping documents in XML projects 50 large documents 50 new project 51 including document parts with XInclude 52 status information 57 streamline with content completion 29 code templates 32 the Attributes panel 34 the Elements view 35 the Entities view 35 the Model panel 33 working with XML Catalogs 54
162. Author Developer Guide it xmlFragment toString offset context AuthorSchemaManager VALIDATION_MODE_STRICT_FIRST_CHILD_LAX_OTHERS Derive the context by adding a new row element with a cell canInsertRow pushContextElement context SDF_TABLE ROW pushContextElement context SDF_TABLE_CELL Test if fragments can be inserted in the new context if authorSchemaManager canInsertDocumentFragments fragmentsTolnsert context AuthorSchemaManager VALIDATION_MODE_STRICT_FIRST_CHILD_LAX_OTHERS Insert a new row with a cell xmlFragment new StringBuilder lt xmlFragment append SDF_TABLE_ROW if SDF_NAMESPACE null amp amp SDF_NAMESPACE length 0 xmlFragment append xmlns append SDF_NAMESPACE append xmlFragment append gt lt xmlFragment append SDF_TABLE_CELL xmlFragment append gt lt xmlFragment append SDF_TABLE_ROW xmlFragment append gt authorAccess getDocumentController insertXMLFragment xmlFragment toString off Get the newly inserted cell AuthorNode newCell authorAccess getDocumentController getNodeAtOffset offset for int i 0 i lt fragmentsTolnsert length i authorAccess getDocumentController insertFragment newCell getEndOffset fragmentsTolnsert il handl
163. Author Developer Guide engine will ask this AuthorReferenceResolver implementation what is the display name for each node which is considered a reference In our case the display name is the value of the location attribute from the ref element public String getDisplayName AuthorNode node String displayNam ref fragment if node getType AuthorNode NODE_TYPE_ELEMENT AuthorElement element AuthorElement node if ref equals element getLocalName AttrValue attrValue element getAttribute location if attrValue null displayName attrValue getValue return displayName The method resolveReference resolves the reference of the node and returns a SAXSource with the parser and the parser s input source It takes as arguments an Aut horNode that represents the node for which the reference needs resolving the syst emID of the node the AuthorAccess with access methods to the Author data model and a SAX Ent ityResolver which resolves resources that are already opened in another editor or resolve resources through the XML catalog In the implementation you need to resolve the reference relative to the systemID and create a parser and an input source over the resolved reference public SAXSource resolveReference AuthorNode node String systemID AuthorAccess authorAccess EntityResolver entityResolver SAXSource saxSource null
164. B selects pd Article Welcome to the Al seme fe sample db5 xml xreflabel Z sample pdF Docbook tevisionfing fe sample xml condition Es sampleXInclude xm ES E conformance 23 section xml Inline Markup and Images Pes fe section2 xml revision a security section3 xml This is a sample showing that lt oXygen b gt 4 can be used to edit userlevel 1 E ys documents in conformity with the dockbookx dtd vendor 5 lake jpeg This is a Docbook figure inserted using the bimagedata tag words E nature1 jpg v a J b xmibase fia Lake in Fagaras role CEE Outline 2 Cd lt x Elements 23 zj i u la a Si an T para di article a title Welcome to the Docbook E abbrev ia Sl secti E acronym 1 E action J title Inline Markup and Im E address 8 0 para Lo is a sample she In order to preview this text in a Web browser you have to choose the b Bebe 8 para Thisisa Docbook HTHL transformation scenario For this press the gt oe figure Configure transformation scenario 4 button or the shortcut gt E authorinitials title Lake in Fagaras CTRL SHIFT C 4 or gt META SHIFT C 4 on Mac OS X then select E beginpage 2 8 mediaobject the scenario Press bOk4 E bibliolist imageobject To apply the stylesheet you have to press the Apply transformation Ebiblioref 0 para In order to preview scenario button or to press PCTRL SHIFT T4 gt M
165. By using the Insert Topic Group Dialog you can easily insert a topicgroup element The Type Format Scope and Collection type attributes can be specified from the dialog Edit properties The Edit properties action available both on the toolbar and on the contextual menu is used to edit the properties of the selected node Depending on the selected node the action will perform the following tasks e Ifa topicref element is selected the action will show a dialog similar with the Insert Topic Reference dialog allowing the editing of some important attributes e Ifatopichead elementis selected the action will show a dialog similar with the Insert Topic Heading dialog allowing the editing of some important attributes e Ifa topicgroup element is selected the action will show a dialog similar with the Insert Topic Group dialog allowing the editing of some important attributes e Ifthe map s root element is selected then the user will be able to easily edit the map s title using the Edit Map title dialog By using this dialog you can also specify whether the title will be specified as the title attribute to the map or as a title element for DITA OT 1 1 and 1 2 or specified in both locations Transforming DITA Maps lt oXygen gt uses the DITA Open Toolkit DITA OT to transform XML content into an output format For this purpose both the DITA Open Toolkit 1 5 M24 and ANT 1 7 come bundled in lt oXygen gt More informations about the
166. Check feasibly valid Checks the Relax NG to be feasibly valid when this document is validated Schematron XPath Version 1 0 Allows XSLT 1 0 expressions for Schematron 1 5 assertion tests 2 0 Allows XSLT 2 0 expressions for Schematron 1 5 assertion tests Optimize visit no attributes If your ISO Schematron assertion tests do not contain the attributes axis you should check this option for faster ISO Schematron validation Allow foreign elements allow for Enable support for allow foreign on ISO Schematron Used to pass non eign Schematron elements to the generated stylesheet Use Saxon EE schema aware for If checked Saxon EE will be used for xslt2 query binding xslt2 query binding Saxon EE Validation The Saxon EE Validation preferences panel is opened from menu Window Preferences gt Author XML XML Parser Saxon EE Validation Figure 17 34 The Saxon EE preferences panel Saxon EE Validation XML Schema version 1 0 xsdversion 1 0 O 1 1 Exsdversion 1 1 XML Schema version 1 0 The validation of XML Schema schemas is done according to the W3C XML Schema 1 0 specification XML Schema version 1 1 The validation of XML Schema schemas is done according to the W3C XML Schema 1 1 specification XProc Engines lt oXygen gt comes with a built in engine called Calabash XProc An external XProc engine can be configured in this panel 384 Configuring the application Figure 17 35 The XProc Engines pr
167. Client oxygenMajorYersion 10 oxygenMinorYersion 10 3 authorMajorYersion 10 authorMinorVersion 10 3 fat a gt Validating XML documents The W3C XML specification states that a program should not continue to process an XML document if it finds a val idation error The reason is that XML software should be easy to write and that all XML documents should be com patible With HTML it was possible to create documents with lots of errors like when you forget an end tag One of the main reasons that HTML browsers are so big and incompatible is that they have their own ways to figure out what a document should look like when they encounter an HTML error With XML this should not be possible However when creating an XML document errors are very easily introduced When working with large projects or many files the probability that errors will occur is even greater Determining that your project is error free can be time consuming and even frustrating For this reason lt oXygen gt provides functions that enable easy error identification and rapid error location Checking XML well formedness A Well Formed XML document is a document that conforms to the XML syntax rules A Namespace Well Formed XML document is a document that is Well Formed XML and is also namespace wellformed and namespace valid The XML Syntax rules for Well Formed XML are All XML elements must have a closing tag e XML tags are case sensitive All XML elemen
168. DITA Open Toolkit are available at http dita ot sourceforge net Available Output Formats You can publish DITA based documents in any of the following formats XHTML DITA Map to XHTML PDF DITA OT DITA Map to PDF using the DITA OT default PDF target PDF2 IDIOM FO Plugin DITA Map to PDF using the DITA OT IDIOM PDF plugin 93 Author for DITA HTML Help CHM JavaHelp Eclipse Help Eclipse Content TocJS RTF TROFF Docbook DITA Map to HTML Help If HTML Help Workshop is installed on your computer then oXygen will detect it and use it to perform the transformation When the transformation fails the hhp HTML Help Project file is already generated and it needs to be compiled to obtain the chm file Note that HTML Help Workshop fails when the files used for transformation contain diacritics in their names due to different encodings used when writing the hhp and hhc files DITA Map to JavaHelp DITA Map to Eclipse Help DITA Map to Eclipse Content A JavaScript file that can be included in an HTML file to display in a tree like manner the table of contents of the transformed DITA map DITA Map to Rich Text Format DITA Map to Text Processor for Typesetters DITA Map to Docbook Because the TocJS transformation does not generate all the files needed to display the tree like table of contents you need to follow this procedure 1 Run the XHTML transformation on the same DITA map Make sure the output gets generat
169. Data Sources In the Data Sources panel click the New button Enter a unique name for this data source and select SQLServer from the driver type combo box Press the Add button to add the following Microsoft SQL Server specific files e sqljdbc jar In the Download links for database drivers section there are listed the URLs from where to download the drivers necessary for accessing Microsoft SQL Server databases in lt oXygen gt You can manage the Driver Files using Add Remove Detect and Stop detection buttons Select the most suited Driver class Click OK to finish the data source configuration How to configure a MySQL Data Source lt oXygen gt s default configuration already contains a generic JDBC data source called MySQL 1 Go to Preferences gt Data Sources In the Data Sources panel click the New button 312 Working with Databases 2 Enter a unique name for this data source and select Generic JDBC from the driver type combo box Press the Add button to add the following MySQL specific files e mysql com jar You can manage the Driver Files using Add Remove Detect and Stop detection buttons 3 Select the most suited Driver class 4 Click OK to finish the data source configuration How to configure an Oracle 11g Data Source 1 Goto Preferences gt Data Sources In the Data Sources panel click the New button 2 Enter a unique name for this data source and select Oracle from the driver type combo
170. ETA SHIFT T 4 E blockquote para To apply the stylesh on Mac OS X a caution 20 secti IM E citation v title CALS Tables and List IEA lt lia Text Grid Author Caret Before After ie Writable Insert Aa 0 AS The tagless rendering of the XML document in the Author mode is driven by a CSS stylesheet which conforms to the version 2 1 of the CSS specification http www w3 org TR CSS21 from the W3C consortium Also some CSS 3 features like namespaces and custom extensions of the CSS specification are supported The CSS specification is convenient for driving the tagless rendering of XML documents as it is an open standard maintained by the W3C consortium A stylesheet conforming to this specification is very easy to develop and edit in lt oXygen gt as it is a plain text file with a simple syntax 64 Authoring in the tagless editor The association of such a stylesheet with an XML document is also straightforward an xml stylesheet XML processing instruction with the attribute type text css must be inserted at the beginning of the XML document If it is an XHTML document that is the root element is a html element there is a second method for the association of a CSS stylesheet an element link with the href and type attributes in the head child element of the html element as specified in the CSS specification http www w3 org TR REC htm140 present styles html h 14 3 2 There are two main types of users of th
171. EX To avoid granting these privileges to the schema owner Oracle recommends that the operations requiring these privileges be performed by a DBA if there are XML schema based XMLType table or columns in other users database schemas How to Configure a PostgreSQL 8 3 Connection 1 Zi 4 Go to Preferences gt Data Sources In the Connections panel click the New button Enter a unique name for this connection and select one of the previously configured PostgreSQL data sources from the Data Source combo box Fill in the Connection Details URL URL to the installed PostgreSQL engine User User name to access the PostgreSQL database engine Password Password to access the PostgreSQL engine Click OK Resource Management Data Source Explorer View This view presents in a tree like fashion the database connections configured in Preferences gt Data Sources You can connect to a database simply by expanding the connection node The database structure can be expanded up to column level lt oXygen gt supports multiple simultaneous database connections and the connections tree provides an easy way to browse them 316 Working with Databases Figure 13 3 Data Source Explorer View Eg Data Source Explorer 3 gt age Oracle SB default Con XML Repository Con XML Schemas Repository ANONYMOUS BI 3 3 crxsys FS CTX_CLASSES FB CLA_NAME VARCHAR FB CLA_DESCRIPTION VARCHAR O El CTX_INDEX_ERRORS
172. Example 8 11 Imbricated functions The result of the functions below will be the local name of the current node with the first letter capitalized capitalize local name The local name function This function evaluates the local name of the current node It does not have any arguments The name function This function evaluates the qualified name of the current node It does not have any arguments The url function This function evaluates the URL of a location relative to the CSS file location and appends each of the relative path components to the final location url location loc_1 loc_2 1 location TOC TF TOG 2n location The location as string If not absolute will be solved relative to the CSS file URL loc_1 loc_n Relative location path components as string optional 223 Author Developer Guide The base uri function This function evaluates the base URL in the context of the current node It does not have any arguments and takes into account the xml base context of the current node See the XML Base specification http www w3 org TR xmlbase for more details The parent url function This function evaluates the parent URL of an URL received as string parent url url url url The url as string The capitalize function This function capitalizes the first letter of the text received as argument capitalize text text text The text for which the first lette
173. IX PER EM SPACE General Punctuation U 2 FIGURE SPACE General Punctuation U 2 PUNCTUATION SPACE General Punctuation U 2 THIN SPACE General Punctuation U 2 HAIR SPACE General Punctuation O U 2 ZERO WIDTH SPACE General Punctuation U 2 LINE SEPARATOR General Punctuation O U 2 PARAGRAPH SEPARATOR General Punctuation U 2 NARROW NO BREAK SPACE General Punctuation U 2 MEDIUM MATHEMATICAL SP General Punctuation A U 3 IDEOGRAPHIC SPACE CJK Symbols and Punctu O U F ZERO WIDTH NO BREAK 5P Arabic Presentation Form Please reopen the files in editor to apply changes CSS The CSS Format preferences panel is opened from menu Window Preferences gt Author Editor Format CSS 367 Configuring the application Figure 17 16 The CSS format preferences panel css Indent class content Class body on new line C Add new line between classes O Preserve empty lines Allow Formatting embedded C55 Indent class content If checked the class content is indented during a Format and Indent Pretty Print operation Class body on new line If checked the class body including the curly brackets are placed on a new line after a Pretty Print operation Add new line between classes If checked an empty line is added between two classes after a Pretty Print oper ation is performed Preserve empty lines If checked the empty lines from the CSS content are preserved
174. In this case an empty task will be inserted after the last child of the first concept s ancestor 115 Predefined document types e task context the current element is a task In this case an empty task will be inserted at current caret position e topic context the current element is a dita s topic An empty task will be inserted at current caret position e topic context one of the current element ancestors is a dita s topic An empty task will be inserted after the last child of the first ancestor that is a topic insert Reference inserts a new reference in the document A reference is a top level container for a reference topic This action is available in one of the following contexts e reference context one of the current element ancestors is a reference In this case an empty reference will be in serted after the last child of the first ancestor that is a reference e reference or dita context the current element is either a dita or a reference An empty reference will be inserted at caret position e topic context the current element is topic descendant of dita element An empty reference will be inserted at caret position e topic context the current element is descendant of dita element and descendant of topic element An empty reference will be inserted after the last child of the first ancestor that is a topic as lInsert Graphic inserts a graphic object at the caret position This is done by inserting either
175. Java Files section Package the compiled class into a jar file Copy the jar file and the JDBC driver files into the frameworks sdf directory Add the jars to the Author class path For this Open the options Document Type Dialog select SDF and press the Edit button Select the Classpath tab in the lower part of the dialog Click on the Actions label The action properties are ID An unique identifier for the action Use clients_report Name The name of the action Use Clients Report 176 Author Developer Guide 7 Menu access key Description Toolbar icon Menu icon Shortcut key Use the letter r Enter the text Connects to the database and collects the list of clients Enter here frameworks sdf TableDB20 gif me The image OTableDB20 gif for the toolbar action is already present in the frameworks sdf directory Leave empty You will use Ctrl Shift c Let s set up the operation The action will work only if the current element is a section XPath expression Invoke operation Set the value to local name section In this case you will use the Java operation you defined earlier Press the Choose button then select simple documentation framework QueryDatabase0Opera tion Once selected the list of arguments is displayed In the figure below the first argument jdbc_driver represents the class name of the MySQL JDBC driver The connection string has the URL syntax jdbc lt
176. L file and opened in the browser 182 Author Developer Guide Figure 8 21 Selecting the predefined scenario Configure Transformation Scenario Scenario type xm transformation with XSLT Scenarios Ea Edit Duplicate 2 Transform now Cancel Note The key f symbol indicates that the scenario is read only It has this state because the scenario was loaded from a Document Type Association The content authors can still change parameters and other settings if they are duplicating the scenario and edit the duplicate In this case the copy of the scenario is created in the user local settings Configuring Extensions You can add extensions to your Document Type Association using the Extensions tab from the Document Type dialog Figure 8 22 Configure extensions for a document type Schema Classpath Author Templates Catalogs Transformation Extensions Extensions bundle simple documentation framework SDFExtensionsBu Reset Individual extensions deprecated use an Extensions bundle instead Content completion handler Choose Reset Link target element finder Choose Reset Drag and drop listener Choose Reset References resolver Choose Reset CSS styles filter Choose Reset Cell spanning provider Choose Reset Column width provider Choose Reset 183 Author Developer Guide
177. ML file in Oxygen XML Editor Author How can I view XML files in Internet Explorer again XML files are opened in Oxygen because Internet Explorer uses the Windows file associations for opening files and you associated XML files with Oxygen XML Editor Author in the installer panel called File Associations This installer panel displays a warning above the XML file association that XML files will not be viewed correctly in Internet Explorer if you associate them with Oxygen XML Editor Author For viewing XML files in Internet Explorer again you have to associate XML files with IE by right clicking on an XML file in Windows Explorer selecting Open With gt Choose Program selecting IE in the list of applications and checking the checkbox Always use the selected program Also you have to run the following command from a command line wscript revert vbs where revert vbs is a text file with the following content function revert Set objShell CreateObject WScript Shell objShell RegWrite HKCR xml xmlfile REG_SZ objShell RegWrite HKCR xml Content Type text xml REG_SZ end function revert 18 2 I associated the ext extension with lt oXygen gt in Eclipse Why does an ext file opened with the Oxygen XML Editor not have syntax highlight Associating an extension with lt oXygen gt in Eclipse 3 5 requires three steps 1 Associate the ext extension with the Oxygen XML Editor go to Windows gt Prefer
178. Note In order to be learned the words need to be separated by space characters The Annotations preferences panel is opened from menu Window gt Preferences gt Author Editor Content Comple tion Annotations 370 Configuring the application Figure 17 19 The Content Completion Annotations preferences panel Annotations tas Show annotations Show annotations as tooltip O Use DTD comments as annotations Cluse all Relax NG annotations as documentation Show annotations Show annotations as tooltip Use DTD comments as annotation Use all Relax NG annotations as documentation XPath When checked lt oXygen gt will display the annotations that are present in the used schema for the current element attribute or attribute value This option is applied also in the Author mode of the XML editor If checked it shows the annotations of elements and attributes as tooltips This option is applied also in the Author mode of the XML editor When checked lt oXygen gt will use all DTD comments as annotation If it is not checked the following decision is performed if among the gathered comments there are special lt oXygen gt doc comments only those will be presented If not all encountered comments will be presented When checked any element that is not from the Relax NG namespace that is http relaxng org ns structure 1 0 will be considered annotation and will be displayed in the annotation wi
179. OUNDED link 0 1 14 lt person id one worker gt 15 lt name gt 16 lt family gt Worker lt family gt Specify information about a person 17 lt given gt One lt given gt 18 lt name gt v lt gt Text Grid Custom validation of XML documents If you need to validate the edited document with other validation engine than the built in one you have the possibility to configure external validators as custom validation engines in lt oXygen gt After such a custom validator is properly configured it can be applied on the current document with just one click on the Custom Validation Engines toolbar The document is validated against the schema declared in the document Some validators are configured by default but they are third party processors which do not support the output message format for linked messages described above LIBXML included in lt oXygen gt Windows edition associated to XML Editor able to validate the edited document against XML Schema Relax NG schema full syntax internal DTD included in the XML document or a custom schema type XML catalogs support catalogs and XInclude processing xinclude are enabled by default in the preconfigured LIBXML validator The postvalid flag is set as default allowing LIBXML to validate correctly the main document even if the XInclude fragments contain IDREFS to ID s located in other frag ments For validation against an external DTD specified by URI in the XML docum
180. Other gt oXygen gt XML Project Procedure 2 2 Eclipse 3 4 plugin installation the Update Site method E 2 Start Eclipse Choose the menu option Help Software Updates Available Software Press the button Add Site in the tab Available Software of the dialog Software Updates Enter the value http www oxygenxml com InstData Eclipse site xml into the Location field of the Add Site dialog Press the OK button Select the checkbox oXygen XML Author for Eclipse and press the Install button Press the Next button in the following install pages You must accept the Eclipse restart at the end of the installation Paste the license information received in the registration email when prompted This will happen when you use one of the wizards to create an XML project or document when you open or create a document associated with lt oXygen gt or when accessing the lt oXygen gt Preferences The oXygen XML Author plugin is installed correctly if you can create an XML project with the New Project wizard of the oXygen XML Author plugin started from menu File gt New gt Other gt oXygen gt XML Project Procedure 2 3 Eclipse 3 3 plugin installation the zip archive method 1 2 Download http www oxygenxml com download html the zip archive with the plugin Unzip the downloaded zip archive in the plugins subdirectory of the Eclipse install directory Installation 3 Restart Eclipse
181. P processor and it contains some Unicode characters that cannot be rendered by the default PDF fonts then a font that is capable to render these characters must be configured and embedded in the PDF result The settings that must be modified for configuring a font for the Apache FOP processor are detailed in this section Running a DITA Map ANT transformation The transformation is run as an external ANT process so you can continue using the application as the transformation unfolds All output from the process appears in the DITA Transformation tab i Tip The HTTP proxy settings from lt oXygen gt are also used for the ANT transformation so if the transformation fails because it cannot connect to an external location you can check the HTTP Proxy Configuration DITA OT customization support Support for transformation customizations You can change all DITA transformation parameters to customize your needs See here for more details In addition you can specify a custom build file parameters to the JVM and many more for the transformation 101 Author for DITA Using your own DITA OT toolkit from lt oXygen gt The DITA OT toolkit which comes with lt oXygen gt is located in the INSTALLATION_DIRECTORY frame works dita DITA OT directory You can configure another DITA OT toolkit directory for use in lt oXygen gt To do this you must edit the transformation scenario that you are using and in the Parameters tab change
182. Provider init ro sync ecss extensions api node AuthorElement sy public void init AuthorElement tableElement this tableElement tableElement AuthorElement colChildren tableElement getElementsByLocalName customcol if colChildren null amp amp colChildren length gt 0 for int i 0 i lt colChildren length i AuthorElement colChild colChildren i if 1 0 colsStartOffset colChild getStartoffset if i colChildren length 1 colsEndOffset colChild getEndoOffset Determine the width for this col AttrValue colWidthAttribute colChild getAttribute width String colWidth null if colWidthAttribute null colWidth colWidthAttribute getValue Add WidthRepresentation objects for the columns this customcol specification spans over colWidthSpecs add new WidthRepresentation colWidth true pk see ro sync ecss extensions api AuthorTableColumnWidthProvider isAcceptingFixedColumnWidth java lang String 57 public boolean isAcceptingFixedColumnWidths String tableCellsTagName return true see ro sync ecss extensions api AuthorTableColumnWidthProvider isAcceptingPercentageColumn java lang String public boolean isAcceptingPercentageColumnWidths String tableCellsTagName return true see ro sync ecss extensions api AuthorTableColumnWidthProvider isAcceptingProportionalColu java l
183. Save As field is opened in a new editor panel in lt oXygen gt with the appropriate built in editor type if the result is an XML file it is opened with the built in XML editor if it is an XSL FO file it is opened with the built in FO editor etc It is enabled only when Open in browser is disabled If this is checked lt oXygen gt will display the transformation result in a built in XHTML browser panel at the bottom of the lt oXygen gt window 285 Transforming documents 4 Important When transforming very large documents you should be aware that en abling this feature will result in a very long time necessary for rendering the transformation result in the XHTML result viewer panel This drawback appears due to the built in Java XHTML browser implementation In this situations if you wish to see the XHTML result of the transformation you should use an external browser by checking the Open in browser checkbox Check box Show As XML If this is checked lt oXygen gt will display the transformation result in an XML viewer panel at the bottom of the lt oXygen gt window with syntax highlight specific for XML documents Text field Image URLs are relative If Show As XHTML is checked this text field specifies the path for resolving to image paths contained in the transformation result XSLT Stylesheet Parameters The global parameters of the XSLT stylesheet used in the transformation scenario are configured from the dialog av
184. TML output from XSLT transformations It contains a tab for each file with HTML results displayed in the view 12 Getting started Figure 3 4 The Browser View Text 4 Browser El Problems Console Results a Po worker two worker three worker four worker Boss Big chief nm so loss Big e ef oxyge com EN Worker One lone oxygenxml com Big Boss Worker Two two oxygenzml com Big Boss Worker Three three oxygenxml com Big Boss Worker Four four oxygenxml com Big Boss Worker Five Ev Govea com Big Boss gt v 45L xhtml personal xml XSL xhtml sales xml The lt oXygen gt XPath Results view The lt oXygen gt XPath Results view is automatically showed in the views pane of the Eclipse window to display XPath results Figure 3 5 The XPath Results View Problems Search Console Progress History Hix XPath Results x Jpersonnel 1 person 1 contr false id Big Boss Jpersonnel 1 person 2 i Supported editor types The lt oXygen gt Eclipse plugin provides special Eclipse editors identified by the following icons t The icon for XML documents The icon for JavaScript documents lt The icon for CSS documents lt oXygen gt Database perspective The Database perspective is similar to the Editor perspective It allows you to manage a database offering support for browsing multiple connections at the same time both relational and nativ
185. Table with fixed width and proportional column widths col span 1 width 2 0 col span 1 width 0 5 Person Name Jane 26 Bart 24 Alexander 22 b They are all students of the computer science departmentd DITA The DITA table layout accepts CALS tables and simple tables The simple tables accept only relative column width specifications by using the relcolwidth attribute of the sim pletable element Figure 5 23 DITA simple table Header 1 Header 2 Column 1 olumn 2 Refreshing the content On occasion you may need to reload the content of the document from the disk or reapply the CSS This can be performed by using the Reload action For refreshing the content of the referred resources you can use the action Refresh references This action affects the displayed referred content such as references XInclude DITA conref etc However this action will not refresh the expanded external entities to refresh those you will need to use the Reload action Validation and error presenting You can validate or check the XML form of the documents while editing them in Author Editor Validate as you type as well as validate on request operations are available Author editor offers validation features and configuring possib ilities similar to text editor You can read more about checking the XML form of documents in section Checking XML form A detailed description of the document validation process and its
186. These elements are marked as having block style for display Elements that are placed one after the other in a flowing sequence are b i These will have inline display Vertical flow book section para title image ref display block Horizontal flow b i display inline Important Having block display children in an inline display parent makes lt oXygen gt Author change the style of the parent to block display Styling the section Element The title of any section must be bold and smaller than the title of the parent section To create this effect a sequence of CSS rules must be created The operator matches any element it can be used to match titles having progressive depths in the document title font size 2 4em font weight bold title font size 2 0em title font size 1 6em x title font size 1 2em Note a CSS rules are combined as follows e All the rules that match an element are kept as a list The more specific the rule is the further it will be placed to the end of the list 145 Author Developer Guide e Ifthereis no difference in the specificity of the rules they are placed in the list in the same order as they appear in the CSS document e The list is then iterated and all the properties from the rules are collected overwriting the already collected values from the previous rules That is why the font size
187. Windows Vista if you want to start or stop the Windows service with the Start menu shortcut called Start Windows service Stop Windows service you have to run the shortcut as Administrator This is a standard option for running Start menu shortcuts on Windows Vista and is necessary for giving the required permission to the command that starts stops the Windows service Installation How to release a floating license To release a floating license key so that it can be registered for other user or for the cases when you do not have Internet access and you own also an individual license to which you want to switch from the floating license you do not have to disable or to uninstall the lt oXygen gt XML Author plugin All you have to do is to go to the main lt oXygen gt XML Author preferences panel press the Register button uncheck the Use a license server checkbox in the license registration dialog paste the individual license key and press OK in the dialog If you only want to stop using the lt oXygen gt XML Author plugin just uncheck the checkbox and press the OK dialog This will release the floating license and leave the plugin in the unregistered state License registration with a registration code If you have only a registration code and you want to register the associated license key you must request this license key by filling the registration code and other details associated with your license in a request form on the lt
188. XML technical committee of the Organization for the Advancement of Structured Information Standards OASIS consortium and based on the XML format originally created and implemented by the OpenOffice org office suite A basic OpenDocument file consists of an XML document that has lt document gt as its root element OpenDocument files can also take the format of a ZIP compressed archive containing a number of files and directories these can contain binary content and benefit from ZIP s lossless compression to reduce file size OpenDocument benefits from separation of concerns by separating the content styles metadata and application settings into four separate XML files lt oXygen gt offers support for editing manipulating and validating documents composing the ODF package directly through the archive support 130 Predefined document types Figure 7 7 Editing ODF packages in lt oXygen gt EH Text 20Document odt 3 H Text Document odt Configurations2 5 META INF mimetype E settings xml fo styles xml fed content xml 23 lt xml version 1 0 encoding UT A lt office document content xmlns o xmlns style urn oasis names xmlns draw urn oasis names y lt gt Text Grid Author Association rules A file is considered to be an ODF document when it has the following namespace urn oasis names tc open document xmlns office 1 0 Schema The RelaxNG schema used for these d
189. XML with a DTD XML Schema or Relax NG schema is designed to be self descriptive XML is not a replacement for HTML XML and HTML were designed with different goals e XML was designed to describe data and to focus on what data is e HTML was designed to display data and to focus on how data looks e HTML is about displaying information XML is about describing information XHTML 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 stricter 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 containing small 276 Transforming documents 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 HTML Help Microsoft HTML H e l p http msdn microsoft com library default asp url library en us htmlhelp html vsconHH1 Start asp frame true is the standard help sys
190. Xygen gt XML Author License Obtain a license key If you do not have a license key you can obtain it in one of the following ways Request a free 30 day trial license key Request a TRIAL license Purchase a permanent license key BUY Now If you have a registration code obtain a license key Request license For registration code Use a license key After you received the license key either trial or permanent paste it below Note that the license key usually received in a registration email is composed of nine lines of text Company User Company A Category Enterprise Component Author Saxon 54 Version 11 Number_of_Licenses 1 Date 12 14 2009 Maintenance 350 SGN MCwCFHUZi69U0b9 dyDXRBSSBERSNRVAhQIKjS9RFWarTPCodb nxtiakptGQ mn Use a license server O Use a license server a 5 Paste the license text in the registration dialog and press OK You have the following alternative for the procedure of license install Procedure 2 5 Save the license in a text file 1 Save the license key in a file named Licensekey txt 2 Copy the file in the lib folder of the installed plugin In that way the license will not be asked when lt oXygen gt XML Author will start 3 Start Eclipse How floating concurrent licenses work If all the floating licenses are used in the same local network the installation procedure of floating licenses is the same as for the Named User licenses Within
191. a NVDL file so it can be visualized in the Author page Association rules A file is considered to be a NVDL document when the namespace is http purl oclc org dsdl nvdl ns structure 1 0 132 Predefined document types Author extensions The following CSS is proposed for visualizing NVDL schemas in the Author page frameworks nvdl nvdl css Representation of Relax NG optimized for editing in the Author mode The Schematron document type This document type is used to associated CSS stylesheets to a Schematron file so it can be visualized in the Author page Association rules A file is considered to be a Schematron document when the namespace is http purl oclc org dsdl schematron Author extensions The following CSS is proposed for visualizing Schematron schemas in the Author page frameworks schematron iso Representation of Schematron optimized for editing in the Author mode schematron css The Schematron 1 5 document type This document type is used to associated CSS stylesheets to a Schematron 1 5 file so it can be visualized in the Author page Association rules A file is considered to be a Schematron 1 5 document when the namespace is http www ascc net xml schematron Author extensions The following CSS is proposed for visualizing Schematron 1 5 schemas in the Author page frameworks schematron schemat Representation of Schematron 1 5 optimized for editing in the Author mode ro
192. a XPath 1 0 or XPath 2 0 expression is typed and executed on the current document from the menu XML gt XPath Ctrl Shift X Cmd Shift X on Mac OS or from the toolbar button Both XPath 2 0 basic and XPath 2 0 schema aware expressions can be executed in the XPath console XPath 2 0 schema aware also takes into account the Saxon EE XML Schema version option The content completion assistant that helps in entering XPath expressions in attributes of XSLT stylesheets elements is also available in the XPath console and offers always proposals dependent of the current context of the cursor inside the edited document The set of XPath functions proposed by the assistant depends on the XPath version selected from the drop down menu of the XPath button 1 0 or 2 0 In the following example the cursor is on a person element and the content completion assistant offers all the child elements of the person element and all XPath 2 0 functions 303 Querying documents Figure 11 1 Content Completion in the XPath console lt xml version 1 0 encoding UTF 8 gt lt persomnel xmlns xsi http wuw w3 org 2001 XNLSchema instance xsi noNamespaceSchemaLocation personal xsda gt Y XPath x lt person id Big Boss gt ES N XPath xPath 2 0 y So lt family gt Boss lt lt given gt Big lt gi Expression lt name gt personnel child person index of linki manager Boss gt 0 lt email gt chief oxy
193. about mouse and caret events occurring in the Author editor page The deactivation event is received when another framework is activated for the same document the user switches to another editor page or the editor is closed The deact ivate method is typically used to unregister the listeners pre viously added on the activate method and to perform other actions For example options related to the deactivated author extension can be saved at this point public void deactivated AuthorAccess authorAccess Store the option authorAccess getOptionsStorage setOption sdf custom option key optionValue Remove the option listener authorAccess getOptionsStorage removeOptionListener sdfOptionListener Remove document listeners authorAccess getDocumentController removeAuthorListener sdfAuthorDocumentListener Ww move mouse listener authorAccess getEditorAccess removeAuthorMouseListener sdfMouseListener Remove caret listener authorAccess getEditorAccess removeAuthorCaretListener sdfCaretListener Other actions Implementing an Author Schema Aware Editing Handler You can implement your own handler for actions like typing delete or paste by providing an implementation of ro sync ecss extensions api AuthorSchemaAwareEditingHandler The Schema Aware Editing must be On or Custom in order for this handler to be called The handler can either resolve a specific case
194. acteristics 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 You can also use editor variables in the template files content and they will be expanded when the files are opened The New from Templates wizard enables you to select predefined templates or templates that have already been created in previous sessions or by other users Open a template using the following options The list of templates presented in the dialog includes Document Types templates Templates supplied with the defined document types User defined templates The user can add template files in the templates folder of the lt oXygen gt install directory Also in the option page can be specified a custom templates folder to be scanned Procedure 4 2 Creating Documents based on Templates 1 Select File gt New New from Templates The New from templates dialog is displayed 2 Scroll the Templates list and select the required Template Type 3 Type aname for the new document and press Next 4 Click Finish A new document is opened that already contains structure and content provided in the template starting point Saving documents The edited document can be saved with one of the actions e File gt Save Ctrl S to save the current document e File gt Save As Displays the Save As dialog used to name and save an open document to a file or save an exist
195. ad the saved scenarios using Import Transformation Scenarios Validation option All the imported scenarios will have added to the name the word import Note The scenarios are exported imported from in the global options not from the project options So be aware that the list of scenarios kept at the project level are not affected Editor variables An editor variable is a shorthand notation for a file path or directory path It is used in the definition of a command the input URL of a transformation the output file path of a transformation the command line of an external tool etc to make the command generic When the same command is applied the notation is expanded so that the same command has different effects depending on the actual value of the notation The following editor variables can be used in lt oXygen gt commands frameworks the path of the frameworks subdirectory of the lt oXygen gt install directory as URL frameworksDir the path of the frameworks subdirectory of the lt oXygen gt install directory S home the path of the user home directory as URL S homeDir the path of the user home directory cfdu current file directory url the path of the current edited document up to the name of the parent directory as URL S cfd current file directory the path of the current edited document up to the name of the parent directory S cfn current file name the name of the current edited document wi
196. add the file Oxygen install folder lib mysql jar in Driver files If you want to connect 402 Configuring the application to a MySQL 5 server you may need the latest driver from the MySQL website http dev mysql com downloads connector j 5 1 html Table Filters The Table Filters preferences panel is opened from menu Window Preferences gt Author Data Sources Table Filters Here you can choose which of the table types will be displayed in the Data Source Explorer view Figure 17 54 Table Filters Preferences Page Table Filters Table types shown in Database Explorer ALIAS GLOBAL TEMPORARY LOCAL TEMPORARY SYNONYM O SYSTEM TABLE TABLE VIEW 2 Note Table types filtering depends on the driver implementation Archive The Archive preferences panel is opened from menu Window Preferences gt Author Archive Figure 17 55 The Archive preferences panel Archive 27 Archive backup options No backup O Single file backup O Incremental backup C Show archive backup dialog Archive types Extensions Type Description zip zip ZIP archive jar ear war jar Java archive odb odf odg odm odp ods odt otg odf Open Document Format ODF docx pptx xlsx dotx docm dotm ppt zip Office Open XML OOXML epub odf IDPF The following options are available in the Archive preferences page 403 Configuring the application The following
197. adn sty 130 ASSOCIAtION TUNES a i 131 SCHEMA dai 131 The OASIS XML Catalog document type esner ipe E E EE Ee seca sean eeu E EEE 131 ASSOCIATION TUIES ins 131 Schena oss Fess oc Te a ed ee cdene peed E a E Shs bobbed bey E vane case EE N cs EE A ea 131 The AME Schema document type oyen pavsdeeegh sean ssn ted peeps RN EATE EESE AO E ORS EEEIEE tee 131 Association TUIES A E E E A A EE 132 Author EXTENSIONS A Aia 132 The RelaxNG doctimient typer eee a AN is dE eda teen D A dai 132 ASSOCIATES a A E ta 132 AUthorEXtenSIONs A a eed evel S 132 The NV DE document types sasha tota e dane decia dondeue E a A eee a NEES 132 Association Tules A tad 132 AUTNOR EXTENSIONS iii 133 The Schematron document ty pe uta ds aed 133 Vil lt oXygen gt XML Author 11 2 User Manual for Eclipse ASSOCIATION TULES cocotero irsr tuedes ph oad abeb NE EOE detroit spas 133 Author extensions a ce ae eae A Se Bae tenia dy bau A ES 133 The Schematron 1 document type sieten doa de nacen len enero tina eae aAa ce dene duet deenedacdenees 133 ASSOCIALION Tules siete sess O E EREE EEE iO weed 133 Author extensions sesgada tes Sead sseeSan geo sumecbeyeareg seh Suede de Suadie ise 133 The XSLT document Ly pe ses este wodk cass Ase 2 ne cinde dod aera lade E EE EE deleted se ce E 133 ASSOCIATION TULES OA 133 Authorextensions tas IS E Peete eee eee 134 The XMS pec document type loses a ee EA a een aces E EEE EASE TEE EREE penne 134 ASSOCIATION ri
198. ailable from the Parameters button Figure 10 6 Configure parameters dialog z Configure parameters draft mode Sa GE E S A A Ca e ebnf statement terminator rtf ebnf statement terminator Punctuation that ends an EBNF statement You can use the following editor variables cfn The current file name without extension cfdu The path of current file directory URL frameworks Oxygen frameworks directory URL home The path to user home directory URL You can interractively ask For parameter values using the following Function prototype fask Message input_type default_walue More details 286 Transforming documents The table presents all the parameters of the XSLT stylesheet and all imported and included stylesheets with their current values If a parameter value was not edited then the table presents its default value The bottom panel presents the default value of the parameter selected in the table a description of the parameter if it is available and the system ID of the stylesheet that declares it For setting the value of a parameter declared in the stylesheet in a namespace for example lt xsl param name p param xmlns p namespace gt default lt xsl param gt use the following expression in the Name column of the Parameters dialog namespace param The buttons of the dialog have the following functions Add Add a new parameter to the list The
199. al menu of current editor Source Format and Indent Element Ctrl I Pretty prints the element that surrounds the caret position contextual menu of current editor Source Import entities list 1 Shows a dialog that allows you to select a list of files as sources for external entities The DOCTYPE section of your document will be updated with the chosen en tities For instance if choosing the file chapterl xml and chapter2 xml the following section is inserted in the DOCTYPE lt ENTITY chapterl SYSTEM chapterl xml gt lt ENTITY chapter2 SYSTEM chapter2 xml gt e contextual menu of current editor Join and normalize The action works on the selection It joins the lines by re placing the line separator with a single space character It also normalizes the whitespaces by replacing a sequence of such characters with a single space XML document actions contextual menu of current editor Show Definition move the cursor to the definition of the current element in the schema associated with the edited XML document DTD XML Schema Relax NG schema NRL schema e contextual menu of current editor gt Copy XPath Ctrl Shift Copy XPath expression of current element or at tribute from current editor to clipboard contextual menu of current editor Go to the matching tag 43 Moves the cursor to the end tag that matches the start tag Or vice versa e contextual menu of current editor gt Go
200. alid at the caret position according to the schema different strategies are applied to find an appropriate insert position 360 Configuring the application Typing Content Completion e If the sibling element can accept the content then a new element with the same name as the sibling is created in which the content will be inserted e You will iterate to the left or to the right of the insertion position without leaving the cur rent context and try to insert the fragment in one of the encountered elements that accepts the content to be inser ted e Reject action when its result is invalid If checked and the result of the paste or drop action is invalid the action will not be performed Controls the behaviour that takes place when typing Available options e Smart typing If the typed character cannot be inser ted at element from the caret position then a sib ling element that can ac cept it will be searched for If the sibling element can accept the content then a new element with the same name as the sibling is cre ated in which the content will be inserted e Reject action when its result is invalid If checked and the result of the typing action is invalid the action will not be per formed Controls the behaviour that takes place when inserting elements using content com pletion 361 Configuring the application Available options e Allow only insertion of
201. alled If you open an archive as an Eclipse editor the archive will be unmounted when the editor is closed Important If a file extension is not known by lt oXygen gt as a supported archive type you can add it from the Archive preferences page 308 Working with Archives Figure 12 1 Browsing an archive amp OB x O BH samples_ zip 53 EH samples_ zip ES import 5 samples 2 5 55 pes samplel css fo sample1 xhtml fod sample2 css fed sample2 xhtml Loy sample3 css fog sample3 xhtml gt cvs debugger dita 3 docbook gt fo import amp jsp 3 nvdl ea 3 2 A The following operations are available on the Archive Browser s toolbar New folder Create a new folder as child of the selected folder in the browsed archive New file Create a new file as child of the selected folder in the browsed archive Add files Add some already existing files as children of the selected folder in the browsed archive Delete Delete the selected resource in the browsed archive Archive Options Open the Archive preferences page The following additional operations are available from the Archive Browser s contextual menu Open Open a resource from the archive in the editor Copy location Copy the URL location of the selected resource Refresh Refresh the selected resource Properties View properties for the selected resource Editing files from archives You can op
202. alog files to your Document Type Association using the Catalogs tab from the Document Type dialog M Important lt oXygen gt XML Editor collects all the catalog files listed in the installed frameworks No matter what the Document Type Association matches the edited file all the catalog mappings are considered when resolving external references Important The catalog files settings are available for all editing modes not only for the Author mode In the XML sample file for SDF you did not used a xsi schemaLocat ion attribute but instead you let the editor use the schema from the association However there are cases in which you must refer for instance the location of a schema file from a remote web location In such cases the catalog may be used to map the web location to a local file system entry In the following section it will be presented an use case for the XML catalogs by modifying our sdf xsd XML Schema file from the Example Files Listings The sdf xml file refers the other file abs xsd through an import element lt xs import namespace http www oxygenxml com sample documentation abstracts schemaLocation abs xsd gt The schemaLocat ion attribute references the abs xsd file located in the same directory What if the file was on the web at the http www oxygenxml com SDF abs xsd location for instance In this case the attribute value will be lt xs import namespace http www oxygenxml com sample docu
203. amework import ro sync ecss css Styles import ro sync ecss extensions api StylesFilter import ro sync ecss extensions api node AuthorNode import ro sync exml view graphics Font public class SDFStylesFilter implements StylesFilter public Styles filter Styles styles AuthorNode authorNode if AuthorNode NODE_TYPE_ELEMENT authorNode getType amp amp table equals authorNode getName styles setProperty Styles KEY_FONT new Font null Font BOLD 12 199 Author Developer Guide return styles Configuring a Table Column Width Provider In the documentation framework the table element and the table columns can have specified widths In order for these widths to be considered by lt oXygen gt Author we need to provide the means to determine them As explained in the Styling the Table Element section which describes the CSS properties needed for defining a table if you use the table element attribute width lt oXygen gt can determine the table width automatically In this example the table has col elements with width attributes that are not recognized by default You will need to implement a Java extension class for determining the column widths Create the class simple docu implement the ro sync ecss impo impo impo impo impo publ The method init is taking as argument the Aut hor the column widths are specified in col elements from the tab rt ro rt ro
204. amp nnnn form This option allows to create multiple result documents using the exs1 docu ment extension element http www exslt org exsl elements document index html This option allows to specify a custom URI resolver class to resolve URI refer ences in xsl import xsl include instructions during XSLT stylesheet loading phase and in document function during XSL transformation phase The previous option specifies partially or fully qualified URI resolver class name e g Acme Resolvers CacheResolver Such name requires addi tional assembly specification using this option or the next option but fully qualified class name which always includes an assembly specifier is all suffi cient See MSDN for more info about fully qualified class names http msdn microsoft com library default asp url library en us cpguide html cpconspecifyingfullyqualifiedtypenames asp This option specifies a file name of the assembly where the specified resolver class can be found This option specifies partially or fully qualified name of the assembly in the global assembly cache http msdn microsoft com library default asp url library en us cpguide html cpconglobalassemblycache asp GAC where the specified resolver class can be found See MSDN for more info about partial assembly names http msdn microsoft com library default asp url library en us cpguide html cpconpartialassemblyreferences asp Also see the previous option This opt
205. an element after an inline child element Figure 5 16 After an inline element the CSS Alterna ives toolbars The nodes in the previous cases are displayed in the tooltip window using their names You can deactivate this feature by unchecking Options Preferences Editor Author Show caret position tooltip checkbox Even if this option is disabled you can trigger the display of the position tooltip by pressing Shift F2 Note The position information tooltip is not displayed if one of the modes Full Tags with Attributes or Full Tags is selected Displaying referred content The referred content entities XInclude DITA conref etc will be resolved and displayed by default You can control this behavior from the Author options page The referred resources are loaded and displayed inside the element or entity that refers them however the displayed content cannot be modified directly When the referred resource cannot be resolved an error will be presented inside the element that refers them instead of the content If you want to make modifications to the referred content you must open the referred resource in an editor The referred resource can be opened quickly by clicking on the link marked with the icon 4 which is displayed before the referred content The referred resource is resolved through the XML Catalog set in Preferences To update the displayed referred content so that it reflects the latest modificat
206. an j extensions html e for Saxon 6 5 5 http saxon sourceforge net saxon6 5 5 extensions html e for Saxon 9 2 0 6 http www saxonica com documentation extensions intro html 300 Transforming documents In order to set an XSLT processor extension a directory or a jar file you have to use the Extensions button of the scenario edit dialog The old way of setting an extension using the parameter Dcom oxygenxml additional classpath was deprecated and you should use the extension mechanism of the XSLT transformation scenario XProc Transformations XProc transformation scenario A sequence of transformations described by an XProc script can be executed with an XProc transformation scenario In the scenario the parameters of the transformation are specified the URL of the XProc script the XProc engine the input ports and the output ports On the XProc tab of the scenario edit dialog it is selected the URL of the XProc script and the XProc engine The engine can be the built in engine called Calabash XProc or other engine configured in Preferences On the Inputs tab of the dialog is configured each port that is used in the XProc script for reading input data Each input port has a name that is assigned in the XProc script and that is used for identifying the port in the list from the Port combo box The XProc engine will read data from the URLs specified in the URLs list The built in editor variables and the custom editor variable
207. an open it in the main editor for further customization using the Open map in editor toolbar action Tip If your map references other DITA Maps they will be shown expanded in the DITA Maps Tree and you will also be able to navigate their content For editing you will have to open each referenced map in a separate editor You can choose not to expand referenced maps in the DITA Maps Manager or referenced content in the opened editors by unchecking the Display referred content checkbox available in the Author preferences page S Note A map opened from WebDAV can be locked when it is opened in DITA Maps Manager by checking the option Lock WebDAV files on open to protect it from concurrent modifications on the server by other users If other user tries to edit the same map he will receive an error message and the name of the lock owner The lock is re leased automatically when the map is closed from lt oXygen gt DITA Maps Manager Creating a map The steps for creating a new DITA map are very simple 1 Go to menu File gt New or click on the L New toolbar button 86 Author for DITA 4 On the tab From templates of the New dialog select one of the DITA Map templates and click OK A new tab is added in the DITA Maps Manager view Press the lel save button on the toolbar of the DITA Maps Manager view In the Save As dialog select a location and a file name for the map Create a topic and add it to a map You add a new
208. and the column width specifications particular to them The tables and columns widths can be visually adjusted by dragging with the mouse their edges and the modifications will be committed back into the source document Figure 5 20 Resizing a column in lt oXygen gt Author editor col span 1 width 2 col span 1 width 0 5 Jane gt 26 Bart l 24 Alexander E 22 b They are all students of the computer science department DocBook The DocBook table layout supports two models CALS and HTML In the CALS model column widths can be specified by using the colwidth attribute of the associated colspec element The values can be fixed or proportional Figure 5 21 CALS table Sample CALS Table with no specified width and proportional column widths colspec colname c1 colnum 1 colwidth 1 colspec colname c2 colnum 2 colwidth 1 5 colspec colname c3 colnum 3 colwidth 0 7 colspec colname c4 colnum 4 colwidth 0 5 colspec colname c5 colnum 5 colwidth 1 7 Horizontal Span a3 as fa5 a ip pp pls bl b2 ME peer el Spans Both4 4 SPan dl directions d4 d5 XHTML The HTML table model accepts both table and column widths by using the width attribute of the table element and the col element associated with each column The values can be represented in fixed units proportional units or per centages 79 Authoring in the tagless editor Figure 5 22 HTML table Sample HTML
209. ang String public boolean isAcceptingProportionalColumnWidths String tableCellsTagName return true 257 Author Developer Guide see ro sync ecss extensions api AuthorTableColumnWidthProvider isTableAcceptingWidth java lang String public boolean isTableAcceptingWidth String tableCellsTagName return td equals tableCellsTagName pk see ro sync ecss extensions api AuthorTableColumnWidthProviderttisTableAndColumnsResizable java lang String public boolean isTableAndColumnsResizable String tableCellsTagName return td equals tableCellsTagName pk see ro sync ecss extensions api Extension getDescription x7 public String getDescription return Implementation for the Simple Documentation Framework table layout ReferencesResolver java package simple documentation framework import java io IOException import java net MalformedURLException import java net URL import javax xml transform sax SAXSource import org apache log43 Logger import org xml sax EntityResolver import org xml sax InputSource import org xml sax SAXException import org xml sax XMLReader import ro sync ecss extensions api AuthorAccess import ro sync ecss extensions api AuthorReferenceResolver import ro sync ecss extensions api node AttrValue import ro sync ecss extensions api node AuthorElement import ro sync ecss
210. ansforming documents e fop xconf available in folder frameworks dita DITA 0T demo fo fop conf an element font must be inserted in the element fonts which is inside the element renderer having the attribute mime application pdf as in the above fopConfiguration xml file for example 1 lt renderer mime application pdf gt lt fonts gt lt font metrics url Arialuni xml kerning yes mbed url file Library Fonts Arialuni ttf gt lt font triplet name Arialuni style normal weight normal gt lt font gt lt fonts gt lt renderer gt Common transformations The following examples use the DocBook XSL Stylesheets to illustrate how to configure lt oXygen gt for transformation to the various target formats Note lt oXygen gt comes with the latest versions of the DocBook and TEI frameworks including special XSLT stylesheets for DocBook and TEI documents DocBook XSL extensions for the Saxon and Xalan processors are included in the frameworks docbook xsl extensions directory The following steps are common to all the example procedures below 1 Ze Set the editor focus to the document to be transformed Select XML gt Configure transformation scenario Alt Shift T C Cmd Alt T C on Mac OS to open the Configure Transformation dialog If you want to edit an existing scenario select that scenario in the list and press the Edit button If you want to create a new scenario press
211. anual at the list of the sections where the configuration of supported data sources is explained and the URLs for downloading the database drivers are spe cified Provide the Driver Class for the data source driver Adds the driver class library Removes driver class library from the list Detects driver candidates Stops the detection of the driver candidates 399 Configuring the application Edit Opens the Data Sources Drivers dialog allowing you to edit the selected driver See above the specifications for the Data Sources Drivers dialog in order to edit a data source there must be no connections using that data source driver Delete Deletes the selected Data Source Driver in order to delete a data source there must be no connections using that data source driver Figure 17 52 The Connections preferences panel c ti Enable Name URL M DB2 jdbc db2 10 0 0 16 50000 SAMPLE retriev O exist xmldb exist 10 0 0 16 8080 exist xmirpc A SQL Server jdbc sqlserver 10 0 0 16 instanceName 500 CA Oracle 10g connect jdbc oracle thin 10 0 0 5 1521 ORACLE A MarkLogic Delete Limit the number of cells 2000 Maximum number of children for container nodes 200 Convert DB Structure to XML Schema Note Checked connections will be visible in the Data Source Explorer View For performance issues you can set the maximum number of cells that will be displayed in the Table Explorer view Lea
212. api jar e tlerror jar e utility jar e xmlparser jar e xmltypes jar 4 Click OK to finish the data source configuration How to configure a Documentum xDb X Hive DB datasource The latest instructions on how to configure support for Documentum xDb X Hive DB versions 8 and 9 in lt oXygen gt can b e found o n our website http www oxygenxml com doc ug oxygenEclipse native xml database support html configure xhive datasource 1 Goto Preferences gt Data Sources In the Data Sources panel click the New button 2 Enter a unique name for this data source and select Documentum xDb X Hive DB from the driver type combo box 323 Working with Databases 3 4 Add the following Documentum xDb X Hive DB specific files found in the Documentum xDb X Hive DB lib directory from the server side e antlr runtime 3 0 1 jar e icu4j jar e xhive jar e google collect jar only for X Hive 9 Click OK to finish the data source configuration Configuring Database Connections This section presents a set of procedures describing how to configure connections that use Native XML Database data sources How to configure a Berkeley DB XML Connection lt oXygen gt supports Berkeley DB XML versions 2 3 10 2 4 13 amp 2 4 16 l 2 4 Go to Preferences gt Data Sources In the Connections panel click the New button Enter a unique name for this connection and select one of the previously configured Berke
213. application is disabled and a permanent license must be purchased in order to use the ap plication For special circumstances if a trial period of greater than 30 days is required please contact lt support oxygenxml com gt All licenses are obtained from the lt oXygen gt web site http www oxygenxml com For definitions and legal details of the license types available for lt oXygen gt XML Author you should consult the End User License Agreement received with the license key and available also on the lt oXygen gt XML Author website at http www oxygenxml com eula_author html Note Starting with version 10 0 lt oXygen gt accepts a license key for a newer version in the license registration dialog e g version 10 0 accepts a license key for version 11 or a license key for version 12 Once you have obtained a license key the installation procedure is described below Named User license registration 1 Save a backup copy of the message containing the new license key 2 Start the application 3 Copy to the clipboard the license text as explained in the message 4 If this is a new install of the application then it will display automatically the registration dialog when it is started In the case you already used the application and obtained a new license go to Window Preferences oXygen and press the OK button to make the registration dialog appear Installation Figure 2 1 Registration Dialog lt o
214. ard an application specific URL for the resource which can then be used for various actions like opening or transforming the resources e Properties allows the user to view various useful properties associated with the resource e Save As allows you to save the name of the selected binary resource as a file on disk WebDAV Connection This section presents the procedure used to configure a WebDAV connection in the Data Source Explorer 330 Working with Databases Figure 13 7 The Data Source Explorer view O lost Found boot 0800 config config 2 6 12 12mdksmp config 2 6 8 1 12mdksmp initrd 2 6 12 12mdksmp imag initrd 2 6 8 1 12mdksmp img 3 initrd smp img 3 initrd img kernel h kernel h 2 6 12 12mdksmp kernel h 2 6 8 1 12mdksmp map message message graphic v 0 Y LD y y i Y lt oXygen gt s default configuration already contains a WebDAV data source called WebDAV How to Configure a WebDAV Connection 1 Goto Preferences gt Data Sources In the Connections panel click the New button 2 Enter a unique name for this connection and select one of the WebDAV data source from the Data Source combo box 3 Fill in the Connection Details WebDAV URL to the WebDAV repository URL User User name to access the WebDAV repository Password Password to access the WebDAV repository 4 Click OK WebDAV connection actions Actions availabl
215. associated schema 34 Editing documents Figure 4 16 The Attributes panel xsd element Attribute name type substitutionGroup default fixed nillable abstract final block The Elements view Figure 4 17 The Elements View lt x Elements 23 E abbrev acronym E action E address E anchor E application E author E authorinitials E beginpage E bibliolist E biblioref E blockquote E calloutlist E caution E citation E citerefentry E citetitle E classname iv EJ Presents a list of all defined elements that you can insert at the current caret position according to the schema used for content completion Double clicking any of the listed elements will insert that element in the edited document All elements from a sequence are presented but the invalid proposals which cannot be inserted in the current context are grayed out The Entities View This view displays a list with all entities declared in the current document as well as built in ones Double clicking one of the entities will insert it at the current cursor position You can also sort entities by name and value 35 Editing documents Figure 4 18 The Entities View 5 Entities 3 Name It g amp apos quot 3 oxy edtjoxygen tegt author amp ltyoXygen amp gt XML A swnClient Syncro SVN
216. aster file using external entities only the master file will contain the Document Type Definition the DTD or other type of schema The included sections can t define again the schema because the main document will not be valid If you want to validate the parts separately you have to use XInclude for assembling the parts together with the master file Creating an included part Open a new document of type XML with no associated schema You can type in the edited document the root element of your section For example if you are using DocBook it can be lt chapter gt lt chapter gt or lt section gt lt section gt Now if you are moving the cursor between the tags and press lt you will see the list of element names that can be inserted Figure 4 27 Content Completion list over a document with no schema lt xml version 1 0 encoding UTF 8 gt lt book gt lt title gt lt lt ti E abbrev An abbreviation especially one followed by a period lt art Eacronym Category Traditional Publishing Inlines lt pre Eaction lt t E anchor E application lt pr E author lt book E authorinitials Note The validation will work on an included file that has no DTD set only if you associate the file with a validation scenario that specifies the master file as the start point of validation Without a validation scenario you can only check the included file to be well formed Creating a new project
217. atalogs The Verbosity option selects the detail level of such messages of the catalog resolver that will be displayed in the Catalogs view at the bottom of the window None No message is displayed by the catalog resolver when it tries to resolve a URI reference with the XML catalogs set in the application Unresolved entities Only the messages that track the failed attempts to resolve URI references are displayed All messages The messages of both failed attempts and successful ones are displayed If the Process namespaces through URI mappings for XML Schema option is not checked only the schema location of an XML Schema that is declared in an XML document is searched in XML catalogs If the option is checked the schema location of an XML Schema that is declared in an XML document is searched in XML catalogs and if the schema location is not resolved the namespace of the schema is also searched in the XML catalogs If the Use default catalog option is checked the first XML catalog which lt oXygen gt will use to resolve system IDs at document validation and URI references at document transformation will be a default built in catalog which maps such references to the built in local copies of the local DocBook and TEI frameworks and the schemas for XHTML SVG and JSP documents You can also add or configure catalogs for each of the defined document types from Document Type Association preferences page When you add delete or edit an XML catalog to
218. ate key password Validate Verifies the entries from the fields assures that the certificate is valid XML Structure Outline The XML Structure Outline preferences panel is opened from menu Window Preferences gt Author Outline Figure 17 60 The XML Structure Outline preferences panel XML Structure Outline he Preferred attribute names for display name id manager subordinates Enable outline drag and drop Preferred attribute names for display The attribute names which should be preferred when displaying element s attrib utes in the outline view If there is no preferred attribute name specified the first attribute of an element is displayed in the outline view Enable outline drag and drop When drag and drop is disabled for the tree displayed by the outline view there is no possibility to accidentally change the structure of the document Scenarios Management The Scenarios Management preferences panel is opened from menu Window Preferences gt Author Scenarios Management Figure 17 61 The Scenarios Management preferences panel Scenarios Management Import Global Transformation Scenarios a Export Global Transformation Scenarios Import transformation scenarios Allows you to import all transformation scenarios from a scenarios properties file Their names will appear in the Configure Transformation Scenario dialog followed by import This way there are no scenarios names confl
219. ate key used for the private key method of authentication of the secure FTP SFTP protocol The user password method of authentication has precedence if it is used in the Open URL dialog The passphrase used for the private key method of authentication of the secure FTP SFTP protocol The user password method of authentication has preced ence if it is used in the Open URL dialog If checked a warning dialog will be shown each time when the authenticity of the host cannot be established In lt oXygen gt there are provided two types of Keystores Java KeyStore JKS and Public Key Cryptography Standards version 12 PKCS 12 A keystore file is protected by a password The Certificates preferences panel is opened from menu Window gt Preferences gt Author Certificates Figure 17 59 The Certificates preferences panel Certificates Mn Keystore type JKS Keystore file Keystore password Certificate alias Private key password Keystore type Represents the type of keystore to be used Keystore file Represents the location of the file to be imported Keystore password The password which is used to protect the privacy of the stored keys Certificate alias The alias to be used to store the key entry the certificate and or the private key inside the keystore 406 Configuring the application Private key password Itis only necessary in case of JKS keystore It represents the certificate s priv
220. ate mode Specifies the name of the initial template to the transformer When specified the XML input URL for the transformation scenario is optional If checked the specified Saxon configuration file will be used to specify the Saxon advanced options If checked the stylesheet is disallowed to call external Java functions If checked display a warning when it is applied to an XSLT 1 0 stylesheet If checked the source XML file is validated against the declared DTD Include the line number in errors for the Policy for handling recoverable errors in the stylesheet Allows the user to choose how dynamic errors will be handled Either one of the following options can be selected recover silently recover with warnings or signal the error and do not attempt recovery Strip whitespaces feature can be one of the three options All Ignorable None 282 Transforming documents Validation of the source file Validation errors in the results tree treated as warnings All Ignorable None strips all whitespace text nodes from source documents before any further processing regardless of any xsl strip space declar ations in the stylesheet or any xml space attributes in the source document strips all ignorable whitespace text nodes from source documents before any further processing regardless of any xsl strip space declarations in the stylesheet or any xml space attributes in the source document Whitespace text nodes a
221. ation output file will have the name of the XML file and the html extension and will be placed in the same directory Open in browser Enable this option 181 Author Developer Guide Saved file Enable this checkbox Figure 8 19 Configuring a transformation scenario Edit scenario A nee E Scenario Name SDF to HTML XSLT FO Processor Output XML URL currentFileURL 2 a B YSL URL frameworks sdf xslfsdf xsl a oe B More about currentFileURL use xml stylesheet declaration Transformer Saxon8B v Parameters Append header and footer Additional XSLT stylesheets 0 Extensions 0 Now the scenario is listed in the Transformation tab Figure 8 20 The transformation tab Schema Classpath Author Templates Catalogs Transformation Extensions E E XML transformation with XSLT E XML transformation with XQUERY E DITA OT transformation E XSLT transformation k XProc transformation XQUERY transformation SOL transformation To test the transformation scenario you created open the SDF XML sample from the Example Files Listings Click on the Wapply Transformation Scenario button The Configure Transformation Dialog is displayed Its scenario list contains the scenario you defined earlier SDF to HTML Click on it then choose Transform now The HTML file should be saved in the same directory as the XM
222. ation rules 128 Author extensions 128 catalogs 128 templates 128 transformation scenarios 128 schema 128 Text editor specific actions 344 check spelling 345 check spelling in files 348 Transformation scenario 277 batch transformation 278 built in transformation scenarios 278 new transformation scenario additional XSLT stylesheets 287 configure transformation scenario 278 creating a transformation scenario 288 XSLT parameters 286 XSLT X Query extensions 288 Transforming documents 276 common transformations 294 HTML Help output 296 HTML output 296 Java Help output 297 PDF output 295 PS output 295 TXT output 296 XHTML output 297 custom XSLT processors 300 output formats 276 supported XSLT processors 297 Transformation scenario 277 Transformation Scenarios view 288 XSL FO processors 289 XSLT processors extensions paths 300 U Uninstalling the plugin 9 Upgrade 8 check for new version 9 V Validating XML documents 36 against a schema 38 caching the schema used for validation 39 custom validation 40 marking validation errors 38 resolving references to remote schemas with an XML Catalog 46 validate as you type 39 validation actions 45 validation example 39 validation scenario 42 checking XML well formedness 36 Validation scenario sharing the validation scenarios project level scenarios 45 W WebDAV Connection 330 actions at connection level 331 at file level 332 at fold
223. ation will output empty elements with a separate closing tag ex lt a atrl v1 gt lt a gt When not checked the same 365 Configuring the application Sort attributes Add space before slash in empty elements Break line before attribute s name Preserve space elements XPath Default space elements XPath Mixed content elements XPath Schema aware format and indent Indent when typing in preserve space elements Indent on paste Note operation will represent an empty element in a more compact form lt a atrl v1 gt When checked the Format and Indent operation will sort the attributes of an element alphabetically When not checked the same operation will leave them in the same order as before applying the operation When checked the Format and Indent operation will add a space before the closing slash of an empty element for instance an empty br will appear as lt br gt If checked the Format and Indent Pretty Print function will break the line before the attribute s name This list contains simplified XPath expressions for the names of the elements for which the contained white spaces like blanks tabs and newlines are preserved by the Format and Indent operation exactly as before applying the operation The allowed XPath expressions are of one of the form e author e listing e chapter abstract title e xs documentation The namespace prefixes like xs in the previous exampl
224. ayout of the grid editor Figure 9 8 Default left to right text orientation lt xml version 1 0 encoding UTF 8 2 sample Hex 9 rows 19 dle iy gg Ey el Ll ay yp Lois Quan el m n vol conversar parla Unicode 170270 210 277 AYN owanw Unicode Ha a vil g besz lni akar azt Unicode ul mondja Quando il mondo vuole comunicare parla Unicode HSA TIO Unicode TH gt MALS EE HS SLIDES OHA Nar verden vil snakke snakker den Unicode AAA A a wln ea ES N r verda nskjer snakke talar ho Unicode Figure 9 9 Right to left text orientation lt xml version 1 0 encoding UTF 8 IM sample text 9 rows Asi dehy is agi Ey gf AL ay y Lario Quan el m n vol conversar parla Unicode Unicode 2 2278 AIN 1277 AYN OFA WaT Ha a vil g besz lni akar azt Unicode ul mondja Quando il mondo vuole comunicare parla Unicode EFAS gt Unicode CF AAE EE HS SLIDES oA N r verden vil snakke snakker den Unicode N r verda snskjer snakke talar ho Unicode O OON DD mH amp w amp Nh gt 275 Chapter 10 Transforming documents XML is designed to store carry and exchange data not to display data When you want to view the data you must either have an XML compliant user agent or transform it to a format that can be read by other user agents This process 1s known as transformation Status messages generated during transformation are displayed in the Console view XSLT Transformations Outp
225. b 2 0 chapter author Current location in the ov title da intri eens PA a pas 8 lt XML Document Overview The Outline view 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 structure and the way tags are nested It allows fast navigation of the document by displaying the start of the content of the child 66 Authoring in the tagless editor elements in the node of the parent element thus allowing to see quickly the content of an element without expanding 1t in the Outline tree It also allows the user to insert or delete nodes using pop up menu actions Modification Follow up When editing the Outline view 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 a better insight on location inside the document and how the structure of the document is affected by one s modifications Document Structure Change Entire XML elements can be moved or copied in the edited document using only the mouse in the Outline view in drag and drop operations If you drag an XML element in the Outline view and drop it on another one in the same panel then the dragged element will be moved after the drop target element If you hold the mouse pointer over the drop targ
226. b eed ER 122 ASSOCIALION TUNES didas 122 NA eee EE odd seen edule ove Dhae se E A eae yh edolersevedane stocks 122 CSS A A A cia 122 AUthOr EXTENSIONS A iii 122 TEMPLE ai 124 Catalonia dd IE dd ad E dd NAO 124 Transformation Scenarios oococononocononncncnrncnonononononono nono non rn rn sees nr rro nr nono nono no RNE 125 The TEL P4 document typen ica ds id DA Bs iia 125 ASSOCIALION FUIES id ri a is Seen bad Whee denen bets 125 Schema sios Fe aie O cadens A 125 AUTNOREXTENSIONS see seeds a A ide 125 Templates a A sai 127 Catalo gS misicne cactus idee terout ng E N heb Aden a daw seb daceayowthos dee uddenSreuddasateasaest 127 Transformation Scenarios ccc cece cece cece ence ence e eee EREI ee ee nro nro nono nono ene en EE T E 127 The TEL P5 document types erite n E E E E E EA sgh N a E AARENSEN 127 Associaton rules A pee ued dust N N lentes 128 STE L IE EEEE ET EET A de 128 Author Extensions a aia dia 128 NO RN 128 Catalogs ai A IAS E iia 128 Transforimati n Scenarios baina 128 The MathMiladocument ty pe tir A dd 128 ASSOC1AION TUES o dia 129 NS NN 129 Templates innen shoes tees scenauead eas setae aeevdaes von das soabdaenaeacuaae a A a EEEE AEEA 129 The Microsoft Office OOXML document type cceeeeeeececeeceeeeeeeececeeeceueeeeeesceaueeeeeeeeeaeeeeuneeeees 129 ASSOCIATION TUNES tn a iia 129 SCHEMA a o i 130 The Open Office ODF document ty Pex sisne dacene ei Ghacdenreaensdnuadeongeddacwed ooo ida
227. ble row with empty cells The action is available when the caret position is inside a table ES lInsert Column inserts a new table column with empty cells after the current column The action is available when the caret position is inside a table 118 Predefined document types e Insert Cell inserts a new empty cell depending on the current context If the caret is positioned between two cells a new one will be inserted at caret s position If the caret is inside a cell then the new one will be created after the current cell Delete Column deletes the table column where the caret is located E Delete Row deletes the table row where the caret is located Join Row Cells joins the content of the selected cells The operation is available if the selected cells are from the same row and they have the same row span The action is also available when the selection is missing but the caret is positioned between two cells Join Cell Above joins the content of cell from current caret position with that of the cell above it Note that this action works only if both cells have the same column span A Join Cell Below joins the content of cell from current caret position with that of the cell below it Note that this action works only if both cells have the same column span m Split Cell To The Left splits the cell from current caret position in two inserting a new empty table cell to the left Note that this action wo
228. box Press the Add button to add the following Oracle 11g specific files e ojdbc5 jar In the Download links for database drivers section there are listed the URLs from where to download the drivers necessary for accessing Oracle 11g databases in lt oXygen gt You can manage the Driver Files using Add Remove Detect and Stop detection buttons 3 Select the most suited Driver class 4 Click OK to finish the data source configuration How to configure a PostgreSQL 8 3 Data Source 1 Go to Preferences gt Data Sources In the Data Sources panel click the New button 2 Enter a unique name for this data source and select Postgres from the driver type combo box Press the Add button to add the following Postgres 8 3 specific files e postgresql 8 3 603 jdbc3 jar In the Download links for database drivers section there are listed the URLs from where to download the drivers necessary for accessing PostgreSQL databases in lt oXygen gt You can manage the Driver Files using Add Remove Detect and Stop detection buttons 3 Select the org postgresql Driver class in the Driver class combo box 4 Click OK to finish the data source configuration Configuring Database Connections This section presents a set of procedures describing how to configure connections that use relational data sources 313 Working with Databases How to Configure an IBM DB2 Connection Figure 13 2 The Connection Configuration Dialog
229. button Press the Add button from the Rules section Press the Choose button that follows the Java class value The following dialog is displayed 156 Author Developer Guide Figure 8 7 Selecting a Java association rule Operation Class simple documentation framework CustomRule v Description Checks if the current Document Type Association is matching the document Classpath 4 Frameworks isdFisdF jar The search classpath is defined in the Classpath tab located below the Rules section Number of classes found 2 To test the association open the sdf xm1 sample and validate it Deciding the initial page You can decide to impose an initial page for opening files which match the association rules For example if the files are usually edited in the Author page you can set it as the initial page for files matching your rules Schema Settings In the dialog for editing the Document Type properties in the bottom section there are a series of tabs The first one refers to the schema that is used for validation of the documents that match the defined association Rules Important If the document refers a schema using for instance a DOCTYPE declaration or a xsi schemaLocation at tribute the schema from the document type association will not be used when validating Schema Type Select from the combo box the value XML Schema Schema URI Enter the value frameworks
230. cccnccnoconnconnconnconeconnconnrnnnnnnrnnnrnnccnnronnccnnccnnconncinnciniss 80 Whitespace handling sesyon tales weed ston son esas tevedeopstmnes ap ned ANE E SiS 81 Minimize differences between versions saved on different computers 0e 82 Change Tracking joss inae ns of cert aa ony a seta sadeu eden syed E NE eed ass Geegaen evades y 82 Managing CAOBA IS eee tase de edt reat aad 83 6 Atithor for DITA aio ita assy E alice des oh oedebeepte essennseatepiewn dsuph eee shen sseaegsateee stony 85 Creatine DITA maps and topiCs 2 sii s ody bens ce id ls et ee 85 Editing DITA Maps att ds nb iaededousdon dau ii lili 85 Creatine aiMap toda 86 Createatopic and add itto a Map vescesscesec ovens sun esss peed eyes ees rior RN E op nae ESE Sunes O AES ES 87 Organize topics a Map seis ss it Sesion ed Ae Rea ase eae See ii 87 Create a DOOKMAP vectores pio a E E a daa nduedsaeareetnes iria dci 87 Create relationships between topics 0 e eee eeeeceeece ence ence eeceeeeeeeeeeeea seca eesa sean eeae eens eeneeeeeeeenes 88 Create an Ndex Entry doit ear 88 ECiting ACOSO Ge he DN aS aR ea el ee otal ad antes 88 Advanced operations costaria e e E dau etoeeeGeut desde van ceoeeathae ms E a R E dea ETES 91 Inserting a Topic Referencia ed E EN EISEN 91 Inserting E il AAA ao R E E T gee EA EEE S 92 Insertine a Topic Groups Sene na A a Nebo Oe Sah E 92 lt oXygen gt XML Author 11 2 User Manual for Eclipse O O 93 Transformin
231. cccnnccnnccnnconnccnnccnnccnncnnncnnncnnncnnrcnaronacnnss 102 Resolving topic references through an XML catalog 20 0 0 eee cece cece cece eeceeeca seca sean eeaes 103 DITA specializations SUPPOLE votos e Seanee np teeees E N e Sea e EEEE oI dest sumer sdeledes 103 Integration of a DITA specialization ccooocccnoccnnnoccnnccnnnnccnnnncnnnccnnnnconnnncnnnconnnncinnncnnnnose 103 Editing DITA Map specializations sssini nre a a a E a NE 103 Editing DITA Topic specializations ooocooocnncnnncnnncnnncnnconnconnconnccnnconnconncnnncnnncnnrcnnronicnnn 103 Use a new DITA Open Toolkit in lt oXygen gt oooccooccnccnncnnnconocnnccnnconnccnncconconnconncnnncnnncnnnnnnrenoss 104 REUSING CONLENE ii A EE A A E E E EOSS 104 Workme with content referendes oenn anea e nE hac TER a Ra EA a a E e e ESS 105 Reusable component os tr rt ii 105 Insert a direct content reference rn eean a e N EE NE E EEAS EPE 106 T Predefined document types asr on E E EE E E A cede dsb E O A a 107 The DocBook V4doc ment type yine ian e a E RA a Int 107 ASSOCIaLION na Ia dd E E E dad 108 NS 108 Author EXTENSIONS uva ai is rod iia dea coco 108 TEMPLE rte 111 Catala AI AI Da rd doi Sai 111 Transformation Scenarios oe eeni ee e EE tes ino 111 The DocBook V5 docuiment type lt i sic sessed ii id ii it 112 ASSOCTATION TUE 5 sasevcehicas fet danny a a a a Mubedendawesdasntee dawn steed italian 112 A Teele ioe Ul Sree oa tg ent ee TOL aie ct tate Te eect A iy ease 112 AUTHOL
232. ce Operating System Tools and Environment Requirements Operating System Windows Windows 98 or later Mac OS minimum Mac OS X 10 4 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 The MD5 sum is available on the Download page http www oxygenxml com download html for every archive You should check the MD5 sum of the downloaded archive with a MDS checking tool available on your platform Environment Prerequisites Prior to installation ensure that your installed Eclipse platform is the following e the latest stable Eclipse version available at the release date The current version works with Eclipse 3 5 e lt oXygen gt XML Author supports only official and stable Java virtual machine versions 1 5 0 and later from Sun Microsystems available at http java sun com and from Apple Computer pre installed on Mac OS X For Mac OS X Java VM updates are available at http www apple com macosx features java lt oXygen gt XML Author may work very well with JVM implementations from other vendors but the eventual incompatibilities will not be solved in further lt oXygen gt XML Author releases lt oXygen gt XML Author does not work with the GNU libgcj Java virtual machine http www oxygenxml com forum ftopic1887 html Installation Installation Instructions Prior to proceedi
233. checked in The label of the updated version An optional description of the file If checked the updated file is checked into the repository but it is also kept checked out in your name Makes the updated file the current version will have the CURRENT version label Cancel Checkout Cancels the check out and loses all modifications since the check out Action is only available if the object is checked out Export Allows you to export the object and save it locally Rename Changes the name of the selected object Copy Copies the selected object to a different location in the tree Action is not available on virtual document descendants This action can also be performed with drag and drop while holding the Ctrl key pressed Move Moves the selected object to a different location in the tree Action is not available on virtual document descendants and on checked out objects This action can also be performed with drag and drop 337 Content Management System CMS Integration X Delete Deletes the selected object from the repository Action is not available on virtual document descendants and on checked out objects e Add Relationship Adds a new relationship for the selected object This action can also be performed with drag and drop between objects Convert to Virtual Document Allows you to convert a simple document to a virtual document Action is available only if the object is a simple document e C
234. cify content reference ranges This is a very useful feature when referencing multiple consecutive steps or list items If you use multiple contiguous sibling selection for IDs at sub topic level the conrefend value will also be set to the value of the last selected ID path Oxygen will present the entire referenced range as read only content 1 Important All keys which are presented in the dialog are gathered from the current opened DITA Map Elements which have the conkeyref attribute set are displayed by default with the target content expanded The current opened DITA Map is also used to resolve references when navigating conkeyref links in the Author page Replace conref conkeyref reference with content Replace the content reference fragment or the conkeyref at caret position with the referenced content This action is useful when you want to make changes to the content but decide to keep the referenced fragment unchanged Insert Ordered List inserts an ordered list with one list item Insert Unordered List inserts an unordered list with one list item Insert List Item inserts a new list item for in any of the above two list types insert Table opens a dialog that allows you to configure the table to be inserted The dialog allows the user to configure the number of rows and columns of the table if the header will be generated if the title will be added and how the table will be framed Insert Row inserts a new ta
235. cify when lt oXygen gt should use the files created in the previous section by creating a document type association Open the Document Type dialog by following the procedure 1 Open the Options Dialog and select the Document Types Association option pane 2 Select the Developer user role from the User role combo box at the top of the dialog This is important because it will allow us to save the document type association in a file on disk instead of lt oXygen gt options 3 Click on the New button In the displayed dialog fill in the following data Name Enter SDF This is the name of the document type Description Enter Simple Documentation Framework This is a short description helping the other users understand the purpose of the Document Type Storage The storage refers to the place where the Document Type settings are stored Internal means the Document Types are stored in the default lt oXygen gt preferences file Since you want to share the Document Type to other users you must select External and choose a file The file must be in the oXygen_installation_directory frameworks sdf directory A possible location is Users user_name Desktop oxygen frameworks sdf sdf framework The framework directory structure will be oxygen frameworks sdf sdf framework schema sdf xsd css sdf css Rules If a document opened in lt oXygen gt matches one of the rules defined for the Document Type then it is activated
236. cludes DTD definitions for new elements as extensions of existing DITA elements and op tionally specialized processing that is new XSLT template rules that match the extension part of the class attribute values of the new elements and thus extend the default processing available in DITA Open Toolkit A specialization can be integrated in lt oXygen gt XML Author with minimum effort If the DTDs that define the extension elements are located in a folder outside the DITA Open Toolkit folder you should add new rules to the DITA OT catalog file for resolving the DTD references from the DITA files that use the specialized elements to that folder This allows correct resolution of DTD references to your local DTD files and is needed for both validation and transformation of the DITA maps or topics The DITA OT catalog file is called catalog dita xml and is located in the root folder of the DITA Open Toolkit If there is specialized processing provided by XSLT stylesheets that override the default stylesheets from DITA OT these new stylesheets must be called from the Ant build scripts of DITA OT Important If you are using DITA specialization elements in your DITA files itis recommended that you activate the Enable DTD processing in document type detection checkbox in the Document Type Association page Editing DITA Map specializations In addition to recognizing the default DITA map formats map and bookmap the DITA Maps Manager can also be used to o
237. comments XPath fftext a Output File nt projects eXmlsamples personal_can_ec xmll Canonicalize Cancel URL Specifies the location of the input URL Exclusive If selected the exclusive uncommented canonicalization method is used Exclusive with comments If selected the exclusive with comments canonicalization method is used Inclusive If selected the inclusive uncommented canonicalization method is used Inclusive with comments If selected the inclusive with comments canonicalization method is used XPath The XPath expression provides the fragments of the XML document to be signed Output Specifies the output file path where the signed XML document will be saved Open in editor If checked the output file will be opened in the editor Certificates A certificate is a digitally signed statement from the issuer an individual an organization a website or a firm saying that the public key and some other information of some other entity has a particular value When data is digitally signed the signature can be verified to check the data integrity and authenticity Integrity means that the data has not been modified Authenticity means the data comes indeed from the entity that claims to have created and signed it Certificates are kept in special repositories called Keystores A Keystore is an encrypted file that contains private keys and certificates All keystore entries key and trusted certi ficate ent
238. conformance os revision security vendor wordsize dir xml base E abbrev E acronym action E address E anchor E application author E authorinitials E beginpage E bibliolist E biblioref E blockquote E calloutlist caution H tation x Before After e Oh ss Caret Although lt oXygen gt comes with already configured frameworks for DocBook DITA TEI XHTML you might need to create a customization of the editor to handle other types of documents For instance in the case you have a collection of XML document types used to define the structure of the documents that are used in your organisation and you want them visually edited by people who are not experienced in using XML There are several ways to customize the editor 1 Create a CSS file defining styles for the XML elements the user will work with and create XML files that refer the CSS through an xml stylesheet processing instruction 2 Fully configure a document type association This involves putting together the CSSs the XML schemes actions menus etc bundling them and distributing an archive The CSS and the GUI elements are settings of the lt oXygen gt 136 Author Developer Guide Author The other settings like the templates catalogs transformation scenarios are general settings and are enabled whenever the association is active no matter the editing mode Text
239. connection Connection connection DriverManager getConnection connectionURL pr Jjava sql Statement statement connection createStatement ResultSet resultSet statement executeQuery sql StringBuffer fragmentBuffer new StringBuffer fragmentBuffer append lt table xmlns http ww oxygenxml com sample documentation gt 175 Author Developer Guide Creates the table header fragmentBuffer append lt header gt ResultSetMetaData metaData resultSet getMetaData int columnCount metaData getColumnCount for int i 1 i lt columnCount i fragmentBuffer append lt td gt fragmentBuffer append xmlEscape metaData getColumnName 1 fragmentBuffer append lt td gt fragmentBuffer append lt header gt Creates the table content whil resultSet next fragmentBuffer append lt tr gt for int i 1 i lt columnCount 1 fragmentBuffer append lt td gt fragmentBuffer append xmlEscape resultSet getObject 1 fragmentBuffer append lt td gt fragmentBuffer append lt tr gt fragmentBuffer append lt table gt Cleanup resultSet close statement close connection close return fragmentBuffer toString The complete source code of this operation is found in the Example Files Listings the
240. contains the caret position Use ancestor section last insertPosition Select After Configuring the Toolbars Now that you have defined the two actions you can add them to the toolbar You can configure additional toolbars on which to add your custom actions The first thing to check is that the toolbar Author custom actions should be displayed when switching to the Author mode Right click in the application window upper part in the area that contains the toolbar buttons and check Author custom actions in the displayed menu if it is unchecked Open the Document Type edit dialog for the SDF framework and select on the Author tab Next click on the Toolbar label Figure 8 11 Configuring the Toolbar Schema Classpath Author Templates Catalogs Transformation Extensions css Actions Menu Contextual menu Toolbar Available actions Current actions Description Toolbars a Toolbar z Toolbar actions group s E Bold p A Toolbar separator orn T Italic Bold Emphasises text Inserts U Underline a A lint E ee and Y axes Initial page The panel is divided in two sections the left side contains a list of actions while the right one contains an action tree displaying the list of actions added in the toolbar The special entry called Separator allows you to visually separate the actions in the toolbar Select the Insert section ac
241. content fragments similar with the conref mechanism Keys are defined at map level which can be referenced using conkeyref The conkeyref attribute contains a key reference to another element and is processed to replace the referencing element with the referenced element The element containing the content key reference acts as a placeholder for the referenced element The identifier for the referenced element must be either absolute or resolvable in the context of the referencing element lt oXygen gt will display the key referred content of a DITA conkeyref if it can resolve it to a valid resource in the context of the current opened DITA Map A content key reference is inserted with the action Insert a DITA Content Key Reference available on the toolbar Author custom actions and on the menu DITA gt Insert 117 Predefined document types Figure 7 5 Insert Content Key Reference Dialog p Insert Content Key Reference Keys gathered from the currently opened DITA Map Key Href Navtitle i iris topics iris xml Iris Topic Care topics care xml Preparation topics care xml Spring concepts springFlowers xml Flowers concepts springFlowers xml K Conkeyref irisfiris para Conrefend Element name p To reference target elements at sub topic level just press the Sub topic button and choose the target According to the DITA 1 2 specification the conre fend attribute can be used to spe
242. content received sent from to a HTTP server The built in client of lt oXygen gt XML Author notifies the server when the connection is established that GZIP compression is supported The current WebDAV Connection details can be saved using the TH button and then used in the Data Source Explorer view Changing file permissions on a remote FTP server Some FTP servers allow the modification of file permissions on the file system for the files that they serve over the FTP protocol This feature of the protocol is accessible directly in the FTP file browser dialog by right clicking on a tree node and selecting the Change permissions menu item The usual Unix file permissions Read Write and Execute are granted or denied in this dialog for the owner of the file the group of the owner and the rest of the users The aggregate number of the current state of the permissions is updated in the Permissions text field when a permission is modified with one of the check boxes 24 Editing documents WebDAV over HTTPS If you want to access a WebDAV repository across an insecure network lt oXygen gt allows you to load and save the documents over the HTTPS protocol if the server understands this protocol so that any data exchange with the WebDAV server is encrypted When a WebDAV repository is first accessed over HTTPS the server hosting the repository will present a security certificate as part of the HTTPS protocol without any user interventi
243. content reference You should follow these steps for inserting an element with a content reference conref attribute that points to an element that is not in a reusable component file 1 Za Start one of the actions Insert a DITA Content Reference and Insert a DITA Content Key Reference In the dialog Insert Content Reference select the file with the referenced content in the URL field In the tree that presents the DITA elements of the specified file that have an id attribute you have to select the element or the interval of elements that you want to reference The conref field will be filled automatically with the id value of the selected element If you select an interval of elements the conrefend field will be filled with the id value of the element that ends the selected interval Press the OK button to insert in the current DITA file an element with the same name and with the same conref attribute value and optionally with the same conrefend attribute value as the element s selected in the dialog 106 Chapter 7 Predefined document types A document type is associated to an XML file according to its defined rules and it specifies many settings used to improve editing the category of XML files it applies for These settings include specifying a default grammar used for validation and content completion default scenarios used for transformation specifying directories with file templates specifying catalogs and a lot of settin
244. context a tooltip will be shown for a couple of seconds displaying the position of the caret relative to the current element context Here are the common situations that can be encountered 72 Authoring in the tagless editor The caret is positioned before the first block child of the current node Figure 5 10 Before first block To apply the stylesheet you Mac OS X gt Section 2 C e The caret is positioned between two block elements Figure 5 11 Between two block elements Configure transf lt paral _ Press Ok4 para To apply the style Mac OS X e The caret is positioned after the last block element child of the current node Figure 5 12 After last block To apply the stylesheet you SR OS X Section 2 C e The caret is positioned inside a node Figure 5 13 Inside a node Configure transformation scenario 4 button or Press POk4 To apply the stylesheet you have to press the e The caret is positioned inside an element before an inline child element Figure 5 14 Before an inline element 3 nario For this press HC on plect the scenario tton or to press CTRL SHIFT T META S e The caret is positioned between two inline elements Figure 5 15 Between two inline elements ion scenario For this press the Co io abi Pre SHIFT TIMETA SHIFT T 73 Authoring in the tagless editor e The caret is positioned inside
245. css extensions api link Attr A public boolean startElement String uri String localName String name Attr atts boolean elementFound false for int i 0 i lt atts length i if link equals atts i getValue if xml id equals atts i getQName xml id attribute elementFound true else check if attribute has ID type String attrLocalName ExtensionUtil getLocalName atts i getQName String attrUri atts i getNamespace if idVerifier hasIDType localName uri attrLocalName attrUri elementFound true return elementFound 268 Chapter 9 Grid Editor Introduction In the grid editor the XML document is displayed as a structured grid of nested tables in which the text content can be modified by non technical users without editing directly the XML tags The tables can be expanded and collapsed with a mouse click to show or hide the elements of the document as needed Also the document structure can be changed easily with drag and drop operations on the grid components The tables can be zoomed using Ctrl Ctrl Ctrl 0 or Ctrl mouse wheel Figure 9 1 The Grid Editor version 1 0 encoding UTF 8 ersonnel lt m gt You can switch between the text tab and the grid tab of the editor panel with the two buttons Text and Grid available at the bottom of the editor panel Tf the edited document is associated with a
246. css extensions api node AuthorElement public class TableCellSpanProvider implements AuthorTableCellSpanProvider 204 Author Developer Guide The method init is taking as argument the AuthorElement that represents the XML table element In our case the cell span is specified for each of the cells so you leave this method empty However there are cases like the table CALS model when the cell spanning is specified in the table element In such cases you must collect the span in formation by analyzing the table element public void init AuthorElement table The method get ColSpan is taking as argument the table cell The table layout engine will ask this AuthorTa bleSpanSupport implementation what is the column span and the row span for each XML element from the table that was marked as cell in the CSS using the property display table cel1 The implementation is simple and just parses the value of column_span attribute The method must return nul 1 for all the cells that do not change the span specification public Integer getColSpan AuthorElement cell Integer colSpan null AttrValue attrValue cell getAttribute column_span if attrValue null The attribute was found String cs attrValue getValue if cs null try colSpan new Integer cs catch NumberFormatException ex The attribute value was not a number return colSpan The row span is determined in a
247. cstr Add the Browse button cstr gridx 2 cstr weightx 0 JButton browseButton new JButton Browse browseButton addActionListener new ActionListener pk Shows a file chooser dialog EA public void actionPerformed ActionEvent e JFileChooser fileChooser new JFileChooser fileChooser setMultiSelectionEnabled false Accepts only the image files fileChooser setFileFilter new FileFilter public String getDescription return Image files public boolean accept File f String fileName f getName return f isFile amp amp fileName endsWith jpeg fileName endsWith jpg fileName endsWith gif fileName endsWith png fileName endsWith svg 236 Author Developer Guide if fileChooser showOpenDialog dlg JFileChooser APPROVE_OPTION Fil fil fileChooser getSelectedFile try Set the file into the text field urlField setText file toURL toString catch MalformedURLException ex This should not happen ex printStackTrace mainContent add browseButton cstr Add the Ok button to the layout cstr gridx 0 cstr gridy 1 cstr weightx 0 JButton okButton new JButton Ok okButton addActionListener new ActionListener public void actionPerformed ActionEvent e dlg setVisible false mainC
248. ctory YourFileName pdf_ or the path and output file name C FileDirectory YourFileName pdf Optionally uncheck the XHTML and XML check boxes in the Show As group Click Transform Now The transformation is started PS Output l 2 Change directory to oxygen frameworks docbook xsl fo Select docbook xs1 click Open The dialog closes Select the FOP tab Check the Perform FOP option The remaining options are enabled Select the following options a XSLT result as input b PS as method c Built in Apache FOP as processor Select the Output tab In the Save As field enter the output file name relative to the current directory YourFileName ps or the path and output file name C FileDirectory YourFileName ps Optionally uncheck the XHTML and XML check boxes in the Show As group Click Transform Now The transformation is started 295 Transforming documents TXT Output l 2 8 9 Change directory to oxygen frameworks docbook xsl fo Select docbook xs1 click Open The dialog closes Select the FOP tab Check the Perform FOP option The remaining options are enabled Select the following options a XSLT result as input b TXT as method c Built in Apache FOP as processor Select the Output tab In the Save As field enter the output file name relative to the current directory YourFileName txt or the path and output file name C FileDirectory YourFileName
249. ctory oXygen install dir sqc If it is installed in a different directory the predefined executable path and working directory must be corrected in Preferences It is associated to XSD Editor Linked output messages of an external engine Validation engines display messages in an output view at the bottom of the lt oXygen gt window If such an output message warning error fatal error etc spans between three to five lines of text and has the following format then the message is linked to a location in the validated document so that a click on the message in the output view highlights 41 Editing documents the location of the message in an editor panel containing the file referred in the message This behavior is similar to the linked messages generated by the default built in validator The format for linked messages is e Type FIEIW the string Type followed by a letter for the type of the message fatal error error warning this line is optional in a linked message e SystemID a system ID of a file the string SystemID followed by the system ID of the file that will be opened for highlighting when the message is clicked in the output message usually the validated file the schema file or an included file e Line a line number the string Line followed by the number of the line that will be highlighted e Column a column number the string Column followed by the number of the column where the highlight wil
250. d false break xpointerldx stackIdx catch NumberFormatException e logger warn e e return linkLocated IDElementLocator java package ro sync ecss extensions commons import ro sync ecss extensions api link Attr import ro sync ecss extensions apl link Elementlocator link ExtensionUtil import ro sync ecss extensions apl import ro sync ecss extensions api link IDTypeVerifier Implementation of an ElementLocator that treats the link as the value of an bi attribute with the type ID a public class IDElementLocator extends ElementLocator pk Class able to tell if a given attribute is of type ID 5 private IDTypeVerifier idVerifi r 267 Author Developer Guide Constructor Qparam idVerifier It tells us if an attribute is of type ID param link The link used to identify an element ey public IDElementlocator IDTypeVerifier idVerifier String link super link this idVerifier idVerifier pk see ro sync ecss extensions api link ElementLocator endElement X java lang String java lang String java lang String A public void endElement String uri String localName String name Nothing to do see ro sync ecss extensions api link ElementLocator startElement x java lang String java lang String java lang String ro sync e
251. d Microsoft s HTML Help Workshop and install it Apply the HTML Help compiler called hhc exe on the html hhp and hhc files in the base dir directory Java Help Output l 2 Change directory to oxygen frameworks docbook xsl javahelp Select javahelp xs1 click Open The dialog closes Set the XSLT parameter base dir it identifies the output directory If not specified the output directory is system dependent Select the FOP tab Uncheck the Perform FOP option The FOP options are disabled Click Transform Now The transformation is started XHTML Output l 2 7 Change directory to oxygen frameworks docbook xsl xhtml Select docbook xs1 click Open The dialog closes Select the FOP tab Uncheck the Perform FOP option The FOP options are disabled Select the Output tab In the Save As field enter the output file name relative to the current directory YourFileName 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 Click Transform Now The transformation is started Supported XSLT processors The lt oXygen gt distribution comes with the following XSLT processors 297 Transforming documents Xalan 2 7 1 Saxon 6 5 5 Xalan Java http xml apache org xalan j is an XSLT
252. d property For setting E background the individual background properties i e background color b d attachment iii iii background image background repeat background attachment E background image and background position at the same place in the style sheet The background property first sets all the individual y F E background position background properties to their initial values then assigns hi Ebackground repeat E border M explicit values given in the declaration background color white margin left 100px text align center The properties and the values offered as proposals are dependent on the CSS Profile selected in the Options Pref erences CSS Validator page Profile combo box The CSS 2 1 set of properties and property values is used for most of the profiles excepting CSS 1 and CSS 3 for which specific proposal sets are used CSS Outline View The CSS Outline View presents the import declarations of other stylesheet files and all the selectors defined in the current CSS document The selector entries can be presented in the order they appear in the document or sorted by element name used in the selector or the entire selector string representation The selection in the outline view can be synchronized with the caret moves or the changes made in the stylesheet document When selecting an entry from the outline view the corresponding import or selector will be highlighted in the CSS
253. dants Refresh Performs a refresh of the selected node s subtree ey Properties Displays the list of properties of the selected cabinet folder Actions available on resources 3 Edit Checks out if not already checked out and opens the selected object in the editor e Edit with Checks out if not already checked out and opens the selected object in the specified editor tool e Open Read only Opens the selected object in the editor for viewing e Open with Opens the selected object in the specified editor tool for viewing 336 Content Management System CMS Integration e Check Out Checks out the selected object from the repository The action is not available if the object is already checked out e Check In Checks in the selected object commits changes into the repository The action is only available if the object is checked out Figure 14 2 Check In Dialog Check In Check In Flowers ditamap Name flowers ditamap Version 1 0 CURRENT Type dm_document Format ditamap Name flowers ditamap 1 0 same version Version 2 1 1 minor version 2 0 major version Version label Description C Keep locks Make this the current version Cancel Name Version Version label Description Keep Locks Make this the current version The name the file will have on the repository Allows you to choose what version the object will have after being
254. deAtInsertionOffset SECTION Check if the fragment is allowed as it is boolean canInsertFragments authorSchemaManager canInsertDocumentFragments fragmentsTolnsert offset AuthorSchemaManager VALIDATION_MODE_STRICT_FIRST_CHILD_LAX_OTHERS if canInsertFragments Insertion in section element handleEvent handleInvalidInsertionEventInSect offset fragmentsTolnsert authorAccess authorSchemaManager catch BadLocationException e 248 Author Developer Guide throw new InvalidEditException e getMessage Invalid typing event e getMessage e false catch AuthorOperationException e throw new InvalidEditException e getMessage Invalid typing event e getMessage e false return handleEvent return lt code gt true lt code gt if the given node is an element with the given local name and from the SDF namespace ay protected boolean isElementWithNameAndNamespace AuthorNode node String elementLocalName boolean result false if node getType AuthorNode NODE_TYPE_ELEMENT AuthorElement element AuthorElement node result elementLocalName equals element getLocalName amp amp element getNamespace equals SDF_NAMESPACE return result pk Try to handle invalid insertion events in a SDF table A
255. default selected engine just select other engine from the drop down list of the combo box For XQuery XSLT files only if no validation scenario is associated the transformer engine will be used in validation process if has validation support Opens the dialog for configuring the XSLT parameters In this dialog you set any global XSLT parameters of the main stylesheet set in the XSL URL field or of the additional stylesheets set with the button Additional XSLT stylesheets Opens a dialog for specifying a URL for a header HTML file added at the begin ning of the result of an HTML transformation and a URL for a footer HTML file added at the end of the HTML result of the transformation Opens the dialog for adding XSLT stylesheets which are applied on the result of the main stylesheet specified in the XSL URL field This is useful when a chain of XSLT stylesheets must be applied to the input XML document Opens the dialog for configuring the XSLT XQuery extension jars or classes which define extension Java functions or extension XSLT elements used in the XSLT XQuery transformation Configure advanced options specific for the Saxon HE PE EE engine They are the same options as the ones set in the user preferences but they are con figured as a specific set of transformation options for each transformation scenario By default if you do not set a specific value in the transformation scenario each advanced option has the same value as the global
256. ding the start tag and end tag Ifitis applied repeatedly starts with selecting the XML element from the cursor position and extends the selection to the ancestor XML elements Each execution of the action extends the current selection to the sur rounding element e contextual menu of current editor Select Attributes Selects all the attributes of the current element e contextual menu of current editor Select gt Parent Selects the parent element of the current element e Double click on an element or processing instruction If the double click is done before the start tag of an element or after the end tag of an element then all the element is selected by the double click action If it is done after the start tag or before the end tag then only the element content without the start tag and end tag is selected e Double click after the opening quote or before the closing quote of an attribute value select the whole attribute value 57 Editing documents Source actions contextual menu of current editor Source Escape Selection 78 Escapes a range of characters by replacing them with the corresponding character entities contextual menu of current editor Source Unescape Selection amp Replaces the character entities with the cor responding characters contextual menu of current editor Source Indent selection Ctrl I Cmd I on Mac OS Corrects the indent ation of the selected block of lines contextu
257. dita css Specific actions for DITA Map documents are e 4 Insert Topic Reference inserts a reference to a topic You can find more information about this action here wm e LA R ais f Cl Insert Content Reference inserts a content reference at the caret position See more about this action here 116 Insert Content Key Reference inserts a content reference at the caret position See more about this action here 117 El Insert Topic Heading inserts a topic heading You can find more information about this action here El Insert Topic Group inserts a topic group You can find more information about this action here Insert Table opens a dialog that allows you to configure the relationship table to be inserted The dialog allows the user to configure the number of rows and columns of the relationship table if the header will be generated and if the title will be added Insert Row inserts a new table row with empty cells The action is available when the caret position is inside a table Insert Column inserts a new table column with empty cells after the current column The action is available when the caret position is inside a table Delete Column deletes the table column where the caret is located E El Delete Row deletes the table row where the caret is located All actions described above are available in the contextual menu main menu DITA submenu and in the Author custom actions t
258. ditor Tem plates Document Templates 375 Configuring the application Figure 17 25 Document Templates preferences panel Document Templates Additional templates directories si m ES Figure 17 26 Document Templates input dialog Choose templates directory Directory Spell Check The Spell Check preferences panel is opened from menu Window Preferences gt Author Editor Spell Check 376 Configuring the application Figure 17 27 Spell check preferences panel Vv EA Automatic Spell Check Spell checking engine Default language Delete learned words Obey lang and xml lang attrib utes When checked the spell checker is activated Spell errors will be highlighted as you type The engines available are Hunspell and AZ Check Each engine has a specific format of spelling dictionaries The languages of the built in dictionaries of the selected engine are listed in the Default language combo box The default language combo allows you to choose the language used by default If the language of your documents is not listed in this combo box you can add a spelling dictionary for your language which will be added to this list Press this button to reset the list of words that were added to the known words using the Learn feature If selected the contents of any element with such an attribute will be checked using a dictionary for the language specified in the attribute
259. ditor panel context menu Source URL Specifies the location of the document for which to verify the signature If the signature is valid a dialog displaying the name of the signer will be opened If not an error message will show details about the problem 343 Chapter 16 Text editor specific actions lt oXygen gt XML Author provides user actions common in any text editor Finding and replacing text in the current file The Find All Elements Attributes dialog This dialog is dialog opened with the menu entry Edit gt Find All Elements and assists you in defining search for XML elements and or attributes operations on the current document Figure 16 1 Find All Elements Attributes dialog Find All Elements Attributes Element name chapter Element text contains y Attribute name os Attribute value contains Y author Case sensitive Leave field empty to specify any As a result the dialog can perform the following e Find all the elements with a specified name e Find all the elements which contain or not a specified string in their text e Find all the elements which have a specified attribute e Find all the elements which have an attribute with or without a specified value All these search criteria can be combined to fine filter your results The results of all the operations in the Find All Elements Attributes dialog will be presented as a list in the Message Panel The dialog fie
260. e Increase current element document depth startElementDepth if endElementDepth startElementDepth The current element is the first child of the parent currentElementIndexStack push new Integer 1 else Another element in the parent element currentElementIndexStack push new Integer lastIndexInParent 1 if startWithElementID This the case when xpointer path starts with an element ID String xpointerElement xpointerPath 0 for int i 0 i lt atts length i if xpointerElement equals atts i getValue if idVerifier hasIDType localName uri atts i getQName atts i getNamespace xpointerPathDepth startElementDepth xpointerPath length 1 266 Author Developer Guide if xpointerPathDepth startElementDepth check if xpointer path matches with the current element path linkLocated true try int xpointerldx xpoi n S ai lem terPath length 1 int stackIdx current ntIndexStack size 1 int stopldx startWithElementID 1 0 while xpointerldx gt stopldx amp amp stackIdx gt 0 int xpointerlndex Integer parselnt xpointerPath xpointerldx int currentElementIndex Integer currentElementIndexStack get SstackIdx intValue ntElementIndex if xpointerIndex curr linkLocate
261. e e DocBook4 gt DocBook5 Conversion converts a DocBook4 compliant document to DocBookS DocBook HTML transforms a DocBook document into a HTML document e DocBook PDF transforms a DocBook document into a PDF document using the Apache FOP engine 111 Predefined document types e DocBook HTML chunk transforms a DocBook document in multiple HTML documents The DocBook V5 document type Customization for DocBook V 5 is similar with that for DocBook V 4 with the following exceptions Association rules A file is considered to be a DocBook V 5 document when the namespace is http docbook org ns docbook Schema DocBook v5 documents use a RelaxNG and Schematron schema located in frameworks docbook 5 O0 rng doc bookxi rng where frameworks is a subdirectory of the lt oXygen gt install directory Author extensions DocBook 5 extensions contain all DocBook 4 extensions plus support for HTML table Templates Default templates are available for DocBook 5 They are stored in frameworksDir docbook templates Docbook 5 folder and they can be used for easily creating a book or article with or without XInclude These templates are available when creating new documents from templates Docbook 5 Article New Docbook 5 Article Docbook 5 Article with XInclude New Docbook 5 XInclude aware Article Docbook 5 Book New Docbook 5 Book Docbook 5 Book with XInclude New Docbook 5 XInclude aware Book Catalogs
262. e port xsd and send it to the content authors Advanced Customization Tutorial Document Type Associations lt oXygen gt Author is highly customizable Practically you can associate an entire class of documents grouped logically by some common features like namespace root element name or filename to a bundle consisting of a CSS stylesheets validation schemas catalog files templates for new files transformation scenarios and even custom actions This is called a Document Type Association Creating the Basic Association In this section a Document Type Association will be created for a set of documents As an example a light document ation framework will be created similar to DocBook and create a complete customization of the Author editor You can find the complete files that were used in this tutorial in the Example Files Listings First step XML Schema Our documentation framework will be very simple The documents will be either articles orbooks both composed Of sections The sections may contain titles paragraphs figures tables and other sections To complete the picture each section will include a def element from another namespace The first schema file lt xml version 1 0 encoding UTF 8 gt lt xs schema xmlns xs http www w3 org 2001 XMLSchema targetNamespace http www oxygenxml com sample documentation xmlns doc http www oxygenxml com sample documentation xmlns abs http www oxygenxml com sa
263. e Arialuni style normal weight bold gt lt font gt lt font metrics url Arialuni Italic xml kerning yes mbed url file Library Fonts Arialuni Italic ttf gt lt font triplet name Arialuni style italic weight normal gt lt font gt lt fonts gt lt fop gt More details about the FOP configuration file are available on http xmlgraphics apache org fop 0 93 configura tion htmlthe FOP website Set FOP configuration file in Oxygen Go to menu Options Preferences gt XML XSLT FO XQuery FO Processors Click the browse button near Configuration file for the built in FOP text field and locate the fopConfigura tion xml file 292 Transforming documents Click on the OK button to accept the changes Add new font to FO output You can do this by changing the stylesheet parameters DocBook Stylesheets Create a transformation scenario that makes use of the docbook xsl file from the oXygen install dir frameworks docbook xsl fo directory You must do this in the Configure Transformation Scenario dialog Also you can use the predefined Docbook PDF scenario which is based on this Docbook stylesheet Run a test trans formation to make sure the PDF is generated The Unicode characters are not yet displayed correctly You have to specify to the stylesheet to generate FO output that uses the font Arialuni Click on the Parameters button in the transformation scenario edi
264. e Author mode developers and content authors A developer is a technical person with advanced XML knowledge who defines the framework for authoring XML documents in the tagless editor Once the framework is created or edited by the developer it is distributed as a deliverable component ready to plug into the application to the content authors A content author does not need to have advanced knowledge about XML tags or operations like validation of XML documents or applying an XPath expression to an XML document He just plugs the framework set up by the developer into the application and starts editing the content of XML documents without editing the XML tags directly The framework set up by the developer is called document type and defines a type of XML documents by specifying all the details needed for editing the content of XML documents in tagless mode the CSS stylesheet which drives the tagless visual rendering of the document the rules for associating an XML schema with the document which is needed for content completion and validation of the document transformation scenarios for the document XML catalogs custom actions available as buttons on the toolbar of the tagless editor The tagless editor comes with some ready to use predefined document types for XML frameworks largely used today like DocBook DITA TEL XHTML General Author Presentation A content author edits the content of XML documents in tagless mode disregarding the XML tags as
265. e Example Files Listings the Java Files section There you will also find the implementations for XPointerElementLocator and IDElementLocator 195 Author Developer Guide Configuring a custom Drag and Drop listener You can add your own drag and drop listener implementation of ro sync ecss extensions api DnDHandler You can choose from three interfaces to implement depending on whether you are using the framework with the lt oXygen gt Eclipse plugin or the standalone version or if you want to add the handler for the Text or Author pages Table 8 2 Interfaces for the DnD listener Interface Description co sync exml editor xmleditor pageau Receives callbacks from the lt oXygen gt standalone application thor AuthorCustomDnDHandler for Drag And Drop in Author com oxygenxml editor editors au Receives callbacks from the lt oXygen gt Eclipse plugin for thor AuthorDnDListener Drag And Drop in Author com oxygenxml editor editors TextDnD Receives callbacks from the lt oXygen gt Eclipse plugin for Listener Drag And Drop in Text Configuring a References Resolver You need to provide a handler for resolving references and obtain the content they refer In our case the element which has references is ref and the attribute indicating the referred resource is location You will have to implement a Java extension class for obtaining the referred resources Create the class simple documentation framework Refe
266. e FOP the user can use other external processors lt oXygen gt has implemented an easy way to add two of the most used commercial FO processors You can easily add RenderX XEP as external FO processor if the user has the XEP installed Also if you have the Antenna House v4 or v5 FO processors Oxygen will use the environmental variables set by the installation to detect and use it for transformations If the environmental variables are not set for the Antenna House installation you can browse and choose the executable just as you would for XEP The FO Processors preferences panel is opened from menu Window Preferences Au thor XML XSLT FO XQuery FO Processors Figure 17 45 The FO Processors preferences panel FO Processors A v Apache FOP Memory available to the built in FOP MB 250 v Enable output to the built in FOP Configuration file 8 dl or C Generates PDF A 1b output External FO processors Name Description TF you have a custom XEP installation you can add it directly eS Tf you have Antenna House installed you can add it directly Enable the output of the built in FOP When checked all FOP output will be displayed in a results pane at the bottom of the editor window including warning messages about FO instructions not supported by FOP Memory available to the built in FOP If your FOP transformations fail with an Out of Memory error select from this combo box a larger value for the
267. e XML databases SQL execution XQuery execution and data export to XML This perspective offers database specific support for e Sleepycat Berkeley DB XML Database e eXist XML Database e IBM DB2 Enterprise edition only 13 Getting started e JDBC ODEC Bridge Enterprise edition only e MarkLogic Enterprise edition only XQuery support only Microsoft SQL Server 2005 and Microsoft SQL Server 2008 Enterprise edition only e MySQL Enterprise edition only Oracle 11g Enterprise edition only PostgreSQL 8 3 Enterprise edition only Software AG Tamino Enterprise edition only TigerLogic Enterprise edition only XQuery support only e Documentum xDb X Hive DB XML Database Enterprise edition only e Documentum CMS 6 5 Enterprise edition only The XML capabilities of the databases marked in this list with Enterprise edition only are available only in the En terprise edition of lt oXygen gt The non XML capabilities of any database listed here are available also in the Academic and Professional editions of lt oXygen gt by registering the database driver as a generic JDBC driver the Generic JDBC type in the list of driver types when defining the data source for accessing the database in lt oXygen gt The non XML capabilities are browsing the structure of the database instance opening a table in the Zable Explorer view handling the values from columns of type XML Type as String values The XML capabiliti
268. e are treated as part of the element name without taking into account its binding to a namespace 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 elements from this list will be treated as mixed when applying the Pretty Print operation meaning that the operation will break the line only when whitespaces are encountered When checked the Format and Indent operation will take into account the schema information regarding the space preserve mixed or element only property of an element If checked automatic tags indentation while editing will take place for all ele ments including the ones that are excluded from Pretty Print default behaviour When unchecked indentation while editing will not take place in elements that have the xml space attribute set on preserve or are in the list of Preserve Space Elements Indent paste text corresponding to the indent settings set by the user This is useful for keeping the indent style of text copied from other document Preserve space elements Default space elements Mixed content elements and Schema aware format and indent work together No matter which one indicates a more restrictive property that property will be applied if one of them indicates that an element is space preserve then it will be treated accordingly 366 Configuring the application S
269. e at connection level e Configure Database Sources opens the Data Sources preferences page where you can configure both data sources and connections e Add container allows you to create a new folder Add Resource allows you to add a new file on the server 331 Working with Databases e Add Container allows you to create a new folder on the server Refresh performs a refresh of the connection Actions available at folder level e Add container allows you to create a new folder 2 Add Resource allows you to add a new file on the server in the current folder e Rename allows you to change the name of the selected folder e Move allows you to move the selected folder in a different location in the tree also available through drag and drop X Delete removes the selected folder Refresh performs a refresh of the selected node s subtree Actions available at file level L Open allows you to open the selected file in the editor e Unlock remove the lock from the current file in the database e Rename allows you to change the name of the selected file e Move allows you to move the selected file in a different location in the tree also available through drag and drop X Delete removes the selected file e Copy location allows you to copy to clipboard an application specific URL for the resource which can then be used for various actions like opening or transforming
270. e configured from the dialog for configuring the XSLT extension for the particular scenario 388 Configuring the application Collection URI Resolver class name Allows the user to specify a custom implementation for the Collection URI resolver used by the XSLT Saxon 9 transformer cr option when run from the command line The class name must be fully specified and the corresponding jar or class extension must be configured from the dialog for config uring the XSLT extension for the particular scenario XSLTProc The XSLTProc preferences panel is opened from menu Window gt Preferences Au thor XML XSLT FO XQuery XSLT XSLTProc Figure 17 42 The XSLTProc preferences panel XSLTProc eo Enable XInclude processing C Skip loading the document s DTD C Do not apply default attributes from document s DTD Do not use Internet to Fetch DTD s entities or docs Maximum depth in templates stack 500 C verbosity C Show version of libxml and libxslt used C Show time information C Show debug information C Show all documents loaded during processing C Show profile information C Show the list of registered extensions Refuses to write to any file or resource C Refuses to create directories The options of the XSLTProc processor are the same as the ones available in the command line for the XSLTProc processor Enable XInclude processing If checked XInclude references will be resolved when XSLTPr
271. e file Sect ion20 gif is located in the directory images inside the jar archive you can refer to it by using images Section20 gif The jar file must be added into the Classpath list 161 Author Developer Guide Small icon 16x16 The path to the file that contains the menu image Insert frameworks sdf Section16 gif Shortcut key A shortcut key combination for triggering the action To define it click in the text field and press the desired key combination You can choose Ctrl Shift s Note The shortcut is enabled only by adding the action to the main menu of the Author mode which contains all the actions that the author will have in a menu for the current document type At this time the action has no functionality added to it Next you must define how this action operates An action can have multiple operation modes each of them activated by the evaluation of an XPath version 2 0 expression Note The XPath expression of an operation mode is evaluated relative to the current element The current element is the one where the caret is positioned In fact there is hierarchy of elements containing the caret position but you are considering only the closest one A simple expression like title is a relative one and checks if the current element has a title child element To check that the current element is a section you can use the expression local name section Note lt oXygen gt Author determines th
272. e fop cli Main fo S fo S method fout You need to add to the classpath JimiProClasses 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 http www apple com downloads ma cosx apple java3dandjavaadvancedimagingupdate html In order to use it install the downloaded package Other FO processors can be configured in the Preferences gt FO Processors panel Add a font to the built in FOP If an XML document is transformed to PDF using the built in Apache FOP processor but it contains some Unicode characters that cannot be rendered by the default PDF fonts then a font that is capable to render these characters must be configured and embedded in the PDF result Locate font First you have to find out the name of a font that has the glyphs for the special characters you used One font that covers the majority of characters including Japanese Cyrillic and Greek is Arial Unicode MS In the following is described how to embed the true type fonts in the output PDF Embedding the fonts is necessary to ensure your document is portable On Windows the fonts are located into the C Windows Fonts directory On Mac they are placed in Lib rary Fonts To install a new font on
273. e of transformation Procedure 4 6 To format and indent a document 1 Open or focus on the document that is to be formatted and indented 2 Select menu XML gt Format and Indent Ctrl Shift F Cmd Shift F on Mac OS or click the toolbar button Format and indent While in progress the Status Panel will indicate Pretty print in progress On completion this will change to Pretty print successful and the document will be arranged Note a Pretty Print can format empty elements as an auto closing markup tag ex lt a gt or as a regular tag ex lt a gt lt a gt It can preserve the order or attributes or order them alphabetically Also the user may specify a list of elements for which white spaces are preserved exactly as before Pretty print and one with elements for which white space is stripped These can be configured from Options gt Preferences Editor Format Pretty Print requires that the structured document is Well Formed XML If the document is not Well Formed XML an error message is displayed The message will usually indicate that a problem has been found in the form and will hint to the problem type It will not highlight the general position of the error to do this run the well formed action by se lecting Document gt Check document form Alt Shift V W Cmd Alt V W on Mac OS Note If the document is not well formed because some XML elements contain code in a specific language for example JavaScript lt
274. e operation to be executed by iterating through the defined operation modes The first operation whose XPath expression matched the current document context gets executed while the others are being ignored Make sure you order correctly your operations by placing the ones with more specific XPath selectors before the ones having more generic selectors For instance the expression person name Cris and age 24 is more specific than person name Cris The action mode using the first expression must be placed before the one using the second expression in the action modes list You decide that you can add sections only if the current element is either a book article or another section XPath expression Set the value to local name section or local name book or local name article 162 Author Developer Guide Invoke operation A set of built in operations is available A complete list is found in the Author Default Op erations section To this set you can add your own Java operation implementations In our case you will use the InsertFragmentOperation built in operation that inserts an XML fragment at the caret position Configure the arguments by setting the following values fragment lt section xmlns http www oxygenxml com sample documentation gt lt title gt lt section gt insertLocation Leave it empty This means the location will be the element at the caret position insertPosition Selec
275. e path e xslu the XSL XQuery input document as a URL e out the output document as a file path e outu the output document as a URL e ps the separator which can be used on different operating systems between libraries specified in the class path The Data Sources preferences panel is opened from menu Window Preferences Author Data Sources Configuration of Data Sources Here you can configure data sources and connections to relational databases as well as native XML databases You can check the list of drivers http www oxygenxml com database_drivers html available for the major database servers 398 Configuring the application Figure 17 50 The Data Sources preferences panel Data Sources Name JDEC ODEC Bridge MySQL ORACLE TAMINO DB2 SQLSERVER EXIST sil m Type kas JDBC JDBC Oracle Tamino DB2 SQLServer exist ad ill New Opens the Data Sources Drivers dialog allowing you to configure a new driver Figure 17 51 The Data Sources Drivers dialog Name MySQL Type Data Sources Drivers Generic JDBC Driver class org gjt mm mysql Driver Driver Files file E Drivers mysqlimysql jar a Name Type Help Driver Class Add Remove Detect Stop Allows you to name the new data source driver Select data source type from the supported driver types Open the User M
276. e returned in the Message Panel Clicking a record in the result list highlights the nodes within the text editor panel with a character level precision Results are returned in a format that is a valid XPath ex pression FileName xml node value node value node value 304 Querying documents Figure 11 2 XPath results highlighted in editor panel with character precision lt person id one worker gt lt name gt lt family gt Worker lt family gt lt given gt One lt given gt lt name gt lt email gt one oxygenxml com lt email gt lt link manager Big Boss gt lt person gt a lt person id two worker gt lt name lt given gt Two lt given gt lt name gt lt email gt twofoxygenxml com lt email gt lt link manager Big Boss gt lt person gt s m gt Text Grid Problems Javadoc Dedaration Console x XPath 3 o a yom y rd Y Boss e oo SO LE fami vit Worker panman me a smem personnel 1 person 5 name 1 family 1 Worker personnel 1 person 6 name 1 family 1 Worker When using the grid editor clicking a result record will highlight the entire node Figure 11 3 XPath results highlighted in the Grid Editor xmins xs http vAwww w3 org 2001 MLSchema xs element name type 8 rows 1 personnel 2 person amame 4 family xs string 5 given xs string 6 email xs string 7 url A 8 link p xsischema 1 xs
277. e row span The action is also available when the selection is missing but the caret is positioned between two cells A Join Cell Above joins the content of cell from current caret position with that of the cell above it Note that this action works only if both cells have the same column span A Join Cell Below joins the content of cell from current caret position with that of the cell below it Note that this action works only if both cells have the same column span m Split Cell To The Left splits the cell from current caret position in two inserting a new empty table cell to the left Note that this action works only if the current cell spans over more than one column The column span of the source cell will be decreased with one at Split Cell To The Right splits the cell from current caret position in two inserting a new empty table cell to the right Note that this action works only if the current cell spans over more than one column The column span of the source cell will be decreased with one La Split Cell Above splits the cell from current caret position in two inserting a new empty table cell above Note that this action works only if the current cell spans over more than one row The row span of the source cell will be decreased with one Split Cell Below splits the cell from current caret position in two inserting a new empty table cell below Note that this action works only if the current cell spans over mor
278. e search Tf it has mo matching end tag C Cursor position between tags Add element content Show all entities add optional content Insert the required attributes C Add First Choice particle Insert the fixed attributes Maximum number of recent items shown 6 Learn options Activation Activation delay 0 Auto close the last opened tag Automatically rename matching tag Use Content Completion Close the inserted element If it has no matching tag Add element content Add optional content Add first Choice particle Case sensitive search Learn attributes values Learn on open document Learn words Dynamic Abbreviations available on CTRL SPACE If the Use Content Completion option is not checked and if this option is checked lt oXygen gt will close the last opened tag when lt is typed If checked lt oXygen gt will automatically rename the matching end tag when the start tag is modified in the editor When unchecked all Content Completion features are disabled When inserting elements from the Content Completion assistant both start and end tags are inserted When checked the end tag of the inserted element will be automatically added only if it is not already present in the document When checked lt oXygen gt will insert automatically the required elements from the DTD or XML Schema or RELAX NG schema This option is applied also in the Author mode of the XML editor When checked
279. e style then the white spaces are preserved e If the text node contains other non white space characters then the white spaces are normalized e If the text node contains only white spaces e If the node has a parent element with the CSS display property set to inline then the white spaces are normalized e If the left or right sibling is an element with the CSS display property set to inline then the white spaces are normalized e If one of its ancestors is an element with the CSS display property set to table then the white spaces are striped e Otherwise the white spaces are ignored Save documents The Author editor will try to format and indent the document while following the white space handling rules e If text nodes are inside an element context where the xml space preserve is set then the white spaces are written without modifications e Ifthe CSS property white space is set to pre for the node style then the white spaces are written without any changes 81 Authoring in the tagless editor e In other cases the text nodes are wrapped Also when formatting and indenting an element that is not in a space preserve context additional Line Separators and white spaces are added as follows e Before a text node that starts with a white space e After a text node that ends with a white space e Before and after CSS block nodes e Ifthe current node has an ancestor that is a CSS table element Editing docum
280. e than one row The row span of the source cell will be decreased with one All actions described above are available in the contextual menu main menu XHTML submenu and in the Author custom actions toolbar Templates Default templates are available for XHTML They are stored in frameworksDir xhtml templates folder and they can be used for easily creating basic XHTML documents These templates are available when creating new documents from templates XHTML 1 0 Strict New Strict XHTML 1 0 XHTML 1 0 Transitional New Transitional XHTML 1 0 XHTML 1 1 DTD Based New DTD based XHTML 1 1 XHTML 1 1 DTD Based Math New XHTML 1 1 with MathML and SVG insertions ML 2 0 SVG 1 1 XHTML 1 1 Schema based New XHTML 1 1 XML Schema based Catalogs There are three default catalogs for XHTML document type frameworks xhtml dtd xhtmlcatalog xml frame works xhtml1 1 dtd xhtmicatalog xml and frameworks xhtml1 1 schema xhtmlcatalog xml 124 Predefined document types Transformation Scenarios The following default transformation scenarios are available for XHTML XHTML to DITA concept converts an XHTML document to a DITA concept document XHTML to DITA reference converts an XHTML document to a DITA reference document XHTML to DITA task converts an XHTML document to a DITA task document e XHTML to DITA topic converts an XHTML document to a DITA topic document The TEI P4 document type The Text Enc
281. e transferred as it is e the text dropped from another text editor or another application into the Author page will be inserted without changes The font size of the current WYSIWYG like editor can be increased and decreased on the fly with the same actions as in the Text editor Ctrl NumPad or Ctrl or Ctrl increase font size mouse wheel Ctrl NumPad or Ctrl or Ctrl mouse decrease font size wheel Ctrl NumPad0 or Ctrl 0 restore font size to the size specified in Preferences Removing the text content of the current element You can remove the text content of the current element and keep only the markup with the action TkRemove Text available on the submenu Refactoring of the contextual menu and on the toolbar XML Refactoring This is useful when the markup of an element must be preserved for example a table structure but the text content must be replaced 78 Authoring in the tagless editor Table layout and resizing The support for editing data in tabular form can manage table width and column width specifications from the source document The specified widths will be considered when rendering the tables and when visually resizing them using mouse drag gestures These specifications are supported both in fixed and proportional dimensions The predefined frameworks DITA DocBook and XHTML already implement support for this feature The layout of the tables from these types of documents takes into account the table width
282. eEv nt true return handleEvent AD ay rive the g iven context by adding the specified element protected void pushContextElement WhatElementsCanGoHereContext context Co co co ntextElemen ntextElemen t contextElement new Context t setQName elementName ntextElemen t setNamespace SDF_NAMESPACE String elementName Element context pushContextElement contextElement null 250 Author Developer Guide Try to handle invalid insertion events in section The solution is to insert the lt code gt fragmentsToInsert lt code gt into a title element if the sect element is empty or into a para element if the sect already contains a title param offset Offset where the insertion event occurred param fragmentsToInsert Fragments that must be inserted at the given offset param authorAccess Author access return lt code gt true lt code gt if the event was handled lt code gt false lt code gt otherwis private boolean handleInvalidiInsertionEventInSect int offset AuthorDocumentFragment fragmentsToInsert AuthorAccess authorAccess AuthorSchemaManager authorSchemaManager throws BadLocationException AuthorOperationException boolean handleEvent false Typing paste inside an section A A A A A A F F AuthorElement sectionElement AuthorElem
283. ecialization 103 DITA MAP document type 120 association rules 121 Author extension 121 catalogs 122 templates 122 transformation scenarios 122 schema 121 DITA Maps 85 advanced operations 91 edit properties 93 inserting a topic group 92 inserting a topic heading 92 inserting a topic reference 91 DITA OT customization support 101 customizing the lt oXygen gt Ant tool 102 increase the memory for Ant 102 resolve topic reference through an XML catalog 103 upgrade DITA OT 102 use your own custom build file 102 use your own DITA OT 102 DITA specialization editing DITA Map specialization 103 DITA transformation scenario 94 transforming DITA Maps 93 output formats 93 running an ANT transformation 101 DITA Topics document type 113 association rules 113 Author extensions 113 catalogs 120 templates 120 transformation scenarios 120 schema 113 DITA transformation scenario 94 customize scenario 95 DocBook Targetset document type 112 413 Index association rules 113 Author extensions 113 templates 113 schema 113 DocBook V4 document type 107 association rules 108 Author extensions 108 catalogs 111 templates 111 transformation scenarios 111 schema 108 DocBook V5 document type 112 association rules 112 Author extensions 112 catalogs 112 templates 112 transformation scenarios 112 schema 112 Documentum CMS Support 333 actions 334 cabinets folders 335 connection 33
284. ected and press the Demote toolbar button This topic reference and all the nested ones are moved as a unit inside the Autumn Flowers topic reference Close the map without saving Create a bookmap The procedure for creating a bookmap is similar with that for creating a map 1 Ze Go to menu File New or click on the L New toolbar button On the tab From templates of the New dialog select the DITA Map Bookmap template and click OK A new tab with the new bookmap is added in the DITA Maps Manager view Press the lel save button on the toolbar of the DITA Maps Manager view In the Save As dialog select a location and a file name for the map 87 Author for DITA Create relationships between topics The DITA map offers the possibility of grouping different types of links between topics in a relationship table instead of specifying the links of each topic in that topic 1 Open the DITA map file where you want to create the relationship table Use the action Y Open that is available on the toolbar of the DITA Maps Manager view Place the cursor at the location of the relationship table Run the action ES Insert a DITA reltable that is available on the Author toolbar on the menu DITA gt Table and on the Table submenu of the contextual menu of the DITA map editor In the Insert Relationship Table dialog that is displayed by this action you set some parameters of the relationship table that will be created t
285. ectionType gt lt xs element name article type doc sectionType gt lt xs element name section type doc sectionType gt lt xs complexType name sectionType gt lt xs sequence gt lt xs element name title type xs string gt lt xs element ref abs def minOccurs 0 gt lt xs choice gt lt xs sequence gt lt xs element ref doc section maxOccurs unbounded gt lt xs sequence gt lt xs choice maxOccurs unbounded gt m lt xs element ref doc para gt lt xs element ref doc ref gt lt xs element ref doc image gt lt xs element ref doc table gt lt xs choice gt lt xs choice gt lt xs sequence gt lt xs complexType gt 226 Author Developer Guide lt xs element name para type doc paragraphType gt lt xs complexType name paragraphType mixed true gt lt xs choice minOccurs 0 maxOccurs unbounded gt lt xs element name b gt lt xs element name i gt lt xs element name link gt lt xs choice gt lt xs complexType gt lt xs element name ref gt lt xs complexType gt lt xs attribute name location type xs anyURI use required gt lt xs complexType gt lt xs element gt lt xs element name image gt lt xs complexType gt lt xs attribute name href type xs anyURI use required gt lt xs complexType gt lt xs element gt lt xs element name table gt lt xs complexType gt lt xs sequence gt
286. ectively to author XML documents visually in a WYSIWYG like way quickly and easily The lt oXygen gt XML Author plugin for Eclipse is a cross platform application for authors who want to edit XML documents visually without extensive knowledge about XML and XML related technologies The WYSIWYG like editor is driven by CSS stylesheets associated with the XML documents and offers the option to switch off XML tags completely when editing an XML document Key Features and Benefits The offers the following key features and benefits Multiplatform availability Windows Mac OS X Linux Non blocking operations you can perform validation and Solaris transformation operations in background Visual WYSIWYG XML editing mode based on W3C Visual DITA Map editor CSS stylesheets Closely integration of the DITA Open Toolkit for gener Support for latest versions of document frameworks ating DITA output DocBook and TEI Chapter 2 Installation This section explains platform requirements and installation procedures It also provides instructions on how to obtain and register a license key how to perform upgrades and uninstall the application if required If you need help at any point during these procedures please send email to lt support oxygenxml com gt Installation Requirements Platform Requirements Minimum run time requirements are listed below e Pentium Class Platform e 256 MB of RAM e 300 MB free disk spa
287. ed as being element only Schema Aware Editing Editing in Author will take into account the schema On Enable all schema aware editing options Off Disable all schema aware editing options Custom Delete element tags with backspace Controls the behaviour for and delete deleting element tags using delete or backspace keys Available options Smart delete If the result of the delete action is inval 359 Configuring the application Paste and Drag and Drop id different strategies will be applied in order to keep the document valid If backspace delete is pressed at the begin ning end of an element the action that should take place is unwrap the ele ment will be deleted and its content will be put in its place If its content is not accepted by the schema in that position you can keep a valid docu ment by applying different strategies like e Search for a preced ing backspace case following delete case element in which you can append that content e Ifthe tag markers of the element to unwrap are not visible a caret move action in the delete ac tion direction will be performed e Reject action when its result is invalid If checked and the result of the delete action is invalid the action will not be per formed Controls the behaviour for paste and drag and drop ac tions Available options e Smart paste and drag and drop If the content inserted by a paste or drop action is not v
288. ed in the same output folder 2 Copy the content of frameworks dita DITA OT demo tocjs basefiles folder in the transform ation s output folder 3 Copy the frameworks dita DITA OT demo tocjs sample basefiles frameset html file in the transformation s output folder 4 Edit frameset html and locate element lt frame name contentwin src concepts about html gt Replace concepts about html with index html Configuring a DITA transformation Creating DITA Map transformation scenarios is similar to creating scenarios in the main editing area See here for more details about creating scenarios in the main editing area The Configure transformation scenario dialog is opened from the toolbar action 4 Configure Transformation Scenario of the DITA Map Manager Select as Scenario typeDITA OT transformation then press the New button Next step involves choosing the type of output the DITA OT ANT scenario will generate 94 Author for DITA Figure 6 5 Select DITA Transformation type DITA Transformation Type Select the type of transformation XHTML PDF DITA OT PDF2 Idiom FO Plugin HTML Help JavaHelp Eclipse Help Eclipse Content DocBook RTF troff Depending on the chosen type of output lt oXygen gt will generate values for the default ANT parameters so that you can execute the scenario right away without further customization D Tip If you want to transfo
289. ed on disk or in a CMS with the extension ditamap Maps can also contain relationship tables that establish relationships between the topics contained within the map Relationship tables are also used to generate links in your published document You can use your map or bookmap to generate a deliverable using an output type such as XHTML PDF HTML Help or Eclipse Help Editing DITA Maps lt oXygen gt provides a special view for editing DITA maps The DITA Maps Manager view presents a map in a sim plified table of contents manner allowing the user to easily navigate the referred topics and maps make changes and perform transformations to various output formats using the DITA OT framework bundled with lt oXygen gt 85 Author for DITA Figure 6 1 The DITA Maps Manager view PA DITA Maps Manager 3 CHO 4 BBL La Introduction q ES Care and Preparation fe Pruning ej Garden Preparation a ES Flowers by Season 3 Spring Flowers ES Tris ES Snowdrop Summer Flowers ES Gardenia E Lilac 1 Autumn Flowers ES Chrysanthemum ES Salvia i Winter Flowers ES Gerbera a Glossary E Copyright E Flowers ditamap You can open a map file from Project in the DITA Maps Manager view by right clicking it and choosing Open in DITA Maps Manager The titles of the referenced resources will be resolved dynamically when navigating the tree After the map is opened in the Manager you c
290. editor 61 Editing documents Figure 4 30 CSS Outline View Dz Outline 23 O e j 24 Element v A mport Folds css warning gt important gt tip gt caution gt note gt methodparam gt before methodsynopsis gt before destructorsynopsis gt before constructorsynopsis gt before fieldsynopsis gt before ooexception gt before oointerface gt before The selectors presented in the CSS Outline View can be quickly found using key search When you press a sequence of character keys while the focus is in the outline view the first selector that starts with that sequence will be selected Folding in CSS stylesheets In a large CSS stylesheet document some styles may be collapsed so that only the needed styles remain in focus The same folding features available for XML documents are also available in CSS stylesheets Formatting and indenting CSS stylesheets pretty print If the edited CSS stylesheet becomes unreadable because of the bad alignment of the text lines the pretty print operation available for XML documents is also available for CSS stylesheets It works in the same way as for XML documents and is available as the same menu and toolbar action Other CSS editing actions The CSS editor type offers a reduced version of the popup menu available in the XML editor type that means only the folding actions the edit actions and a part of the source actions only the ac
291. edure 1 Choose the menu option Help Software Update Manage Configuration and from the list of products select lt oXygen gt XML Author and XSLT Debugger Select Disable Accept the restart of the Eclipse IDE Again choose the menu option Help Software Update Manage Configuration and from the list of products select lt oXygen gt XML Author Enable Show Disabled Features from the dialog toolbar From the right section of the displayed window choose Uninstall After the uninstall procedure is complete accept the Eclipse restart If you wish to completely remove the application directory and any work saved in it you will have to delete this directory manually To remove the application configuration and any personal customizations delete the SAPP DATA com oxygenxml author directory on Windows usually 9 APPDATA has the value user home dir Application Data com oxygenxml author on Linux from the user home directory Chapter 3 Getting started Supported types of documents The lt oXygen gt XML Author provides a rich set of features for working with e XML documents and applications e CSS documents Getting help Online help is available at any time while working in lt oXygen gt XML Author by going to Help gt Help Contents gt oXygen User Manual for Eclipse Perspectives The interface uses standard interface conventions and components to provide a familiar and intuitive editing environment
292. een 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 XML Author installation packages including the Java Runtime Environment JRE DocBook DTD and stylesheets This product includes software developed by the Apache Software Foundation http www apache org http www apache org the Apache FOP Xerces XML Parser and Xalan XSLT This product includes software with copyright C 2002 2008 Yutaka Furubayashi Poka poka Dream Factory 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 Microsystems Users are advised that SyncRO Soft Ltd assumes no responsibility for errors or omissions or for damages resulting from the use of lt oXygen gt XML Author and the aforesaid third party software Nor does SyncRO Soft Ltd assume any responsibility for licensing of the aforesaid software should
293. eferences panel XProc gt XProc Engines Name Description Engine type calabash Default implementati Proc Calumet Calument engine XProc Show XProc messages When Show XProc messages is enabled all messages emitted by the XProc processor during a transformation will be presented in the results view For an external engine you must specify the name that will be displayed in the XProc transformation scenario and the command line that will start it Figure 17 36 Creating an XProc external engine IAS Engine type XProc iv Name calabash Description Default implementation of XProc Output Encoding Default encoding lv Error Encoding Default encoding lv Working directory D Projects exml lib calabash lr Command line java al 2 classpath d calabash libfcalabash jar d calabash lib saxon9 s9api jar d calabash lib saxon9sa jar d calabashflib common s httpclient 3 1 jarj d calabashjlib commons logging 1 1 1 jarj d calabash lib commons codec 1 3 jarjd calabashjlib wl 385 Configuring the application Also other parameters can be set a description the encodings for the output stream and the error stream of the engine the working directory of the command that will start the engine The encodings will be used for reading and displaying the output of the engine The working directory and the command line can use built
294. eft right center inherit justify none underline II overline II line through inher blink it text decoration text indent ALL text transform ALL top ALL unicode bidi ALL vertical align baseline sub super top text top middle bot lt percentage gt lt length gt tom text bottom inherit visibility visible hidden inherit collapse white space normal pre nowrap pre wrap pre line width lt length gt lt percentage gt auto inherit supported for block level and replaced elements e g images tables table cells word spacing ALL z index ALL lt oXygen gt CSS Extensions Media Type oxygen The style sheets can specify how a document is to be presented on different media on the screen on paper speech synthesiser etc You can specify that some of the features of your CSS stylesheet should be taken into account only in the lt oXygen gt Author and ignored in the rest This can be accomplished by using the media type oxygen For instance using the following CSS b font weight bold display inline media oxygen b text decoration underline would make a text bold if the document was opened in a web browser who does not recognize media oxygen and bold and underlined in lt oXygen gt Author You can use this media type to group specific lt oXygen
295. election New Opens a dialog in which you can type the name of a stylesheet The name is considered relative to the URL of the current edited XML document You can use editor variables 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 Additional XSLT stylesheets list Up Move the selected stylesheet up in the list Down Move the selected stylesheet down in the list The path specified in the URL text field can include special lt oXygen gt editor variables 287 Transforming documents XSLT XQuery Extensions The Edit Extensions dialog is used to specify the jars and classes containing extension functions called from the XSLT X Query file of the current transformation scenario An extension function called from the XSLT or XQuery file of the current transformation scenario will be searched in the specified extensions in the order of the list displayed in the dialog For changing the order of the items the user must select the item that must be moved to other position in the list and press the t up and down buttons Creating a Transformation Scenario Use the following procedure to create a scenario 1 Select XML gt Configure transformation scenario Alt Shift T C Cmd Alt T C on Mac OS to open the Configure Transformation dialog 2 Click the Duplicate Scenario button of the dialog to create a copy of the current
296. election of the element to be used as document root Public ID Specifies the PUBLIC identifier declared in the Prolog 19 Editing documents Figure 4 3 The Create an XML Document Relax NG Tab New XML Document cle Customize document XML schema DTD RNG RNC gt NRL NVDL URL file samples frameworks xhtml relaxngjxhtml rng x B E Cluse relative paths XML syntax O Compact syntax Root Element html x Namespace http www w3 org 1999 xhtml Prefix Description Complete the dialog as follows 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 document enables selection of the element to be used as document root Namespace Specifies the document namespace Prefix Specifies the prefix for the namespace of the document root Description Shows a small definition for the currently selected element 20 Editing documents Figure 4 4 The Create an XML Document NRL Tab New XML Document Custo
297. element has an optional mode attribute If this is present the template will only be matched when the same mode is used in the invoking lt i gt xsl apply templates lt i gt element lt td gt lt tr gt SEES lt td gt lt b gt for each lt b gt lt td gt lt td gt The xsl for each element causes iteration over the nodes selected by a node set expression lt td gt lt tr gt lt tr gt lt td column_span 2 gt End of the list lt td gt lt tr gt lt table gt lt section gt lt section gt lt title gt xPath lt title gt lt abs def gt XPath XML Path Language is a terse non XML syntax for addressing portions of an XML document lt abs def gt lt para gt Some of the XPath functions lt para gt lt table gt 231 Author Developer Guide lt header gt lt td gt Function lt td gt lt td gt Description lt td gt lt header gt SELLA lt td gt format number lt td gt lt td gt The lt i gt format number lt i gt function converts its first argument to a string using the format pattern string specified by the second argument and the decimal format named by the third argument or the default decimal format if there is no third argument lt td gt lt tr gt lt tr gt lt td gt current lt td gt lt td gt The lt i gt current lt i gt function returns a node set that has the current node as its only member lt td gt lt tr gt lt tr gt lt td gt generate id lt td gt
298. ema and within attribute values or at the beginning of attribute values in XML documents where lists of possible values have been defined for that element in the schema associated with the document The content of the Content Completion assistant is dependent on the element structure specified in the DTD XML Schema Relax NG full or compact syntax schema or NRL NVDL schema associated to the edited document The number and type of elements displayed by the assistant is dependent on the current position of the cursor in the structured document The child elements displayed within a given element are defined by the structure of the specified DTD XML Schema Relax NG full or compact syntax schema or NRL NVDL schema All elements that can t be child elements of the current element according to the specified schema are not displayed Inside Relax NG documents the Content Completion assistant is able to present element values if such values are specified in the Relax NG schema Also in Relax NG documents the Content Completion assistant presents additional values of type ID for an anyURI data type It presents also pattern names defined in the Relax NG schema as possible values for pattern references For example if the schema defines an enumValuesElem element lt element name enumValuesElem gt lt choice gt lt value gt valuel lt value gt lt value gt value2 lt value gt lt value gt value3 lt value gt lt choice gt lt element gt
299. ements attrib ute names and attribute values The background color of row headers that are not selected The background color of the row header that is currently selected and has the focus The background color of the row header that is currently selected and does not have the focus The background color of column headers that are not selected The background color of the column header that is currently selected and has the focus The background color of the column header that is currently selected and does not have the focus The column headers are painted with two color gradients one for the upper 1 3 part of the header and the other for the lower 2 3 part The start and end colors of the first gradient are set with the first two color buttons The start and end colors of the second gradient are set with the last two color buttons Author The Author preferences panel is opened from menu Window Preferences gt Author Editor Author 356 Configuring the application Figure 17 9 The lt oXygen gt Author preferences panel Show caret position tooltip Show placeholders for empty ele ments Show Author layout messages Show block range Hide comments Hide processing instructions Hide doctype HE eS If checked the position information tooltip will be displayed More information about the position information tooltip can be found in the section Position in formation tooltip The documentation tooltip can
300. en Line width Format and Indent 100 iv Performance C Clear undo buffer before Format and Indent Detect indent on open The editor tries to detect the indent settings of the opened XML document In this way you can correctly format pretty print files that were created with dif ferent settings without changing your options More than that you can activate the advanced option for detecting the maximum line width to be used for formatting and hard wrap These features were designed to minimize the differ ences created by the pretty print operation when working with a versioning system like CVS for example Indent with tabs When checked enables Indent with tabs to set the indent to a tab unit When unchecked Indent with tabs is disabled and the indent will measure as many spaces as needed in order to go to the next tab stop position The maximum number of space characters is 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 using the Indent With Tabs option If set to 4 one tab will equal 4 white spaces or 1 tab with size of 4 char acters depending on which option was set in the Indent With Tabs option Hard line wrap This feature saves time when writing a reach text XML document You can set a limit for the length of the lines in your document When this limit is exceeded the editor will i
301. en in lt oXygen gt and edit files directly from an archive When saving the archived file you will be prompted with some backup operations which can be performed to ensure that your archive data will not be corrupted You have the following backup before save options No backup Perform no backup of the archive before save This means that the file will be saved directly in the archive without any additional precautions 309 Working with Archives Single file backup Incremental backup Never ask me again Before any operation which modifies the archive is performed the archive contents will be duplicated The duplicate file name will be originalArchiveFileName bak and will be saved in the same directory Before each operation which modifies the archive is performed the archive contents will be duplicated The duplicate file names will be originalArchiveFile Name bak dupNo and the files will be saved in the same directory Check this if you do not want to be notified again to backup The last backup option you chose will always be used as the default one You can re enable the dialog pop up from the Archive preferences page 310 Chapter 13 Working with Databases XML is a storage and interchange format for structured data and it is supported by all major database systems lt oXygen gt offers the means of managing the interaction with some of the widely used databases both relational one
302. ences gt General gt Editors gt File Associations add ext to the list of file types select ext in the list by clicking on it add Oxygen XML Editor to the list of Associated editors and make it the default editor 2 Associate the ext extension with the Oxygen XML content type go to Windows gt Preferences gt General gt Content Types and for the Text gt XML gt oXygen XML content type add ext to the File associations list 3 Press the OK button of the Eclipse preferences dialog When a ext file is opened the icon of the editor and the syntax highlight should be the same as for XML files opened with the Oxygen XML Editor 411 Index Symbols lt oXygen gt CSS extensions lt oXygen gt CSS custom functions 223 attributes 226 base uri 224 capitalize 224 concat 224 local name 223 lowercase 224 name 223 parent url 224 replace 225 unparsed entity uri 225 uppercase 224 url 223 additional properties display tags 222 folding elements 220 link elements 221 supported features from CSS Level 3 additional custom selectors 218 attr function 216 namespace selectors 215 A Archives 308 browse 308 edit 309 file browser 308 modify 308 Author editor 64 Attributes view 68 Change Tracking 82 content author role 65 contextual menu 74 edit content 78 edit markup 76 editing XML 76 Elements view 68 Entities view 70 external ref
303. ensions api ArgumentDescriptor import ro sync ecss extensions api ArgumentsMap import ro sync ecss extensions api AuthorAccess import ro sync ecss extensions api AuthorOperation import ro sync ecss extensions api AuthorOperationException public class QueryDatabaseOperation implements AuthorOperation private static String ARG_JDBC_DRIVER jdbc_driver private static String ARG_USER user private static String ARG_PASSWORD password private static String ARG_SOL sql private static String ARG_CONNECTION connection return The array of arguments the developer must specify when configuring the action public ArgumentDescriptor getArguments ArgumentDescriptor args new ArgumentDescriptor new ArgumentDescriptor ARG_JDBC_DRIVER ArgumentDescriptor TYPE_STRING The name of the Java class that is the JDBC driver new ArgumentDescriptor ARG_CONNECTION ArgumentDescriptor TYPE_STRING 238 Author Developer Guide The database URL connection string new ArgumentDescriptor ARG_USER ArgumentDescriptor TYPE_STRING The name of the database user new ArgumentDescriptor ARG_PASSWORD e d e Q e ArgumentDescriptor TYPE_STRING The database password new ArgumentDescriptor ARG_SQL ArgumentDescriptor TYPE_STRING The SQL statement to be executed y return args return The operatio
304. ent authorAccess getDocumentController getNodeAtOffset offset if sectionElement getStartOffset 1 sectionElement getEndOffset Empty section element WhatElementsCanGoHereContext context authorSchemaManager createWhatElementsCanGoHereContext offset Derive the context by adding a title pushContextElement context TITLE Test if fragments can be inserted in title element if authorSchemaManager canInsertDocumentFragments fragmentsTolnsert context AuthorSchemaManager VALIDATION_MODE_STRICT_FIRST_CHILD_LAX_OTHERS Create a title structure and insert fragments inside StringBuilder xmlFragment new StringBuilder lt append TITLE if SDF_NAMESPACE null amp amp SDF_NAMESPACE length 0 xmlFragment append xmlns append SDF_NAMESPACE append xmlFragment append gt append lt append TITLE append gt Insert title authorAccess getDocumentController insertXMLFragment xmlFragment toString offset Insert fragments AuthorNode newParaNode authorAccess getDocumentController getNodeAtOffset offset 1 for int i 0 i lt fragmentsTolnsert length i authorAccess getDocumentController insertFragment newParaNode getEndOffset fragmentsTolnsert il handleEvent true else Check if th
305. ent the parameter dtdvalid ds must be added manually to the DTD validation command line ds represents the detected DTD declaration in the XML document Note Known problem file paths containing spaces are not handled correctly in the LIBXML processor For example the built in XML catalog files of the predefined document types DocBook TEI DITA etc are not handled by LIBXML if lt oXygen gt is installed in the default location on Windows C Program Files because the built in XML catalog files are stored in 40 Editing documents Saxon SA MSXML 4 0 MSXML NET XSV SQC Schema Quality Checker from IBM the frameworks subdirectory of the installation directory which in this case contains at least a space character Note On Mac OS X if the full path to the LIBXML executable file is not spe cified in the Executable path text field some errors may occur on validation against a W3C XML Schema like Unimplemented block at xmlschema c These errors can be avoided by specifying the full path to the LIBXML executable file included in lt oXygen gt It is associated to XML Editor and XSD Editor It is able to validate XML Schema schemas and XML documents against XML Schema schemas The validation is done according to the W3C XML Schema 1 0 specification or according to the W3C XML Schema 1 1 one This can be configured in Preferences included in lt oXygen gt Windows edition It is associa
306. ents You can insert space characters in any text nodes Line breaks are permitted only in space preserve elements Tabs are marked in the space preserve elements with a little marker Note CDATA sections comments processing instructions have by default the white space CSS property set to pre unless overridden in the CSS file you are using Also they are considered to be block nodes Minimize differences between versions saved on different computers The number of differences between versions of the same file saved by different content authors on different computers can be minimized by imposing the same set of formatting options when saving the file for all the content authors An example for a procedure that minimizes the differences is 1 Create an lt oXygen gt project file that will be shared by all content authors 2 Set your own preferences in the following panels of the Preferences dialog Editor Format and Editor Format XML 3 Save the preferences of these two panels in the lt oXygen gt project by selecting the button Project Options in these two panels 4 Save the project and commit the project file to your versioning system so all the content authors can use it 5 Make sure the project is opened in the Project view and open your XML files in the Author mode and save them 6 Commit the saved XML files to your versioning system When other content authors will change the files only the changed lines will be di
307. enu Create an index entry The index entries of are used for Editing actions Important References can be made either by using the href attribute or by using the new keyref attribute to point to a key defined in the map Oxygen tries to resolve both cases keyrefs are solved relative to the current map The following general actions can be performed on an opened DITA Map 88 Author for DITA 2 Open 2 Open URL H Save gt Apply Transformation Scenario 4 Configure Transformation Scen ario Refresh References 30Open map in editor 30Open map in editor with resolved topics i Tip Allows opening the DITA Map in the DITA Maps Manager view You can also open a DITA Map by dragging it in the DITA Maps Manager from the file system explorer Allows opening remote DITA Maps in the DITA Maps Manager view See Open URL for details Allows saving the currently opened DITA Map Allows the user to start the DITA ANT Transformation scenario associated with the opened map For more transformation details see here Allows the user to configure a DITA ANT Transformation scenario for the opened map For more transformation details see here Sometimes after a topic was edited and its title changed the topic s title needs to be also updated in the DITA Maps manager view You can use this action to refresh and update titles for all referred topics For complex operations which cannot be performed in the sim
308. eported errors with this setting to keep the time for error marking short Clear validation markers on close When a document edited with the lt oXygen gt plugin is closed all the error markers added in the Problems view for the validation errors obtained for that document are removed Custom Validation The Custom Validation preferences panel is opened from menu Window Preferences gt Author Editor Custom Validation Figure 17 29 Custom Validation preferences panel Custom Validation Name Associated editors TA RN REE EE SaxonsA XML Editor XSD Editor MSXML NET XML Editor XSD Editor XSL Editor xSV XML Editor XSD Editor SQC X5D Editor MSXML4 0 XML Editor XSD Editor XSL Editor Intel XML Software Suite XML Editor XSD Editor If you want to add a new custom validation tool or edit the properties of an exiting one you can use the Custom Valid ator dialog displayed by pressing New or Edit buttons 379 Configuring the application Figure 17 30 Custom validator dialog 3 Custom validator Name LIBXML Executable path oxygenInstallDir xmllint 3 Working directory Associated editors XML Editor je 2 2 Other noout cf Command line arguments for detected schemas XSD noout catalogs xinclude schema ds cf E RNG noout catalogs xinclude relaxng ds cf RNC EJ NRL Ej NVDL SCH E O DID noout catalogs xinc
309. epository Level ooooooccoccnnccnnconnccnnccnncnnnconaconncos 318 Microsoft SQL Server s XML Schema Repository Level oooocconccnccnnccnnccnnccnno 319 Table Explorer VieWo id a a od 319 Native XML Database NXD Support prenera yene a o e aE ES EEE EEES E ESR E AN 321 Configuring Database Data Sources ooocooccnccnnccnnconnccnnccnnconnconncnnncnnnrnnronnrnnncnnconnccnnccnncnnncnnncos 321 How to configure a Berkeley DB XML datasource oocoooccoccncccnncnnccnnccnnconnccnncconcnnnconncinncos 321 How to configure an eXist datasource 0 eee cece cece ee ce ee ce eecaeeea cena cena eeu eeneeeeeeeenes 322 How to configure a MarkLogic datasource oocoocccccnnccnnccnnconnccnnccnncnnnconnconncnnncnnnronannninnose 322 How to configure a Software AG Tamino datasource cooccocccnccnnccnnccnnconnccnnccnnconnconnconiconnss 322 How to configure a Raining Data TigerLogic datasource oooooccnccnnccnnccnnccnnccnnconaconaconiconoss 323 How to configure a Documentum xDb X Hive DB datasource ooccoccoccncnoconcnnconcnnroncnnnos 323 Configuring Database Connections cece ceeecc cece ence ence neces a E eeaaeeae VEEE ER INE 324 How to configure a Berkeley DB XML Connection coocccoccnnccnnccnnconnconeconncnnacnnoconcnnninnoss 324 How to configure an eXist Connection 2 2 0 0 ee eee eee cence eee ce seca ceca cena eens eeneeeneeeeeeeeees 324 How to configure a MarkLogic Connection ocoocccccnnccnnccnnconnconnccnnccnnconnconncnnncnn
310. equires this to be done by default e Allows calls on extension functions If checked external functions called is disallowed Checking this is recommended in an environment where untrusted stylesheets may be executed Also disables user defined extension elements to gether with the writing of multiple output files all of which carry similar security risks 387 Configuring the application DTD based validation of the source file If checked XML source documents are validated against their DTD Line numbering If checked line numbers are maintained for the source document Policy for handling recoverable errors in the stylesheet Allows the user to choose how dynamic errors will be handled Either one of the following options can be selected recover silently recover with warnings or signal the error and do not attempt recovery Strip whitespaces feature can be one of the three options All Ignorable None All strips all whitespace text nodes from source documents before any further processing regardless of any xsl strip space declarations in the stylesheet or any xml space attributes in the source document Ignorable strips all ignorable whitespace text nodes from source documents before any further processing re gardless of any xsl strip space declarations in the stylesheet or any xml space attributes in the source document Whitespace text nodes are ignorable if they appear in elements defined in the DTD or schema as having e
311. er handleDeleteSelection in int int ro sync ecss extensions api AuthorAccess e public boolean handleDeleteSelection int selectionStart int selectionEnd int generatedByActionld AuthorAccess authorAccess throws InvalidEditException 246 Author Developer Guide Not handl return false pk ed r see ro sync ecss extensions ro sync ecss extensions api ro sync ecss extensions api ay public boolean handleJoinElemen AuthorAccess authorAccess throws Invalid Edit Exception Not handl return false pk ed see ro sync ecss extensions int ro sync ecss ex ro sync ecss extensions api e public boolean int action boolean hand AuthorSchemaMana authorAcce if authors authors han Id leln ss g chemaManager isLe chemaManager hasL dlePasteFragment int offset AuthorAccess sertionEvent ger authorSch etDocumentCon api AuthorSchemaAwareEditi node AuthorNode java util AuthorAccess ts AuthorNode targetNode L api AuthorSchemaAwareEditi AuthorAccess authorAccess throws Invali ngHandler handleJoinElements List ist lt AuthorNode gt nodesToJoin ngHandler handlePasteFragment tensions api node AuthorDocumentFragment int AuthorDocumentFragment fragmentsToInser false emaManager troller getAuthorSchemaMa arnSchema a
312. er level 332 configuration 331 X XHTML document type 122 association rules 122 Author extensions 122 catalogs 124 templates 124 transformation scenarios 125 CSS 122 schema 122 XML Outline view 47 document structure change 49 popup menu 49 document tag selection 50 modification follow up 49 outliner filters 48 XML document overview 48 XML Schema document type 131 association rules 132 XMLSpec document type 134 association rules 134 Author extensions 132 134 catalogs 134 135 416 Index templates 134 transformation scenarios 134 schema 134 XSLT document type 133 association rules 133 Author extensions 134 417
313. erLogic XDMS database SoftwareAG Tamino database Documentum xDb X Hive DB XML database MySQL database Copy the jar files from the Berkeley database install directory to the lt oXygen gt install directory as described in the procedure for configuring a Berkeley DB data source Go to the IBM website http www 306 ibm com software data db2 ex presos down load htm 1 http www 306 ibm com software data db2 express download html in the DB2 Clients and Development Tools category select the DB2 Driver for JDBC and SOLJ download link fill the download form and download the zip file Unzip the zip file and use the db2jcc jar and db2jcc_license_cu jar files in lt oXygen gt for configuring a DB2 data source Copy the jar files from the eXist database install directory to the lt oXygen gt install directory as described in the procedure for configuring an eXist data source Download Java and NET XCC distributions XCC Connectivity Packages from http xqzone marklogic com download XCC Details about configuring a MarkLogic data source are here Both SQL Server 2005 and SQL Server 2008 are supported Download the SQL Server 2005 JDBC driver called sql jdbc jar from the Microsoft website http www microsoft com downloads details aspx familyid C47053EB 3B64 4794 950D 81E1EC91C1BA amp displaylang en and use it for configuring an SQL Server data source Download the SQL Server 2008 JDBC driver called sqljdbc4 jar from the
314. eration implements AuthorOperation ava ava ava ava ava ava ava Er E A a ee ava e Pe A al Pe el al ace at Ee a ld al ro sy ro sy ro sy ro sy ro sy avax avax avax avax avax avax avax avax avax aw awt awt aw awt awt io ne nce nc ne nc ne t GridBagConstrain File swi swi GridBagLayout event ActionEven t event Actionl event WindowAdap event WindowEvent ES F Listener ter e t MalformedURLException swing BorderFac swing JBut ton swing JDialog ng JFileChooser swing JFra me swing JLabel ng JPanel swing JTex tField tory swing filechooser FileFilter ecss extensions api ArgumentDescriptor ecss extensions api ArgumentsMap ecss extensions api AuthorAccess ecss extensions api AuthorOperation ecss extensions api AuthorOperationException 234 Author Developer Guide Implementing the Author Operation Interface Performs the operation 7 public void doOperation AuthorAccess authorAccess ArgumentsMap arguments throws IllegalArgumentException AuthorOperationException JFrame oxygenFrame JFrame authorAccess getParentFrame String href displayURLDialog oxygenFrame if href length 0 Creates the image XML fragment String imageFragment lt image xmlns http www oxygenxml c
315. ere is just a title List lt AuthorNode gt contentNodes sectionElement getContentNodes if contentNodes size 1 251 Author Developer Guide AuthorNode child contentNodes get 0 isTitleChild isElementWithNameAndNamespace child TITL E isTitleChild amp amp child getEndOffset lt offset boolean if We are after the titl Empty sect element WhatEl authorSchemaMana ementsCanGoHereContext context ger createWhatElementsCanGoHereContext offset Derive the cont pushContextElement Tes if au fr co Au Stri aes sl D t if fragme xt by adding a para context PARA ts can be inserted in para element thorSchemaManager canInsertDocumentFragments agmentsToInsert ntext thorSchemaManager VALIDATION_MODE_STRICT_FIRST_CHILD_LAX_OTHERS reate a para structure and insert fragments inside ngBuilder xmlFragment new StringBuilder lt append PARA SDF_NAMESPACE null amp amp SDF_NAMESPACE length 0 xmlFragment ap xmlF 1 auth of 1 ragment appe nsert para orAccess get fset nsert fragme pend xmlns append SDF_NAMESPACE append nd gt append lt append PARA append gt DocumentController insertXMLFragment xmlFragment toString nt
316. erences 74 find replace 74 navigation 71 bookmarks 72 display the markup 72 Outline view 66 position information tooltip 72 reload content 80 roles content author developer 65 validation 80 whitespace handling 81 versions differences 82 WYSIWYG editing 64 Author Settings C actions 160 insert section 160 insert table 163 Author default operations 166 Java API 169 Author Extension State Listener 187 Author Schema Aware Editing Handler 188 CSS Styles Filter 199 example 1 170 example 2 173 Extensions Bundle 184 generate unique ID 207 References Resolver 196 Table Cell Span Provider 204 Table Column Width Provider 200 menus 160 contextual menu 166 main menu 165 toolbars 160 configure toolbar 164 Common problems 411 Configure the application 349 Archive 403 certificates 406 CSS validator 381 custom validation 379 Data Sources 398 download links for database drivers 401 table filters 403 document type association 351 Editor preferences 353 author 356 author track changes 362 code templates 374 content completion 368 document checking 378 document templates 375 elements and attributes by prefix 373 format 363 format CSS 367 format JavaScript 368 format XML 365 grid 355 open save 374 pages 354 schema aware 358 412 Index spell check 376 syntax highlight 372 editor variables 409 fonts 351 global 350 import preferences fro
317. es The elements that can be inserted in a specific context can be filtered using the filterElements method The SDFSchemaManagerFilter uses this method to replace the td child element with the th element when header is the current context element public Wh 1 jf f 3 if St if List lt CIElement gt filterElements List lt CIElement gt elements atElementsCanGoHereContext context f the element from the current context is the header element remove th td element from the list of content completion proposals and add the th element context null ack lt ContextElement elementStack ContextElement con if header equal if elements gt elementStack context getElementStack null textElement context getElementStack peek s contextElement getQName null for Iterator lt CIElement gt iterator elements iterator iterator hasNext CIElement element iterator next Remove the td element if td equals element getOQName lements remove element break 190 Author Developer Guide else lements new ArrayList lt CIElement gt Insert the th element in the list of content completion proposals CIElement thElement new SDFElement thElement setName th elements add thElement else If
318. es and is the default shortcut of the action Document gt Content Completion gt Show Code Templates Content Completion helper panels Information about the current element being edited are also available in the Model panel and Attributes panel located on the left hand side of the main window The Model panel and the Attributes panel combined with the powerful Outline view provide spacial and insight information on the edited document The Model panel The Model panel presents the structure of the current edited tag and tag documentation defined as annotation in the schema of the current document Open the Model panel from Window gt Show View gt Other oXygen Model view Figure 4 13 The Model View sf Model 3 Eo lt xs complexType gt Namespace http fwww w3 org 2001 XMLSchema Content element only Attributes name string Required true Whitespace collapse Pattern o amp Ci L 0e 1 mixed boolean abstract boolean final Union block Union Did ID Model xs annotation 0 1 xs simpleContent xs complexContent xs group xs all xs choice xs sequence 0 1 xs attribute xs attributeGroup 0 UNBOUNDED xs anyAttribute 0 1 Defines a top level complex type Complex Type Definitions provide For Constraining element information items by providing Attribute Declarations governing the appearance and content of attributes Co
319. es are displaying an XML Schema node in the tree of the database structure for databases with such an XML specific structure with actions for open ing editing validating the schemas in an lt oXygen gt editor panel handling the values from columns of type XML Type as XML instance documents that can be opened and edited in an lt oXygen gt editor panel validating an XML instance document added to an XML Type column of a table etc For a detailed feature matrix that compares the Academic Professional and Enterprise editions of lt oXygen gt please go to the lt oXygen gt website http www oxy genxml com feature_matrix html Note Only connections configured on relational data sources can be used to import to XML or to generate XML schemas 14 Getting started Figure 3 6 Database perspective TEA R File Edit Navigate Search Project XMLTools Run XML Window Help i W7 g ax CR 083258 DEA Y o gt 3 e Sug Oracle ja S A default E Lea XML Repository Loa XML Schemas Repository E e ANONYMOUS 82 BI cTxSYS Ea DBSNMP DIP 2 DMSYS v Sa m al a Et E E al Hg Data Source Explorer 53 O S S_NC_ROWINFO 1 xml 230 O fs Model 23 Z attribute O JE Outline x d E e luje T Containerstats A2D19F2AF4E740D TotalRows 11 TotalContainers O FanOut 11 ImmediateContainers O LastAnalyzedDate 2007 02 13T1 o S lt ContainerStats Re
320. es of documents which can benefit of a validation scenario are a complex XQuery with a main module which imports modules developed independently but validated in the context of the main module of the query and an XML document in which the master file includes smaller fragment files using XML entity references In an XQuery validation scenario the default validator of lt oXygen gt Saxon 9 or any connection to a database that supports validation Berkeley DB XML Database eXist XML Database Software AG Tamino Documentum xDb X Hive DB XML Database can be set as validation engine Sharing the Validation Scenarios Project Level Scenarios In the upper part of the dialog showing the list of scenarios you will find two radio buttons controlling where the scenarios are stored Validation Actions in the User Interface Use one of the actions for validating the current document Select menu XML gt Validate Document Alt Shift V V Cmd Alt V V on Mac OS or click the button yA Validate Document available in the Validate toolbar to return an error result list in the Message panel Mark up of current document is checked to conform with the specified DTD XML Schema or Relax NG schema rules It caches the schema and the next execution of the action uses the cached schema Select menu XML Reset Cache and Validate or click the button s Reset Cache and Validate available in the Validate toolbar to reset the cache with the schema and validate the d
321. es separated by comma are accepted The full name of a Java class that has access to all root element attributes and the above 4 values in order to decide if the document matches the rule An alternative to the rule you defined for the association is to write the entire logic in Java l Create a new Java project in your IDE Create the 1ib directory in the Java project directory and copy there the oxygen jar file from the oXy gen_installation_directory lib The oxygen jar contains the Java interfaces you have to im plement and the available Author API needed to access its features Create the class simple documentation framework CustomRule This class must implement the ro sync ecss extensions api DocumentTypeCustomRuleMat cher interface The interface defines two methods matches and getDescription 1 The matches method is the one that is invoked when the edited document must be checked against the doc ument type association It takes as arguments the root local name its namespace the document location URI the PublicID and the root element attributes It must return t rue when the document matches the association 2 The getDescription method returns a description of the rule Here is the implementation of these two methods The implementation of mat ches is just a Java equivalent of the rule we defined earlier public boolean matches String systemID String rootNamespace String rootLocalName Stri
322. es they refer In this option it is set the color that will be used for the background of the current element at cursor position or the background of two elements when the cursor 1s between two elements Here you can set the method of format and indent that is applied when a docu ment is saved in Author mode Only the modified content The save operation formats only the nodes that were modified in Author mode The entire document The save operation applies formatting to the entire document regardless of the nodes that were modified in Author mode If the checkbox Apply also the Text page Format and Indent actionis selected the con tent of the document is formatted by ap plying the Format and Indent ac tion on every switch from the author ed itor to the text editor of the same docu ment Up and Down arrows will skip positions between blocks and will stop on the next previous line only if the caret is vertical Default display mode for element tags presented in Author mode You can choose between Full Tags with Attributes Full Tags Block Tags Inline Tags Partial Tags and No Tags Allows you to configure the author tags background color Allows you to configure the author tags foreground color The Schema aware preferences panel is opened from menu Window Preferences gt Author Editor Author Schema aware 358 Configuring the application Figure 17 10 The lt oXygen gt Schema aware preferences
323. espace ElementDepth xpointerPath length 1 mentDepth es with the current element path h length 1 Elemen int xpointerIndex Integer int currentElementIndex IndexStack size 1 EID S Eos 50 amp amp stackIdx gt 0 parselInt xpointerPath xpointerldx Integer currentElementI if xpointerIndex current ndexStack get stackIdx intValue linkLocated false break xpointerldx stackldx catch NumberFormatException logger warn e e return linkLocated The method end is empty ElementiIndex e Element will be invoked at the end of every element in the XML document even when the element The XPointerElement Locator implementation of the endElement updates the depth of the current element path and the index of the element in its parent public void endElement String uri String localName String name ndElementDepth startElementDepth 194 Author Developer Guide startElementDepth 7 lastIndexInParent Integer currentElementIndexStack pop intValue The IDElementLocator implementation The IDElementLocator is an implementation of the abstract class ro sync ecss exten sions api link ElementLocator for links that use an id The constructor only assigns field values and the method endElement is empty for this implementatio
324. est_name type xs string gt lt xs element name passed type xs boolean gt lt xs sequence gt 137 Author Developer Guide lt xs complexType gt lt xs element gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs schema gt The use case is that several users are testing a system and must send report results to a content management system The Author customization should provide a visual editor for this kind of documents Writing the CSS A set of rules must be defined for describing how the XML document is to be rendered into the lt oXygen gt Author This is done using Cascading Style Sheets or CSS on short CSS is a language used to describe how an HTML or XML document should be formatted by a browser CSS is widely used in the majority of websites Note For more information regarding CSS please read the specification http www w3 org Style CSS A tutorial is available here http www w3schools com css css_intro asp The elements from an XML document are displayed in the layout as a series of boxes Some of the boxes contain text and may flow one after the other from left to right These are called in line boxes There are also other type of boxes that flow one below the other like paragraphs These are called block boxes For example consider the way a traditional text editor arranges the text A paragraph is a block because it contains a vertical list of lines The lines are
325. et for a short time before the drop then the drop target element will be expanded first and the dragged element will be moved inside the drop target element after its opening tag You can also drop an element before or after another element if you hold the mouse pointer towards the upper or lower part of the targeted element A marker will indicate whether the drop will be performed before or after the target element If you hold down the CTRL key after dragging there will be performed a copy operation instead of a move one The drag and drop action in the Outline view can be disabled and enabled from the Preferences dialog i Tip You can select and drag multiple nodes in the Author Outliner tree The popup menu of the Outline tree Edit attributes for the selected node A dialog is presented allowing the user to see and edit the attributes of the selected node See here for more details about editing attributes The Append child Insert before and Insert after submenus of the outline tree popup menu allow to quickly insert new tags in the document at the place of the element correctly selected in the Outline tree The Append child submenu lists the names of all the elements which are allowed by the schema associated with the current document as child of the current element The effect is the same as typing the lt character and selecting an element name from the popup menu offered by the content completion assistant The Insert before and Insert af
326. et position The arguments of the op eration are header The text that will be placed before the selection footer The test that will be placed after the selection The arguments of InsertFragmentOperation fragment The value for this argument is a text This is parsed by the lt oXygen gt Author as it was already in the document at the caret position You can use entities references declared in the document and it is namespace aware The fragment may have multiple roots Note You can use even namespace prefixes that are not declared in the inserted fragment if they are declared in the document where the insertion is done For clarity you should always to prefix and declare namespaces in the inserted fragment Note If there are namespace declarations in the fragment that are identical to the in the document insertion context the namespace declaration attributes are removed from the fragment elements 167 Author Developer Guide Example 8 2 Prefixes that are not bound explicitly For instance the fragment lt x item id dty2 gt gent lt x item id dty3 gt Can be correctly inserted in the document I marks the insertion point lt xml version 1 0 encoding UTF 8 gt lt DOCTYPE x root lt ENTITY ent entity gt gt lt x root xmlns x nsp gt lt x root gt Result lt xml version 1 0 encoding UTF 8 gt lt DOCTYPE x root lt ENTITY ent entity gt
327. eters for the licenses folder and server port or you can set these two parameters to other values The default folder for the floating license file is license server install dir license and the default TCP IP server port is 12346 To change the default values of the license server the following parameters have to be used e licenseDir followed by the path of the directory where the license files will be placed e port followed by the port number used to communicate with lt oXygen gt XML Author instances Important The license folder must contain a text file called license txt which must contain a single floating license key corresponding to the set of purchased floating licenses If you have more than one floating license key for the same lt oXygen gt version obtained from different purchases please contact us at supportOoxy genxml com to merge your license keys into a single one After the floating license server is set up the lt oXygen gt XML Author application can be started and configured to request a license from it Procedure 2 7 Request a floating license from the license server 1 2 Start Eclipse Go to Window gt Preferences gt oXygen gt Register The license dialog is displayed Check the Use a license server checkbox Fill in the Host text field with the host name or IP address of the license server Fill in the Port text field with the port number used for communicating with the license
328. etset URL file C Documents and Settings marius Desktop target db Structure Content S documentation B book lt oXygen gt XML Editor 10 1 User Manual lt oXygen gt XML userGuide chapter 1 Chapter 1 Introducti introduction sect1 the section sect the section called About the lt oxygen gt User Manu chapter 2 Chapter 2 Installation installation sect1 the section called Installation Requirements inst sect2 the section called Platform Requirements pl sect2 the section called Operating System Tools and E sect3 the section called Operating System op sect3 the section called Tools tools T sect3 the section called Environment Prereauisites lt Mm y Type filter text G Type filter text targetdoc userGuide targetptr key features and benefits sa xreftext the section called Key Features and Benefits Insert xreftext in the OLink After you choose the Target set URL the structure of the target documents is presented For each target document targetdoc the content is displayed allowing for easy identification of the target pt r for the olink element which will be inserted You can use the Search fields to quickly identify a target If you already know the values for the targetdoc and targetptr you can insert them directly in the corresponding fields You have also the possibility to edit an olink u
329. f there is one remains unchanged The fragment will be inserted in the current context of the cursor position That means that if the current XML document uses some 166 Author Developer Guide InsertOrReplaceFragmentOperation InsertOrReplaceTextOperation Surround WithFragmentOperation Surround WithTextOperation namespace declarations then the inserted fragment must use the same declara tions The inserted fragment will not be copied and pasted to the cursor position but the namespace declarations of the fragment will be adapted if needed to the existing namespace declarations of the XML document Examples of namespace adjusting when the fragment is inserted and the descriptions of the arguments are described here Similar to InsertFragmentOperation except it removes the selected content before inserting the fragment Inserts a text It removes the selected content before inserting the text section text The text section to insert Surrounds the selected content by a fragment Since the fragment can have multiple nodes the surrounded content will be always placed in the first leaf element If there is no selection the operation will simply insert the fragment at the caret position The arguments are described here The surround with text operation takes two arguments two text values that will be inserted before and after the selected content If there is no selected content the two sections will be inserted at the car
330. f you want to apply the rule only when the root element is in no 352 Configuring the application New Edit Delete Up Down Enable DTD XML Schema pro cessing in document type detection Only for local DTDs XML Schemas Note namespace you must leave this field empty remove the ANY_VALUE string Root local name Specifies the local name of the root element any by default File name Specifies the name of the file any by default Public ID Represents the Public ID of the matched document Java class Presents the name of the class which will be used to determine if a document matches the rule Opens a new dialog allowing you to add a new association Opens a new dialog allowing you to edit an existing association Deletes one of the existing association Moves the selected association one level up the order is important because the first document type association in the list that can be associated with the docu ment will be used Moves the selected association one level down When this is enabled the matching process will also examine the DTD XML Schema associated with the document For example the fixed attributes declared in the DTD for the root element will be analyzed also if this is specified in the association rules Example 17 1 Enabling DTD Processing for DITA customizations If you are writing DITA customizations you should enable this checkbox DITA Topics and Maps are also matched by look
331. ference the component in other locations using the actions Create Reusable Component and Insert Reusable Component A reusable component is a file usually shorter than a topic You also have the option of replacing the selection with the component that you are in the process of creating e You can add edit and remove a content reference conref attribute to from an existing element The actions Add Edit Content Reference and Remove Content Reference are available on the contextual menu of the Author editor and on the DITA menu When a content reference is added or an existing content reference is edited you can select any topic ID or interval of topic IDs set also the conrefend field in the dialog for adding editing the content reference from a target DITA topic file e You can insert an element with a content reference conref or conkeyref attribute using one of the actions Insert Content Reference and Insert Content Key Reference that are available on the DITA menu the Author custom actions toolbar and the contextual menu of the Author editor DITA makes the distinction between local content that is the text and graphics that are actually present in the element and referenced content that is referred by the element but is located in a different file You have the option of displaying referenced content by setting the option Display referred content that is available from menu Options Preferences Ed itor Pages Author 104 Author f
332. following XPointer element scheme patterns element element ID element 1 2 3 element e lementID 3 4 locate the element with the specified id integer n locates the nth child element of the previously located element stepwise navigation starting from the element located by the given name A child sequence appearing alone identifies an element by means of stepwise nav igation which is directed by a sequence of integers separated by slashes each A child sequence appearing after a NCName identifies an element by means of The constructor separates the id integers which are delimited by slashes into a sequence of identifiers an XPointer path It will also check that the link has one of the supported patterns of the XPointer element scheme public XPointerElementLocator IDTypeVerifi r idVerifi r String link throws ElementLocatorException super link this idVerifier idVerifier link link substring element length link length 1 StringTokenizer stringTokenizer new StringTokenizer link false xpointerPath new String stringTokenizer countTokens int i 0 while stringTokenizer hasMoreTokens xpointerPath i stringTokenizer nextToken boolean invalidFormat false Empty xpointer component is not supported if xpointerPath i length 0 invalidFormat true ae as gt ONA try Integer parselnt xpointe
333. font_size em The complete CSS rule is para display block background color attr bg_color color font size attr font_size em margin attr space em The document is rendered as document article a Blue paragraph Text Grid Author Additional Custom Selectors Oxygen Author provides support for selecting additional types of nodes These custom selectors apply to document doctype sections processing instructions comments CDATA sections and entities In order for the custom selectors 218 Author Developer Guide to work in your CSSs you will have to declare the Author extensions namespace at the beginning of the stylesheet documents namespace oxy url http www oxygenxml com extensions author Example rules e document oxy document display block e doctype sections oxy doctype display block color blue background color transparent e processing instructions oxy processing instruction display block color purple background color transparent e comments oxy comment display block color green background color transparent CDATA sections oxy cdata display block color gray background color transparent e entities oxylentity display morph editable false color orange 219 Author Developer Guide background color transparent A sample document rendered using these rules document lt IDOCTYPE root l
334. formation Options O None O Exclusive O Exclusive with comments Inclusive O Inclusive with comments XPath personnel ID personal ID Envelope O Detached Output File C runtime EclipseApplication samples samples personal signed xml B Open in editor URL Specifies the location of the input URL None If selected no canonicalization algorithm is used Exclusive If selected the exclusive uncommented canonicalization method is used Exclusive with comments If selected the exclusive with comments canonicalization method is used Inclusive If selected the inclusive uncommented canonicalization method is used Inclusive with comments If selected the inclusive with comments canonicalization method is used XPath The XPath expression provides the fragments of the XML document to be signed ID Provides ID of the XML element to be signed 342 Digital signature Envelope If selected the enveloping signature is used Detached If selected the detached signature is used Append KeyInfo The element ds KeyInfo will be added in the signed document only if this option is checked Output Specifies the output file path where the signed XML document will be saved Open in editor If checked the output file will be opened in the editor Verifying the signature The user can select a file to verify its signature in the following dialog displayed by the action Verify Signature available from e
335. from templates TEI P4 Lite New TEI P4 Lite TEI P4 New Document New TEI P4 standard document Catalogs There are two default catalogs for TEI P4 document type frameworks tei xmI teip4 schema dtd catalog xml and frameworks tei xml teip4 custom schema dtd catalog xml Transformation Scenarios The following default transformations are available TEI HTML transforms a TEI document into a HTML document TEI P4 gt TEI P5 Conversion convert a TEI P4 document into a TEI P5 document TEI PDF transforms a TEI document into a PDF document using the Apache FOP engine The TEI P5 document type Customization for TEI PS is similar with that for TEI P4 with the following exceptions 127 Predefined document types Association rules A file is considered to be a TEI PS document when the namespace is http www tei c org ns 1 0 Schema The RNG schema used for these documents is located in frameworks tei xml tei custom schema relaxng tei_all Plus rng where frameworks is a subdirectory of the lt oXygen gt install directory Author extensions The CSS file used for rendering TEI PS content and custom actions are the same with those configured for TEI P4 Templates Default templates are available for TEI P5 They are stored in frameworksDir tei templates TEI P5 folder and they can be used for easily creating basic TEI P5 documents These templates are available when creating new documents from
336. g 2001 XMLSchema instance xsi noNamespaceSchemaLocation urn oasis names tc dita xsd topic xsd 1 1 gt the URN can be resolved to a local schema file with a catalog entry like lt system systemId urn oasis names tc dita xsd topic xsd 1 1 uri topic xsd gt Document navigation Navigating between XML elements located in various parts of the currently edited document is easy due to several powerful features Folding of the XML elements XML documents are organized as a tree of elements When working on a large document you can collapse some elements leaving in the focus only the ones you need to edit Expanding and collapsing works on individual elements expanding an element leaves the child elements unchanged 46 Editing documents Figure 4 24 Folding of the XML Elements lt person id Big Boss gt lt person id one worker gt lt name gt lt family gt Worker lt family gt lt given gt One lt given gt lt name gt lt email gt onefoxygenxml cor lt email gt lt link manager Big Boss gt lt person gt lt person id two worker gt lt person id three worker gt lt name gt lt family gt Worker lt family gt lt given gt Three lt given gt lt name gt lt email gt threefoxygenxml com lt email gt lt link manager Big Boss gt lt person gt 5 lt person id four vorker gt To toggle the folded state of an element click on the special mark displayed in the
337. g instruction referring to a XSLT stylesheet commonly used for display in Internet browsers then lt oXygen gt will prompt the user and offer the option to associate the document with a default scenario containing in the XSL URL field the URL from the href attribute of the processing instruction This scenario will have the Use xml stylesheet declaration checkbox set by default will use Saxon as transformation 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 preserved because the output file name is specified with the help of two editor variables cfd and cfn lt oXygen gt comes with preconfigured built in scenarios for usual transformations that enable the user to obtain quickly the desired output associate one of the built in scenarios with the current edited document and then apply the scenario with just one click Defining a new transformation scenario The Configure Transformation Scenario dialog is used to associate a scenario from the list of all scenarios with the edited document by selecting an entry from the list The dialog is opened by pressing the A gt Configure Transformation Scenario button on the Transformation toolbar of the document view Once selected the scenario will be applied with only one click on the apply Transformation Scenario on the same toolbar Pressing the Appl
338. g special formatting vocabulary XSL consists of three parts XSL Transformations XSLT XSLT is a language for transforming XML documents XML Path XPath 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 XSL FO is an XML vocabulary for specifying formatting semantics lt oXygen gt supports XSLT XPath version 1 0 using Saxon 6 5 5 Xalan Xsltproc MSXML 3 0 4 0 NET and XSLT XPath 2 0 by using Saxon 9 2 0 6 B Saxon 9 2 0 6 EE and Saxon NET Transformation scenario Before transforming the current edited XML document in lt oXygen gt you must define a transformation scenario to apply to that document A scenario is a set of values for various parameters defining a transformation It is not related 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 is applied on the edited XML document and other transform parameters Scenarios that apply to XSLT files Such a scenario contains the location of an XML document that the edited XSLT stylesheet is applied on and other transform parameters Scenarios that apply to XQuery files Such a scenario contains the location of an XML source that the edited XQuery file is applied on and other transform parameters When the XML source is a native XML database the XML s
339. g that is displayed contains a Create new file action which displays the New file dialog This allows you to choose the type or the template for the file If the action succeeds the file is created with the referred location and name and is opened in a new editor panel This is useful when you decide first on the file name and after that you want to create it in the exact location specified at the current cursor position Document type actions are specific to some document type Examples of such actions can be found in section Predefined document types Editing XML in lt oXygen gt Author Editing the XML markup One of the most useful feature in Author editor is the content completion support The fastest way to invoke it is to press Ctrl Space on Mac OS X the shortcut is Meta Space Content completion window offers the following types of actions e inserting allowed elements for the current context according to the associated schema if any e inserting element values if such values are specified in the schema for the current context e inserting new undeclared elements by entering their name in the text field 76 Authoring in the tagless editor e inserting CDATA sections comments processing instructions Figure 5 18 Content completion window Split sect3 A E example E figure E important E itemizedlist E note E para w Split sect3 If you press Enter the displayed content completion wi
340. ge Si manager lt link subordinates E subordinates lt person gt lt person id one worker lt name gt lt family gt Worker lt given gt One lt gi p History lt name gt Ipersonnel child person index of link manager Boss gt 0 lt email gt onefoxygenx lt link manager Big lt person gt lt person id two worker lt name gt lt family gt Worker Execute Cancel lt given gt Two lt gi lt name gt lt email gt twofoxygenxml com lt email gt lt link manager Big Boss gt lt person gt The evaluation of the XPath expression tries to resolve the locations of documents referred in the expression through the XML catalogs which are configured in Preferences and the current XInclude preferences for example when eval uating the collection URIofCollection function XPath 2 0 If you need to resolve the references from the files returned by the collection function with an XML catalog set up in the lt oXygen gt preferences you have to specify in the query which is the parameter of the collection function the name of the class of the XML catalog enabled parser for parsing these collection files The class name is ro sync xml parser CatalogEnabledXMLReader and you specify it like this let docs collection iri to uri file D temp test XQuery catalog mydocsdir recurse yes select xml parser ro sync xml parser CatalogEnabledXMLReader The results of an XPath query ar
341. ge Explorer view Also you can select several files in the views like Package Explorer Navigator and validate them with one click by selecting the action Validate selection the action Validate selection with Schema or the action Configure Validation Scenario available from the contextual menu of that view the submenu Batch Validate If there are too many validation errors and the validation process is long you can limit the maximum number of reported errors 45 Editing documents Resolving references to remote schemas with an XML Catalog When a reference to a remote schema must be used in the validated XML document for interoperability purposes but alocal copy of the schema should be actually used for validation for performance reasons the reference can be resolved to the local copy of the schema with an XML catalog For example if the XML document contains a reference to a remote schema docbook rng lt oxygen RNGSchema http www oasis open org docbook xm1 5 0 rng docbook rng type xml1 gt 1t can be resolved to a local copy with a catalog entry lt system systemId http www oasis open org docbook xml1 5 0 rng docbook rng uri rng docbook rng gt An XML catalog can be used also to map a W3C XML Schema specified with an URN in the xsi schemaLocation at tribute of an XML document to a local copy of the schema For example if the XML document specifies the schema with lt topic xmlns xsi http www w3 or
342. gin transforms a DITA topic to PDF using the DITA Open Toolkit 1 5 M24 and the Apache FOP engine The DITA MAP document type DITA maps are documents that collect and organize references to DITA topics to indicate the relationships among the topics They can also serve as outlines or tables of contents for DITA deliverables and as build manifests for DITA projects Maps allow scalable reuse of content across multiple contexts They can be used by information architects writers and publishers to plan develop and deliver content 120 Predefined document types Association rules A file is considered to be a dita map document when either of the following occurs root element name is one of the following map bookmap e public id of the document is OASIS DTD DITA Map or OASIS DTD DITA BookMap e the root element of the file has an attribute named class which contains the value map map and a DITAArchVer sion attribute from the http dita oasis open org architecture 2005 namespace This enhanced case of matching is only applied when the Enable DTD processing option from the Document Type Detection option page is enabled Schema The default schema used for DITA Map documents is located in frameworks dita DITA OT dtd map dtd where frameworks is a subdirectory of the lt oXygen gt install directory Author extensions The CSS file used for rendering DocBook content is located in frameworks dita css
343. gs tab by pressing the New button Enter frame works sdf catalog xml in the displayed dialog To test the catalog settings restart lt oXygen gt and try to validate a new sample Simple Documentation Framework document There should be no errors Configuring Transformation Scenarios When distributing a framework to the users it is a good idea to have the transformation scenarios already configured This would help the content authors publish their work in different formats Being contained in the Document Type Association the scenarios can be distributed along with the actions menus toolbars catalogs etc In the following section you will create a transformation scenario for your framework Create the directory xs1 in the directory frameworks sdf The directory structure for the documentation framework should be oxygen frameworks sdf schema css templates xsl Create the sdf xs1 file in the xs1 directory The complete content of the sdf xs1 file is found in the Example Files Listings Open the Options Preferences Document Type Associations Open the Document Type dialog for the SDF framework then choose the Transformation tab Click on the New In the Edit Scenario dialog fill the following fields Name The name of the transformation scenario Enter SDF to HTML XSL URL frameworks sdf xsl sdf xsl Transformer Saxon 9B Change to the Output tab Change the fields Save as S cfd cfn html This means the transform
344. gs which can be used to improve editing in the Tagless editor The tagless editor comes with some predefined document types already configured when the application is installed on the computer These document types describe well known XML frameworks largely used today for authoring XML documents Editing a document which conforms to one of these types is as easy as opening it or creating it from one of the predefined document templates which also come with the application Figure 7 1 Document Type preferences page Document Type Association ey gts Change frameworks Document Type Associations directory location User role Developer y Document type Enabled Storage Namespace Rootlocal name File name PublicID DITA Y External DITA Map A External DITAVAL Y External F 4 DocBook 4 Y External Rule book a Rule article A a Rule i OASIS Rule chapter a DocBook 5 4 External Docbook Targetset 4 External EAD A External 4 FO A External A 4 es i E r New Edit Duplicate Remove Up Down Y Enable DTD XML Schema processing in document type detection __ Only for local DTDs XML Schemas Restore Defaults Apply The DocBook V4 document type DocBook is a very popular set of tags for describing books articles and other prose documents particularly technical documentation 107 Predefined document types Association rules A file is considered to be a DocB
345. gt CSS features and also to hide them when opening the docu ments with other viewers 214 Author Developer Guide Supported Features from CSS Level 3 Namespace Selectors In the current CSS 2 1 standard the element selectors are ignoring the namespaces of the elements they are matching Only the local name of the elements are considered in the selector matching process lt oXygen gt Author uses a different approach similar to the CSS Level 3 specification If the element name from the CSS selector is not preceded by a namespace prefix it is considered to match an element with the same local name as the selector value and ANY namespace otherwise the element must match both the local name and the namespace In CSS up to version 2 1 the name tokens from the selectors are matching all elements from ANY namespace that have the same local name Example lt x b xmlns x ns_x gt lt y b xmlns y ns_y gt Are both matched by the rule b font weight bold Starting with CSS Level 3 you can create selectors that are namespace aware Example 8 5 Defining both prefixed namespaces and the default namespace Given the namespace declarations namespace sync http sync example org namespace http example com foo In a context where the default namespace applies synclA represents the name A in the http sync example org namespace IB represents the name B that belongs to NO NAMESPACE IC represents the name C
346. gt XML Author license server as a Windows service ocoooccoccccccno 7 How to release a floating censes esiseinas en r e e a enii aaee 8 License registration with a registration code ocoooccnccnncnnncnnocnnccnnconnconnccnnccnnconnconncnnncnnncnnncnnrcnncnns 8 Unregistering the license key comia E TEE cess EEE EEEE E E N E E an 8 Upgrading the lt oXygen gt XML Author application oooccocccnccnnccnnccnncnnncnncnnncnnnrnnnnnncnnnronncnnconncinniinno 8 Checking for New Versions iesistie bin yecuets eE luce cesta bce es satce evens buen cob beu uses aa bee sob obgecesepnuendoubuvesss 9 Uninstalling the Eclipse plugin ericsson rnia reek ga desi agas E eo rolas sane s 9 3 Getting Started A OS 10 Supported types Of GOCUMENIS 2scc sesecctsscesccudssvesecsgseateesssdecss speed cengssects sca veeseags shots ars basada sirena gen 10 Getting help tii ss 10 Perspectives nosotras rana pp io ETER 10 lt oXygen gt XML perspective 2 2 0 0 eee Ere EEE EE EE TEE E EEEE ESEE 10 The lt oXygen gt CustOm MENU pieri r er sessed sevens sds eesieedssscesadivetaundastecestevessesds sect asssedoans 11 The lt oXygen gt toolbar buttons 2 2 0 0 eee cece cee cee ce teen seca ceca cena eens een eeeeeeeeeeeeeeeeeaees 11 NS cs nansasas vat AG sath tG bas petMAS TE otha E ORAS a aah OM bas PNT Ra Ta ase NEM setae 11 The Outline Views sec sce debe dese vorcnests oes cae aaa E cs civessogeeebe dees be ycesteshe geet beers 12 The lt oX yeen gt Text
347. gt install directory CSS The default CSS options for the XHTML document type are set to merge the CSSs specified in the document with the CSSs defined in the XHTML document type Author extensions The CSS file used for rendering XHTML content is located in frameworks xhtml css xhtml css 122 Predefined document types Specific actions are E B Bold changes the style of the selected text to bold by surrounding it with b tag T Italic changes the style of the selected text to italic by surrounding it with i tag U Underline changes the style of the selected text to underline by surrounding it with u tag Note For all of the above actions if there is no selection then a new specific tag will be inserted These actions are available in any document context H Headings groups actions for inserting h1 h2 h3 h4 h5 h6 elements T Insert Paragraph inserts a new paragraph depending on the current context If current context is a paragraph context one of the ancestors of the element at caret position is p then a new paragraph will be inserted after the paragraph at caret Otherwise a new paragraph is inserted at caret position aclInsert Graphic inserts a graphic object at the caret position This is done by inserting an img element regardless of the current context The following graphical formats are supported GIF JPG JPEG BMP PNG SVG Insert Ordered List inserts an ordered list ol elemen
348. h the logical folder support of the project allows you to group your files and transform them very easily Tf the resources from a linked folder in the project have been changed outside the view you can refresh the content of the folder by using the Refresh action from the contextual menu The action is also performed when selecting the linked resource and pressing F5 key You can also use drag and drop to arrange the files in logical folders but not in linked folders Also dragging and dropping files from the project tree to the editor area results in the files being opened Including document parts with Xinclude XInclude is a standard for assembling XML instances into another XML document through inclusion It enables larger documents to be dynamically created from smaller XML documents without having to physically duplicate the content of the smaller files in the main file XInclude is targeted as the replacement for External Entities The advantage of using XInclude is that unlike the entities method each of the assembled documents is permitted to contain a Document Type Declaration DOCTYPE Decl This means that each file is a valid XML instance and can be independently validated It also means that the main document to which smaller instances are included can be validated without having to remove or comment the DOCTYPE Decl as is the case with External Entities This is makes XInclude a more convenient and effective method for managing XML i
349. han one column The column span of the source cell will be decreased with one Las burSplit Cell Above splits the cell from current caret position in two inserting a new empty table cell above Note that this action works only if the current cell spans over more than one row The row span of the source cell will be decreased with one tz Split Cell Below splits the cell from current caret position in two inserting a new empty table cell below Note that this action works only if the current cell spans over more than one row The row span of the source cell will be decreased with one Generate IDs allows you to generate ID for the current selection or for the element at caret position if the element appears in ID Generation dialog In this dialog you can specify the elements for which lt oXygen gt should generate an ID You can choose to automat ically generate an ID for these elements by selecting Auto generate ID s for elements You can choose a pattern for the generated ID using the field ID Pattern If the element already has an ID this ID is preserved All actions described above are available in the contextual menu main menu TEI P4 submenu and in the Author custom actions toolbar Templates Default templates are available for XHTML They are stored in frameworksDir tei templates TEI P4 folder and they can be used for easily creating basic TEI P4 documents These templates are available when creating new documents
350. he Project view can be checked for well formedness with one action available on the popup menu of the Project view Y Check well form 37 Editing documents Validating XML documents against a schema A Valid XML document is a Well Formed XML document which also conforms to the rules of a schema which defines the legal elements of an XML document The schema type can be XML Schema Relax NG full or compact syntax Schematron Document Type Definition DTD Namespace Routing Language NRL or Namespace based Validation Dispatching Language NVDL The purpose of the schema is to define the legal building blocks of an XML document It defines the document structure with a list of legal elements The lt oXygen gt A Validate document function ensures that your document is compliant with the rules defined by an associated DTD XML Schema Relax NG or Schematron schema XML Schema or Relax NG Schema can embed Schematron rules For Schematron it is possible to select the validation phase Note a Validation of an XML document against a W3C XML Schema containing a type definition with a minOccurs or maxOccurs attribute having a value larger than 256 limits the value to 256 and issues a warning about this restriction in the Message panel at the bottom of the lt oXygen gt window Otherwise for large values of the minOccurs and maxOccurs attributes the validator fails with an OutOfMemory error which practically makes lt oXygen gt
351. he digests computed by the signing and relying parties and hence the equivalence of the canonical forms over which they were computed ensures that the information content of the document has not been altered since it was signed The following canonicalization algorithms are used in lt oXygen gt Canonical XML or Inclusive XML Canonicaliza tion CXMLC14N http www w3 org TR 2001 REC xml c14n 20010315 and Exclusive XML Canonicalization EX CC14N http www w3 org TR 2002 REC xml exc c 14n 20020718 The first is used for XML where the context doesn t change while the second was designed for canonicalization where the context might change Inclusive Canonicalization copies all the declarations even if they are defined outside of the scope of the signature In this way all the declarations you might use will be unambiguously specified A problem appears when the signed XML is moved into another XML document which has other declarations because the Inclusive Canonicalization will copy then and the signature will be invalid Exclusive Canonicalization finds out what namespaces you are actually using the ones that are a part of the XML syntax and just copies those It does not look into attribute values or element content so the namespace declarations required to process these are not copied This type of canonicalization is useful when you have a signed XML document that you wish to insert into other XML documents and it will insure the sig
352. he fragment to be inse An XPath expression indi The insert position relati sal 1 Value lt section xmins http www oxygenxml com s Type Fragment XPathExpr ConstantList Operation priority ID An unique identifier for the action You can use insert_section Name Menu access key Description Large icon 20x20 The name of the action It is displayed as a tooltip when the action is placed in the toolbar or as the menu item name Use Insert section On Windows the menu items can be accessed using ALT letter combination when the menu is visible The letter is visually represented by underlining the first letter from the menu item name having the same value Since the name is Insert section you can use as a menu access key the letter s You can add a short description for the action In our case Adds a section element will suffice The path to the file that contains the toolbar image for the action A good practice is to store the image files inside the framework directory This way we can use the editor variable frameworks to make the image file relative to the framework location Insert frameworks sdf Section20 gif Note If the images are bundled in a jar archive together with some Java operations im plementation for instance it might be convenient for you to refer the images not by the file name but by their relative path location in the class path If the imag
353. he last element is also highlighted by a thin light blue bar for easier identification Clicking one element from the top stripe selects the entire element in the Editor view The tag names displayed in the breadcrumb can be customized with an Author extension class that implements Au thorBreadCrumbCustomizer See the Author SDK http www oxygenxml com developer html for details about using it The locations of selected text are stored in an internal list which allows navigating between them with the buttons Ctri Alt Back and Ctrl Alt gt Forward that are available on the toolbar Navigation The Append child Insert before and Insert after submenus of the top stripe pop up menu allow to quickly insert new tags in the document at the place of the selected element The Append child submenu lists the names of all the elements which are allowed by the schema associated with the current document as child of the current element The effect is the same as typing the lt character and selecting an element name from the popup menu offered by the content com pletion assistant The Insert before and Insert after submenus list the elements which are allowed by the schema asso ciated with the current document as siblings of the current element inserted immediately before respectively after the current element The Cut Copy Paste and Delete items of the popup menu execute the same actions as the Edit menu items with the same name on the elemen
354. he number of rows the number of columns a table title optional a table header op tional After setting the table parameters press OK in the Insert Table dialog for inserting a table in the edited DITA map Set the type of the topics in the header of each column The header of the table the relheader element already contains a relcolspec element for each table column You should set the value of the attribute type of each relcolspec element to a value like concept task reference When you click in the header cell of a column that is a relcolspec element you can see all the attributes of that relcolspec element including the type attribute in the Attributes view You can edit the attribute type in this view To insert a topic reference in a table cell just place the cursor in that cell and run the action J Insert Topic Reference that is available on the Author toolbar on the menu DITA gt Insert and on the Insert submenu of the contextual menu Optionally for adding a new row to the table removing an existing row you should run the action Insert Row a Delete Row that is available on the Author toolbar on the menu DITA gt Table and on the Table submenu of the contextual menu ES Optionally for adding a new column to the table removing an existing column you should run the action 1Insert Column Delete Column that is available on the Author toolbar on the menu DITA Table and on the Table submenu of the contextual m
355. he validation process Strip non significant whitespaces If checked strip non significant white space from the input XML document during the load phase Enabling this option can lower memory usage and improve transformation performance while in most cases creating equivalent output Show time information If checked the relative speed of various transformation steps can be measured time to load parse and build the input document time to load parse and build the style sheet document time to compile the style sheet in preparation for the transformation time to execute the style sheet 391 Configuring the application Forces ASCII output encoding Allow multiple output documents Use named URI resolver class Assembly file name for URI resolver class Assembly GAC name for URI resolv er class List of extension object class names Use specified EXSLT assembly Credential loading source xml There is a known problem with NET 1 X XSLT processor Sys tem Xml Xsl XslTransform class it doesn t support escaping of characters as XML character references when they cannot be represented in the output encod ing That means that when you output a character that cannot be represented in output encoding it will be outputted as Usually this happens when output encoding is set to ASCII With this option checked the output is forced to be ASCII encoded and all non ASCII characters get escaped as XML character references
356. heck well formedness on save Save all files before transformation or validation Clear undo buffer on save Code Templates or Format document when longest line exceeds 5000 C Save all files before transformation or validation Specifies the default behavior when the longest line of a document exceeds the specified limit You can choose between e Always format e Never format e Always ask If selected the lt oXygen gt plugin will perform a well formed check every time the user saves a document Save all opened files before validating or transforming an XML document In this way the dependencies are resolved for example when modifying both the XML document and its XML Schema If checked the undo action has no effect after you ve saved your document You can only undo the modifications made after you ve saved it Code templates are small document fragments that can be reused in other editing sessions lt oXygen gt comes with a large set of ready to use templates for XSL XQuery and XML Schema You can even share your code templates with your colleagues using the Export and Import functions To obtain the template list you can use the Content Completion on request shortcut key usually CTRL SPACE or the Code Templates on request shortcut key CTRL SHIFT SPACE The first shortcut displays the code templates in the same content completion list with elements from the schema of the document The second shortcut displays onl
357. hich are also based on the ZIP archive format This means that you can modify transform validate files directly from OOXML or ODF packages Using files directly from archives Now you can transform validate and perform many other operations on files directly from an archive When selecting an URL for a specific operation like transformation or validation you can click the Browse for archived file button to navigate and choose the file from a certain archive Browsing and modifying archives structure You can navigate archives directly in the Archives Browser either by opening them from the Navigator or by using the integration with the Eclipse File System For the EFS Eclipse File System integration you must right click the archive in the Navigator and choose Expand Zip Archive All the standard Eclipse Navigator actions are available on the mounted archive If you decide to close the archive you can use the Collapse ZIP Archive action located in the contextual menu for the expanded archive Any file opened from the archive expanded in the EFS will be closed when the archive in unmounted Warning The ZIP support needs the IBM437 character set to be properly installed in the Java Runtime Environment in order to be able to navigate open ZIP archives If you encounter an error message when expanding a ZIP archive about the JVM that is missing a charset then the JVM used to run Eclipse does not have the character set library properly inst
358. iation apra a Sande yeaten a abe dvegnevt see tassqeecgasegveutieas iebdneey yeh 351 EME a a nie od Shad redactada 353 PAGES atorrante 354 a A OG E BES ies Sy AUGER as eth Ue Re Me elas E is eae daar ees 355 AULD OR a cete a dias mode en pad sedas 356 Schema aware A A Svar dey eel eed reed pees 358 Track Changes snes fete Bee E Synetevedh A E E sess suns ENSS 362 Messages do A Aci 363 Format senene a lirio 363 AM A O A E NIN 365 RA 367 E SAA A A 367 JAVASCLIPU NN 368 Content Completion oi obs 368 AMOS ci af 370 APM AA RA 371 Syntax High ht sasen es ac gvedewes toot der rei on A E NESSES 372 Syntax Highlight Elements Attributes by Prefix oooncoocccnccnnconnconnconoconncnnacnnaconacnncnnnos 373 Open SAVE RS 374 Code Templates ivi a is E ia R eae 374 Document Templates tesina analista 375 Spell Check iia ta 376 Document Checkin gi onyen ean sand E roo diiniita 378 Custom Validation iii ise 379 xiii lt oXygen gt XML Author 11 2 User Manual for Eclipse GSS Validator eccocrno on in avn tes ed tae vhs betes E E E E ie eens 381 DMUs oi fan i Sas ri A TO Sa 381 MIL Catalog NN 381 XAML Parser o iii iaa 383 Saxon EE Valid tor ene eo cateo 384 A PLOC Engines ii 384 XSLT FO X QUEII otto iii irritan 386 O TD ttt o dE Site Se tas oe 386 ORO 386 Saxon HE PE EE cdi td ad 387 Saxon HE PE EE Advanced options ocoooccoccnnccnncnnocnnccnnconnconnccnnccnncnnnconacinncos 388 ASTON taa weaken ta eed eae tee 389 MSXML
359. icts Export transformation scenarios Allows you to export all transformation scenarios available in the Configure Transformation Scenario dialog 407 Configuring the application View The View preferences panel is opened from menu Window gt Preferences gt Author View Figure 17 62 The View preferences panel View es Console Fixed width console Limit console output Console buffer 80000 Tab width 8 Fixed width console When checked a line in the Console view will be hard wrapped after Maximum character width characters Limit console output When checked the content of the Console view will be limited to a configurable number of characters Console buffer specifies the maximum number of characters that can be written at some point in the Console view Tab width specifies the number of spaces used for depicting a tab Automatically importing the preferences from the other distribution If you want to use the settings from standalone in the Eclipse plugin just delete the file with the Eclipse plugin settings user home dir Application Data com oxygenxml author oxyAuthorO0ptionsEc11 2 xml on Windows user home dir com oxygenxml author oxyAuthorO0ptionsEc11 2 xml on Linux start Eclipse and the standalone settings will be automatically imported in Eclipse The same for importing the Eclipse plugin settings in standalone delete the file user home dir com oxygenxml author oxyAu
360. ies without re engineering Internally the lt oXygen gt XML Editor uses 16bit characters covering the Unicode Character set Opening and saving Unicode documents On loading documents lt oXygen gt receives the encoding of the document from the Eclipse platform This is then used to instruct the Java Encoder to load support for and save using the code chart specified While in most cases you will use UTF 8 simply changing the encoding name will cause the file to be saved using the new encoding To edit document written in Japanese or Chinese you will need to change the font to one that supports the specific characters a Unicode font For the Windows platform use of Arial Unicode MS or MS Gothic is recommended Do not expect Wordpad or Notepad to handle these encodings Use Internet Explorer or Word to eventually examine XML documents When a document with a UTF 16 encoding is edited and saved in lt oXygen gt the saved document will have a byte order mark BOM which will specify the byte order of the document s content The default byte order is platform de pendent That means that a UTF 16 document created on a Windows platform where the default byte order mark is UnicodeLittle will have a different BOM than a UTF 16 document created on a Mac OS platform where the byte order mark is UnicodeBig The byte order and the BOM of an existing document will be preserved by lt oXygen gt when the document is edited and saved Note
361. iles Listings the Java Files section In the listing below the XML document contains the ref element lt ref location referred xml gt Reference lt ref gt When no reference resolver is specified the reference has the following layout Figure 8 23 Reference with no specified reference resolver Reference without a reference resolver bReference4 When the above implementation is configured the reference has the expected layout Figure 8 24 Reference with reference resolver Reference with a reference resolver Reference Edit referenced content Referred paragraph Configuring CSS Styles Filter You can modify the CSS styles for each ro sync ecss extensions api node AuthorNode rendered in the Author page using an implementation of ro sync ecss extensions api StylesFilter You can implement the various callbacks of the interface either by returning the default value given by lt oXygen gt or by con tributing to the value The received styles ro sync ecss css Styles can be processed and values can be overwritten with your own For example you can override the KEY_BACKGROUND_COLOR style to return your own implementation of ro sync exml view graphics Color or override the KEY_FONT style to return your own implementation of ro sync exml view graphics Font For instance in our simple document example the filter can change the value of the KEY_FONT property for the table element package simple documentation fr
362. in ANY namespace including NO NAMESPACE D represents the name D in the http example com foo namespace Example 8 6 Defining only prefixed namespaces Given the namespace declaration namespace sync http sync example org Then synclA represents the name A in the http sync example org namespace IB represents the name B that belongs to NO NAMESPACE IC represents the name C in ANY namespace including NO NAMESPACE D represents the name D in ANY namespace including NO NAMESPACE 215 Author Developer Guide The attr function Properties Values Collected from the Edited Document In CSS Level 2 1 you may collect attribute values and use them as content only for the pseudo elements For instance the before pseudo element can be used to insert some content before an element This is valid in CSS 2 1 title beforel content Title id attr id If the title element from the XML document is lt title id titlel2 gt My title lt title gt Then the title will be displayed as Title id titlel2 My title In lt oXygen gt Author the use of attr function is available not only for the content property but also for any other property This is similar to the CSS Level 3 working draft http www w3 org TR 2006 WD css3 values 200609 19 functional The arguments of the function are attr attribute_name attribute_type default_value attribute_name attribute_type default_value att
363. in applying an XQuery over an XML SQL transformation Executes an SQL over a database If you want an XSLT scenario select as Scenario type either XML transformation with XSLT or XSLT transformation then complete the dialog as follows 279 Transforming documents Figure 10 2 The Configure Transformation Dialog XSLT Tab Edit scenario Scenario Name Docbook PDF XSLT FO Processor Output XML URL currentFileURL ix 3 XSL URL 4 frameworks docbook xsl fo docbook_custom xsl ia 44 Pele More about currentFileURL Cluse xml stylesheet declaration Transformer Saxon6 5 5 v 3 O XML URL Specifies an input XML file to be used for the transformation Please note that this URL is resolved through the catalog resolver If the catalog does not have a mapping for the URL then the editor will try to use the file directly Note If the transformation engine is Saxon 9 and a custom URI resolver is configured for Saxon 9 in Preferences then the XML input of the trans formation is passed to that URI resolver The following buttons are shown immediately after the input field Insert Editor Variables Opens a pop up menu allowing to intro duce special lt oXygen gt editor variables or custom editor variables in the XML URL field Browse for local file Opens a local file browser dialog allow ing to select a local file name for the text field Br
364. in the same document and the editor panel can become cluttered Marking tags with different colors based on the namespace prefix allows easier identification of the tags Figure 4 28 Example of coloring XML tags by prefix lt xsl template match name gt lt fo list item gt lt fo list item label end indent label end gt lt fo block text align end font weight bold gt Full Name lt fo block gt lt fo list item label gt lt fo list item body start indent body start gt lt fo block text align start color red gt lt xsl apply templates select t gt lt fo block gt lt fo list item body gt lt fo list item gt lt xsl template gt 60 Editing documents Editing CSS stylesheets lt oXygen gt provides special support for developing CSS stylesheet documents Validating CSS stylesheets lt oXygen gt includes a built in CSS validator integrated with the general validation support This brings the usual val idation features to CSS stylesheets Content Completion in CSS stylesheets A content completion assistant similar to the one of XML documents offers the CSS properties and the values available for each property It is activated on the CTRL Space shortcut and it is context sensitive when it is invoked for the value of a property Figure 4 29 Content Completion in CSS stylesheets quote color 000066 E azimuth A The background property is a shorthan
365. ing file with a new name e File gt Save All Saves all open documents Opening and Saving Remote Documents via FTP SFTP lt oXygen gt supports editing remote files using the FTP SFTP protocols The remote opened files can be edited exactly as the local ones They can be added to the project and can be subject to XSL and FO transformations 22 Editing documents Figure 4 6 Open URL dialog Open using FTP SFTP WebDAV URL Ftp marius devel sync rofhome marius Identification User marius iy Password eeeeee Save Browse For remote file Server URL Ftp devel sync ro lv C Autoconnect Browse 3 4 automatic tests 4 wey a SE c 6 2 InkBaseDir E InkDir W E InkLnkDir H E parent H E Permissions samples HE ftp 2 RelaxNG Ea personal schema xml fe personal dtd fa personal xml fe personal xsd Loy personal xsl fed personal2 xml 7 testListFiles LL teckSETD j New Folder Note The FTP part is using passive access to the FTP servers Make sure the server you are trying to connect to is supporting passive connections Also the UTF 8 encoding is supported and can be configured for communication with the FTP server if the server supports it Files can be opened through the Secure FTP SFTP protocol using the regular user password mechanism or using a private key file and a passphrase The user password mechanism has precedence
366. ing file but lt oXygen gt XML Author displays it as if it is there in the referencing file You can also choose to view local content instead of referenced content to edit the attributes or contents of the refer encing element Reusable component When you need to reuse a part of a DITA topic in different places in the same topic or in different topics it is recom mended to create a separate component and insert only a reference to the new component in all places Below are the steps for extracting a reusable component inserting a reference to the component and quickly editing the content inside the component 1 Select with the mouse the content that you want to reuse in the DITA file opened in Author mode 2 Start the action Create Reusable Component that is available on the DITA menu the Author framework actions toolbar and the contextual menu of the Author editor 3 Inthe combo box Reuse Content select the DITA element with the content that you want to extract in a separate component The combo box contains the current DITA element where the cursor is located for example a p element a paragraph or a step or a taskbody or a conbody etc and also all the ancestor elements of the current element 4 Inthe Description area you should enter a textual description for quick identification by other users of the com ponent 5 Ifyou want to replace the extracted content with a reference to the new component you should leave the chec
367. ing for the DITAArch Version attribute in the root element If the DTD is not processed on detection then this attribute specified as default in the DTD will not be detected on the root element and the DITA customization will not be correctly matched When the previous feature is enabled you can choose to process only the local DTDs XML Schemas The Reset Defaults button that is available in all Preferences panels has no effect for document types with external storage Editor The Editor preferences panel is opened from menu Window Preferences gt Author Editor Use these options to configure the visual aspect of the text editor The same options panel is available in the restricted version of the Preferences dialog 353 Configuring the application Figure 17 6 The Editor preferences panel Editor Appearance color options Editor background Completion proposal background Completion proposal Foreground Documentation window background Documentation window Foreground Line wrap disables Folding Highlight matching tag Enable Folding when opening a new editor Minimum fold range only for XML 4 Editor background color Completion proposal background Completion proposal foreground Documentation window background Documentation window foreground Line Wrap disables folding Highlight matching tag Enable folding when opening a new editor Minimum fold range only for XML Pages
368. ings The unparsed entity uri function This function returns the uri value of an unparsed entity name unparsed entity uri unparsedEntityName unparsedEntityName unparsedEntityName The name of an unparsed entity defined in the DTD This function can be useful to display images which are referred with unparsed entity names Example 8 12 CSS for displaying the image in Author for an imagedata with entityref to an unparsed entity imagedata entityref content url unparsed entity uri attr entityref 225 Author Developer Guide The attributes function This function concatenates the attributes for an element and returns the serialization attributes ll Example 8 13 attributes For the following XML fragment lt element attl x xmlns a 2 x amp quot gt theattributes function will return att l x xmlns a 2 x Example Files Listings The Simple Documentation Framework Files XML Schema files sdf xsd lt xml version 1 0 encoding UTF 8 gt lt xs schema xmlns xs http www w3 org 2001 XMLSchema targetNamespace http www oxygenxml com sample documentation xmlns doc http www oxygenxml com sample documentation xmlns abs http www oxygenxml com sample documentation abstracts elementFormDefault qualified gt lt xs import namespace http www oxygenxml com sample documentation abstracts schemaLocation abs xsd gt lt xs element name book type doc s
369. ins in addition to the edit actions described above the following actions Check Spelling in Files Check spelling for the files in the scope of the current edited DITA Map See more details here Open in editor Open in the editor the resources referred by the selected nodes Open Map in Editor with resolved Open the map in the main editing area with all the topic references expanded in topics the map content Cut Copy Paste Undo Redo Common edit actions with the same functionality as those found in the text ed itor Paste before Paste after Will paste the content of the clipboard before respectively after the selected node Append Child Insert After Topic reference Append Insert a topic reference as a child sibling of the selected node Topic reference to the current edited Append Insert a topic reference to the file current edited file as a child sibling of the selected node Topic heading Append Insert a topic heading as a child sibling of the selected node Topic group Append Insert a topic group as a child sibling of the selected node You can also arrange the nodes by dragging and dropping one or more nodes at a time Drop operations can be performed before after or as child of the targeted node The relative location of the drop is indicated while hovering the mouse over a node before releasing the mouse button for the drop Drag and drop operations allow you to Copy Select the nodes you want to copy and start dragging
370. install dir dicts A pre built dictionary can be added by copying the corresponding dar archive to the same directory and restarting lt oXygen gt A dictionary can be built with the tool available at http www xmlmind com spellchecker dictbuilder shtml Learned words are stored into an persistent learned words dictionary with the tdi extensions located in e directory on Windows XP Note If you cannot find the com oxygenxml folders please check the Roaming folder from the Application Data e directory on Windows Vista e directory on Mac OS X Learning words There is one dictionary for each language country variant combination If the Learn button is pressed by mistake the only possibility to delete the learned word from the learned words dictionary is to use the button Delete learned words that is available in Preferences Ignoring words You can set a list of XPath expressions that match the elements that will be ignored by spell checking in XML documents Only a small subset of XPath expressions is supported that is only the and separators and the wildcard which means expressions like a b The XPath expressions are specified in Preferences Spell checking as you type Spell checking feature can be also used as you type by enabling it from the Preferences panel When you edit a document the spell checker underlines the words with errors in real time and you can correct them when they appear Also for words
371. ion allows to specify extension object http msdn microsoft com library default asp url library en us cpguide html cpconxsltargumentlistforstylesheetparametersextensionobjects asp classes whose public methods then can be used as extension functions in an XSLT stylesheet It is a comma separated list of namespace qualified extension object class names Each class name must be bound to a namespace URI using prefixes as when providing XSLT parameters http www xmllab net Products nxslt tabid 62 Default aspx parameters MSXML NET supports rich library of the EXSLT http www exslt org and EXSLT NET http www xmllab net exslt extension functions via embedded or plugged in EXSLT NET http workspaces gotdotnet com exslt library EXSLT support is enabled by default and cannot be disabled in this version If you want to use an external EXSLT NET implementation instead of a built in one use this option This option allows to specify user credentials to be used when loading XML source documents The credentials should be provided in the username pass word domain format all parts are optional 392 Configuring the application Credential loading stylesheet This option allows to specify user credentials to be used when loading XSLT stylesheet documents The credentials should be provided in the username pass word domain format all parts are optional FO Processors Besides the built in formatting objects processor Apach
372. ions of the referred resource you can use the Refresh references action Please note that the content of the expanded external entities can only be refreshed by using the Reload action Finding and replacing text The Find Replace dialog can be used in the Author page in the same way as in the Text page These limitations can be compensated by using the Find All Elements dialog Contextual menu More powerful support for editing the XML markup is offered via actions included in the contextual menu Two types of actions are available generic actions actions that not depends on a specific document type and document type actions actions that are configured for a specific document type 74 Authoring in the tagless editor Figure 5 17 Contextual menu Edit Attributes Alt Shift Enter Rename para Rg Paste Ctrl Paste as XML Select Refactoring gt Insert Entity Open File at Caret F3 B Bold Ctrl Shift B T italic U Underline Ctrl Shift U a Link Insert Section Y Insert Paragraph Ctri Shift P EJ Insert Graphic E Insert Equation t List E Table Generate IDs Options The generic actions are e Rename the element from the caret position can be renamed quickly using the content completion window If the Allow only insertion of valid elements and attributes schema aware option is enabled only the proposals from the content completion list are allowed otherwise a custom ele
373. is ccatse iii reta tada recabada 163 Configuring the ToO DatS sis scsnss deen yesh cuies swan aii lohan geese eee oak ninia isis 164 Configuring the Main Menu cece cece ceec E a E E E 165 Configuring the Contextual Menu 0 eee cee cee ce eeeeeeea seca eeae eens eeueeneeeneees 166 Author Default Operations 2 0 00 0 ce rece cece EEEE Een EEE oa Ear EEE sean eeue esas 166 The arguments of Insert Fragment Operation s sseesrssesresresrerreseeerese 167 The arguments of SurroundWithFragmentOperation cccocccononncononocinones 169 Java API Extending Author Functionality through Java ooocconcnnccnnccnnccnnccnncnnnconaconicnnono 169 Example 1 Step by Step Example Simple Use of a Dialog from an Author Opera TODS io Steed euane es deat tea cey hun des ua Soop aio one ida ea tush wetese abuse syst vend 170 Example 2 Operations with Arguments Report from Database Operation 173 Configuring New Elle Templates 0s 302 2 coli sede nse suchas cad eee E ae Sereda ong E 178 Configuring XML Catalogs wii A es ed ee 180 Configuring Transformation Scenarios ccooccccnoccnnoccnnnconnnconnncnnnncnnnnncnoncrnnnnconnnrcnonccnnnnccnnninnns 181 Configuring EXtenS1onsy ci o edie ah Se Sah ak See a SERES 183 Configuring an Extensions Bundle e cece cece cece cence nee ce cece ceca cece eens een eeneeeeeeeeeeeeees 184 Implementing an Author Extension State Listener ooocooccnccnnccnnconnconncon
374. ist with one list item Insert List Item inserts a new list item for in any of the above three list types Insert Table opens a dialog that allows you to configure the table to be inserted The dialog allows the user to configure the number of rows and columns of the table if the header and footer will be generated and how the table will be framed Also CALS or HTML table model can be selected Note Unchecking the Title checkbox an informaltable element will be inserted Insert Row inserts a new table row with empty cells The action is available when the caret position is inside a table Insert Column inserts a new table column with empty cells after the current column The action is available pty when the caret position is inside a table y Insert Cell inserts a new empty cell depending on the current context If the caret is positioned between two cells a new one will be inserted at caret s position If the caret is inside a cell then the new one will be created after the current cell Delete Column deletes the table column where the caret is located ES Delete Row deletes the table row where the caret is located Join Row Cells joins the content of the selected cells The operation is available if the selected cells are from the same row and they have the same row span The action is also available when the selection is missing but the caret is positioned between two cells A Join Cell Above joins
375. ity is good for retrieving nodes from within documents e Adding editing indices e Node the node name e Namespace the index namespace e Index strategy e Index type e Uniqueness indicates whether the indexed value must be unique within the container e Path type e node indicates that you want to index a single node in the path e edge indicates that you want to index the portion of the path where two nodes meet e Node type e element an element node in the document content e attribute an attribute node in the document content metadata a node found only in a document s metadata content e Key type e equality improves the performances of tests that look for nodes with a specific value e presence improves the performances of tests that look for the existence of a node regardless of its value e substring improves the performance of tests that look for a node whose value contains a given substring e Syntax types the syntax describes what sort of data the index will contain and is mostly used to determine how indexed values are compared Actions available at resource level Refresh performs a refresh of the selected resource S Open opens the selected resource in the editor e Rename allows you to change the name of the selected resource e Move allows you to move the selected resource in a different container in the database tree also available through drag and drop X Delete removes the selected reso
376. ive Using Check Spelling The Check Spelling option XML gt Check Spelling Ctrl Shift Q or the toolbar button A Check spelling enables you to perform the check spelling on the current document Figure 16 2 Check Spelling Dialog Spelling Unrecognized word Worket Replace with Worker Guess Replace Replace all Ignore Ignore all Worker Worked Workers Workout Market Workup Corker Forker Porker Wicket Wormer Worser Yorker Learn EEE Dictionary English O Begin at caret position Complete the dialog as follows Unrecognized Word Contains the word that cannot be found in the selected dictionary The word is also highlighted in the XML document 345 Text editor specific actions Replace with The character string which is suggested to replace the unrecognized word Guess Displays a list of words suggested to replace the unknown word Double clicking a word in this list automatically inserts it in the document and continues the spell checking process Dictionary Displays a list with the available dictionaries Replace Replaces the currently highlighted word in the XML document with the selected word in the Replace with field Replace All Replaces all occurrences of the currently highlighted word in the XML document with the selected word in the Replace with field Ignore Allows you to continue checking the document while ignoring
377. ive DB 323 eXist 322 MarkLogic 322 Tamino 322 TigerLogic 323 database connections configuration 324 Berkeley DB XML 324 Documentum xDb X Hive DB 326 eXist 324 MarkLogic 325 Tamino 325 TigerLogic 326 resource management Data Source Explorer view 327 NVDL document type 132 association rules 132 Author extensions 133 O OASIS XML Catalog document type 131 association rules 131 schema 131 Open Office ODF document type 130 association rules 131 schema 131 Q Querying documents running XPath expressions 303 XPath console 303 R Relational databases 311 connections configuration 313 IBM DB2 314 JDBC ODBC connection 314 Microsoft SQL Server 315 MySQL 315 Oracle 11g 315 PostgreSQL 8 3 316 data sources configuration 311 generic JDBC data source 312 IBM DB2 311 Microsoft SQL Server 312 MySQL 312 Oracle 11g 313 PostgreSQL 8 3 313 resource management 316 Data Source Explorer view 316 Table Explorer view 319 RelaxNG document type 132 association rules 132 Author extensions 132 415 Index S Schematron 1 5 document type 133 Schematron 1 5 document type association rules 133 Author extensions 133 Schematron document type 133 association rules 133 Author extensions 133 T TEI P4 document type 125 association rules 125 Author extensions 125 catalogs 127 templates 127 transformation scenarios 127 schema 125 TEI P5 document type 127 associ
378. jar multiple jar files lib java jaxws jar multiple jar files lib java utils jar multiple jar files Note If for some reason the jar files are not found you can add them manually by using the Add Files and Add Recursively buttons and navigating to the lib java folder from the DFS SDK 4 Click OK to finish the data source configuration How to configure a Documentum CMS connection 1 Goto Preferences gt Data Sources In the Connections panel click the New button 2 Enter a unique name for this connection and select one of the previously configured Documentum CMS data sources from the Data Source combo box 3 Fill in the Connection Details URL URL to the Documentum CMS http lt hostname gt lt port gt User User name to access the Documentum CMS repository Password Password to access the Documentum CMS repository Repository The name of the repository to log into 4 Click OK Documentum CMS actions lt oXygen gt allows the user to browse the structure of a Documentum repository in the Data Source Explorer view and perform various operations on the repository resources 334 Content Management System CMS Integration You can drag and drop folders resources to other folders to perform Move Copy operations with ease If the drag and drop is between resources you can create a relationship between the respective resources Drag the child item to the parent item Figure 14 1 Browsi
379. k import org xml sax Attributes import ro sync ecss extensions api DocumentTypeCustomRuleMatcher public class CustomRule implements DocumentTypeCustomRuleMatcher pk Checks if the root namespace is the one of our documentation framework y public boolean matches String systemID String rootNamespace String rootLocalName String doctypePublicID Attributes rootAttributes return http www oxygenxml com sample documentation equals rootNamespace public String getDescription return Checks if the current Document Type Association is matching the document DefaultElementLocatorProvider java package ro sync ecss extensions commons import org apache log43 Logger 262 Author Developer Guide ro nc ecss extensions link import import Elementl Element apl apl sy ro sync ecss extensions link OCator OcatorException import ro sync ecss extensions link ElementlI sy OCatorProvider api import ro sync ecss extensions api link Default implementatio Depending on the lin xinclude element sc n for locating elements K heme element 1 2 se structure the following cases ar IDTypeVerifier based on a given link covered http www w3 ID based links t org TR 2003 REC xptr el A he link represents the va e men lue 20030325 of an attribute
380. kbox Replace selection with content reference with the default value selected 6 Press the Save button which will open a file system dialog where you have to select the folder and enter the name of the file that will store the reusable component 7 Press the Save button in the file system dialog to save the the reusable component in a file If the checkbox was selected in the Create Reusable Component dialog the conref attribute will be added to the element that was ex tracted as a separate component In Author mode the content that is referenced by the conref attribute is displayed with grey background and is read only because it is stored in other file 105 Author for DITA Optionally to insert a reference to the same component in other location just place the cursor at the insert location and run the action Insert Reusable Component that is available on the DITA menu the Author framework actions toolbar and the contextual menu of the Author editor Just select in the file system dialog the file that stores the component and press the OK button The action will add a conref attribute to the DITA element at the insert loc ation The referenced content will be displayed in Author mode with grey background to indicate that it is not editable Optionally to edit the content inside the component just click on the open icon 22 at the start of the grey background area which will open the component in a separate editor Insert a direct
381. keeps a history of the last used schemas lt oXygen gt logs the URL of the detected schema in the Status view The oxygen processing instruction has the following attributes RNGSchema specifies the path to the Relax NG schema associated with the current document type specifies the type of Relax NG schema is used together with the RNGSchema attribute and can have the value xml or compact NRLSchema specifies the path to the NRL schema associated with the current document NVDLSchema specifies the path to the NVDL schema associated with the current document SCHSchema specifies the path to the SCH schema associated with the current document Associating a schema with the namespace of the root element The namespace of the root element of an XML document can be associated with an XML Schema using an XML catalog If there is no xsi schemaLocation attribute on the root element and the XML document is not matched with a document type the namespace of the root element is searched in the XML catalogs set in Preferences If there is an element uri or rewriteUri or delegateUri in the XML catalog that associates the namespace with a schema that schema will be associated with the XML document Learning document structure When working with documents that do not specify a schema or for which the schema is not known or does not exist lt oXygen gt is able to learn and translate it to a DTD which in turn can be saved to a file in order to provide a
382. ken into ac count This option forces validation against a referred schema XML Schema Relax NG schema Schematron schema even if the document includes also a DTD declaration It is useful when the DTD declaration is used to declare entities and the schema reference is used for validation Enable XInclude processing if checked the XInclude support in lt oXygen gt is turned on Xerces XML Parser documentation According to the specification for XIn clude processors must add an xml base attribute to elements included from locations with a different base URI Without these attributes the resulting infoset information would be incorrect Unfortunately these attributes make XInclude processing not transparent to Schema validation One solution to this is to modify your schema to allow xml base attributes to appear on elements that might be included from different base URIs 383 Configuring the application If the addition of xml base and or xml lang is undesired by your application you can disable base URI fix up Language fix up Xerces XML Parser documentation The processor will preserve language in formation on a top level included element by adding an xml lang attribute if its include parent has a different language property If the addition of xml lang is undesired by your application you can disable the Language fix up Check ID IDREF Checks the ID IDREF matches when the Relax NG document is validated
383. key references are rendered as images 114 Predefined document types File Reference inserts an xref element with the value of attribute format set to xml Web Link inserts an xref element with the value of attribute format set to html and scope set to external Related Link to Topic inserts a link element inside a related links parent Related Link to File inserts a link element with the format attribute set to xml inside a related links parent Related Link to Web Page inserts a link element with the attribute format set to html and scope set to external inside a related links parent Note The actions for inserting references described above are grouped inside link toolbar actions group 5 Insert Section Step inserts a new section step in the document depending on the current context A new section will be inserted in either one of the following contexts e section context when the value of class attribute of the current element or one of its ancestors contains topic or s section e topic s body context when the value of class attribute of the current element contains topic body A new step will be inserted in either one of the following contexts e task step context when the value of class attribute of the current element or one of its ancestors contains task step e task steps context when the value of class attribute of the current element contains task steps T I
384. l gt 27 Editing documents Select menu Document Schema gt Associate schema or click the toolbar button 4 Associate schema to open a dialog for selecting a schema used for Content Completion and document validation The schema is one of the types XML Schema with or without embedded Schematron rules DTD Relax NG XML syntax with or without embedded Schematron rules Relax NG compact syntax NRL NVDL Schematron This is a dialog helping the user to easily associate a schema file with the edited document Enables definition of a XML Document Prolog using the system identifier of a XML Schema DTD Relax NG full or compact syntax schema NRL Namespace Routing Language schema NVDL Namespace based Validation Dispatching Language schema or Schematron schema If you associate an XML Schema with embedded Schematron rules or a Relax NG schema XML syntax with embedded Schematron rules you have to check the Embedded Schematron rules checkbox available for these two types of schemas Embedded Schematron rules are not supported in Relax NG schema with compact syntax When associating a XML Schema to the edited document if the root element of the document defines a default namespace URI with a xmlns attribute the Associate schema action adds a xsi schemaLocation attribute Otherwise it adds a xsi noNamespaceSchemaLocation attribute The URL combo box contains a predefined set of schemas that are used more often and it also
385. l reel eth oie ceed eee ti lid loli sce 34 The Elements VIEW tatoo dei Sumac eo Sadeee yp wba ss over toes Rai 35 Th Entities VIEW cota a dude aged evict Och Sage Need Suds tet ade del estan doled 35 Validating XML documents ses renn sa gan lease ANT 36 Checking XML well formedness 1 0 0 0 0c cece cece cece ceee ce ecce cece cena cena ceneeeaeeeaeceeeeeeeeaeesaeeaaes 36 Validating XML documents against a schema cece cece cece eee ee eece cece cena cena eeneeeeeeeeeeeeees 38 Marking Validation Errors ao aer E E a aa coats ee ls eek a Pa Wen ee ase 38 Validation Example iccs csacs poroso foetus anu chtes ates geste eetdans A a Ea ANEA 39 Caching the Schema Used for Validation 2 0 0 0 0 cece ece cee cc ence ence neces ceeeceeeeneeeneeeaes 39 Nalidate AS A O 39 Custom validation of XML documents coooccnncnnccnnccnnconoconocnnconnconnconnconnconnconncnnnconnss 40 Linked output messages of an external engine ooccoccocnnccoconcnnconcnnconcnnconcnnronnns 41 Validation SCA ci do 42 Sharing the Validation Scenarios Project Level Scenarios ocoooccncccnccnnccnnocnninnnronacnnos 45 Validation Actions in the User Interface coooconoccnccnnocnnccnncnnocnnccnnconnconnccnnconncnnncnnnoos 45 Resolving references to remote schemas with an XML Catalog oocccoocccnnccncnoccnnncnnnnoos 46 Document navigation yest eee Lessee ta a 46 Folding of the XML Clement eos 0 cases snye ser e somes de o E airoso 46 OUTING VIEW is
386. l start on the highlighted line this line is optional in a linked message e Description message content the string Description followed by the content of the message that will be displayed in the output view Validation Scenario A complex XML document is usually split in smaller interrelated modules which do not make much sense individually and which cannot be validated in isolation due to interdependencies with the other modules A mechanism is needed to set the main module of the document which in fact must be validated when an imported module needs to be checked for errors A typical example is the chunking DocBook XSL stylesheet which has chunk xs1 as the main module and which imports a stylesheet module called param xs1 which only defines XSLT parameters and other modules called chunk common xsl and chunk code xs1 The module chunk common xs1 defines a named XSLT template with the name chunk which is called by chunk code xs1 The parameters defined in param xs1 are used in the other modules without being redefined Validation of chunk code xsl as an individual XSLT stylesheet issues a lot of misleading errors referring to parameters and templates used but undefined which are only caused by ignoring the context in which this module is used in real XSLT transformations and in which it should be validated To validate such a module properly a validation scenario must be defined which sets the main module of the stylesheet and als
387. l asp Validate documents during parse If checked and either the source or style sheet document has a DTD or schema phase against which its content should be checked validation is performed Do not resolve external definitions By default MSXSL instructs the parser to resolve external definitions such as during parse phase document type definition DTD external subsets or external entity references when parsing the source and style sheet documents If this option is checked the resolution is disabled Strip non significant whitespaces If checked strip non significant white space from the input XML document during the load phase Enabling this option can lower memory usage and improve transformation performance while in most cases creating equivalent output Show time information If checked the relative speed of various transformation steps can be measured time to load parse and build the input document time to load parse and build 390 Configuring the application the style sheet document time to compile the style sheet in preparation for the transformation time to execute the style sheet Start transformation in this mode Although style sheet execution usually begins in the empty mode this default may be changed by specifying another mode Changing the start mode allows execution to jump directly to an alternate group of templates MSXML NET The MSXML NET preferences panel is opened from menu Window Preferences
388. l be returned to the message panel For each occurrence of the element node a record will be created in the result list In the example an XPath query on the file oxygen xm1 determined that oxygen xml chapter 1 sect1 3 sect2 7 example 1 Which means In the file oxygen xml first chapter third section level 1 seventh section level 2 the example node found is the first in the section Note a If your project is comprised of a main file with ENTITY references to other files you can use XPath to return all the name elements of a certain type by querying the main file The result list will query all referenced files Important If the document defines a default namespace then lt oXygen gt will bind this namespace to the first free prefix from the list default defaultl default2 etc For example if the document defines the default namespace xm Ins something and the prefix default is not associated with a namespace then you can match tags without prefix in a XPath expression typed in the XPath console by using the prefix default For example to find all the level elements when the root element defines a default namespace you should execute in the XPath console the expression default level To define default mappings between prefixes that can be used in the XPath console and namespace URIs go to the XPath Options user preferences panel and enter the mappings in the Default prefix namespace mappings table The same p
389. lds are described as follows Element name The target element name to search for Only the elements with this exact name are returned For any element name just leave the field empty Element text The target element text to search for The combo box beside this field allows you to specify that you are looking for an exact or partial match of the element text For any element text select contains in the combo box and leave the field empty 344 Text editor specific actions Attribute name Attribute value Case sensitive If you leave the field empty but select equals in the combo box only elements with no text will be found Select not contains to select all elements which do not have the specified text inside The name of the attribute which needs to be present in the elements Only the elements which have an attribute with this name will be returned For any no attribute name just leave the field empty The attribute value The combo box beside this field allows you to specify that you are looking for an exact or partial match of the attribute value For any no attribute value select contains in the combo box and leave the field empty If you leave the field empty but select equals in the combo box only elements that have at least an attribute with an empty value will be found Select not contains to select all elements which have attributes without a specified value When this option is checked operations are case sensit
390. le Seon A A A eae AS 134 Sch ma ati a a a riel cla nd ii oi ide 134 Author extension S a A a E pri R EO 134 Templates so tdi E secre aces E E EERE E E aE GS EEPE 134 Catalogs ai A A Sadan oad E dad neste S 134 Transformation Scenarios resien sects ma dee ae e R a E E R EE S 134 The FO document PE A A IO DE a TEES 134 A ON 135 O O pean Uae tos iene doesn ee eae 135 AUthOT EXTENSIONS eres 508 E otdens seats Acepta AEE Couey about suede man seatensroed Seas 135 Transformation Scenarios decir e aa 135 The EAD documenttypes testy sone sstuseleeeh A deeds oeennede TYEE EEEN 135 ASSOCIALION TUES valia A Ata 135 O ON 135 AUthOr Extension du dsd 135 O NR 135 Catalogs ii A A a ned SI ES 135 s Author Developer Gulden titi ir tirarle EAE sit 136 INOCUIDAD 136 Simple Customization Tutorial 4 55 00 3 ef evga ib lors os Sewn Ee E op tad gee pass faldones 137 XML Schema ssc oie ons Sade AAA inde E E E AT 137 Writing the CSS aiee e a a tote deh aernusnthecashedaen seus davgduyedousnetdanguweades S aE 138 The XML Instance Template neei E i s EEE AA AA E EE AEUR a EEEa EASES 141 Advanced Customization Tutorial Document Type Associations occooccnnccnncnnnconicnnccnnncnnnonononaronicnnn 142 Creating the Basic Association iio do ie ET 142 Errst step XML Schema ito ne ter 000k oe dealer canes feels e a S 142 Second step The CSS yori eects ern ii ii fai ai 144 Defining the General L yo t epes eoe a r incaico yee 145 Styling thesect ton Ele
391. lected cell is painted with a color that is different from the rest of the selection You can select discontinuous regions of nodes and place them in the clipboard using the copy action Pasting these nodes may be done in two ways relative to the current selected cell by default as brother just below after or as last child of the selected cell The paste as child action is available in the contextual menu Paste as Child The copied nodes from the grid can be pasted also into the text editor or other applications When copying from grid into the text editor or other text based applications the inserted string represents the nodes serialization The nodes from tables can be copied using HTML or RTF in table format The resulting cells contain only the concatenated values of the text nodes 273 Grid Editor Figure 9 5 Copying from grid to other editors lt email chiefvoxygenxml com email gt lt email one oxygenxml coms email lt email three oxygenxml coms email gt lt email four oxygenxml coms email lt email five oxygenxml coms email email chief oxygenxml com one oxygenxml com two oxygenxml com three oxygenxml com four oxygenxml com five oxygenxml com 2 chief oxygenxml com 3 lone oxygenxml corm ls lthree oxygenxml corm 6 four oxygenxml com 7 five oxygenxml com In the grid editor you can paste wellformed xml content or tab separated values from other edit
392. left part of the document editor next to the start tag of that element or click on the action r Toggle fold Ctrl Alt Y available from the context menu Other menu actions related to folding of XML elements are available from the context menu of the current editor Document Folding Close Other Folds Ctrl NumPad Fold all the sections except the current element Document Folding Collapse Child Folds Fold the sections indented with one level inside the current element Document Folding Bo Expand Child Folds Ctrl NumPad Cmd NumPad Unfold the sections in dented with one level inside the current element Document Folding P gt Expand All Ctrl NumPad Cmd NumPad on Mac OS Unfold all the sections inside the current element Document Folding gt Toggle Fold Alt Shift Y Cmd Alt Y on Mac OS Toggles the state of the current fold You can use folding by clicking on the special marks displayed in the left part of the document editor Outline View The Outline view has the following available functions e the section called XML Document Overview e the section called Outliner filters e the section called Modification Follow up e the section called Document Structure Change e the section called Document Tag Selection 47 Editing documents Figure 4 25 The Outline View TP Sn a W a pE Outline 2 RANES E personnel person Big Boss name
393. lement inserted with the help of the Content Completion assistant This option is applied also in the Author mode of the XML editor 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 Content Completion assistant This option is applied also in the Author mode of the XML editor When checked lt oXygen gt will remember the last inserted items from the Content Completion window The number of items to be remembered is limited by Maximum number of recent items shown combo box These most frequently used items are displayed on the top of Content Completion window and their icon is decorated with a small red square This option is applied also in the Author mode of the XML editor Limits the number of recently used items presented at the top of the content completion window This option is applied also in the Author mode of the XML editor When checked lt oXygen gt will display a list with all attributes values learned from the current document This option is applied also in the Author mode of the XML editor When checked lt oXygen gt will automatically learn the document structure when the document is opened This option is applied also in the Author mode of the XML editor When checked lt oXygen gt will automatically learn the typed words and will make them available in a Content Completion fashion by pressing CTRL SPACE
394. lement only content None strips no whitespace before further processing However whitespace will still be stripped if this is specified in the stylesheet using xsl strip space Saxon9SA specific options Schema based validation of the source file This determines whether source documents should be parsed with schema validation enabled Lax schema based validation of the source file This determines whether source documents should be parsed with schema validation enabled Validation errors in the result tree treated as warnings If checked all validation errors are treated as warnings oth erwise they are treated as fatal Saxon HE PE EE Advanced options The Saxon HE PE EE Advanced preferences panel is opened from menu Window Preferences Au thor XML XSLT FO XQuery XSLT Saxon Saxon HE PE EE Advanced The advanced XSLT options which can be configured for the Saxon 9 transformer both the Basic and the Schema Aware versions are Figure 17 41 The Saxon HE PE EE XSLT Advanced preferences panel Advanced Ae URI Resolver class name r Collection URI Resolver dass name cr The resolver classes must be present in the scenario extensions URI Resolver class name Allows the user to specify a custom implementation for the URI resolver used by the XSLT Saxon 9 transformer r option when run from the command line The class name must be fully specified and the corresponding jar or class extension must b
395. lesheets may be executed Also disables user defined extension elements to gether with the writing of multiple output files all of which carry similar security risks e Policy for handling recoverable errors in the stylesheet Allows the user to choose how dynamic errors will be handled Either one of the following options can be selected recover silently recover with warnings or signal the error and do not attempt recovery Saxon HE PE EE The Saxon HE PE EE preferences panel is opened from menu Window Preferences Au thor XML XSLT FO XQuery XSLT Saxon Saxon HE PE EE The XSLT options which can be configured for the Saxon 9 transformer both the Basic and the Schema Aware versions are Figure 17 40 The Saxon HE PE EE XSLT preferences panel Saxon HE PE EE e gt y Saxon HE PE EE options C version warnings not novw DTD based validation of the source file v Line numbering 1 Recoverable errors Recover with warnings w1 x Strip whitespaces None snone x Optimization level 10 v Saxon PE EE options Disable calls on extension Functions noext Saxon EE specific options Validation of the source file Lax schema validation vlax x Validation errors in the result tree treated as warnings vw e Version warnings If checked a warning will be generated when running an XSLT 2 0 processor against an XSLT 1 0 stylesheet The XSLT specification r
396. ley data sources from the Data Source combo box Fill in the Connection Details Environment home directory Path to the Berkeley DB XML s home directory Verbosity The user can choose between four levels of verbosity DEBUG INFO WARNING ERROR Join existing environment If checked an attempt will be made to join an existing environment in the specified home directory and all the original environment settings will be preserved If that fails you should consider reconfiguring the connection with this option unchecked Click OK How to configure an eXist Connection l 2 Go to Preferences gt Data Sources In the Connections panel click the New button Enter a unique name for this connection and select one of the previously configured eXist data sources from the Data Source combo box Fill in the Connection Details XML DB URI URI to the installed eXist engine User User name to access the eXist database engine 324 Working with Databases 4 Password Password to access the eXist database engine Collection eXist organizes all documents in hierarchical collections Collections are like directories They are used to group related documents together This text field allows the user to set the default collection name Click OK How to configure a MarkLogic Connection 1 2 4 Go to Preferences gt Data Sources In the Connections panel click the New button Enter a unique name for this connec
397. ll 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 ib subdirectory of the in stallation 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 Saxon6 The Saxon 6 preferences panel is opened from menu Window Preferences Au thor XML XSLT FO XQuery XSLT Saxon Saxon 6 386 Configuring the application Figure 17 39 The Saxon 6 XSLT preferences panel Saxon6 C Line numbering I C Disable calls on extension functions noext Handling of recoverable stylesheet errors O Recover silently w0 Recover with warnings 41 O Signal the error and do not attempt recovery w2 Line numbering If checked line numbers are maintained for the source document e Disable calls on extension functions If checked external functions called is disallowed Checking this is recommended in an environment where untrusted sty
398. ll value You can simply press ENTER after you have selected the grid cell Stop editing a cell value You can either press ENTER when already in cell editing To cancel the editing without saving in the document the current changes you have to press the ESC key 272 Grid Editor Drag and Drop DnD in the Grid Editor The DnD features of the grid editor make easy the arrangement of the different sections in your XML document Using DnD you can e Copy or move a set of nodes e Change the order of columns in the tables e Move the rows from the tables These operations are available for single selection and multiple selection Note that when dragging the editor paints guide lines showing accepted locations where the nodes can be dropped Nodes can be dragged outside the grid editor and text from other applications can be dropped inside the grid See Copy and Paste in the Grid Editor for details Copy and Paste in the Grid Editor The selection in the grid is a bit complex relative to the selection in a text component It consists of a current selected cell and additional selected cells These additional cells are either hand picked by the user using the mouse or are implied by the current selected cell To be more specific let s consider you click the name of the column this becomes the current selected cell the editor automatically extends the selection so it contains also all the cells from that column The current se
399. log level Refresh performs a refresh of the selected node s subtree Actions available at schema level Refresh performs a refresh of the selected node s subtree Actions available at table level Refresh performs a refresh of the selected node s subtree Edit opens the selected table in the Table Explorer View _JExport to XML opens the Export Criteria dialog XML Schema Repository level For relational databases that support XML schema repository XSR in their database catalogs the actions available at this level are presented in the following sections Oracle s XML Schema Repository Level Refresh performs a refresh of the selected node s subtree e Register Opens a dialog for adding a new schema file in the DB XML repository To add an XML Schema enter the schema URI and location on your file system Local scope means that the schema will be visible only to the user who registers it Global scope means that the schema is public IBM DB2 s XML Schema Repository Level Refresh performs a refresh of the selected node s subtree e Register opens a dialog for adding a new schema file in the XML Schema repository In this dialog the following fields can be set e XML schema file location on your file system e XSR name schema name e Comment short comment optional e Schema location primary schema name optional Decomposition means that parts of the XML documents are sto
400. lt oXygen gt XML Author 11 2 User Manual for Eclipse THE UE PUNCH ON 2 45 se sec a a e a a a n E a a 223 Th e bas SUENA CIAO E r e eee ce r 224 The parent urT UNC A E 224 The capitals Ze UNC a a a E EE 224 The uppercase function A ee el 224 The lowercase J UOC usd dde riiask 224 Th concat A UIC A Sa ad 224 The rep kacei UOC ile 225 The unparsed entity uri function 20 0 cece cece ee eee cee eeeeneeeeneeneneeee 225 Theattributes TUN CON drid 226 Example Files Listing Sissener ase EE EEEE EEES ea EEEE E EEE EEEE 226 The Simple Documentation Framework Files ssesssssessseersererreresrrerssrrresrreersrrrrrreesrereesreees 226 XME Schema files A iia 226 o A 226 o A O NN NS 228 CSS Ple cn moni ERRE DAA 228 AE A ea eat Mea Lebar ee 228 A A RO NEET 230 Saf Samp Lex AMO ai 230 KSLA BIUES Fics fetaveasverstinceteastanatt conde eve races we eine as deco laste RR 232 SOE CRS O NO 232 NON 234 Insert Image Operation Java O E EE A A lis 234 Quer yDatabaSeOPe rats One JAVA Hwecrgrsp euecss sense SS ENEE E Ence eens 238 SDFEXtenSTONSBUNGLESs Java oia 241 SDFSchemaManagerFilter JAVA ococcccncnconcncnnoncnnnncnnoncnnoncncononconcnconenconencnss 244 SDFSchemaAwareEditingHandler JaVa ocococcncnncncnnoncnnencncnnnnccnccnnnonconancnos 245 TableCellSpanProvider JAVA imstande Rie 252 TableColumnWidthBrovidel Ja Vaud roer aut 254 ReferencesResolver JaVa ccoccncccnconcnnoncncononnnncncn
401. lude postvalid cf E O Name Executable path Working directory Associated editors Command line arguments for detec ted schemas Name of the custom validation tool displayed in the Custom Validation Engines toolbar Path to the executable file of the custom validation tool You can insert here editor variables like homeDir pd etc The working directory of the custom validation tool The following editor vari ables can be used homeDir The path to user home directory pd Project directory oxygenInstallDir lt oXygen gt installation directory The editors which can perform validation with the external tool Command line arguments used to validate the current edited file against different types of schema W3C XML Schema Relax NG full syntax Relax NG compact syntax Namespace Routing Language Schematron DTD other schema type The arguments can include any custom switch like rng and the editor variables S cf The path of the currently edited file S cfu Path of current file URL 380 Configuring the application S ds The path of detected schema file S dsu The path of detected schema file URL CSS Validator The CSS Validator preferences panel is opened from menu Window Preferences gt Author CSS Validator Figure 17 31 CSS Validator preferences panel CSS Validator lt P y Profile C553 bd Media Type handheld X Warning level Normal y P
402. m other distribution 408 import export global options 349 license 350 Network Connections 405 outline 407 reset global options 408 scenarios management 407 408 view 408 XML 381 XML catalog 381 XML parser 383 Saxon EE Validation 384 XProc 384 XSLT 386 XSLT FO XQuery 386 XSLT FO XQuery preferences custom engines 397 FO Processors 393 MSXML 390 MSXML NET 391 Saxon HE PE EE 387 Saxon HE PE EE advanced options 388 Saxon6 386 XPath 395 XSLTProc 389 Content Management System 333 copy paste grid editor 273 CSS support in lt oXygen gt Author lt oXygen gt CSS extensions 214 Media Type oxygen 214 CSS 2 1 features properties support table 211 supported selectors 209 unsupported selectors 210 Customization support 136 Document Type Associations advanced customization tutorial 142 Author Settings 159 Basic Association 142 configuring extensions Link target reference finder 191 configuring Transformation Scenarios 181 New File Templates 178 XML Catalogs 180 example files 226 the Simple Documentation Framework Files 226 simple customization tutorial CSS 138 XML Instance Template 141 XML Schema 137 D Databases 311 Native XML databases NXD 321 Relational databases 311 WebDAV Connection 330 Digital signature 339 canonicalizing files 340 certificates 341 signing files 342 verifying the signature 343 DITA Map DITA specialization support 103 editing DITA Topic sp
403. mand and enter as password any combination of at least 6 characters This will set the password for future operations with the key store 3 Restart Eclipse Opening the current document in a Web browser To open the current document in the default Web browser installed on the computer use the action Open in browser available on menu XML and also on the Document toolbar It is useful for seeing the effect of applying an XSLT stylesheet or a CSS stylesheet on a document which specifies the stylesheet using an xml stylesheet processing instruction Closing documents To close documents use one of the following methods e File gt Close Ctrl F4 Closes only the selected tab All other tab instances remain e File gt Close All Ctrl Shift F4 Closes all opened documents If a document is modified or has no file a prompt to save not to save or cancel the save operation is displayed e Close accessed by right clicking on an editor tab Closes the selected editor e Close Other Files accessed by right clicking on an editor tab Closes the other files except the selected tab e Close All accessed by right clicking on an editor tab Closes all open editors within the panel Viewing file properties In the Properties view you can quickly access information about the current edited document like the character encoding full path on the file system schema used for content completion and document validation document type name and path ass
404. ment Type specific page setting to override the general page settings Select the initial page for each editor Editor Page MERRITT A XS5D Editor Design WSDL Editor Text XSL Editor Text NRL Editor Text NYDL Editor Text XProc Editor Text RNG Editor Text Schematron Editor Text Allow Document Type specific page If checked the initial page setting from the Document type dialog will override setting to override the general page the general page setting setting Grid The Grid preferences panel is opened from menu Window gt Preferences gt Author Editor Grid Figure 17 8 The Grid editor preferences panel Grid ae Compact representation C Format and indent when passing From grid to text or on save Default column width characters 16 Current selection color Selection color j Border color eel mm mm m E cc Foreground color Row header colors Background color Current selection color Selection color Column header colors Background color E E E E Current selection color mua cS E SS es ss a Selection color Compact representation If checked a child element is displayed at the same height level with the parent element If unchecked a child elements is presented nested with one level in the parent container that is lower than the parent with one row 355 Configuring the application Format and indent when passing from grid to
405. ment ii ed ae ee tees 145 Styling thet abe Elements scsroea sos deee igen scout das dey saceoy ees oa ioe iden E EESE 147 Styling the Inline Elements n i e ec e ce cee ece cece nee E TaN A SE OEE essa sean EEEE 149 Styling Elements from other Namespace oooccccoccconccnnnnccnnncnnnnccnnnncnnnocnnnncinnnncnonicnns 149 Styling Image S Tap da aaa aoe se 150 Marking elements as foldable ooooonccnnoccnnnccnnnccnnnnccnnoncnnncnnnnnconnccnnnnccnnnncnnnioos 151 Marking elements as NKS i eeose e eee c eee c eee a KETE r ESE o EE O RE 152 Third Step THE ASSoc1at ons oS onesie ean a E o E E E AEN E NES 152 Organizing the Framework Files oooocoooccnnccnnconoconoconocnnncnnnnnnnonnronoronncnnconncinncnnno 153 ASSOCIATION MA OO 154 Java API Rules implemented in Java ooooconocnnccnnncnnccnncnnocnnccnnccnnconnccnncnnnions 155 Deciding the Initial Page operation otero proc ER SE E NE EA tics 157 Schema Settings uma aii 157 Author CSS SONES patricia e a te oedaeacten a a E E E Eaa 157 Testing the Document Type Association oocoooccnnconcconcconocnnncnnocnncnnnconoronccnnconnrinnnnno 158 Packaging and Deploying sesers ess sua desea E RRE EE SIT EENE SEIE 159 viii lt oXygen gt XML Author 11 2 User Manual for Eclipse A NS 159 Configuring Actions Menus and Toolbars ooocooccnnccncccnncnnccnnccnnccnnconnccnnconnconaconncnnncnnnes 160 The Insert Secom Acton s es dalt trote dpi 160 The Insert Table ACton i
406. ment name can also be provided e Cut Copy Paste common edit actions with the same functionality as those found in the text editor e Paste As XML similar to Paste operation except that the clipboard s content is considered to be XML e Select contains the following actions e Select gt Select Element selects the entire element at the current caret position e Select gt Select Content selects the entire content of the element at the current caret position excluding the start and end tag Performing this action repeatedly will result in the selection of the content of the ancestor of the currently selected element content Select gt Select Parent selects the parent of the element at the current caret position Note You can select an element by triple clicking inside its content If the element is empty you can select it by double clicking it e Refactoring contains a series of actions designed to alter the document s structure Toggle Comment encloses the currently selected text in an XML comment or removes the comment if it is commented 75 Authoring in the tagless editor e Split Element splits the content of the closest element that contains the caret s position Thus if the caret is positioned at the beginning or at the end of the element the newly created sibling will be empty Join Elements joins two adjacent elements that have the same name The action is available only when the
407. ment type sh n t iere eosin oes TE re E EE degodstaeen css oS 209 CSS support in lt oXygen gt Author sssini esses eseri sospes EPE Ene Ees EET E EV pies sees ctesdbeedevedssseteagens 209 CSS 2 1 feat reS ici iia ETETE 209 Supported selector sra e E T a E e E shake E pR 209 Unsupported selector sro re sees oE EEEE E EE EEEE EEI Ei 210 Properties Support Table raisers ande eeose rE S o EEE EOS EEEE PEIE RSTS EEEE PREPRESS 211 lt oXygen gt CSS Extensions siss eisien er Ee eE EEEE EEEE ETENE KEE EE EDET SE EE E E EER 214 Media Type oxygen uisome e rote O E E E E E E E rad 214 Supported Features from CSS Level 3 ooooooconoconoconoconoconccnnccnncnnoconncnnconnccnnccnnccnnconnconncos 215 Namespace Selectors cotocico spoilers iria r re ea o Ep E AAEE EEEE seers gseedebagesnntes 215 The attr function Properties Values Collected from the Edited Document 216 Additional Custom Selectors isser enina seetads este spas serve ste E ses E e eS 218 Additional Properties sss ccss cee o ictericia oes jo EO Mews eels Doses rouse ee 220 Folding elements foldable and not foldable child properties 220 Link Clements elites bosta id bon ois pod ist as 221 Display Tag Markers citrico ria ea a a N E 222 lt oXygen gt Custom CSS functions ooccooccnnconnconnconconncnnncnnncnnrnnnronccnnronnccnnccnnconnconncinices 223 The Local name UNC LON s ea aa aa E NEE PAE ENSE 223 The name C UA soesoenan e ad 223 ix
408. mentation abstracts schemaLocation http www oxygenxml com SDF abs xsd gt There is a problem with this approach What happens if an Internet connection is not available How will you check the document for errors if a part of the schema is not available The answer is to create a catalog file that will help the parser locate the missing piece containing the mapping http www oxygenxml com SDF abs xsd gt local_path abs xsd To do this create a new XML file called catalog xml and save it into the oXygen_installation_direct ory frameworks sdf directory The content of the file should be lt xml version 1 0 gt lt catalog xmlns urn oasis names tc entity xmlns xml catalog gt lt system systemId http www oxygenxml com SDF abs xsd uri schema abs xsd gt 180 Author Developer Guide lt uri name http www oxygenxml com SDF abs xsd uri schema abs xsd gt lt catalog gt This means that all the references to http www oxygenxml com SDF abs xsd must be resolved to the abs xsd file located in the schema directory The uri element is used by URI resolvers for example for resolving a URI reference used in an XSLT stylesheet Note The references in the XML catalog files are relative to the directory that contains the catalog Save the catalog file and modify the sdf xsd file by changing its import element then add the catalog to the Document Type association You can do this in the Catalo
409. ments Show attributes Show Hide attribute values for the displayed elements The displayed attribute values can be changed from the Outline preferences panel The content of the Outline view can also be filtered with patterns typed in the text field of the view The patterns can include the wildcard characters and If more than one pattern is used they must be separated by comma Any pattern is a prefix filter that is a is appended automatically at the end of every pattern 48 Editing documents Modification Follow up When editing the Outline view 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 location where in the document one is positioned and how the structure of the document is affected by one s modifications Document Structure Change Entire XML elements can be moved or copied in the edited document using only the mouse in the Outline view in drag and drop operations If you drag an XML element in the Outline view and drop it on another one in the same panel then the dragged element will be moved after the drop target element If you hold the mouse pointer over the drop target for a short time before the drop then the drop target element will be expanded first and the dragged element will be moved inside the drop target element after its opening tag You can also drop an element before or after
410. mize document XML schema DTD RNG RNC NRL NVDL URL File E Projects eXmli test RelaxNG NRL nrlSchema nrl lv use relative paths Add optional content Add First Choice particle O Complete the dialog as follows URL Specifies the location of a NRL schema NRL Figure 4 5 The Create an XML Document NVDL Tab New XML Document ls ay Customize document XML schema DTD RNG RNC NRL N DL gt URL File E samples samples nvdl xhtml xforms nvdl lv B Root Element Prefix Description use relative paths e e y Namespace https fwww w3 org 2002 xforms j Definition of bind container Add optional content Add first Choice particle Complete the dialog as follows URL Specifies the location of a Namespace based Validation Dispatching Language schema NVDL Document Root Populated from the elements defined in the specified NVDL document enables selection of the element to be used as document root 21 Editing documents Namespace Specifies the document namespace Prefix Specifies the prefix for the namespace of the document root Description Shows a small definition for the currently selected element Creating Documents based on Templates Templates are documents containing a predefined structure They provide starting points on which one can rapidly build new documents that repeat the same basic char
411. ml stylesheet processing instructions and the processing instructions define titles for the CSSs Note The CSS settings dialog allows to create a virtualxm1l st ylesheet processing instructions The CSSs defined in the Document Type Association dialog and the xml stylesheet processing instructions from the XML document are processed together as being all a list of processing instructions lt oXygen gt Author fully implements the W3C recommendation regarding Associating Style Sheets with XML docu ments For more information see _ http www w3 org TR xml stylesheet http www w3 org TR REC htm140 present styles html h 14 3 2 Testing the Document Type Association To test the new Document Type create an XML instance that is conforming with the Simple Document Format You will not specify an XML Schema location directly in the document using an xsi schemaLocation attribute lt oXygen gt will detect instead its associated document type and use the specified schema lt book xmlns http www oxygenxml com sample documentation xmlns abs http www oxygenxml com sample documentation abstracts gt lt title gt My Technical Book lt title gt lt section gt lt title gt XML lt title gt lt abs def gt Extensible Markup Language lt abs def gt lt para gt In this section of the book I will explain different XML applications lt para gt lt section gt lt book gt 158 Author Developer Guide Whe
412. mp amp oadingErrors amp amp authorSchemaManager getAu handleInsertionEvent handleInsertionEvent offset fr return handleInsertionEvent pk see ro sync ecss extensions ro sync ecss extensions api AuthorAccess i char EI public boolean handleTyping int throws Invalid Edit Exception boolean hand AuthorSchemaManager authorSch authorAccess getDocumentCon leTy ping false thorSchemaAwareOptions is api AuthorschemaAwareEditi offset char ch AuthorAcc emaManager troller getAuthorSchemaMa if authorSchemaManager isLearnSchema amp amp authorSchemaManager hasl authorSc try AuthorDo hema cume authorAccess getDocumen handleTyping catch A utho CadingErrors amp amp Manager getAu ntFragment ch handlelnse rOperationExc throw new InvalidEditExce Invalid typing event thorSchemaAwareOptions is aracterFragment tController createNewDocu rtionEvent offset new AuthorDocumentFragment characterFragment eption e ption e getMessage T getMessage fals dEditException nager EnableSmartPaste agmentsToInsert authorAccess ngHandler handleTyping int ess authorAccess nager EnableSmartTyping mentTextFragment String valueO authorAccess e 247 Author Devel
413. mple documentation abstracts elementFormDefault qualified gt lt xs import namespace http www oxygenxml com sample documentation abstracts schemaLocation 142 Author Developer Guide abs xsd gt The namespace of the documents will be http www oxygenxml com sample documentation The namespace of the def element is http www oxygenxml com sample documentation abstracts Now let s define the structure of the sections They all start with a title then have the optional def element then either a sequence of other sections or a mixture of paragraphs images and tables lt xs element name book type doc sectionType gt lt xs element name article type doc sectionType gt lt xs element name section type doc sectionType gt lt xs complexType name sectionType gt lt xs sequence gt lt xs element name title type xs string gt lt xs element ref abs def minOccurs 0 gt lt xs choice gt lt xs sequence gt lt xs element ref doc section maxOccurs unbounded gt lt xs sequence gt lt xs choice maxOccurs unbounded gt lt xs element ref doc para gt lt xs element ref doc image gt lt xs element ref doc table gt lt xs choice gt lt xs choice gt lt xs sequence gt lt xs complexType gt The paragraph contains text and other styling markup such as bold b and italic 1 elements lt xs element name para type doc paragraphType gt
414. n If the property is a URL of the form xhive host port the Documentum xDb X Hive DB connection will attempt to connect to an Documentum xDb X Hive DB server running behind the specified TCP IP port User name to access the Documentum xDb X Hive DB database engine Password to access the Documentum xDb X Hive DB database engine The name of the database to access from the Documentum xDb X Hive DB database engine If checked the Documentum xDb X Hive DB session ends with a commit otherwise it ends with a rollback 326 Working with Databases 4 Click OK Resource Management Data Source Explorer View This view presents in a tree like fashion the database connections configured in Preferences gt Data Sources You can connect to a database simply by expanding the connection node The database structure can be expanded up to column level lt oXygen gt supports multiple simultaneous database connections and the connections tree provides an easy way to browse them Some of the basic components employed by the XML DB API are collections and resources and they appear in the tree sorted in alphabetical order A B collection is a hierarchical container for resources and further sub collections There are two types of resources XML resource and non XML resource An XML resource represents an xml document or a document fragment selected by a previously executed XPath query Figure 13 6 The Da
415. n Streamline with Content Completion lt oXygen gt s intelligent Content Completion feature is a content assistant that enables rapid in line identification and insertion of structured language elements attributes and in some cases their parameter options Figure 4 9 Content Completion Assistant lt xs sequence gt lt xs element ref name gt lt xs element ref email minOccurs 0 ma lt xs element ref url minOccur lt xs element ret 1ink mind lt xs sequence gt h block lt xs attribute na default lt xs annotati bfixed lt xs docu form curs unbounded gt unbounded gt urs 0 maxOccurs 1 gt Specifies the value of the block attribute on this element The block attribute prevents an element that has a specified type of derivation From being used in place of this element This value can contain all or a list that is a subset of extension restriction or substitution lt xs annotat name lt xs attribute gt 4pnillable lt xs attribute na btype lt xs annotati lt xsidocu lt xs annotat If the Content Completion assistant is enabled in user preferences the option Use Content Completion it is automat ically displayed after a configurable delay from the last key press of the lt character that is entered into a document or from CTRL Space on a partial element or attribute name Moving the focus to highlight an element and pressing the Enter key or the Tab key insert
416. n The method startElement checks each of the element s attribute values and when one matches the link it considers the element found if one of the following conditions is satisfied e the qualified name of the attribute is xml id e the attribute is of type ID The type of the attribute is checked with the help of the method IDTypeVerifier hasIDType public boolean startElement String uri String localName String name Attr atts boolean elementFound false for int i 0 i lt atts length i if link equals atts i getValue if xml id equals atts il getQName xml id attribute elementFound true else check if attribute has ID type String attrLocalName ExtensionUtil getLocalName atts i getQName String attrUri atts i getNamespace if idVerifier hasIDType localName uri attrLocalName attrUri elementFound true return elementFound Creating a customized link target reference finder If you need to create a custom link target reference finder you can do so by following these steps Create the class which will implement the ro sync ecss extensions api link ElementLocatorPro vider interface As an alternative your class could extend ro sync ecss extensions commons De faultElementLocatorProvider the default implementation As a start point you can use the source code of the DefaultElementLocatorProvider implementation which is found in th
417. n informalexample informalfigure informaltable equation example figure table msgset procedure sidebar qandaset anchor bridgehead remark highlights abstract authorblurb epigraph indexterm beginpage As you can see this error message is a little more difficult to understand so understanding of the syntax or processing rules for the DocBook XML DTD s listitem element is required However the error message does give us a clue as to the source of the problem but indicating that The content of element type listitem must match Luckily most standards based DTD s XML Schema s and Relax NG schemas are supplied with reference documentation This enables us to lookup the element and read about it In this case you should learn about the child elements of listitem and their nesting rules Once you have correctly inserted the required child element and nested it in accordance with the XML rules the document will become valid on the next validation test Caching the Schema Used for Validation If you don t change the active editor and you don t switch to other application the schema associated to the current document is parsed and cached at the first validate action and is reused by the next Validate document actions without re parsing it This increases the speed of the validate action starting with the second execution if the schema is large or is located on a remote server on the Web To reset the cache and re parse the schema
418. n description if public String getDescription return Executes a database query and puts the result in a table public void doOperation AuthorAccess authorAccess ArgumentsMap map throws IllegalArgumentException AuthorOperationException Collects the arguments String jdbcDriver String map getArgume String connection String map getArgume String user String map getArgume String password String map getArgume String sql String map getArgumentValue ARG_SQL e tValue ARG_JDBC_DRIVER e tValue ARG_CONNECTION pu tValue ARG_USER Y tValue ARG_PASSWORD int caretPosition authorAccess getCaretOffset try authorAccess insertXMLFragment getFragment jdbcDriver connection user password sql caretPosition catch SQLException e throw new AuthorOperationException The operation failed due to the following database error getMessage catch ClassNotFoundException e throw new AuthorOperationException The JDBC database driver was not found Tried to load jdbcDriver e 239 Author Developer Guide pk Creates a connection to the database executes the SOL statement and creates an XML fragment containing a table element that wraps the data from the result set param jdbcDriver The class name of the JDBC dri
419. n its length exceeds the maximum line length defined for the pretty print operation Indent on Enter The Indent on Enter option indents the new line inserted when Enter is pressed Smart Enter The Smart Enter option inserts an empty line between the start and end tags and places the cursor in an indented position on the empty line automatically when the cursor is between the start and end tag and Enter is pressed Triple click A triple click with the left mouse button selects a different region of text of the current document depending on the position of the click in the document e if the click position is inside a start tag or an end tag then the entire element enclosed by that tag is selected e if the click position is immediately after a start tag or immediately before an end tag then the entire content of the element enclosed by that tag is selected including all the child elements but excluding the start tag and the end tag of the element e otherwise the triple click selects the entire current line of text Syntax highlight depending on namespace prefix The syntax highlight scheme of an XML file type allows the configuration of a color per each type of token which can appear in an XML file Distinguishing between the XML tag tokens based on the namespace prefix brings additional visual help in editing some XML file types For example in XSLT stylesheets elements from different namespaces like XSLT XHTML XSL FO or XForms are inserted
420. n of a XML Document Prolog using the system identifier of a XML Schema DTD Relax NG full or compact syntax NRL Namespace Routing Language or NVDL Namespace based Validation Dispatching Language 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 17 Editing documents Figure 4 1 The Create an XML Document Dialog XML Schema Tab New XML Document JE Customize document XML schema gt DTD RNG RNC NRL NYDL URL file samples frameworks fo xsd Fo xsd E 3 Cluse relative paths Root Element root x Namespace http www w3 org 1999 XSL Format Prefix Description This is the top node of the formatting object tree It holds an fo layout master set Formatting object which holds all masters used in the document an optional fo declarations and one or v Add optional content mn Complete the dialog as follows URL Specifies the location of an XML Schema Document XSD You can also specify an URI if it is solved by the lt oXygen gt catalog Example 4 1 DITA XSD URI urn oasis names tc dita xsd topic xsd 1 1 Document Root Populated from the elements defined in the specified XSD enables selection of the element to be used as document root Namespace Specifies the document namespace Prefix Specifies the prefix f
421. n the specialized topics without additional modifications The toolbar menu actions should be customized to insert the correct element names if this is the case You can go to the DITA document type from the Document Type Association page and edit the actions to insert the element names as specified in your specialization See this section for more details Use a new DITA Open Toolkit in lt oXygen gt Apply the following steps for using a new DITA Open Toolkit e Edit your transformation scenarios and in the Parameters tab change the value for the dita dir directory to point to the new directory e If you want to use exclusively the libraries that come with the new DITA Open Toolkit you have to go to the Ad vanced tab click the Libraries button uncheck the checkbox Allow lt oXygen gt to add high priority libraries to classpath and configure all libraries that will be used by the ANT process If there are also changes in the DTD s and you want to use the new versions for content completion and validation go to the lt oXygen gt preferences in the Document Type Association page edit the DITA and DITA Map document types and modify the catalog entry in the Catalogs tab to point to the custom catalog dita xml Reusing content The DITA framework allows reusing content from other DITA files with a content reference in the following ways e You can select content in a topic create a reusable component from it and re
422. n trying to validate the document there should be no errors Now modify the title to title2 Validate again This time there should be one error cvc complex type 2 4 a Invalid content was found starting with element title2 One of http www oxygenxml com sample documentation title is expected Undo the tag name change Press on the Author button at the bottom of the editing area lt oXygen gt should load the CSS from the document type association and create a layout similar to this document book section para E a Ml My Technical Book PXMLd Definition extensible Markup Language 1 In this section of the book I will explain different XML applications x AS BaN Text Grid Author Packaging and Deploying Using a file explorer go to the lt oXygen gt frameworks directory Select the sdf directory and make an archive from it Move it to another lt oXygen gt installation eventually on another computer Extract it in the frameworks directory Start lt oXygen gt and test the association as explained above If you create multiple document type associations and you have a complex directory structure it might be easy from the deployment point of view to use an lt oXygen gt all platforms distribution Add your framework files to it repackage 1t and send it to the content authors Warning When deploying your customized sdf directory please make sure that your sdf directory contains the sdf framew
423. n15 css The XSLT document type This document type is used to associated CSS stylesheets to an XSLT stylesheet file so it can be visualized in the Author page Association rules A file is considered to be a XSLT document when the namespace is http www w3 org 1999 XSL Transform 133 Predefined document types Author extensions The following CSS is proposed for visualizing XSLT stylesheets in the Author page frameworks xslt xslt css Representation of XSLT optimized for editing in the Author mode The XMLSpec document type XMLSpec is a markup language for W3C specifications and other technical reports Association rules A file is considered to be an XMLSpec document when the root name is spec Schema XMLSpec documents use a RelaxNG schema located in f frameworks xmlspec schema xmlspec rng where frameworks is a subdirectory of the lt oXygen gt install directory Author extensions Templates Default templates are available for XMLSpec They are stored in frameworksDir xmlspec templates folder and they can be used for easily creating an XMLSpec These templates are available when creating new documents from templates XMLSpec New Document New XMLSpec document Catalogs The default catalog is stored in frameworks xmlspec catalog xml Transformation Scenarios The following default transformation scenarios are available e XMLSpec PDF transforms an XMLSpec document into PDF d
424. n_span type xs integer gt lt xs extension gt lt xs complexContent gt lt xs complexType gt The def element is defined as a text only element in the imported schema abs xsd lt xml version 1 0 encoding UTF 8 gt lt xs schema xmlns xs http www w3 org 2001 XMLSchema targetNamespace http www oxygenxml com sample documentation abstracts gt lt xs element name def type xs string gt lt xs schema gt Now the XML data structure will be styled Second step The CSS If you read the Simple Customization Tutorial then you already have some basic notions about creating simple styles The example document contains elements from different namespaces so you will use CSS Level 3 extensions supported by the lt oXygen gt layout engine to associate specific properties with that element Note Please note that the CSS Level 3 is a standard under development and has not been released yet by the W3C However it addresses several important issues like selectors that are namespace aware and values for the CSS properties extracted from the attributes of the XML documents Although not yet conforming with the current CSS standard these are supported by the lt oXygen gt Author 144 Author Developer Guide Defining the General Layout Now the basic layout of the rendered documents is created Elements that are stacked one on top of the other are book article section title figure table imag
425. nature verifies correctly every time so it is required when you need self signed structures that support placement within different XML contexts Inclusive Canonicalization is useful when it is less likely that the signed data will be inserted in other XML document and it s the safer method from the security perspective because it requires no knowledge of the data that are to be secured in order to safely sign them The canonicalization method can specify whether or not comments should be included in the canonical form output by the XML canonicalization method If a canonical form contains comments corresponding to the comment nodes in the input node set the result is called canonical XML with comments In an uncommented canonical form comments are removed including delimiter for comments outside document element These three operations Digital Signing Canonicalization and Verification of the signature are available from the Tools menu or from the Editor contextual menu gt Source Canonicalizing files The user can select the canonicalization algorithm to be used for his document from the following dialog displayed by the action Canonicalize available from editor panel context menu Source 340 Digital signature Figure 15 1 Canonicalization settings dialog fa Canonicalize Input URL file C eclipse plugins com oxygenx x Canonicalize options Exclusive Exclusive with comments Inclusive Inclusive with
426. nccnnccnnccnnconnccnnccnnconaconaconiconoss 313 Configuring Database Connections essers eiet e ke se aED ae IE oea 313 How to Configure an IBM DB2 Connection ooccocccnccnnccnnconnccnnccnncnnnconeconncnnncnnncnnncnnrnnnss 314 How to Configure a JOBC ODBC Connection ccooccnccnncnnncnnocnnccnnconnconnccnnccnnconnconncnncnnnes 314 How to Configure a Microsoft SQL Server Connection ooococccnncnnccnnccnnconnconnccnncnnnconacinicos 315 How to Configure a MySQL Connection cooccnnccnnconcnnncnnocnnonnncnnncnnccnnconnccnnccnnconncnnncnnnes 315 How to Configure an Oracle 11g Connection ocoooccoccnccnnncnnccnnccnnccnnccnnccnnccnnconnconnconnnnnnss 315 How to Configure a PostgreSQL 8 3 Connection coocccoccnnccnnccnnccnncnnnconncnnncnnncnnacnnnnnnronoss 316 Resource Manantial tios ia es 316 AE O O cteetstecnabe Mexgeucbase C aA 316 Actions available at connection level ooooooonccncnnccnnccnnconnccnnccnnconnconncnnncnnncnaroninnnns 318 Actions available at catalog level ooooonncnnnnnnccnccnnconnconnccnnccnncnnnconncnnncnnncnnroninnnns 318 Actions available at schema level oooooccooccnnccnnconoconoconccnnncnnrcnnronccnnccnnccnnccnnions 318 Actions available at table level aniier reena E EERE TEE ER ER 318 XML Schema Repository level oooonccnnccnccnnccnnccnnconnconoconnconnroncnnnrcnncnnncnncinninnno 318 Oracle s XML Schema Repository Level ooooconoconccnnccnnccnnccnncnnoconccnnccnncinncnnns 318 IBM DB2 s XML Schema R
427. nconnconicnnncnnncnanonoss 187 Implementing an Author Schema Aware Editing Handler 0 0 0 0 00 ceeeceee cece teen eenes 188 Configuring a Content completion handler 0 0 0 0 cece cee cece cece ce eece cece cena een eeneeeneeeeees 189 Configuring a Link target element finder 2 2 0 0 ce cece ce cece cee e eens ce eeeeeeeeeeeeeeeeeeaeeaaes 191 The DefaultElementLocatorProvider implementation eee 191 The XPointerElement Locator implementation oocooccncccnccnnccnncinnccnninns 192 The IDElement Locator implementation oooconocnnccnnccnncnnninnccnnccnnconncinncins 195 Creating a customized link target reference finder oooncccccnccnnccnnconnconnconnconnconnconncos 195 Configuring a custom Drag and Drop listener 0 eee cece cc ee ce ne cence ences eeeeeeeeeaees 196 Configuring a References Resolver 0 2 0 0 c cece ceee cece cnecce cece cece eens ceneeeneeeaeeeeeeeeeeeeeeeeeeaees 196 Configuring CSS Styles Filtet sceri nesine pe cocaine cantas es aaa dante ree 199 Configuring a Table Column Width Provider ooocooocnnccnnccnnccnncnnccnnccnnconnccnnconnconaconiciniss 200 Configuring a Table Cell Span Provider ooncooccncccncccnccnnccnnccnnccnnconnconnconncnnncnnncnnrcnnronoss 204 Configuring an Unique Attributes Recognizer oooccocccnccnnccnnconnccnnccnnconnconncnnacnnarononnnrnnnss 207 Customizing the default CSS of a document type 0 0 0 0 cee ee cece cece cece ce ceneeeneeeeeeeeeeeeeeeeeaees 208 Docu
428. nd Plug in Development Team C Line wrap disables folding Y Highlight matching tag Y Enable Folding when opening a new editor Minimum fold range only For XML 4 Restore Defaults Apply lt oXygen gt License The License information panel is opened from menu Window gt Preferences gt Author This panel presents the data of the license key which enables the lt oXygen gt XML Author plugin registration name category and number of purchased licenses encrypted signature of the license key Clicking on the Register button opens the lt oXygen gt XML Author License dialog that allows you to insert a new license key Global The Global preferences panel is opened from menu Window Preferences gt Author Global Figure 17 3 The Global preferences panel Global ey zy Use custom frameworks Document Type Associations directory Frameworks directory Ey i Use custom frameworks directory For editing different types of XML documents for content completion valida tion authoring lt oXygen gt can use information from the external document types which are stored in the frameworks directory If a custom frameworks directory is specified then the lt oXygen gt will load the document types from this location Show hidden files and directories Show system hidden files and folders in the file and directory browsers This setting is not available on Mac OS X
429. nd the file becomes writable you will be able to make modifications to it on the spot without having to reopen it 63 Chapter 5 Authoring in the tagless editor Authoring XML documents without the XML tags Once the structure of the XML document and the required restrictions on the elements and attributes are fixed with an XML schema the editing of the document is easier in a WYSIWYG what you see is what you get editor in which the XML markup is not visible This tagless editor is available as the Author mode of the XML editor The Author mode is activated by pressing the Author button at the bottom of the editing area where the mode switches of the XML editor are available Text Grid and Author see the following screenshot The Author mode renders the content of the XML document visually based on a CSS stylesheet associated with the document Many of the actions and features available in Text mode are also available in Author mode Figure 5 1 oXygen Author Editor g oXygen XML oxy Sample samples docbook v4 sample xml Eclipse SDK BAX File Edit Navigate Search Project XML Tools Run XML DocBook4 Window Help Coe BiB Q iv E e oe es EARE XVKFVUBERE x0 0940 BH DEM A Es Navigator 23 A fed personal xml fe personal xsd fe sample xml Za gt attributes SO EB lieu ceras WR EEE Irae e 5 dita e a Y css DocBook default x article 21 attribute Value amp docbook aid 2 5 v4 E 7 lang
430. ndow next to the content completion window and in the Model View When unchecked only elements from the Relax NG annota tions namespace that is http relaxng org ns compatibility annotations 1 0 will be considered annotation The XPath preferences panel is opened from menu Window Preferences gt Author Editor Content Comple tion XPath Figure 17 20 The Content Completion XPath preferences panel XPath lt a XPath Enable content completion for XPath expressions Include XPath Functions Include XSLT Functions Include axes Show signatures of XSLT XPath functions Enable content completion for XPath expressions Disables and enables content completion in XPath expressions entered in the XSL attributes match select and test and also in the XPath toolbar Options are available to allow the user to include XPath functions XSLT func tions or axes in the content completion suggestion list The XPath section controls if the functions axes are presented in the content completion list when editing XPath ex pressions 371 Configuring the application Show signatures of XSLT XPath If checked the editor will indicate in a tooltip helper the signature of the XPath functions function located at the caret position Syntax Highlight lt oXygen gt supports Syntax Highlight for XML JavaScript PHP CSS documents While lt oXygen gt provides a default color configuration for highlighting the tokens yo
431. ndow will contain as first entries the Split lt Element name gt items Usually you can only split the closest block element to the caret position but if it is inside a list item the list item will also be proposed for split Selecting Split lt Element name gt splits the content of the specified element around the caret position Thus if the caret is positioned at the beginning or at the end of the element the newly created sibling will be empty If the caret is positioned inside a space preserve element the first choice in the content completion window is Enter which inserts a new line in the content of the element If there is a selection in the editor and you invoke content completion a Surround with operation can be performed The tag used will be the selected item from the content completion window By default you are not allowed to insert element names which are not considered by the associated schema as valid proposals in the current context This can be changed by unchecking the Allow only insertion of valid elements and attributes checkbox from the Schema aware preferences page Joining two elements You can choose to join the content of two sibling elements with the same name by using the Join elements action from the editor contextual menu The same action can be triggered also in the next situations e The caret is located before the end position of the first element and Delete key is pressed e The caret is located after the end p
432. next Remove the td element if td equals element getOQName lements remove element break Insert the th CIElement thElement new SDFElement thElement setName th elements add thElement return elements Override public String getDescription return null SDFSchemaAwareEditingHandler java package simple documentation framework extensions the list of content ElementStack peek element in the list of content completion proposals text ndler import java util List import jJavax swing text BadLocationException import ro sync contentcompletion xml ContextElement import ro sync contentcompletion xml WhatElementsCanGoHereCon import ro sync ecss extensions api AuthorAccess import ro sync ecss extensions api AuthorOperationException import ro sync ecss extensions api AuthorSchemaAwareEditingHa import ro sync ecss extensions api AuthorSchemaManager import ro sync ecss extensions api InvalidEditException import ro sync ecss extensions api node AuthorDocumentFragment import ro sync ecss extensions api node AuthorElement import ro sync ecss extensions api node AuthorNode Specific editing support for SDF documents Handles typing and paste events inside section and tables 4 public class SDFSchemaAwareEditingHandler i private static final Stri ng SDF_NAMESPACE T
433. nformation is bound to the selected URL displayed in the File URL combo box and used further in opening saving the file If the check box Save is selected then the user and password are saved between editing sessions The password is kept encrypted into the options file Note Your password is well protected In the case the options file is used on other machine by a user with a different username the password will become unreadable since the encryption is username dependent This is also true if you add URLs having user and password to your project e The Browse for remote file section contains the server combo and the Autoconnect check box Into the server combo it may be specified the protocol the name or IP of the server D Server URLs When accessing a FTP server you need to specify only the protocol and the host like ftp server com ftp ftp apache org or if using a nonstandard port ftp server com 7800 etc By pressing the Browse button the directory listing will be shown in the component below When Autoconnect is selected then at every time the dialog is shown the browse action will be performed e The tree view of the documents stored on the server You can browse the directories and make multiple selections Additionally you may use the Rename Delete and New Folder to manage the file repository The file names are sorted in a case insensitive way GZIP compression is handled correctly for the
434. ng lt oXygen gt XML Author while preserving any personal configuration settings and customizations Procedure 2 8 Upgrade Procedure 1 Uninstall the lt oXygen gt XML Author plugin see Uninstall procedure 2 Follow the Installation instructions 3 Restart the Eclipse platform 4 Start the lt oXygen gt XML Author plugin to ensure that the application can start and that your license is recognized by the upgrade installation 5 If you are upgrading to a major version for example from 8 2 to 9 0 then you will need to enter the new license text into the registration dialog that is shown when the application starts Installation 6 Select Window Preferences gt Plug In Development gt Target Platform and next to the list entry you should see the version number of the newest installed plugin If the previous version was 8 2 0 the list entry should now contain 9 0 0 Checking for new versions lt oXygen gt XML Author offers the option of checking for new versions at the http www oxygenxml com site when the application is started You can check for new versions manually at any time by going to menu Help Check for New Versions Uninstalling the Eclipse plugin Warning The following procedure will remove the lt oXygen gt XML Author plugin from your system It will not remove the Eclipse platform If you wish to uninstall Eclipse please see its uninstall instructions Procedure 2 9 Uninstall Proc
435. ng Auto generate ID s for elements You can choose a pattern for the generated ID using the field ID Pattern If the element already has an ID this ID is preserved 119 Predefined document types All actions described above are available in the contextual menu main menu DITA submenu and in the Author custom actions toolbar Templates Default templates available for DITA topics are stored in frameworksDir dita templates topic folder They can be used for easily creating a DITA s concept reference task or topic These templates are available when creating new documents from templates DITA Composite New DITA Composite DITA Concept New DITA Concept DITA Glossentry New DITA Glossentry DITA Reference New DITA Reference DITA Task New DITA Task DITA Topic New DITA Topic DITA Learning Assessment New DITA Learning Assessment learning specialization in DITA 1 2 DITA Learning Content New DITA Learning Content learning specialization in DITA 1 2 DITA Learning Summary New DITA Learning Summary learning specialization in DITA 1 2 DITA Learning Overview New DITA Learning Overview learning specialization in DITA 1 2 Catalogs The default catalog is stored in frameworks dita catalog xml Transformation Scenarios The following default transformation scenarios are available for DITA Topics DITA XHTML transforms a DITA topic to XHTML using DITA Open Toolkit 1 5 M24 DITA PDF Idiom FO Plu
436. ng a Documentum repository Data Source Explorer x Connections a Documentum Connection m adrian gt DITA Projects 3 6 Flowers 9 concepts 5 0 images l Chrysanthemums jpa E Gardeniaflower jpg If Gerbera jpg i Iris_sanguinea jpg Lilac jpg If Salvia jpg Snowdrop jpg 5 0 tasks lt e gardenPreparation xml lt e pruning xml topics lt o gt Flowers ditamap Actions available on connection Configure Database Sources Opens the Data Sources preferences page where you can configure both data sources and connections e New Cabinet Creates a new cabinet in the repository Type The type of the new cabinet default is dm_cabinet Name The name of the new cabinet Title The title property of the cabinet Subject The subject property of the cabinet Refresh Performs a refresh of the connection Actions available on cabinets folders New Folder Creates a new folder in the current cabinet folder Path Shows the path where the new folder will be created Type The type of the new folder default is dm_folder Name The name of the new folder Title The title property of the folder 335 Content Management System CMS Integration Subject The subject property of the folder L New Document Creates a new document in the current cabinet folder Path Shows the path where the new document will be created Name The name of the new document
437. ng doctypePublicID Attributes rootAttributes return http www oxygenxml com sample documentation equals rootNamespace 155 Author Developer Guide public String getDescription return Checks if the current Document Type Association is matching the document The complete source code is found in the Example Files Listings the Java Files section Package the compiled class into a jar file Here is an example of an ANT script that packages the classes dir ectory content into a jar archive named sdf jar lt xml version 1 0 encoding UTF 8 gt lt project name project default dist gt lt target name dist gt lt jar destfile sdf jar basedir classes gt lt fileset dir classes gt lt include name gt lt fileset gt lt jar gt lt target gt lt project gt Copy the sdf jar file into the frameworks sdf directory Add the sdf jar to the Author classpath To do this select SDF Document Type from the Document Type Association options page and press the Edit button Select the Classpath tab in the lower part of the dialog Press the Add button In the displayed dialog enter the location of the jar file relative to the lt oXygen gt frameworks directory If you are in the process of developing the extension actions you can also specify a path to a directory which holds compiled Java classes Clear the rules you defined before by using the Remove
438. ng the current document in a Web browser occocccoccnnccnnconnconnconnconcnnncnnronnronrnnccnnccnnccnnicos 26 Closing dOCUMENIS enee tec iedsia e Eni EE e a es 26 Viewing file properties viril perra pt abcess ion dedo yee 26 Editing AMLO Si A A ii 27 Associate a schemato a document 5 ccasssosee ds estes usesvocsagsvesasegssccebsdbecseengesvecssagveoswsgs EEPE ES ESE ni 27 lil lt oXygen gt XML Author 11 2 User Manual for Eclipse Setting a schema for the Content Completion oocooccnnccnccnnccnnccnnconnconnconnconnconncnnnnnnncnnronose 27 Setting ardetault Schema vomita A pd 27 Adding a Processing Instruction eneeier ien ea Er e E E E E E RE NENS 27 Associating a schema with the namespace of the root element ocooocnnccnnccnnccnncnnncnnnso 28 Learning document Structure sye ness sees ees ea sue Seda nods wean ss O E suness te See EREE EEs 28 Streamline with Content Completion 0c ccc ee cece E ence neceeeceeeeeeeceeeeaeeeaeseaeeea sean eeaes 29 Code templates sost sscdese ised seh ther eeebsmen sd out g sadeu radon R aa degre E saa ceusdee Svea eae seb RE eee 32 Content Completion helper panels ooocoooconccnnccnnccnnonnncnnncnnncnnccnnconnconnccnnconnconnconncnnncnnnes 33 IA adage tres daves een tess N E pare atopytuadesa tee TERS AE ES 33 The Element Structure panel riesi 0 cece cence cece ence ence r E ERSS 33 Phe Annotation panel vas asco doit dan ddan dere EE A aaa sr denia 34 The Attributes pane
439. ng the references ence he reference nod horNode node E_TYPE ELEMENT ment node ame tAttribute location Return the systemID of the referred content param authorAccess The author access horNode node F ry AuthorEle lem if attrValue String attrStri try URL absoluteUrl aut systeml catch logger D rror E return systemID null ngVal at horAccess correc absolute MalformedURLException y nt g new U Url toStr LocalName _ELEM node ment tAttribu ing e ENT te location trValue getValue RL node getXMLBaseURL tURL attrStringVal Verifies if the references of the given node must be refreshed when the attribute with th specified name has changed 261 Author Developer Guide param node The node with the references param attributeName The name of the changed attribute return lt code gt true lt code gt if the references must be refreshed public boolean isReferenceChanged AuthorNode node String attributeName return location equals attributeName A F pk return The description of the author extension fe public String getDescription return Resolves the ref references CustomRule java package simple documentation framewor
440. ng with the following instructions please ensure that your system complies with the prerequisites detailed in the installation requirements There are two ways of installing the lt oXygen gt Eclipse plugin the Update Site method and the zip archive method Procedure 2 1 Eclipse 3 3 plugin installation the Update Site method l Start Eclipse Choose the menu option Help Software Update Find and Install Select the checkbox Search for new features to install and press the Next button From the dialog Update sites to visit press the button Add update site or New Remote Site Enter the value http www oxygenxml com InstData Eclipse site xml into the URL field of the New Update Site dialog Press the OK button Select the checkbox oXygen XML Author and press the Next button 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 Paste the license information received in the registration email when prompted This will happen when you use one of the wizards to create an XML project or document when you open or create a document associated with lt oXygen gt or when accessing the lt oXygen gt Preferences The oXygen XML Author plugin is installed correctly if you can create an XML project with the New Project wizard of the oXygen XML Author plugin started from menu File gt New gt
441. ning from the left with en E before and E after Pseudo elements The before and after pseudo elements can be used to insert generated content before or after an element s content Unsupported selectors The following CSS level 2 1 selectors are not supported by the lt oXygen gt Author Table 8 4 Unsupported CSS 2 1 selectors Expression Name Description Example E myid ID selectors Matches any E element with ID equal to myid E link E visited The link pseudo class Matches element E if E is the source anchor of a hyperlink of which the target is not yet visited link or already visited vis ited E active E focus E first line E hover The dynamic pseudo classes The first line pseudo class Matches E during certain user actions The first line pseudo element applies special styles to the con tents of the first formatted line of a paragraph E first letter The first letter pseudo class The first letter pseudo element must select the first letter of the first line of a block if it is not preceded by any other content such as images or inline tables on its line The first letter pseudo element may be used for initial caps and drop caps which are common typographical effects 210 Author Developer Guide Properties Support Table All the properties belonging to the aural and paged categories are not supp
442. nncnnocononnncnnroncrnnccnncinninno 291 Set FOP configuration file in Oxygen oooococcnnccnnccnnconnconnconncnnnconcnnnronocnnccnnccnncconions 292 Add new font to FO output ssor oesi in E E E EE i 293 DocBook Stylesheets sienn a n EEE NE i 293 TEL Stylesheets irr e a E E E E E a E NEA weed 293 DITA OT Styl sheetS a erone anr ni e EE EE OET thet ERAS ENE Ea 293 Common transformation Ss asnes n r o rs E ee ii 294 O NO Miven sat 295 PESO Ups nO ii ET eet E ies 295 TXT OUT put ows saavesysecgus essences garadeeegh sutossny ted us perewtuss lowed oneth suas eaves bees EENE EES 296 HIME Output sect cts RO a eae BU A ee a ee 296 HIME Help Outputs O e E A das qebes der Gevuaas 296 Java Help Output id east E a teen tel ily 297 XHTML Outputs cocacola rosita eetedaves ranita 297 Supported XSIET processors Wei ida a iros 297 Configuring custom XSLT processors coooccnoconoconccnnncnnnnnnronoronccnnconnccnncrnncrnnconncnnncnnnnnnnnnirenose 300 Configuring the XSLT processor extensions paths cee cece cece cece cece cece cece eeu eeneeeneeeeeeenes 300 AProc TranslOrmMatlOns pesene veda devo op O 301 XProc transformation Scenario 0 ee ee cece cee cece ee E E eens eens eeneeeeeeeeeeeeeeeeeeaees 301 Integration of an external XProc engine the XProc API oocoooncccnnccnnnccnnnccnnnnconnncnnnnccnnnnccnnccnnnns 301 11 Querying documents tii A eed el edt wet eae a welded Seren 303 Running XPath ex A tun aedpp nee dose A EAE SEE ven
443. noncnnoncnrononcononcnnoncnnenccnnnns 258 CUSTOMRUL Ss JAVA laca tomas ees 262 DefaultElementLocatorProvider JaVa ococcncncoconcnnencncononcnnancnnoncnnancnnonono 262 XPointerelementhocator JAVA sng epeei Heads rotas Meee de ESAS ata Eee eke 263 TDR tement Locator AV tien asta cia 267 9 Grid Ed ocio NE 269 TOCA ii A ia 269 Layouts Grid and A Saeed laceadusheogerb aden se vit dorgaubabew R dangivedtenatwet doz cevdass 270 Navigatin Me pad din dia pe Ad ed Seiad ood 270 Expand AMMA COM orinal reed RATO heen te E EEE ENEDES 271 Collapse ALA CULO iu Ss Ad id 271 Expand Children Action ooren det rsterims dictan a a dinar odo eE sagetenn Leceeeuaded puedes dad 271 Collapse Children A ction mi ia td 271 Collapse O O studs S ERER E EES 271 Specific Grid ACOSO toes See det Sub a A eee ede aces Ua ded 271 sorting a Table Columns ersz gos iaccrsovtdes desetacegveet ieee deb E dee ouden sured awe gebsgoned evades dau eedersaweans 271 Inserting a rOW IM table serai ee cctecs ceed sae ys ccedbeneee a ye vedas 272 Inserting colima table cc cn dees tadenopuveguese vonage yo Stadhege twa E TEE Ueeawenteenwess 272 Clearing the content of a COLUMN 200 0 eee cce cence cee ca cece cece cena cena Ee S E 272 PAGING NOCES s at ade eda es 272 Duplicating nodes mii EN EE E E E Nine c 272 Refresh lay OU to a ties 272 Start editing acelli vale dE mea R NS 272 Stop editing a cell values ss deus edecscyusd saa rita titi att nica vibe tp ade 272 lt
444. nrnnccnncnnose 325 How to configure a Software AG Tamino Connection cooccconoccnnnccnnnccnnnnccnnorcnnnccnnnnccnnccnnns 325 How to configure a Raining Data TigerLogic Connection coooccoccnnccnnccnnccnnconnconoconaconiconnns 326 How to configure an Documentum xDb X Hive DB Connection occooccccnonocononoconanoconiononos 326 Resource Management a nenns oier EE EES E a EEN E io a E 327 Data Source Explorer View secesio en e codi le NEOR NS 327 Berkeley DB XML Connection miras td es E E A E E RES 328 Actions available at connection level ooooconncnnccnnccnnocnncnnocnnccnnccnnccnnccnnccnnioos 328 Actions available at container level o o ocooncnnnncccnnccnnccnnccnnconnconnccnncnnnconncnnnoos 328 Actions available at resource level oooooooncnnnnnccnnccnnccnnconnconnconnccnnconnconnconnoos 329 eXIst Conecta A AA ti 330 Actions available at connection level ooooconncnnccnnccnnccnncnnoconccnnccnnconnconnccnncons 330 Actions available at container level o ooooncnnnnnccnnccnnccnnconnconnconnconnconnconaconnnos 330 Actions available at resource level oooocooncnnnnnccnnccnnccnnconnconnconnccnnconnconaconnoos 330 WebDAV Conde Clair A A 330 How to Configure a WebDAV Connection oocooccccccnccnnconnconnccnncnnnconncnnncnnnrnnncnnronnrnnccnnccnnccnnions 331 WebDAV connection actions ooocooccnccnnccnnccnnccnnconnccnncnnncnnnrrnnrnnnrnnnrnnnrnnnnnnrnnnrnnncnnccnnccnnccnnioos 331 Actions available at connection level 2 2 0
445. nsert Paragraph inserts a new paragraph depending on the current context If current context is a paragraph context the value of class attribute of the current element or one of its ancestors contains topic p then a new paragraph will be inserted after this paragraph Otherwise a new paragraph is inserted at caret position insert Concept inserts a new concept Concepts provide background information that users must know before they can successfully work with a product or interface This action is available in one of the following contexts e concept context one of the current element ancestors is a concept In this case an empty concept will be inserted after the current concept e concept or dita context current element is a concept or dita In this case an empty concept will be inserted at current caret position e dita topic context current element is a topic child of a dita element In this case an empty concept will be inserted at current caret position e dita topic context one of the current element ancestors is a dita s topic In this case an empty concept will be in serted after the first topic ancestor Insert Task inserts a new task Tasks are the main building blocks for task oriented user assistance They generally provide step by step instructions that will enable a user to perform a task This action is available in one of the fol lowing contexts e task context one of the current element ancestors is a task
446. nsert a new line before the word that breaks the limit and indent the next line This will minimize the need of reformatting the document Indent on Enter If checked it indents the new line introduced when pressing Enter Enable Smart Enter If checked it inserts a new indented line between start and end tag Detect line width on open If checked it detects the line width automatically when the document is opened Format and indent the document on When checked the Format and indent the document on open operation will open format and indent an XML document before opening it in the editor panel This option applies only to documents associated with the XML editor not to docu ments associated with the XSD editor RNG editor or XSL editor 364 Configuring the application Line width Format and Indent Defines the point at which the Format and Indent Pretty Print function will perform hard line wrapping So if set to 100 Pretty Print will wrap lines at the 100th space inclusive of white spaces tags and elements Clear undo buffer before Format and If checked the undo buffer is cleared The undo action can now only undo the Indent Format and Indent action XML The XML Format preferences panel is opened from menu Window gt Preferences gt Author Editor Format XML Figure 17 14 The XML format preferences panel XML Ces v Format and Indent XML Preserve empty lines O Expand empty elements C Preserve text as it is
447. nserted both from the toolbar action and the contextual node actions Figure 6 3 Insert Topic Heading Dialog Insert Topic Heading Element name topichead v Attributes Navigation title My daily tasks Type topic Format dita x Scope local x Collection type v Keys Cy By using the Insert Topic Heading Dialog you can easily insert a topichead element The Navigation title is required but other attributes can be specified as well from the dialog Inserting a Topic Group The topicgroup element identifies a group of topics such as a concepts tasks or references or other resources A topicgroup can contain other topicgroup elements allowing you to express navigation or table of contents hierarchies as well as implying relationships between the containing topicgroup and its children You can set the collection type of a container topicgroup to determine how its children are related to each other Relationships end up expressed as links in the output with each participant in a relationship having links to the other participants by default A topic group may be inserted both from the toolbar action and the contextual node actions 92 Author for DITA Figure 6 4 Insert Topic Group Dialog Insert Topic Group Element name topicgroup Attributes Type x Format dita x Scope local x Collection type
448. nstances that need to be stand alone documents and part of a much larger work The main application for XInclude is in the document orientated content frameworks such as manuals and Web pages Employing XInclude enables authors and content managers to manage content in a modular fashion that is akin to Object Orientated methods used in languages such as Java C or C The advantages of modular documentation include reusable content units smaller file units that are easier to edited better version control and distributed authoring An example create a chapter file and an article file in the samples folder of the lt oXygen gt install folder and include the chapter file in the article file using XInclude Chapter file introduction xml lt xml version 1 0 gt lt DOCTYPE chapter PUBLIC OASIS DTD DocBook XML V4 3 EN http www oasis open org docbook xml 4 3 docbookx dtd gt lt chapter gt lt title gt Getting started lt title gt lt section gt lt title gt Section title lt title gt lt para gt Para text lt para gt lt section gt lt chapter gt Main article file lt xml version 1 0 gt lt DOCTYPE article PUBLIC OASIS DTD DocBook XML V4 3 EN http www docbook org xml 4 3 docbookx dtd lt ENTITY xinclude SYSTEM frameworks docbook dtd xinclude mod gt 52 Editing documents xinclude I gt lt article gt lt title gt Install guide lt
449. nstraining element information item children to be empty or to conform to a specified element only or mixed content model or else constraining the character information item children to conform to a specified simple type definition hud The Element Structure panel The element structure panel shows the structure of the current edited or selected tag in a Tree format The information includes the name model and attributes the currently edited tag may have The allowed attributes are shown along with any restrictions they might possess 33 Editing documents Figure 4 14 The Element Structure panel Et Model 23 e lt xs complexType gt Namespace http fwwwy w3 org 2001 XMLSchema Content element only Attributes name string Required true Whitespace collapse Pattern Citc amp i i e i mixed boolean abstract boolean final Union block Union Did ID Model xs annotation 0 1 xs simpleContent xs complexContent xs group xs all xs choice xs sequence 0 1 xs attribute xs attributeGroup 0 UNBOUNDED xs anyAttribute 0 1 The Annotation panel The Annotation panel shows the annotations that are present in the used schema for the currently edited or selected tag This information can be very useful to persons learning XML because it has small available definitions for each used tag Figure 4 15 The Annotation panel
450. nt is not supported if xpointerPath i length 0 invalidFormat true if i gt 0 try Integer parselnt xpointerPath i catch NumberFormatException e invalidFormat true if invalidFormat throw new ElementLocatorException false 265 Author Developer Guide Only the element scheme is supported when locating XPointer links Supported formats element elementID element 1 2 3 element elemID 2 3 4 1 if Character isDigit xpointerPath 0 charAt 0 This is the case when xpointer have the following pattern 1 5 7 xpointerPathDepth xpointerPath length else This is the case when xpointer starts with an element ID xpointerPathDepth 1 startWithElementID true see ro sync ecss extensions api link ElementLocator endElement E java lang String java lang String java lang String ay public void endElement String uri String localName String name ndElementDepth startElementDepth startElementDepth A lastIndexInParent Integer currentElementIndexStack pop intValue see ro sync ecss extensions api link ElementLocator startElement x java lang String java lang String java lang String A ro sync ecss extensions api link Attr ed public boolean startElement String uri String localName String name Attr atts boolean linkLocated fals
451. nt type node is expanded the associated tokens are listed Selecting a token displays the current color properties 372 Configuring the application and enables you to modify them You can also select a token by clicking directly in the preview area on that type of token You can edit the following color properties of the selected token Foreground color The Foreground button opens a color dialog that allow setting the color properties for the selected token with one of the methods Swatches HSB or RGB Background color The Background button opens the same color dialog as the Foreground button Bold style This checkbox enables the bold variant of the font for the selected token This property is not applied to a bidirectional document Italic style This checkbox enables the italic variant of the font for the selected token This property is not applied to a bidirectional document The Preview panel displays the appearance of all token colors in a sample document as they will be rendered in the editor Modifications are saved when the OK button is clicked Cancel discards changes Restore Defaults button changes all the token colors to the default values Syntax Highlight Elements Attributes by Prefix The Syntax Highlight preferences panel is opened from menu Window Preferences gt Author Editor Syntax Highlight Elements Attributes by Prefix Figure 17 22 The Elements Attributes by Prefix preferences panel Elemen
452. ntext e Cross Reference inserts an xref element with the value of attribute format set to dita The target of the xref is selected in a dialog which lists all the IDs available in a file selected by the user Figure 7 3 Insert a cross reference in a DITA document Insert Reference ES URL D projects exml samples dita concepts oil xml dE B Target type All m 3 Qil concept oilconcept prolog sect1 related links related3 lt conbody id body2 gt lt p gt Motor oil keeps changed every lt conbody gt ce A Href value exml samples dita concepts oil xml oilconcept body2 e Key Reference inserts a user specified element with the value of attribute keyref attribute set to a specific key name As stated in the DITA 1 2 specification keys can be defined at map level which can be then referenced The target of the keyref is selected in a dialog which lists all the keys available in the current opened map from the DITA Maps Manager You can also reference elements at sub topic level by pressing the Sub topic button and choosing the target Important All keys which are presented in the dialog are gathered from the current opened DITA Map Elements which have the keyref attribute set are displayed as links The current opened DITA Map is also used to resolve references when navigating keyref links in the Author page Image elements which use
453. ntext If the caret is positioned between two cells a new one will be inserted at caret s position If the caret is inside a cell then the new one will be created after the current cell Delete Column deletes the table column where the caret is located ES Delete Row deletes the table row where the caret is located Join Row Cells joins the content of the selected cells The operation is available if the selected cells are from the same row and they have the same row span The action is also available when the selection is missing but the caret is positioned between two cells A Join Cell Above joins the content of cell from current caret position with that of the cell above it Note that this action works only if both cells have the same column span ElJoin Cell Below joins the content of cell from current caret position with that of the cell below it Note that this action works only if both cells have the same column span E Split Cell To The Left splits the cell from current caret position in two inserting a new empty table cell to the left Note that this action works only if the current cell spans over more than one column The column span of the source cell will be decreased with one 126 Predefined document types at Split Cell To The Right splits the cell from current caret position in two inserting a new empty table cell to the right Note that this action works only if the current cell spans over more t
454. nto the Console view allowing the user to monitor how the operation is being executed Messages contain a timestamp the name of the thread that generated it and the actual status information The number of displayed messages in the console view can be controlled from the options panel XML editor specific actions lt oXygen gt offers groups of actions for working on single XML elements They are available from the On Windows the context menu can be displayed with the mouse on a right click or with the keyboard by pressing the special context menu key available on Windows keyboards Edit actions e Turns on line wrapping in the editor panel if it was off and vice versa It has the same effect as the Line wrap preference e contextual menu of current editor gt Toggle comment Ctrl Comment the current selection of the current editor If the selection already contains a comment the action removes the comment from around the selection If there is no selection in the current editor and the cursor is not positioned inside a comment the current line is commented If the cursor is positioned inside a comment then the commented text is uncommented Select actions The Select actions are enabled when the caret is positioned inside a tag name e contextual menu of current editor Select gt Element Selects the entire current element e contextual menu of current editor Select Content Selects the content of the current element exclu
455. o Table using the Y Edit button Select the Insert section action in the left and the Table label in the right then press the saAdd as sibling button Now select the Insert table action in the left and the Table in the right Press the Add as child button Figure 8 13 Configuring the Menu Schema Classpath Author Templates Catalogs Transformation Extensions css Actions Menu Contextual menu Toolbar Available actions Current actions Name Description a E Bold Separator Menu separator Z Italic Submenu Submenu U Underline By Bold Emphasises text Inserts w a Link Delete Column Delete a table column Delete Row Delete a table row S Insert Section Edit OLink Edit an existing OLink EEE ss Generate IDs Generate IDs for the cur Ax 9 Z Initial page 165 Author Developer Guide When opening a Simple Documentation Framework test document in Author mode the menu you created is displayed in the editor menu bar between the Debugger and the Document menus In the menu you find the Table submenu and the two actions Figure 8 14 Author Menu SDF Framework Window Help Table gt JInserttable Ctri Shift T Insert Section S Note The shortcut of an action defined for the current document type is enabled only if the action is added to the main menu Otherwise the author can run the action onl
456. o configure a Software AG Tamino datasource The latest instructions on how to configure Software AG Tamino support in lt oXygen gt can be found on our website http www oxygenxml com doc ug oxygenEclipse native xml database support htmifconfigure tamino datasource 1 Goto Preferences gt Data Sources In the Data Sources panel click the New button 322 Working with Databases 2 Enter a unique name for this data source and select Tamino from the driver type combo box 3 Using the Add button add the following jar files available in the SDK TaminoAP14J 1lib subdirectory of the Tamino 4 4 1 database install directory e TaminoAPI4J jar e TaminoAPI4J 110n jar e TaminoJCA jar s Note You must use the jar files from the version 4 4 1 of the Tamino database 4 Click OK to finish the data source configuration How to configure a Raining Data TigerLogic datasource The latest instructions on how to configure TigerLogic support in lt oXygen gt can be found on our website http www oxygenxml com doc ug oxy genEclipse native xml database support html configure tigerlogic datasource 1 Goto Preferences gt Data Sources In the Data Sources panel click the New button 2 Enter a unique name for this data source and select TigerLogic from the driver type combo box 3 Add the following TigerLogic specific files found in the TigerLogic JDK lib directory from the server side e connector jar e jca connector jar e tl
457. o the validation engine used to find the errors Usually this is the engine which applies the transformation in order to detect by validation the same errors that would be issued by transformation To define a validation scenario first open the Configure Validation Scenario dialog You do this with the Configure Validation Scenario action available on the menu XML and on the toolbar of the lt oXygen gt plugin You can use the default engine set in Preferences or use a custom validation scenario The list of reusable scenarios for documents of the same type as the current document is displayed 42 Editing documents Figure 4 20 Configure Validation Scenarios Configure Validation Scenario O Use default engine 2 Use custom validation scenario Scenarios Scenarios for XML Documents MultiValidate Sample UserManual 0 viana A validation scenario is created or edited in a special dialog opened with the New button or with the Edit one Figure 4 21 Edit a Validation Scenario Edit scenario Name Docbook 5 URL of the file to validate lial pdu docbook v5 sampleMathMLandsvG xml XML Document Default engine gt pdu docbook v5 sampleMathMLandS G xml XML Document MSXML4 0 Input type Validation engine Yalidate as you type Extension O Validate as you type is disabled in preferences g ja The table columns are URL of the file t
458. o validate Input type Validation engine Validate as you type The URL of the main module which includes the current module and which is the entry module of the validation process when the current module is validated The type of the document that is validated in the current validation unit XML document XSLT document XQuery document etc One of the engines available in lt oXygen gt for validation of the type of document to which the current module belongs If this option is checked then the validation operation defined by this row of the table is applied also by the Validate as you type feature If the Validate as you type feature 43 Editing documents Extensions is disabled in Preferences then this option does not take effect as the Preference setting has higher priority A list of Java jar files or classes which implement extensions of the language of the current module For example when the current module is an XSLT stylesheet an ex tension jar contains the implementation of the XSLT extension functions or the XSLT extension elements used in the stylesheet which includes the current module A row of the table is created or edited in the following dialog Figure 4 22 Edit a Validation Unit Add validation unit Input URL e D Projects eXml samples docbookjv5 section2 xml x 4 o Type XML Document Validation Processor LIBXML O Use detected scheme Use cus
459. oXygen gt XML Author website The button Request license for registration code in the registration dialog available from menu Window gt Preferences oXygen Register opens this request form in the default Web browser on your computer Unregistering the license key Sometimes you need to unregister your license key for example to release a floating license to be used by other user and still use the current lt oXygen gt XML Author instance with an individual Named User license or to transfer your license key to other computer before other user starts using your current computer This is done by going to Windows gt Preferences oXygen Register to display the license registration dialog making sure the text area for the license key is empty and the checkbox Use a license server is unchecked and pressing the OK button of the dialog This brings up a confirmation dialog in which you select between falling back to the license key entered previously for the case of releasing a floating license and reverting to the individual license entered previously in the Register dialog and re moving your license key from your user account of the computer Upgrading the lt oXygen gt XML Author application From time to time upgrade and patch versions of lt oXygen gt XML Author are released to provide enhancements that rectify problems improve functionality and the general efficiency of the application This section explains the procedure for upgradi
460. oXygen gt XML Author 11 2 User Manual for Eclipse Drag and Drop DnD in the Grid Editor oooccnncnnccnnccnncnnncnnnconoronccnnccnnconnconnconnconnconncnnncnnncnnrenireniss 273 Copy and Paste in the Grid Editoris ennnen pa o ro iia del ade rias 273 Bidirectional Text Support in the Grid Editor ooccoccnncnnncnnccnnconnconnconnconnconnconnconncnnncnnnrnnncnnronarcninnns 275 10 Transforming documents merene e aa n e eii ida i 276 XSLT Tramstormations ie 276 Qutput Toral 1 AAA ted 276 Transformation SCEMArlO sesine cintia ddebeder a Seb daws E NAS 277 Batch transforma A a ee eels 278 Built in transformation scenarios 2 0 0 0 tiee phn E oE EEES NEEESE SEEK EES NEE PEASE 278 Defining a new transformation scenario oocooccnccnnccnnccnnconnconnccnnccnncnnnconncnnncnnncnnnrnnncnarenoss 278 XSLT Stylesheet Parameters carrito E E EE E EE NEAS 286 Additional XSLT Stylesheets soreer e a e o E r EREE EE 287 XSLT X Query EXtensions sisone op n e e A r e e aE eS 288 Creating a Transformation Scenario coocccoccnnccnnccnnconeconncnnncnnnnnnnonnronccnnccnnccnnccnnions 288 Transformation SCenariOs VIEW s sree nan e ae a EA AEE R aE ES AE aS ERAEN E 288 XSL FO processors Fui da E E E RES eects R EER 289 Add a font to the built in FOP sendin e N a a e Ea e NEEE 290 Locate font r pen A A E o 290 Generate font Metrics Me orayan oee ae e E AE shes Eaa in RA Ee ER a E 290 Register font to FOP configuration coocccoccnnccnnccnnconeconoco
461. oc is used as transformer in the transformation scenario Skip loading the document s DTD If checked the DTD specified in the DOCTYPE declaration will not be loaded Do not apply default attributes from If checked the default attributes declared in the DTD and not specified in the document s DTD document are not included in the transformed document Do not use Internet to fetch DTD s If checked the remote references to DTD s and entities are not followed entities or docs Maximum depth in templates stack If the limit of maximum templates is reached the transformation ends with an error Verbosity If checked the transformation will output detailed status messages about the transformation process in the Warnings view Show version of libxml and libxslt If checked lt oXygen gt will display in the Warnings view the version of the used libxml and libxslt libraries invoked by XSLTProc Show time information If checked the Warnings view will display the time necessary for running the transformation 389 Configuring the application Show debug information If checked the Warnings view will display debug information about what tem plates are matched parameter values etc Show all documents loaded during If checked lt oXygen gt will display in the Warnings view the URL of all the processing files loaded during transformation Show profile information If checked lt oXygen gt will display in the Warnings view a table with all
462. ociated transformation scenario if the file is read only document s total number of characters line width if indent with tabs is enabled and the indent size The view can be accessed by going to Window Show View Other toXygen Editor properties To copy a value from the Properties View in the clipboard for example the full file path use the Copy action available on the right click menu of the view 26 Editing documents Editing XML documents Associate a schema to a document Setting a schema for the Content Completion In case you are editing document fragments for instance the chapters from a book each one in a separate file you can activate the Content Completion for these fragments in two ways Setting a default schema The list of document types available at Options Preferences gt Document Type Association contains a set of rules for associating a schema with the current document when no schema is specified within the document The schema is one of the types XML Schema XML Schema with embedded Schematron rules Relax NG XML syntax or compact syntax Relax NG XML syntax with embedded Schematron rules Schematron DTD NRL NVDL The rules are applied in the order they appear in the table and take into account the local name of the root element the default namespace and the file name of the document Important The editor is creating the Content Completion lists by analysing the specified schema and
463. ocument This action will also re parse the catalogs and reset the schema used for content completion It returns an error result list in the Message panel Mark up of current document is checked to conform with the specified DTD XML Schema or Relax NG schema rules Select menu XML gt Validate with Alt Shift V E Cmd Alt V E on Mac OS or click the button Y Validate with available in the Validate toolbar This can be used to validate the current document using a selectable schema XML Schema DTD Relax NG NRL NVDL Schematron schema Returns an error result list in the Message panel Mark up of current document is checked to conform with the specified schema rules e Select contextual menu of Navigator or Package Explorer view Batch Validation Validate to validate all selected files with their declared schemas e Select contextual menu of Navigator or Package Explorer view Batch Validation Validate With to select a schema and validate all selected files with that schema XML gt Clear validation markers Alt Shift V X Cmd Alt V X on Mac OS or click the toolbar button x Clear validation markers to clear the error markers added to the Problems view at the last validation of the current edited document e Select contextual menu of Navigator or Package Explorer view Batch Validation gt Configure Validation Scenario to configure and apply a validation scenario in one action to all the selected files in the Navigator or Packa
464. ocument using the Apache FOP engine e XMLSpec HTML transforms an XMLSpec document into HTML document e XMLSpec HTML Diff produces color coded HTML from diff markup XMLSpec HTML Slices produces chunked HTML specifications The FO document type FO describes the formatting of XML data for output to screen paper or other media 134 Predefined document types Association rules A file is considered to be an FO document when the it s namespace is http www w3 org 1999 XSL Format Schema FO documents use a XML Schema located in frameworks fo xsd fo xsd where frameworks is a subdirectory of the lt oXygen gt install directory Author extensions Transformation Scenarios The following default transformation scenarios are available e FO PDF transforms an FO document into PDF document using the Apache FOP engine The EAD document type EAD Document Type Definition DTD is a standard for encoding archival finding aids using Extensible Markup Language XML The standard is maintained in the Network Development and MARC Standards Office of the Library of Congress LC in partnership with the Society of American Archivists Association rules A file is considered to be a FO document when the it s namespace is urn isbn 1 931666 22 9 or it s public ID is DTD ead dtd Encoded Archival Description EAD Version 2002 EN Schema EAD documents use a Relax NG Schema located in framewo
465. ocuments is located in frameworks odf schemas OpenDocument schema v1 1 rng where frameworks is a subdirectory of the lt oXygen gt install directory The OASIS XML Catalog document type The OASIS http www oasis open org committees entity spec 2001 08 06 html XML catalog is a document describing a mapping between external entity references or URI s and locally cached equivalents You can read more about using catalogs in lt oXygen gt here Association rules A file is considered to be an XML Catalog document when it has the following namespace urn oas is names tc entity xmlns xml catalog or when its root element name is catalog Schema The OASIS 1 1 XSD schema used for these documents is located in frameworks xml catalog1 1 xsd where frameworks is a subdirectory of the lt oXygen gt install directory The XML Schema document type This document type is used to associated CSS stylesheets to an XML Schema so it can be visualized in the Author page 131 Predefined document types Association rules A file is considered to be an XML Schema document when the root name is schema and namespace is ht tp www w3 org 2001 XMLSchema Author extensions The following CSS alternatives are proposed for visualizing XML Schemas in the Author page frameworks xmlschema schema Documentation representation of XML Schema optimized for editing and main css viewing documentation frameworks
466. oding Initiative TEI Guidelines is an international and interdisciplinary standard that enables libraries museums publishers and individual scholars to represent a variety of literary and linguistic texts for online research teaching and preservation Association rules A file is considered to be a TEI P4 document when either of the following occurs e the root s local name is TEL2 e the document s public id is TEI P4 Schema The DTD schema used for these documents is located in frameworks tei tei2xml dtd where frameworks is a subdirectory of the lt oXygen gt install directory Author extensions The CSS file used for rendering TEI P4 content is located in frameworks tei xml tei css tei_oxygen css Specific actions are B Bold changes the style of the selected text to bold by surrounding it with hi tag and setting the rend attribute to bold Z Italic changes the style of the selected text to italic by surrounding it with hi tag and setting the rend attribute to italic U Underline changes the style of the selected text to underline by surrounding it with hi tag and setting the rend attribute to ul Note For all of the above actions if there is no selection then a new specific tag will be inserted These actions are available in any document context 125 Predefined document types 5 Insert Section inserts a new section subsection depending on the current context For example if the cu
467. of the combine attribute The following HTML tags are recognized inside the text content of an XML Schema annotation p br ul li They are rendered as in an HTML document loaded in a web browser p begins a new paragraph br breaks the current line ul encloses a list of items li encloses an item of the list For DTD lt oXygen gt defines a custom mechanism for annotation using comments enabled from the option Use DTD comments as annotations The text of a comment with the following format will be presented on content completion lt doc Description of th lement gt The operation of the Content Completion assistant is configured by the options available in the options group called Content Completion Code templates You can define short names for predefined blocks of code called code templates The short names are displayed in the content completion window if the word at cursor position is a prefix of such a short name lt oXygen gt comes with a lot of predefined code templates but you can define your own code templates for any type of editor 32 Editing documents To obtain the template list you can use the Content Completion on request shortcut key usually CTRL SPACE or the Code Templates on request shortcut key CTRL SHIFT SPACE The first shortcut displays the code templates in the same content completion list with elements from the schema of the document The second shortcut displays only the code templat
468. om sample documentation href href gt Inserts this fragment at the caret position int caretPosition authorAccess getCaretOffset authorAccess insertXMLFragment imageFragment caretPosition pk Has no arguments return null s7 public ArgumentDescriptor getArguments return null return A description of the operation public String getDescription return Inserts an image element Asks the user for a URL reference End of interface implementation Auxiliary methods Displays the URL dialog param parentFrame The parent frame for 235 Author Developer Guide the dialog return The selected URL string value or the empty string if the user canceled the URL selection private String displayURlDialog JFrame parentFrame final JDialog dlg new JDialog parentFrame Enter the value for the href attribute true JPanel mainContent new JPanel new GridBagLayout The text field GridBagConstraints cstr new GridBagConstraints cstr gridx 0 cstr gridy 0 cstr weightx 0 cstr gridwidth 1 cstr fill GridBagConstraints HORIZONTAL mainContent add new JLabel Image URI cstr cstr gridx 1 cstr weightx 1 final JTextField urlField new JTextField urlField setColumns 15 mainContent add urlField
469. on lt oXygen gt XML Author will use this certi ficate to decrypt any data stream received from the server For the authentication to succeed you should make sure the security certificate of the server hosting the repository can be read by lt oXygen gt XML Author This means that lt oXygen gt XML Author can find the certificate in the key store of the Java Runtime Environment in which it runs You know the server certificate is not in the JRE s key store if you get the error No trusted certificate found when trying to access the WebDAV repository You can add a certificate to the key store by exporting it to a local file using any HTTPS capable Web browser for example Internet Explorer and then importing this file into the JRE using the keytool executable bundled with the JRE The steps are the following using Internet Explorer if you use other browser the procedure is similar Procedure 4 3 Import a HTTPS server certificate 1 Export the certificate into a local file a Point your HTTPS aware Web browser to the repository URL If this is your first visit to the repository it will be displayed a security alert stating that the security certificate presented by the server is not trusted Figure 4 7 Security alert untrusted certificate Security Alert Information you exchange with this site cannot be viewed or Y changed by others However there is a problem with the site s security certificate A The security certifica
470. on schema Now let s add some actions for inserting a section and a table To add a new action follow the procedure 1 Open the Options Dialog and select the Document Types Association option pane 2 Inthe lower part of the Document Type Association dialog click on the Author tab then select the Actions label 3 To add a new action click on the Add button The Insert Section Action This paragraph describes how you can define the action for adding a section We assume the icon files Sec tionl6 gif for the menu item and S Section20 gif for the toolbar are already available Although we could use the same icon size for both menu and toolbar usually the icons from the toolbars are larger than the ones placed in the menus These files should be placed in the frameworks sdf directory 160 Author Developer Guide Figure 8 10 The Action Edit Dialog When this XPath expression is true invoke operation with the arguments Action ID insert_section Name Insert Section Menu access key Description Insert a section to the caret position Large icon 20x20 4frameworks sdF Section20 iF Small icon 16x16 frameworks sdF Section16 qif Shortcut key Ctrl Shift S Operations local name section or local name booKk or local name article ro sync ecss extensions commons operations InsertFragmentOperation Choose Name Fragment insertLocation insertPosition Description T
471. onicalized document could possibly be dif ferent from one produced from a canonicalized document The canonical form of an XML document is physical rep resentation of the document produced by the method described in this specification The term canonical XML refers to XML that is in canonical form The XML canonicalization method is the algorithm defined by this specification that generates the canonical form of a given XML document or document subset The term XML canonicalization refers to the process of applying the XML canonicalization method to an XML document or document subset XML canonicalization is designed to be useful to applications that require the ability to test whether the information content of a document or document subset has been changed This is done by comparing the canonical form of the original document before application processing with the canonical form of the document result of the application processing 339 Digital signature A digital signature over the canonical form of an XML document or document subset would allows the signature digest calculations to be oblivious to changes in the original document s physical representation During signature generation the digest is computed over the canonical form of the document The document is then transferred to the relying party which validates the signature by reading the document and computing a digest of the canonical form of the received document The equivalence of t
472. only with databases that have been created starting with version 4 2 1 325 Working with Databases 4 Show system collections Click OK In all other cases a message appears saying that a list of databases is not available Check this if you want to see the Tamino system collections in the Data Source Explorer How to configure a Raining Data TigerLogic Connection 1 2 4 Go to Preferences gt Data Sources In the Connections panel click the New button Enter a unique name for this connection and select one of the previously configured TigerLogic data sources from the Data Source combo box Fill in the Connection Details Host The host name or ip address of the installed TigerLogic engine Port The port number of the TigerLogic engine User User name to access the TigerLogic engine Password Password to access the TigerLogic engine Database The name of the database to access from the TigerLogic engine Click OK How to configure an Documentum xDb X Hive DB Connection l 2 Go to Preferences gt Data Sources In the Connections panel click the New button Enter a unique name for this connection and select one of the previously configured Documentum xDb X Hive DB data sources from the Data Source combo box Fill in the Connection Details URL User Password Database Run XQuery in read write session with committing The URL property for Documentum xDb X Hive DB connectio
473. ontent add okButton cstr mainContent setBorder BorderFactory createEmptyBorder 10 5 10 5 Add the Cancel button to the layout cstr gridx 2 JButton cancelButton new JButton Cancel cancelButton addActionListener new ActionListener public void actionPerformed ActionEvent e urlField setText dlg setVisible false j mainContent add cancelButton cstr When the user closes the dialog from the window decoration assume Cancel action dlg addWindowListener new WindowAdapter public void windowClosing WindowEvent e urlField setText dlg getContentPane add mainContent dlg pack dlg setLocationRelativeTo parentFrame dlg setVisible true 237 Author Developer Guide return urlField getText public s InsertImageOperation operation System out println Choosen URL tion displayURLDialog new JFrame Test method para tatic void main String args new InsertImageOperation opera QueryDatabaseOperation java m args The arguments are ignored package simple documentation framework import java sql Connection import java sql DriverManager import java sql ResultSet import java sql ResultSetMetaData import java sql SQLException import java util Properties import ro sync ecss ext
474. onvert to Simple Document Allows you to convert a virtual document to a simple document Action is available only if the object is a virtual document with no descendants e Copy location Allows you to copy to clipboard an application specific URL for the object which can then be used for various actions like opening or transforming the resources Refresh Performs a refresh of the selected object est Properties Displays the list of properties of the selected object DITA transformations on DITA content from Documentum lt oXygen gt comes with the DITA Open Toolkit which is able to transform a DITA map to various output formats However DITA Open Toolkit requires local DITA files so first you need to check out a local version of your DITA content Once you have a local version of a DITA map just load it in the DITA Maps Manager view and run one of the DITA transformations that are predefined in lt oXygen gt or a customization of such a predefined DITA transform ation Note a The DITA files checked out from the Documentum CMS add the dctm namespace which is not supported by the DITA DTDs You need to set the validate parameter to false in your DITA transformation in order to avoid the validation error that would be reported at the beginning of the DITA transformation if the validate parameter keeps the default value true 338 Chapter 15 Digital signature Overview Digital signatures are widely used as security
475. ook document when either of the following occurs root element name is a book or article e public id of the document contains OASIS DTD DocBook XML Schema The schema used for DocBook documents is in frameworks docbook dtd docbookx dtd where frameworks is a subdirectory of the lt oXygen gt install directory Author extensions The CSS file used for rendering DocBook content is located in frameworks docbook css docbook css Specific actions for DocBook documents are B Bold emphasized text emphasizes the selected text by surrounding it with lt emphasis role bold gt tag Italic emphasized text emphasizes the selected text by surrounding it with lt emphasis role italic gt tag U Underline emphasized text emphasizes the selected text by surrounding it with lt emphasis role italic gt tag Note For all of the above actions if there is no selection then a new emphasis tag with specific role will be inserted These actions are available in any document context These actions are grouped under the Emphasize toolbar actions group e link inserts a hypertext link e ulink inserts a link that address its target by means of an URL Universal Resource Locator e olink inserts a link that address its target indirectly using the targetdoc and targetptr values which are present ina Targetset file 108 Predefined document types Figure 7 2 Insert OLink Dialog OLink Targ
476. oolbar 121 Predefined document types Templates Default templates available for DITA Maps are stored in frameworksDir dita templates map folder They can be used for easily creating a DITA map and bookmap files These templates are available when creating new documents from templates DITA Map Bookmap New DITA Bookmap DITA Map Map New DITA Map DITA Map Learning Map New DITA learning and training content specialization map DITA Map Learning Bookmap New DITA learning and training content specialization bookmap DITA Map Eclipse Map New DITA learning and training content specialization bookmap Catalogs The default catalog is stored in frameworks dita catalog xml Transformation Scenarios The following predefined transformation scenarios are available for DITA Maps DITA Map XHTML transforms a DITA Map to XHTML using DITA Open Toolkit 1 5 M24 DITA Map PDF Idiom FO Plugin transforms a DITA Map to PDF using the DITA Open Toolkit 1 5 M24 and the Apache FOP engine The XHTML document type The Extensible HyperText Markup Language or XHTML is a markup language that has the same depth of expression as HTML but also conforms to XML syntax Association rules A file is considered to be a XHTML document when the root element name is a html Schema The schema used for these documents is located in frameworks xhtml dtd xhtml1 strict dtd where frameworks is a subdirectory of the lt oXygen
477. oper Guide return handleTyping Handle an insertion event either typing or paste Qparam offset Offset where the insertion event occurred param fragmentsToInsert Fragments that must be inserted at the given offset param authorAccess Author access return lt code gt true lt code gt if the event was handled lt code gt false lt code gt otherwis throws InvalidEditException The event was rejected because it is invalid private boolean handleInsertionEvent int offset AuthorDocumentFragment fragmentsTolnsert AuthorAccess authorAccess throws InvalidEditException AuthorSchemaManager authorSchemaManager authorAccess getDocumentController getAuthorSchemaManager boolean handleEvent false try AuthorNode nodeAtInsertionOffset authorAccess getDocumentController getNodeAtOffset offset if isElementWithNameAndNamespace nodeAtInsertionOffset SDF_TABLE Check if the fragment is allowed as it is boolean canInsertFragments authorSchemaManager canInsertDocumentFragments fragmentsTolnsert offset AuthorSchemaManager VALIDATION_MODE_STRICT_FIRST_CHILD_LAX_OTHERS if canInsertFragments handleEvent handleInvalidInsertionEventInTable offset fragmentsTolnsert authorAccess authorSchemaManager else if isElementWithNameAndNamespace no
478. or DITA Working with content references The DITA feature called conref short for content reference enables a piece of content to be included by reference in multiple contexts When you need to update that content you need to update it in only one place Typical uses of content references are for product names warnings definitions or process steps You can use either or both of the following strategies for managing content references e Reusable components With this strategy you create a new file for each piece of content that you want to reuse e Arbitrary content references You may prefer to keep many pieces of reusable content in one file For example you might want one file to consist of a list of product names with each product name in a phrase lt ph gt element within the file Then wherever you need to display a product name you can insert a content reference that points to the appropriate lt ph gt element in this file This strategy requires more setup than Reusable Components but makes easier centrally managing the reused content lt oXygen gt XML Author creates a reference to the external content by adding a conref attribute to an element in the local document The conref attribute defines a link to the referenced content made up of a path to the file and the topic ID within the file The path may also reference a specific element ID within the topic Referenced content is not physically copied to the referenc
479. or createAttributesValueEditor return new SDFAttributesValueEditor Simple documentation framework state listener e public AuthorExtensionStateListener createAuthor return new SDFAuthorExtensionStatelistener boolean arg0 ExtensionStateListener Filter for content completion proposals from the schema manager af public SchemaManagerFilter createSchemaManagerFilter return new SDFSchemaManagerFilter Default element locator ay public ElementLocatorProvider creat return new DefaultElementLocatorProvider ElementLocatorProvider 242 Author Developer Guide Expand content references E public AuthorReferenceResolver createAuthorReferenceResolver return new SDFReferencesResolver pk CSS styles filtering xf public StylesFilter createAuthorStylesFilter return new SDFStylesFilter pk Provider for table cell span informations ed public AuthorTableCellSpanProvider createAuthorTableCellSpanProvider return new TableCellSpanProvider pk Table column width provider responsible of handling modifications regarding table width and column widths dl public AuthorTableColumnWidthProvider createAuthorTableColumnWidthProvider return new TableColumnWidthProvider pk Editing support for SDF documents responsible of handling typing and paste events inside sec
480. or the namespace of the document root Description Shows a small definition for the currently selected element Add optional content If it is selected the elements and attributes that are defined in the XML Schema as optional are generated in the skeleton XML document created in a new editor panel when the OK button is pressed Add first Choice particle If it is selected the first element of an xs choice schema element is generated in the skeleton XML document created in a new editor panel when the OK button is pressed 18 Editing documents Figure 4 2 The Create an XML Document DTD Tab New XML Document Customize document XML schema DTD RNG RNC NRL NYDL URL file E samples frameworks docbook 4 4 dtd docbookx dtd iv a use relative paths Root Element article lv PublicID 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 Add optional content Add first Choice particle Complete the dialog as follows System ID Specifies the location of a Document Type Definition DTD Document Root Populated from the elements defined in the specified DTD enables s
481. or this col null ttribute null colWidt hAttribute getValue Representation objects for the columns this customcol specification ttribute colChild getAttribute width new WidthRepresentation colWidth true 200 Author Developer Guide The method isTableAcceptingWidth should check if the table cells are td public boolean isTableAcceptingWidth String tableCellsTagName return td equals tableCellsTagName The method isTableAndColumnsResizable should check if the table cells are td This method determines if the table and columns can be resized by dragging with the mouse the edge of a column public boolean isTableAndColumnsResizable String tableCellsTagName return td equals tableCellsTagName The methods get TableWidth and getCel 1Width are used for determining the table width and the column width The table layout engine will ask this AuthorTableColumnWidthProvider implementation what is the table width for each table element and the cell width for each cell element from the table that was marked as cell in the CSS using the property display table cell The implementation is simple and just parses the value of the width attribute The methods must return nul 1 for the tables cells that do not have a specified width public WidthRepresentation getTableWidth String tableCellsTagName WidthRepresentation toReturn null if tableElement null amp amp td
482. ork file that is the file defined as External Storage in Document Type Association dialog shall always be stored inside the sdf directory If your external storage points somewhere else lt oXygen gt will not be able to update the Document Type Association options automatically on the deployed computers Author Settings You can add a new Document Type Association or edit the properties of an existing one from the Options Prefer ences Document Type Association option pane All the changes can be made into the Document type edit dialog 159 Author Developer Guide Figure 8 9 The Document Type Dialog Document type Name SDF Description A Simple Documentation Framework Storage Internal O External Rules Namespace Root local name File name Public ID Jaya class ls m gt Q x Schema Classpath Author Templates Catalogs Transformation Extensions The schema defined here is used only if there is no schema detected in the XML file Schema type xm Schema x Schema URI 4 frameworks sdfisdF xsd w e Initial page o Configuring Actions Menus and Toolbars The lt oXygen gt Author toolbars and menus can be changed to provide a productive editing experience for the content authors You can create a set of actions that are specific to a document type In the example with the sdf framework you created the stylesheet and the validati
483. orming a large DITA map transformation you may want to in crease the memory allocated to the Java Virtual Machine from the default value 64 MB to a higher value 256MB You can do this easily by setting the value Xmx256m without quotes to the JVM Arguments text field In this way you can avoid the Out of Memory OutOfMemoryError messages received from the ANT process Oxygen adds by default as high priority libraries which are not transformation depend ent and also patches for certain DITA Open Toolkit bugs You can specify all the ad ditional libraries jar files or additional class paths which will be used by the ANT transformer You can also decide to control all libraries added to the classpath Example 6 2 Additional jars specified for XHTML For example the additional jars specified for XHTML are the DITA OT dost and re solver jars xerces and saxon 6 jars In the Output Tab you can configure options related to the place where the output will be generated Figure 6 9 Output settings tab Edit DITA Scenario Scenario Type PDF DITA OT Base directory Output Folder Output File Open in browser Saved file other location Name hierarchy PDF DITA OT Parameters Filters Advanced Output Temporary files directory temp Woe Woe Woe You have several parameters that you can specify here 99 Author for DITA Base directory All the relative paths which appear as val
484. orresponding listener is available only for lt oXygen gt Eclipse plugin The methods corresponding to each implementation are creat eAuthorAWTDndListener createText SWIDnd Listener and createAuthorSWTDndListener public AuthorDnDListener createAuthorAWTDndListener return new SDFAuthorDndListener For more details about the Author drag and drop listeners see the Configuring a custom Drag and Drop listener section Another extension which can be included in the bundle is the reference resolver In our case the references re represented by the ref element and the attribute indicating the referred resource is location To be able to obtain the content of the referred resources you will have to implement a Java extension class which implements the ro sync ecss extensions api AuthorReferenceResolver The method responsible for creating 185 Author Developer Guide the custom references resolver is createAuthorReferenceResolver The method is called each time a document opened in an Author editor page matches the Document Type Association where the extensions bundle is defined The instantiated references resolver object is kept and used until another extensions bundle corresponding to another Document Type is activated as result of the detection process public AuthorReferenceResolver createAuthorReferenceResolver return new ReferencesResolver A more detailed description of the references re
485. ors If you paste xml content the result will be the insertion of the nodes obtained by parsing this content Figure 9 6 Copying XML data into grid lt person id one worker gt lt family gt Worker lt family gt name family Worker lt given Ones given _ a lt name gt given One lt email one oxygenxml com lt email email one oxygenxml com slink manager Big Boss gt link s person gt manager Big Boss If the pasted text contains multiple lines of tab separated values it can be considered as a matrix of values By pasting this matrix of values into the grid editor the result will be a matrix of cells If the operation is performed inside existing cells the values from these cells will be overwritten and new ones will be created if needed This is useful for example when trying to transfer data from Excel like editors into grid editor 274 Grid Editor Figure 9 7 Copying tab separated values into grid id email 1 Big Boss chief oxygenxml com 1d1 Email 142 Email2 143 Email3 Bidirectional Text Support in the Grid Editor If you are editing documents employing a different text orientation you can change the way text is rendered and edited in the grid cells For this you can use the shortcut CTRL SHIFT O to toggle from the default left to right text orientation to the right to left orientation Note that this change applies only to the text from the cells not to the l
486. ortant lt oXygen gt Author handles both absolute and relative specified URLs If the image has an absolute URL location e g http www oasis open org images standards oasis_standard jpg then it is loaded directly from this location If the image URL is relative specified to the XML document e g images my_screenshot jpg then the location is obtained by adding this value to the location of the edited XML document An image can also be referenced by the name of a DTD entity which specifies the location of the image file For example if the document declares an entity graphic which points to a JPEG image file lt i ENTITY graphic SYSTEM depo keyboard_shortcut jpg NDATA JPEG gt and the image is referenced in the XML document by specifying the name of the entity as the value of an attribute lt mediaobject gt lt imageobject gt lt imagedata entityref graphic scale 50 gt lt imageobject gt lt mediaobject gt The CSS should use the functions url attr and unparsed entity uri for displaying the image in the Author mode 7 Note Note that the scale attribute of the imagedata element will be considered without the need of a CSS customization and the image will be scaled accordingly 150 Author Developer Guide imagedata entityref content url unparsed entity uri attr entityref To take into account the value of the width attribute of the imagedata and use it for resizing the image
487. orted in lt oXygen gt Author The properties from the table below belong to the visual category 211 Author Developer Guide Table 8 5 CSS Level 2 1 Properties and their support in lt oXygen gt Author Name Supported Values Not Supported Values background attachment ALL background color lt color gt inherit transparent background image ALL background position ALL background repeat ALL background ALL border collapse ALL border color lt color gt inherit transparent border spacing ALL border style lt border style gt inherit border top border right border bot lt border width gt lt border style gt border top tom border left color inherit border top color border right color lt color gt inherit transparent border bottom color border left color border top style border right style lt border style gt inherit border bottom style border left style border top width border right width lt border width gt inherit border bottom width border left width border width lt border width gt inherit border lt border width gt lt border style gt I border top color inherit bottom ALL caption side ALL clear ALL clip ALL color lt color gt inherit content normal none lt string gt lt uri gt lt counter gt attr no open qu
488. osition of the first element and Backspace key is pressed e The caret is located before the start position of the second element and Delete key is pressed e The caret is located after the start position of the second element and Backspace key is pressed In either of the described cases if the element has no sibling or the sibling element has a different name Unwrap op eration will be performed automatically Unwrapping the content of an element You can unwrap the content of an element by deleting its tags using the Delete element tags action from the editor contextual menu The same action can be triggered in the next situations e The caret is located before the start position of the element and Delete key is pressed e The caret is located after the start position of the element and Backspace key is pressed e The caret is located before the end position of the element and Delete key is pressed The caret is located after the end position of the element and Backspace key is pressed 77 Authoring in the tagless editor Removing all the markup of an element You can remove the markup of the current element and keep only the text content with the action Remove All Markup available on the submenu Refactoring of the contextual menu and on the toolbar XML Refactoring When you press Delete or Backspace in the presented cases the element is unwrapped or it is joined with its sibling Tf the current element is empty the element
489. ote no close lt identifier gt open quote close quote inherit quote counter increment lt identifier gt lt integer gt none inherit counter reset lt identifier gt lt integer gt none inherit cursor ALL direction ltr rtl inherit display inline block list item table table row group run in inline block in table header group table footer group table row line table considered table column group table column table cell block table caption none inherit empty cells show hide inherit float ALL font family lt family name gt lt generic family gt lt family name gt lt generic family gt inherit 212 Author Developer Guide Name Supported Values Not Supported Values font size lt absolute size gt lt relative size gt lt length gt lt percentage gt inherit font style normal italic oblique inherit font variant ALL font weight normal bold bolder lighter 100 200 300 400 500 600 700 800 900 inherit font font style II font weight font size line font variant line height height font family inherit caption icon menu message box small cap tion status bar height ALL left ALL letter spacing
490. ou have to restart lt oXygen gt after removing an extension from the table in order for that extension to not be recognised anymore as an archive extension Custom Editor Variables A custom editor variable is defined by a name a string value and a text description and can be used in the same expres sions where the built in variables can be used for example the command line of an external tool the working directory of a custom external validator or the input URL of a transformation scenario The string value will replace the name of the variable in the expression at runtime 404 Configuring the application Figure 17 57 Custom editor variables Custom Editor Variables lt p v Name Value Description A istart dir E E Start directory of command line validator standard params c config xml v level 5 list List of command line standard parameters Network Connections 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 Configuration dialog enables 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 Network Connections panel by selecting Window Preferences gt Author Network Configuration Figu
491. ource field of the scenario is empty because the XML data is read with XQuery functions like document When the XML 277 Transforming documents source is a local XML file the URL of the file is specified in the XML input field of the scenario A scenario can be created at document type level or at global level The scenarios defined at document type level are available only for the documents that match that document type The global scenarios are available for any document In order to apply a transformation scenario one has to press the Apply Transformation Scenario button from the Transformation toolbar Batch transformation Alternatively a transform action can be applied on a batch of files from the Project view s contextual menu 52 without having to open the files Apply Transformation Scenario applies to each selected file the transformation scenario associated to that file If the currently processed file does not have an associated transformation scenario then a warning is displayed in the Warnings view to let the user know about it Transform with allows the user to select one transformation scenario to be applied to each one of the currently selected files Built in transformation scenarios If the Apply Transformation Scenario button from the Transformation toolbar is pressed currently there is no scenario associated with the edited document and the edited document contains a xml stylesheet processin
492. owse for remote file Opens a URL browser dialog allowing to select a remote file name for the text field Browse for archived file Opens a zip archive browser dialog allow ing to select a file name from a zip archive that will be inserted in the text field 280 Transforming documents XSL URL Use xml stylesheet declaration Transformer Parameters Append header and footer Additional XSLT stylesheets Extensions Advanced options 2 Open in editor Opens the file with the path specified in the text field in an editor panel Specifies an input XSL file to be used for the transformation Please note that this URL is resolved through the catalog resolver If the catalog does not have a mapping for the URL then the editor will try to use the file directly The above set of browsing buttons are available also for this input Use the stylesheet declared with an xml stylesheet declaration instead of the stylesheet specified in the XSL URL field By default this checkbox is not selec ted and the transformation applies the XSLT stylesheet specified in the XSL URL field If it is checked the scenario applies the stylesheet specified explicitly in the XML document with the xml stylesheet processing instruction This combo box contains all the transformer engines available for applying the stylesheet These are the built in engines and the external engines defined in the user preferences If you want to change the
493. page Window gt Preferences gt oXygen you can find the Import Export preferences buttons which allow you to move your global preferences in XML format from one computer to another Preferences Once the application is installed you can use the Preferences dialog accessed from Options gt Preferences to customize the application for your requirements and network environment You can always revert modifications to their default values by using the Restore Defaults button available in each preference page If you don t know how to use a specific preference that is available in any Preferences panel or what effect it will have you can open a help page about the current panel at any time using the help button located in the left bottom corner of the dialog Figure 17 1 The Help button of the Preferences dialog XML XML Structure Outline Plug in Development Run Debug A restricted version of the Preferences dialog is available at any time in editors of the lt oXygen gt plugin by right clicking in the editor panel and selecting Preferences 349 Configuring the application Figure 17 2 Eclipse Preferences dialog restricted version Preferences ay editor Ex Editor er General Appearance color options Ant Editor background Color c Java Completion proposal background oxy Completion proposal foreground Documentation window background Documentation window Foregrou
494. panel Schema Aware Schema aware normalization Format and indent Indent blocks only content Schema Aware Editing Oon Oof Custom Schema aware actions Delete element tags with backspace and delete Smart delete Reject action when its result is invalid Paste and Drag and Drop Smart paste and drag and drop Reject action when its result is invalid Typing Smart typing Reject action when its result is invalid Content Completion Allow only insertion of valid elements and attributes Warn on invalid content when performing action Join Elements Delete Element Tags Schema aware normalization format When opening a document in Author white spaces can be normalized or removed and indent in order to obtain a more compact display The reverse process takes place when saving the document in the Author By default this algorithm is controlled by the CSS display property If this option is checked then this process will be schema aware so the algorithm will take into account if the element is declared as element only or mixed It will also take into account options Preserve space elements Default space elements Mixed content elements from option page Window Preferences Author gt Editor gt Format XML Indent blocks only content If checked even if an element is declared in the schema as being mixed but it has a blocks only content as specified by the CSS property display of its chil dren it will be treat
495. pen and edit specializations of DITA Maps All advanced edit actions available for the map like insertion of topic refs heads properties editing allow the user to specify the element to insert in an editable combo Moreover the elements which appear initially in the combo are all the elements which are allowed to appear at the insert position for the given specialization The topic titles rendered in the DITA Maps Manager are collected from the target files by matching the class attribute and not a specific element name When editing DITA specializations of maps in the main editor the insertions of topic reference topic heading topic group and conref actions should work without modification For the table actions you have to modify each action by hand to insert the correct element name at caret position You can go to the DITA Map document type from the Document Type Association page and edit the table actions to insert the element names as specified in your specialization See this section for more details Editing DITA Topic specializations In addition to recognizing the default DITA topic formats topic task concept reference and composite topic special izations can also be edited in the Author page 103 Author for DITA The Content Completion should work without additional modifications and you can choose the tags which are allowed at the caret position The CSS styles in which the elements are rendered should also work o
496. ple shc _ para This is a Figure title Lake in Fagaras mediaobject imageobject para In order to preview para To apply the stylesh 3 0 secti title CALS Tables and List we D THe A E E gil Ae E KVUERE xD0r OA Eile Edit Navigate Search Project XML Tools Run XML DocBook4 Window Help ae aa SEA A H gl fed personal xml personal xsd fet sample xml Su ziu gt a gt Era ss WMH EEE A Y SY r A css DocBook default iv article gt Article Welcome to the Docbook Inline Markup and Images This is a sample showing that lt oXygen b gt 4 can be used to edit documents in conformity with the dockbookx dtd This is a PDochookd figure inserted using the bimagedata tag Lake in Fagaras In order to preview this text in a Web browser you have to choose the gt Docbook HTML 4 transformation scenario For this press the gt Configure transformation scenario 4 button or the shortcut gt CTRL SHIFT C 4 or gt META SHIFT C 4 on Mac OS X then select the scenario Press bOk4 To apply the stylesheet you have to press the Apply transformation scenario button or to press POTRL SHIFT T4 gt META SHIFT T 4 on Mac OSX lv Text Grid Author Writable Insert yaaa Al Attributes 23 u las para condition userlevel role lt x Elements 23 para Attribute id lang remap xreflabel revisionflag arch Value
497. plified DITA Maps view like editing a relationship table you can open the map in the main editing area See more about editing a map in the main edit area here Open the map in the main editing area with all the topic references expanded in the map content The additional edit toolbar can be shown by clicking the Show Hide additional toolbar expand button located on the general toolbar The following edit actions can be performed on an opened DITA Map Insert Topic Reference El Insert Topic Heading El Insert Topic Group Edit properties A Edit other attributes X Delete t Move Up Y Move Down Promote Inserts a reference to a topic file See more about this action here Inserts a topic heading See more about this action here Inserts a topic group See more about this action here Edit the properties of a selected node See more about this action here Edits all the attributes of a selected node A dialog is presented allowing the user to see and edit the attributes of the selected node See here for more details about editing attributes Deletes the selected nodes Moves the selected nodes in front of their respective previous siblings Moves the selected nodes after their next respective siblings Moves the selected nodes after their respective parents as a siblings 89 Author for DITA Demote Moves the selected nodes as children to their respective previous siblings The contextual menu conta
498. port display block margin lem description display block background color EEEE color black E Ay Ay line display block important display inline font weight bold title display block font size 2em results display table margin 2em border 1px solid green entry display table row test_name passed display table cell border 1lpx solid green padding 20px 140 Author Developer Guide passed font we ight bold Figure 8 2 A report opened in the Author document report description line important xml stylesheet type text css href test reports css Automated test report This is the report of the test automatically ran Each test suite is ran at 20 00h each day Database connection test XSLT transformation test DTD validation test false Please bcheck 4 the failed ones Text Grid Author The XML Instance Template Based on the XML Schema and the CSS file the lt oXygen gt Author can help the content author in loading editing and validating the test reports An XML file template must be created a kind of skeleton that the users can use as a starting point for creating new test reports The template must be generic enough and refer the XML Schema file and the CSS stylesheet This is an example lt xml version 1 0 encoding UTF 8 gt lt xml styl sheet type text css href test_report
499. pplies to XSL files the field XSL URL is containing currentFile Just like in the XML case you can specify here the path to a master stylesheet The path can be configured using the editor variables or the custom editor variable 283 Transforming documents Figure 10 4 The Configure Transformation Dialog FO Processor Tab Edit scenario Scenario XSLT FO Processor Output IV Perform FO Processing Name Docbook PDF Input XSLT result as input Edited document as input Method pdf v Processor Built in Apache FOP OK Cancel Checkbox Perform FO Processing Radio button XSLT result as input Radio button Edited document as in put Combo box Method Combo box Processor Enable or disable applying an FO processor either the built in Apache FOP engine or an external engine defined in Preferences during the transformation The FO processor is applied to the result of the XSLT transformation defined on the XSLT tab of the dialog The FO processor is applied directly to the current edited document The output format of the FO processing PDF PostScript or plain text The FO processor which can be the built in Apache FOP processor or an external processor 284 Transforming documents Figure 10 5 The Configure Transformation Dialog Output Tab Edit scenario Scenario Name Docbook PDF XSLT FO Processor Output Output File Open in browse
500. pport for the most common types of links e links based on ID attribute values e XPointer element scheme The method getElement Locator determines what Element Locator should be used In the default implement ation it checks if the link is an XPointer element scheme otherwise it assumes it is an ID A non null IDTypeVeri fier will always be provided if a schema is associated with the document type The l ink string argument is the anchor part of the of the URL which is composed from the value of the link property specified for the link element in the CSS public ElementLocator getElementLocator IDTypeVerifier idVerifier String link 191 Author Developer Guide Element tor elementLocator try if link startsWith xpointer eleme elementLoca Oca null element nt scheme new X GOE PointerElementLocator idVerifier link else Loca eleme catch Elemen logger warn Exceptio ment new I te link ele ntLoca by ID Elemen D COE tLocatorException e n when creat W tLocator idVerifier link lement locator for link link Cause e e return elementLocator The XPointerElementLocator implementation The XPointerElementLocator is an implementation of the abstract class ro sync ecss exten sions api link Element Locator for links that have one of the
501. prefix ocooccncccnccnnccnnccnnccnnccnnccnncnnnconaconaconiconoss 60 Editing CSS Stylesheets sn NO 61 Validating CSS stylesheetsiuii o E E i n 61 lt oXygen gt XML Author 11 2 User Manual for Eclipse Content Completion in CSS stylesheets oooococccnccnnccnnconnconnconncnnnconncnnncnnncnnrcnnronnrnnccnnconnccnnions 61 CSS Outline Vivos ra 61 Folding 1 CSS Stylesheets aturdido cria cett pleno ines me dtu cates E nouensaes ita 62 Formatting and indenting CSS stylesheets pretty print cece cece eee ec cece ceca een eeneeeneeeenees 62 Other CSS COIN actions isos e sea weed RE ORE E ph Sunes she Sea teeny vem ess pived dese a Seabees 62 Changing the user interface language ssn e cee ccee E cece ce eece cena cena E E A A E teen sean sean eegs 62 Handling A SN 63 3 Authoring in the tagless edita tl ete 64 Authoring XML documents without the XML tags ooocoocccnccnnconnccnnccnncnnnconncnnncnnncnnronnrnnncnnconncinnccnnions 64 General Author Pres ntationy its is aia 65 AUN VIEWS ont si oil Moved eGth veh nee E a thas dnc A EE E ES 66 OUTLINE VIEW Suit e a seed wee Sh ae teed ta edith eg Muh ered oes ASIS 66 XML Document Overview ce ces cin ecegenstee ooh sumads ne Sacgonpeseee sk cangdav Ea EEE TEREE ENEE 66 Modification Follow up siii ia is li ee Mae eel ete ine ee 67 Document Structure Change ssn eae deoevent scenes ssgersenssacouetuades geea dav INE 67 The popup menu of the Outline tree 2 0 0 eee cee cee ce ee
502. processor for transforming XML documents into HTML text or other XML document types It implements XSL Transformations XSLT Version 1 0 and XML Path Language XPath Version 1 0 Saxon 6 5 5 http saxon sourceforge net saxon6 5 5 is an XSLT processor which implements the Version 1 0 XSLT and XPath with a number of powerful extensions This version of Saxon also includes many of the new features that were first defined in the XSLT 1 1 working draft but for conformance and portability reasons these are not available if the stylesheet header specifies ver sion 1 0 Saxon 9 2 0 6 Home Edition HE Saxon HE PE http saxon sf net implements the basic conformance level for Professional Edition PE XSLT 2 0 and XQuery The term basic XSLT 2 0 processor is defined in the draft XSLT 2 0 specifications it is a conformance level that requires support for all features of the language other than those that involve schema processing The HE product remains open source but removes some of the more advanced features that were present in Saxon PE Saxon 9 2 0 6 Enterprise Edition Saxon EE http www saxonica com is the schema aware edition of Saxon 9 EE and it is one of the built in processors of lt oXygen gt Saxon EE includes an XML Schema processor and schema aware XSLT XQuery and XPath pro cessors The validation in schema aware transformations is done according to the W3C XML Schema 1 0 specification or according to the
503. putSource inputSource entityResolver resolveEntity null absoluteUrl toString if inputSource null inputSource new InputSource absoluteUrl toString XMLReader xmlReader authorAccess newNonValidatingXMLReader xmlReader setEntityResolver entityResolver saxSource new SAXSource xmlReader inputSource catch MalformedURLException e logger error e is catch SAXException e logger error e catch IOException e logger error e jes return saxSource Get an unique identifier for the node referenc 260 Author Developer Guide The u recursively param node The node that has refer return An unique identifier for t Ef public String getReferenceUniquelD Aut String id null if node getType AuthorNode NOD AuthorElement element AuthorEle if ref equals element getLocalN AttrValue attrValue element g if attrValue null id attrValue getValue return id The referenc nod param nod XA AA A F F gt return The systemID of the referred conten public String getRefer AuthorAccess au String systemID null if node getTyp AuthorElement if Q lem nt AttrValue attrValu ref equals element get nceSystemID Aut thorAccess AuthorNode NODE_TYPE nique identifier is used to avoid resolvi
504. r Saved file Other location C Open in editor Show As XML Image URLs are relative to O Prompt for file Save As 4cfd 4cFn pdf 4 la Cancel Radio button Prompt for file Text field Save As Check box Open in browser Radio button Saved file Radio button Other location Check box Open in editor Check box Show As XHTML At the end of the transformation a file browser dialog will be displayed for specifying the path and name of the file which will store the transformation result The path of the file where it will be stored the transformation result The path can include special lt oXygen gt editor variables or custom editor variables If this is checked lt oXygen gt will open automatically the transformation result in a browser application specific for the type of that result HTML XHTML PDF text When Open in browser is selected this button can be selected to specify that lt oXygen gt should open automatically at the end of the transformation the file specified in the Save As text field When Open in browser is selected this button can be used to specify that lt oXygen gt should not open the file specified in the Save As text field it should open the file specified in the text field of the Other location radio button The file path can include special lt oXygen gt editor variables or custom editor variable When this is checked the transformation result set in the
505. r example the Java system property varname can be inserted in any expression where built in editor variables like currentFileURL are allowed with the expression system var name An editor variable can be created also from an environment variable of the operating system For example the environ ment variable VAR_NAME can be inserted in any expression where built in editor variables like currentFileURL are allowed with the expression env VAR_NAME The current date can be inserted at cursor location with the custom variable date yyyy MM dd The date format is the year with 4 digits the month with 2 leters the day with 2 letters The custom editor variables are configured in Preferences 410 Chapter 18 Common problems 18 1 Before installing Oxygen XML Editor Author I had no problems viewing XML files in Internet Explorer but now Internet Explorer opens an XML file in Oxygen XML Editor Author How can I view XML files in Internet Explorer again oooooonoccnonccononocononocononoconororo nono ro nrn corro ron roce nnrncrnnrnronrnronnorinanos 411 18 2 I associated the ext extension with lt oXygen gt in Eclipse Why does an ext file opened with the Oxygen XML Editor not have syntax highlight ooooonccoccnnccnnccnnconoconoconaconocnnccnoronccnnconnccnnccnncons 411 18 1 Before installing Oxygen XML Editor Author I had no problems viewing XML files in Internet Explorer but now Internet Explorer opens an X
506. r panel at the cursor position Attributes view The Attributes panel presents all the possible attributes of the current element allowed by the schema of the document and allows to insert attributes in the current element or change the value of the attributes already used in the element The attributes already present in the document are painted with a bold font Default values are painted with grey color Clicking on the Value column of a table row will start editing the value of the attribute from the selected row If the possible values of the attribute are specified as list in the schema associated with the edited document the Value column works as a combo box where you can select one of the possible values to be inserted in the document The attributes table is sortable by clicking on the column names Thus the table s contents can be sorted in ascending order in des 68 Authoring in the tagless editor cending order or in a custom order where the used attributes are placed at the beginning of the table as they appear in the element followed by the rest of the allowed elements as they are declared in the associated schema Figure 5 5 The Attributes View Y person lv Attribute Value id Big Boss contr false Y A combo box located in the upper part of the view allows you to edit the attributes of the ancestors of the current element The contextual menu of the view allows you to insert a new element Add ac
507. r table caption display placed at the beginning or the end of an element displayed as a table will be grouped and presented as blocks at the top or the bottom of the table Note Mixing elements having table cell table group table row etc display type with others that have block or inline display or with text content breaks the layout of the table In such cases the table is shown asablock Note Having child elements that do not have table cell or table display in a parent with table row display breaks the table layout In this case the table display is supported for the children of the tab1e row element in order to allow sub tables in the parent table Note lt oXygen gt Author can automatically detect the spanning of a cell without the need to write a Java extension for this This happens if the span of the cell element is specified using the colspan and rowspan attributes just like in HTML or cols and rows attributes For instance the following XML code lt table gt lt UE gt lt td gt Cell 1 1 lt td gt lt td gt Cell 1 2 lt td gt lt td gt Cell 1 3 lt td gt lt tr gt lt tr gt lt td gt Cell 2 1 lt td gt lt td colspan 2 rowspan 2 gt Cell spanning 2 rows and 2 columns lt td gt lt tr gt lt tr gt lt td gt Cell 3 1 lt td gt lt tr gt lt table gt using the CSS table display table tr display table row td 148 Author Developer Guide di
508. r will be capitalized The uppercase function This function transforms to upper case the text received as argument uppercase text text text The text to be capitalized The lowercase function This function transforms to lower case the text received as argument lowercase text text text The text to be lower cased The concat function This function concatenates the received string arguments concat str_1 str_2 SETA ds x str_2 str_1 str_n The string arguments to be concatenated 224 Author Developer Guide The replace function This function has two signatures e replace text target replacement text target replacement This function replaces each substring of the text that matches the literal target string with the specified literal replace ment string text The text in which the replace will occur target The target string to be replaced replacement The string replacement e replace text target replacement isRegExp text target replacement isRegExp This function replaces each substring of the text that matches the target string with the specified replacement string text The text in which the replace will occur target The target string to be replaced replacement The string replacement isRegExp If true the target and replacement arguments are considered regular expressions in PERL syntax if false they are considered literal str
509. rPath i 192 Author Developer Guide catch NumberFormatException e invalidFormat true if invalidFormat throw new ElementLocatorException Only the element scheme is supported when locating XPointer links Supported formats element elementID element 1 2 3 element elemID 2 3 4 teks if Character isDigit xpointerPath 0 charAt 0 This is the case when xpointer have the following pattern 1 5 7 xpointerPathDepth xpointerPath length else This is the case when xpointer starts with an element ID xpointerPathDepth 1 startWithElementID true The method startElement will be invoked at the beginning of every element in the XML document even when the element is empty The arguments it takes are uri the namespace URI or the empty string if the element has no namespace URI or if namespace processing is disabled localName the local name of the element qName the qualified name of the element atts the attributes attached to the element If there are no attributes it will be empty The method returns t rue if the processed element is found to be the one indicated by the link The XPointerElementLocator implementation of the startElement will update the depth of the current element and keep the index of the element in its parent If the xpointerPath starts with an element ID then the current element ID is verified to match the specified ID If this i
510. rameter If the parameter setting is user defined and therefore variable the assistant will be closed to enable manual insertion The values of the attributes can be learned from the same elements in the current document If you press CTRL Enter instead of Enter or Tab after inserting the start and end tags in the document lt oXygen gt will insert an empty line between the start and end tag and the cursor will be positioned between on the empty line on an indented position with regard to the start tag If the feature Add Element Content of Content Completion is enabled all the elements that the new element must contain as specified in the DTD or XML Schema or RELAX NG schema are inserted automatically in the document The Content Completion assistant can also add optional content and first choice particle as specified in the DTD or XML Schema or RELAX NG schema for the element if the two options are enabled The content assistant can be started at any time by pressing CTRL Space The effect is that the context sensitive list of proposals will be shown in the current position of the caret in the edited document if element attribute or attribute value insertion makes sense Such positions are anywhere within a tag name or at the beginning of a tag name in an XML document XML Schema DTD or Relax NG full or compact syntax schema anywhere within an attribute name or at the beginning of an attribute name in any XML document with an associated sch
511. re 17 58 The Network Connections preferences panel Network Connections teo Enable the HTTP WEBDAV protocols Warning This may alter other plugins functionality Advanced HTTP Connection Settings Read timeout s 20 WebDAV Lock WebDAV files on open FTP Connection Settings Encoding for FTP control connection ISO 8859 1 SFTP Connection Settings Private key file B Passphrase Show SFTP certificate warning dialog Changing settings require restarting the Eclipse Complete the dialog as follows Enable the HTTP WEBDAV proto When checked Http WebDAV proxy and proxy settings are enabled The host cols port username and password that the lt oXygen gt plugin uses are the ones set in the general Network Connections settings of Eclipse 405 Configuring the application Lock WebDAV files on open Encoding for FTP control connection Private key file Passphrase Show SFTP certificate warning dia log Certificates 4 Important This may affect other plugins functionality If checked the files opened through WebDAV are locked on the server so that they cannot be edited by other users while the lock placed by the current user still exists The encoding used to communicate with FTP servers It is one of ISO 8859 1 and UTF 8 If the server supports the UTF 8 encoding lt oXygen gt will use it for communication Otherwise it will use ISO 8859 1 The path to the file containing the priv
512. re are CSSs specified in the document then ignore CSSs from the associated document type _ merge them with CSSs from the associated document type Y Initial page Author 208 Author Developer Guide Press OK in all the dialogs to validate the changes Now you can start editing DITA documents based on the new CSS stylesheet You can edit the new CSS stylesheet itself at any time and see the effects on rendering DITA XML documents in the Author mode by running the Refresh action available on the Author toolbar and on the DITA menu Document type sharing A document type can be shared between authors in two ways e save the document type at global level in the Document Type Association panel and distribute a zip file that includes all the files of the document type CSS stylesheets jar files with custom actions etc Each user will unzip the zip file in a subdirectory of the frameworks directory and will restart the application for adding the new document type to the list of the Document Type Association panel e save the document type at project level in the Document Type Association panel and distribute both the Oxygen project file and the files of the document type CSS stylesheets jar files with custom actions etc Each user will copy the files of the document type in the subdirectory of the frameworks directory that corresponds to the doc ument type and will load the Oxygen project file in the Project view CSS
513. re ignorable if they appear in elements defined in the DTD or schema as having element only content strips no whitespace before further processing However whitespace will still be stripped if this is specified in the stylesheet using xsl strip space Available only for Saxon SA Schema validation This mode requires an XML Schema and determines whether source documents should be parsed with schema validation enabled Lax schema validation This mode determines whether source documents should be parsed with schema validation enabled if an XML Schema is provided Disable schema validation This determines whether source docu ments should be parsed with schema validation disabled Available only for Saxon SA If checked all validation errors are treated as warnings otherwise they are treated as fatal When creating a scenario that applies to an XML file lt oXygen gt fills the XML URL with the default variable currentFile This means the input for the transformation is taken from the currently edited file You can modify this value to other file path This is the case of currently editing a section from a large document and you want the transformation to be performed on the main document not the section You can specify in this case either a full absolute path file c project docbook test xml or a path relative to one of the editor variables like the current file directory S cfdu test xml When the scenario a
514. red into relational tables Which parts map to which tables and columns is specified into the schema annotations 318 Working with Databases Schema dependencies management is done by using the Add and Remove buttons Actions available at schema level amp Refresh performs a refresh of the selected node and it s subtree e Unregister removes the selected schema from the XML Schema Repository S View opens the selected schema in lt oXygen gt Microsoft SQL Server s XML Schema Repository Level Refresh performs a refresh of the selected node s subtree e Register Opens a dialog for adding a new schema file in the DB XML repository In this dialog you enter a collection name and the necessary schema files XML Schema files management is done by using the Add and Remove buttons Actions available at schema level amp Refresh performs a refresh of the selected node and it s subtree e Add adds a new schema to the XML Schema files e Unregister removes the selected schema from the XML Schema Repository 8 View opens the selected schema in lt oXygen gt Table Explorer View Every table from the Data Source Explorer can be displayed and edited by pressing the Edit button from the contextual menu or by double clicking one of its fields To modify a cell s content double click it and start typing When editing is finished lt oXygen gt will try to update the database with the new cell content
515. references panel allows also the configuration of the default namespace used in XPath 2 0 expressions entered into the XPath toolbar and the creation of different results panels for XPath queries executed on different XML docu ments To apply a XPath expression relative to the element on which the caret is positioned use the action XML editor contex tual menu gt XML Document gt Copy XPath Ctrl Shift also available on the context menu of the main editor panel to copy the XPath expression of the current element or attribute to the clipboard and the Paste action of the contextual menu of the XPath console to paste this expression in the console Then add your relative expression and execute the resulting complete expression 306 Querying documents The popup menu available on right click in the Expression panel of the XPath expressions dialog offers the usual edit actions Cut Copy Paste Select All On Windows the context menu can be displayed with the mouse on a right click or with the keyboard by pressing the special context menu key available on Windows keyboards 307 Chapter 12 Working with Archives lt oXygen gt offers the means to manipulate files directly from ZIP type archives By manipulation one should understand opening and saving files directly in archives browsing and modifying archive structures The archive support is available for all ZIP type archives for JAR and ODF formats and for IDML files w
516. rencesResolver This class must implement the ro sync ecss extensions api AuthorReferenceResolver interface import ro sync ecss extensions api AuthorReferenceResolver import ro sync ecss extensions api AuthorAccess import ro sync ecss extensions api node AttrValue import ro sync ecss extensions api node AuthorElement import ro sync ecss extensions api node AuthorNode public class ReferencesResolver implements AuthorReferenceResolver The method hasReferences verifies if the handler considers the node to have references It takes as argument an AuthorNode that represents the node which will be verified The method will return t rue if the node is considered to have references In our case to be a reference the node must be an element with the name ref and it must have an attribute named location public boolean hasReferences AuthorNode node boolean hasReferences false if node getType AuthorNode NODE_TYPE_ELEMENT AuthorElement element AuthorElement node if ref equals element getLocalName AttrValue attrValue element getAttribute location hasReferences attrValue null return hasReferences The method getDisplayName returns the display name of the node that contains the expanded referred content It takes as argument an Aut horNode that represents the node for which the display name is needed The referred content 196
517. ribute_name The name of the attribute This argument is required attribute_type The type of the attribute This argument is optional If it is missing the type of the argument is considered st ring This argument indicates what is the meaning of the attribute value and helps to perform conversions of this value lt oXygen gt Author accepts one of the following types color The value represents a color The attribute may specify a color in different formats lt oXygen gt Author supports colors specified either by name red blue green etc or as an RGB hexadecimal value FFEEFF url The value is an URL pointing to a media object lt oXygen gt Author supports only images The attribute value can be a complete URL or a relative one to the XML document Please note that this URL is also resolved through the catalog resolver integer The value must be interpreted as an integer number The value must be interpreted as a float number length The value must be interpreted as an integer percentage The value must be interpreted relative to another value length size expressed in percents em The value must be interpreted as a size 1 em is equal to the font size of the relevant font 216 Author Developer Guide default_value ex px cm in pt pe The value must be interpreted as a size 1 ex is equal to the height of the x character of the relevant font The value must be interpreted as a size
518. ries are accessed via unique aliases An alias must be assigned for every new entry of either a key or certificate as areference for that entity No Keystore can store an entity if it s alias already exists in that Keystore and no KeyStore can store trusted certificates generated with keys in it s KeyStore In lt oXygen gt there are provided two types of keystores Java Key Store JKS and Public Key Cryptography Standards version 12 PKCS 12 A keystore file is protected by a password In a PKCS 12 keystore you should not store a certi ficate without alias together with other certificates with or without alias as in such a case the certificate without alias cannot be extracted from the keystore 341 Digital signature To set the options for a certificate or to validate it go to Options gt Preferences Certificates S Note A certificate without alias stored in a PKCS 12 keystore together with other certificates with or without alias cannot be always extracted correctly from the keystore due to the missing alias Such a certificate should be the only certificate of a PKCS 12 keystore Signing files The user can select the type of signature to be used for his document from the following dialog displayed by the action Sign available from editor panel context menu Source Figure 15 2 Signature settings dialog Sign Input URL 20Files Oxygen 20XML 20Editor 209 2 samples personal xml la la Trans
519. rks ead rng ead rng where frameworks is a sub directory of the lt oXygen gt install directory Author extensions Templates Default templates are available for EAD They are stored in frameworksDir ead templates folder and they can be used for easily creating an EAD document These templates are available when creating new documents from templates EAD NWDA Template 2008 04 New EAD document 08 Catalogs The default catalog is stored in frameworks ead catalog xml 135 Chapter 8 Author Developer Guide Introduction Starting with version 9 lt oXygen gt adds extensive support for customization The Author mode from lt oXygen gt was designed for bridging the gap between the XML source editing and a friendly user interface The main achievement is the fact that the Author combines the power of the source editing and the intu itive interface of a text editor Figure 8 1 oXygen Author Editor oXygen XML oxy Sample samples docbook v4 sample xml Eclipse SDK Weed MG EL EA S Navigator 53 aS 5 dita docbook S E v4 sample db5 pdf fo sample db5 xml D sample pdf f sample xml fe sampleXInclude xm fe sectiont xml fog section2 xml fod section3 xml GS vs E lake jpeg naturel jpa v i gt B Outline 3 os article 4 title Welcome to the Docbook 0 0 secti title Inline Markup and Im para This is a sam
520. rks only if the current cell spans over more than one column The column span of the source cell will be decreased with one at Split Cell To The Right splits the cell from current caret position in two inserting a new empty table cell to the right Note that this action works only if the current cell spans over more than one column The column span of the source cell will be decreased with one La Split Cell Above splits the cell from current caret position in two inserting a new empty table cell above Note that this action works only if the current cell spans over more than one row The row span of the source cell will be decreased with one LJ Split Cell Below splits the cell from current caret position in two inserting a new empty table cell below Note that this action works only if the current cell spans over more than one row The row span of the source cell will be decreased with one Note a DITA supports CALS table model similar with DocBook document type in addition to the simpletable element specific for DITA 4 Caution Column specifications are required for table actions to work properly e Generate IDs allows you to generate ID for the current selection or for the element at caret position if the element appears in ID Generation dialog In this dialog you can specify the elements for which lt oXygen gt should generate an ID You can choose to automat ically generate an ID for these elements by selecti
521. rly applied when switching to Author mode 65 Authoring in the tagless editor Figure 5 2 Document with no CSS association default rendering document element Cannot load the associated CSS file s The error was No CSS file specified Please switch to the text mode and use the Associate XSLT CSS Stylesheet ae action to associate a CSS Stylesheet to your document The document content Text Grid Author I Description 1 item W No CSS file specified Author views The content author is supported by special views which are automatically synchronized with the current editing context of the editor panel and which present additional information about this context thus helping the author to see quickly the current location in the overall document structure and the available editing options Outline view The Outline view has the following available functions e the section called XML Document Overview e the section called Modification Follow up e the section called Document Structure Change Figure 5 3 The Outline View DE Outline 3 Bla MM o amp gt para A content author edits the co Al para In case the edited XML docume para The syntax of such a processi You can read more about assoc para When the document has no C55 600000000 D a ao The content author is sup synchronized with the c 0 q2 Additional information a
522. rm your DITA topics to various formats using the DITA Open Toolkit you can open them in the DITA Maps Manager view using the Open button located on the internal toolbar and transform them from here Customizing the DITA scenario The Parameters tab In the Scenario Edit Parameters Tab you can customize all the parameters which will be sent to the DITA OT build file 95 Author for DITA Figure 6 6 Edit DITA Ant transformation parameters Edit DITA Scenario Scenario Name hierarchy XHTML Type XHTML Parameters Filters Advanced Output Name Description Value Aj args input The path and name of the input fi 4cf args outext The output file extension name fo html args xhtml toc The root file name of the output index dita dir The absolute path of the toolkit s saiga v a y 3 All the parameters that can be set to the DITA OT build files for the chosen type of transformation eg XHTML are listed along with their description The values for some important parameters are already filled in You can find more information about each parameter in the DITA OT Documentation http dita ot sourceforge net doc DITA antscript html Using the toolbar buttons you can Add Edit or Remove a parameter Depending on the parameter type the parameter value will be a simple text field for simple parameter values a combo box with some predefined values or will have a file chooser
523. rmer based on the System Xml 2 0 library available in the NET 2 0 framework from Microsoft http msdn microsoft com xml It is available only on Windows 299 Transforming documents You should have the NET Framework version 2 0 already installed on your system oth erwise you get this warning MSXML NET requires NET Framework version 2 0 to be installed Exit code 128 You can get the NET Framework version 2 0 from Microsoft web site http www mi crosoft com downloads details aspx FamilyID 9655156b 356b 4a2c 857c e62f50ae9a55 amp DisplayLang en http www microsoft com downloads details aspx FamilyID 9655156b 356b 4a2c 857c e62f50ae9a55 amp DisplayLang en Saxon NET Saxon NET http weblog saxondotnet org is the port of Saxon 9B XSLT processor to the NET platform and it is available on a Mozilla Public License 1 0 MPL from the Mozilla http www mozilla org MPL MPL 1 0 html site In order to use it you have to unzip in the lt oXygen gt install folder the Saxon NET distri bution which you can download from _http saxon sourceforge net http www saxondotnet org saxon net downloads Saxon NET 1 0 RC1 zip You should have the NET Framework version 1 1 already installed on your system oth erwise you get this warning Saxon NET requires NET Framework 1 1 to be installed You can get the NET Framework version 1 1 from Microsoft web site http www mi crosoft com downloads ThankYou aspx familyId 262d25e3 f589
524. rofile Choose one of the available validation profiles CSS 1 CSS 2 CSS 2 1 CSS 3 SVG SVG Basic SVG Tiny Mobile TV Profile ATSC TV Profile Media Type Choose one of the available mediums all aural braille embossed handheld print projection screen Warning Level Set the minimum severity level for reported validation warnings It is one of all normal most important no warnings XML XML Catalog The XML Catalog preferences panel is opened from menu Window gt Preferences gt Author XML XML Catalog 381 Configuring the application Figure 17 32 The XML Catalog preferences panel XML Catalog 2 gt Prefer O system public verbosity None O Unresolved entities All messages Process namespaces through URI mappings for XML Schema Use default catalog file D Projects exml frameworks catalog xml Catalogs pdu xlink catalog xml Additional catalogs are added from each document type Changes in the catalogs list or the files referred may require reopening the files which use them The Prefer option is used to specify if lt oXygen gt will try to resolve first the PUBLIC or SYSTEM 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 When using catalogs it is sometimes useful to see what catalog files are parsed if they are valid or not and what identifiers are resolved by the c
525. row element will be inserted with a new cell in which the fragments will be inserte k param offset Offset where the insertion event occurred param fragmentsToInsert Fragments that must be inserted at the given offset param authorAccess Author access return lt code gt true lt code gt if the event was handled lt code gt false lt code gt otherwis sg private boolean handleInvalidInsertionEventInTable int offset AuthorDocumentFragment fragmentsToInsert AuthorAccess authorAccess AuthorSchemaManager authorSchemaManager throws BadLocationException AuthorOperationException boolean handleEvent false Typing paste inside a SDF table We will try to wrap the fragment into a new cell and insert it inside a new row WhatElementsCanGoHereContext context authorSchemaManager createWhatElementsCanGoHereContext offset StringBuilder xmlFragment new StringBuilder lt xmlFragment append SDF_TABLE_ROW if SDF_NAMESPACE null amp amp SDF_NAMESPACE length 0 xmlFragment append xmlns append SDF_NAMESPACE append xmlFragment append gt Check if a row can be inserted at the current offset boolean canInsertRow authorSchemaManager canInsertDocumentFragments new AuthorDocumentFragment authorAccess getDocumentController createNewDocumentFragmentInContext 249
526. rrent context is div then a div2 will be inserted and so on T Insert Paragraph inserts a new paragraph depending on the current context If current context is a paragraph context one of the ancestors of the element at caret position is p then a new paragraph will be inserted after the paragraph at caret Otherwise a new paragraph is inserted at caret position Insert Image inserts a graphic object at the caret position The following dialog is displayed allowing the user to specify the entity that refers the image itself o Insert Ordered List inserts an ordered list dist element with type attribute set to ordered with one list item item element Insert Itemized List inserts an unordered list list element with type attribute set to bulleted with one list item item element Insert List Item inserts a new list item for in any of the above two list types insert Table opens a dialog that allows you to configure the table to be inserted The dialog allows the user to configure the number of rows and columns of the table and if the header will be generated Insert Row inserts a new table row with empty cells The action is available when the caret position is inside a table ES lInsert Column inserts a new table column with empty cells after the current column The action is available when the caret position is inside a table y Insert Cell inserts a new empty cell depending on the current co
527. s AuthorNode newParaNode au for au fr hand thorAccess g int i 0 thorAccess g agmentsTolns leEvent tr etDocumentController getNodeAtOffset offset 1 i lt fragmentsToInsert length i etDocumentController insertFragment newParaNode getEndOffset ert i return handleEvent ue TableCellSpanProvider java package simple documentation framework public class TableCellSpanProvider implements AuthorTableCellSpanProvider pk Extracts th in columns of the ce integer sp cifing what is the width 11 representing in the table layout the cell element x7 252 Author Developer Guide public Integer getColSpan AuthorElement cell Integer colSpan null AttrValue attrValue cell getAttribute column_span if attrValue null The attribute was found String cs attrValue getValue if cs null try colSpan new Integer cs catch NumberFormatException ex The attribute value was not a number return colSpan pk Extracts the integer specifing what is the height in rows of the cell representing in the table layout the cell element Af public Integer getRowSpan AuthorElement cell Integer rowSpan null AttrValue attrValue cell getAttribute row_span if attrValue null The attribute was found String rs attrValue getValue if rs null tr
528. s gt Author XML XSLT FO XQuery XPath 395 Configuring the application Figure 17 47 The XPath preferences panel XPath V Unescape XPath expression No namespace Use the namespace of the root This namespace Default prefix namespace mappings e y v y XPath Default Namespace only for XPath version 2 0 O Use the default namespace from the root element Prefix Namespace URI Unescape XPath expression No namespace Use the default namespace from the root element Use the namespace of the root This namespace Default prefix namespace mappings Remove When checked unescapes the entities found in the XPath expression For example the expression varlistentry starts with os amp x73 is equivalent with varlistentry starts with os s If checked lt oXygen gt will consider unprefixed element names in XPath expres sions evaluated in the XPath console as belonging to no namespace If checked lt oXygen gt will consider unprefixed element names in XPath expres sions evaluated in the XPath console as belonging to the default namespace de clared on the root element of the document If checked lt oXygen gt will consider unprefixed element names in XPath expres sions evaluated in the XPath console as belonging to the same namespace as the root element of the document The user has the possibility to enter here the namespace of the
529. s DITA Maps ii e Ma eh a edo PA ii 93 Available Output Formats ienee 463 scges ede dos dete oct be aI Ae eaa e a docto ein lineares 93 Configuring a DITA transformation 00 eee ec ee cence eee ece ence eeeeeeeeeeeeeeeaeeeaeeaa sean eeaes 94 Customizing th DITA Scenario sion sucess n sus cess Sedaned wetesspawed dy oth ene tddi webs deen tees 95 The Parameters tab iii A A Ai bo 95 TOS di A A A Ai 96 The Advanced AMD As 97 THE Output TAD 0550 08 05 AN 99 The FO Processor tab aiii ca ube eee dab did dior 100 Set a font for PDF output generated with Apache FOP oooooccccnoccnnccconnccnnnncnonccnnnnccnnnncnnnose 101 Running a DITA Map ANT transformation oocooocnnccnncnnncnnccnnccnnconnccnnconnconncnnncnnncnnncnnnonoss 101 DITA OF Customization SUpport sosro Hoss a dodo agee op sites EEA NEEE T EEEa Et 101 Support for transformation customizations ocoooccnccnncnnnnnnncnnocnnccnnconnccnnccnnccnnconncrnncnnncnnnes 101 Using your own DITA OT toolkit from lt oXygen gt oooocooccnccnnccnnconnccnnconnconnconnconacnnncnaronoss 102 Using your custom build file ooooccnoccnnconcconccnnccnnocnnonnnrnnncnnccnnconnccnnccnncnnnconncinncos 102 Customizing the lt oXygen gt Ant tool oooocccccnnccnnconnconnconnconnconoconcnnnrnnnnnnronncnnccnnrinncnnns 102 Upgrading to a new version of DITA OT ooooccnocnnccnnccncconccnnccnnconnconnconnconnconncnnncnnncnnronoss 102 Increasing the memory for the Ant Process oocoocc
530. s and Native XML Databases By interaction one should understand browsing querying SQL execution support content editing importing from databases generating XML Schema from database structure Relational Database Support Relational databases use a relational model and are based on tables linked by a common key lt oXygen gt offers support for the following relational databases IBM DB2 JDBC ODBC Bridge MySQL Microsoft SQL Server Oracle 11g like browsing the tables of these types of database in the Data Source Explorer view executing SQL queries against them calling stored procedures with input and output parameters In the following sections one can find the tools that lt oXygen gt offers for working with relational databases and a de scription on how to configure a relational data source a connection to a data source and also the views where connections can be browsed and results are displayed Configuring Database Data Sources How to configure an IBM DB2 Data Source 1 Goto Preferences gt Data Sources In the Data Sources panel click the New button 2 Enter a unique name for this data source and select DB2 from the driver type combo box Figure 13 1 Data Source Drivers Configuration Dialog Data Sources Drivers Name DB2 Source Type DB2 x Driver class com ibm db2 jcc DB2Driver x Driver files file C Documents 20and 205ettings bogdan Application 20Data com oxygenxml File C
531. s both the start and end tags of the highlighted element into the document The delay is configurable in Preferences as a number of milliseconds from last key press The DTD XML Schema Relax NG NRL or NVDL schema used to populate the Content Completion assistant is specified in the following methods in order of precedence e The schema specified explicitly in the document In this case lt oXygen gt reads the beginning of the document and resolves the location of the DTD XML Schema Relax NG schema NRL or NVDL schema Note Limitation In case of XML Schema the content completion takes into account only the schema declarations from the root element of the document If a schema declaration is attached to other element of the XML doc ument it is ignored 29 Editing documents e The default schema rule declared in the Document Type Association preferences panel which matches the edited document After inserting the cursor is positioned directly before the gt character of the start tag if the element has attributes in order to enable rapid insertion of any attributed supported by the element or after the gt char of the start tag if the element has no attributes Pressing the space bar directly after element insertion will again display the assistant In this instance the attributes supported by that element will be displayed If an attribute supports a fix set of parameters the assistant will display the list of valid pa
532. s can be used for specifying a URL On the Parameters tab you can specify the parameters available on each port Each port where is sent the output of the XProc transformation is associated with a URL on the Outputs tab of the dialog The built in editor variables and the custom editor variables can be used for specifying a URL The result of the XProc transformation can be displayed as a sequence in an output view with two sides a list with the output ports on the left side and the content of the document s that correspond to the output port selected on the left side If the checkbox Open in editor is selected the XProc transformation result will be opened automatically in an editor panel Figure 10 8 XProc Transformation results view dx XPath Results Y Error Log 2 Problems El Console Custom Validation xsv amp Sequence El XProc Results 3 fy x gt O result lt html gt A O lt html gt lt head gt lt head gt ls lt title gt Movies In Theaters lt title gt lt style media all lang en type text css gt ChannelTitle font family Verdana re font size 1ipt font weight bold width 500px text align center ArticleEntry v Gia a gt XProc Transformation 23 Integration of an external XProc engine the XProc API In order to create an XProc integration project the following requirements must be fulfilled e Take the oxygen jar from oXygenInstallDir 1lib and put it in the
533. s the case the depth of the XPointer is updated taking account of the depth of the current element If the XPointer path depth is the same as the current element depth then the kept indices of the current element path are compared to the indices in the XPointer path If all of them match then the element has been found public boolean startElement String uri String localName String name Attr atts boolean linkLocated false Increase current element document depth startElementDepth if endElementDepth startElementDepth The current element is the first child of the parent currentElementIndexStack push new Integer 1 193 Author Developer Guide else Another element in the parent element currentElementIndexStack push new Integer lastIndexInParent 1 if startWithElementID This the case when xpointer String xpointerElement xpoint int i 0 i lt atts length itt if xpointerElement equals att for if idVerifier hasIDType localName uri atts i xpointerPathDepth start break if xpointerPathDepth startEle check if xpointer path match linkLocated true try int xpointerldx xpoi int stackldx current int stopldx startWith while xpointerldx gt stopldx nterPat Element path starts with an element ID erPath 0 s i getValue getQName atts i getNam
534. s the following command uninstallWindowsService bat The installWindowsService bat script installs the lt oXygen gt XML Author license server as a Windows service with the name oXygenLicenseServer and accepts two parameters the path of the folder containing the floating license key files and the local port number on which the server accepts connections from instances of the lt oXygen gt XML Author The parameters are optional The default values are license for the license file folder 12555 for the local port number The JAVA_HOME variable must point to the home folder of a Java runtime environment installed on your Windows system The startService bat script starts the Windows service so that the license server can accept connections from lt oXygen gt XML Author clients The stopService bat script stops the Windows service The license server is shut down and it cannot accept connections from lt oXygen gt XML Author clients The uninstallService bat script uninstalls the Windows service created by the installService bat script When the license server is used as a Windows service the output messages and the error messages cannot be viewed as for a command line script so that they are redirected automatically to the following log files created in the directory where the license server is installed outLicenseServer log the standard output stream of the server errLicenseServer log the standard error stream of the server On
535. sOid A2D19F2A ES lt TotalRows gt 11 lt TotalRows gt BE lt TotalContainers gt 0 lt TotalConta A Content mixed lt Fan0ut gt 11 lt Fan0ut gt D Attributes lt ImmediateContainers gt 0 lt Immediz ResOid CDATA lt LastdnalyzedDate gt 2007 02 13T1 lt ContainerStats gt lt ContainerStats gt Model ja PCDATA TotalRows TotalContaine l m 3 rslFanOutlImmediateContainerslLas m Te ee haere gt 4n annotation is not available for Text Grid Author n o the current selection alt 23 Mex Tar exw Oj n p a m Pe DB e x ote Zen E xs PATEAR en ContainerStats SYS_NC_ROWINFO SYS XMLTYPE a aac anOut lt ContainerStats Res0id 8323DD7B0D9B42669C84AE E ImmediateContainers lt ContainerStats ResOid 42D19F2AF4E740D784C89S E LastAnalyzedDate lt ContainerStats ResOid FA85105495544DCD814512 E TotalContainers lt ContainerStats ResOid 97D317E20BEB40778FCO83f E TotalRows lt ContainerStats ResOid 8F742164E6074068B6E429 lt ContainerStats ResOid C54309D41EF9498EBDCE 14 lt ContainerStats ResOid 13345C0B013049908BFAEC lt ContainerStats ResOid 0F1383B7D5DA439A449AF64 lt ContainerStats ResOid BADBB7630EF 487 9B6A0DE x Ed 0 3 0 0M40N o Main menu Main toolbar Editor panel Data Source explorer Table explorer Provides menu driven access to all the features and functions available within lt oXy gen g
536. schema DTD XML Schema Relax NG etc the editor offers content completion for the element and attributes names and values If you choose to insert an element that has required content it will be inserted automatically including the subtree of needed elements and attributes To display the content completion popup you have to start editing for example by double clicking the cell When editing pressing CTRL SPACE redisplays the popup Figure 9 2 Content Completion in Grid Editor xs annotation xs complexType xs annotation xs complexType ys complexType xs annotation xs complexType xs annotation 269 Grid Editor Layouts Grid and Tree The grid editor has two modes for the layout The default one is the grid layout This smart layout of the grid editor detects the recurring elements in the XML document and creates tables having as columns the children including the attributes of these elements In this way it is possible to have tables nested in other tables reflecting the structure of your document Figure 9 3 Grid Layout lt xml version 1 0 encoding UTF 8 Y test P table Mi tr Did first last 3 rows 410001 Jhon Doe 2 10002 Mark Ewing 3 10003 Dave Flint El El The other layout mode is tree like This layout does not create any table it presents the structure of the document directly Figure 9 4 Tree Layout lt xml version 1 0 encoding UTF 8 Mitest M table Y tr id 1000
537. sedene nne a n aE E E E n S a sudo say Season pessmesl 390 MSXML NET 4020 A IS E S cess 391 FO PrOCESSOLS oi li 393 A o O teeta 395 C storm ESINES o sesscey soars pwderedon paueecs E E pause a E E AE p Ea 397 Data SOUPCES ii Ad eae E aT 398 Configuration of Data Sources s c1 si svececen seat aecawetiwes aE eede ces hvete ees eatueb eset dec n det 398 Download links for database drivers ocooccoconcnoconcnnconococonococononncononoronoroconorocononoronnoronos 401 Table Filters en eta yee sees 403 ATC Cid 403 C stom Editor Vara bles ios ksadeved tens eeie Sas ein RE steeds cnn nte atico 404 Network Connections icc3viiivesais a A dias 405 SS O OS O NA 406 XML Structure Outline evi a eas ates o io 407 Scenarios Management s sedie ae cirio denaddac de E a 407 VEW R T EEE A O EE EER ee 408 Automatically importing the preferences from the other distribution ooccooccnnccnnconoconoconccnnncnnrcnnrcnnss 408 Reset Globa Options riranna A A ME Sees A Res 408 Scenarios Management assenso reana Ra a a a RE EA E EEN RES 408 Editor variables i oe A A 409 Custom editor variables messier a e E E E E e E EAEn 410 18 Common problem Si ee ee Aer E IR sb ee A Sane teens 411 o ERTER SANAE E A A EEE E EE EARTE 412 xiv Chapter 1 Introduction Welcome to the User Manual of lt oXygen gt XML Author 11 1 0 plugin for Eclipse This book explains how to use the 11 1 0 version of the lt oXygen gt XML Author plugin for Eclipse eff
538. ser to locate them more easily The ruler contains the following areas e top area containing a success validation indicator that will turn green in case the validation succeeded or red otherwise e middle area where the errors markers are depicted in red The number of markers shown can be limited by modifying the setting Window gt Preferences oXygen Editor Document checking Maximum number of errors reported per document Clicking on a marker will highlight the corresponding text area in the editor The error message is displayed both in the tool tip and in the error area on the bottom of the editor panel 38 Editing documents Status messages from every validation action are logged into the Console view Validation Example Example 4 5 Validation error messages In this example you will use the case where a DocBook listitem element does not match the rules of the docbookx dtd In this case running Validate Document will return the following error Fi The content of element type listitem must match calloutlist glosslist itemizedlist orderedlist segmentedlist simplelist variablelist caution important note tip warning l literallayout programlisting programlistingco screen screenco screenshot synopsis cmdsynopsis funcsynopsis classsynopsis fieldsynopsis constructorsynopsis destructorsynopsis methodsynopsis formalpara para simpara address blockquote graphic graphicco mediaobject mediaobjectco informalequatio
539. server Default is 12346 Click the OK button If the maximum number of available licenses was not exceeded a license key is received from the floating license server and registered in lt oXygen gt XML Author The license details are displayed in the About dialog opened from menu Help If the maximum number of licenses was exceeded a warning dialog will pop up letting the user know about the problem The message contains information about the users who re quested and successfully received the floating licenses before exceeding the maximum number of licenses Installation How to install the lt oXygen gt XML Author license server as a Windows service In order to install the lt oXygen gt XML Author license server as a Windows service you should run the Windows installer downloaded from the URL provided in the registration email message containing your floating license key If you want to install start and uninstall yourself the server as a Windows service you can run the scripts created in the install folder from a command line console with the install folder of the license server as the current folder on Windows Vista you have to run the console as Administrator For installing the Windows service installWindowsService bat After installing the server as a Windows service use the following two commands to start and stop the license server startWindowsService bat stopWindowsService bat Uninstalling the Windows service require
540. similar manner public Integer getRowSpan AuthorElement cell Integer rowSpan null AttrValue attrValue cell getAttribute row_span if attrValue null The attribute was found String rs attrValue getValue if rs null try rowSpan new Integer rs catch NumberFormatException ex The attribute value was not a number return rowSpan The method hasColumnSpecifications always returns t rue considering column specifications always available 205 Author Developer Guide public boolean hasColumnSpecifications AuthorElement tableElement return true The complete source code of the implementation is found in the Example Files Listings the Java Files section In the listing below the XML document contains the table element lt table gt lt header gt lt td gt Cc1 lt td gt lt td gt C2 lt td gt lt td gt C3 lt td gt lt td gt C4 lt td gt lt header gt lt tr gt lt td gt cs 1 rs 1 lt td gt lt td column_span 2 row_span 2 gt cs 2 rs 2 lt td gt lt td row_span 3 gt cs 1 rs 3 lt td gt lt tr gt lt tr gt lt td gt cs 1 rs 1 lt td gt lt tr gt lt tr gt lt td column_span 3 gt cs 3 rs 1 lt td gt lt tr gt lt table gt When no table cell span provider is specified the table has the following layout Figure 8 27 Table layout when no cell span provider is specified document
541. sing the action Edit OLink available on the contextual menu The action make sense only if the dialog was already displayed with a proper Targetset e uri inserts an URI element The URI identifies a Uniform Resource Identifier URI in content e xref inserts a cross reference to another part of the document The initial content of the xref is automatically detected from the target Note These actions are grouped under the Link toolbar actions group S Insert Section inserts a new section subsection in the document depending on the current context For example if the current context is sect then a sect2 will be inserted and so on T Insert Paragraph inserts a new paragraph depending on the current context If current context is a paragraph context one of the ancestors of the element at caret position is para then a new paragraph will be inserted after the paragraph at caret Otherwise a new paragraph is inserted at caret position Insert Graphic inserts a graphic object at the caret position This is done by inserting either lt figure gt or lt in linegraphic gt element depending on the current context The following graphical formats are supported GIF JPG JPEG BMP PNG SVG 109 Predefined document types AE 5 Insert Ordered List inserts an ordered list with one list item Insert Itemized List inserts an itemized list with one list item Insert Variable List inserts a DocBook variable l
542. solution gt lt target resolution gt 72 lt target resolution gt lt default page settings height 1lin width 8 26in gt lt renderers gt 291 Transforming documents lt renderer mime application pdf gt lt filterList gt lt value gt flate lt value gt lt filterList gt lt fonts gt lt font metrics url Arialuni xml kerning yes mbed url file Library Fonts Arialuni ttf gt lt font triplet name Arialuni style normal weight normal gt lt font gt lt fonts gt lt renderer gt lt renderers gt lt fop gt The embed url attribute points to the TTF file to be embedded You have to specify it using the URL convention The metrics url attribute points to the font metrics file with a path relative to the base element The triplet refers to the unique combination of name weight and style italic for each variation of the font In our case is just one triplet but if the font had variants you would have to specify one for each variant Here is an hypothetic example for the Arial Unicode if it had italic and bold variants lt fop version 1 0 gt lt fonts gt lt font metrics url Arialuni xml kerning yes mbed url file Library Fonts Arialuni ttf gt lt font triplet name Arialuni style normal weight normal gt lt font gt lt font metrics url Arialuni Bold xml kerning yes mbed url file Library Fonts Arialuni Bold ttf gt lt font triplet nam
543. solver can be found in the Configuring a References Resolver section To be able to dynamically customize the default CSS styles for a certain AuthorNode an implementation of the ro sync ecss extensions api StylesFilter can be provided The extensions bundle method responsible for creating the Sty lesFilter is createAuthorStylesFilter The method is called each time a document opened in an Author editor page matches the document type association where the extensions bundle is defined The instantiated filter object is kept and used until another extensions bundle corresponding to another Document Type is activated as result of the detection process public StylesFilter createAuthorStylesFilter return new SDFStylesFilter See the Configuring CSS styles filter section for more details about the styles filter extension In order to edit data in custom tabular format implementations of the ro sync ecss extensions api Au thorTableCellSpanProviderandthe ro sync ecss extensions api AuthorTableColum nWidthProvider interfaces should be provided The two methods from the ExtensionsBundle specifying these two extension points are createAuthorTableCellSpanProvider and createAuthorTable ColumnWidthProvider public AuthorTableCellSpanProvider createAuthorTableCellSpanProvider return new TableCellSpanProvider public AuthorTableColumnWidthProvider createAuthorTableColumnWidthProvider return new TableColumnWidthProvider
544. spell dictionary is sup ported by the applications Mozilla OpenOffice and Chrome browser If your language is not included in the list of built in dictionaries you can probably have a dictionary for your language you can add it with the following steps You add a Hunspell dictionary with the following steps Procedure 16 1 Add Hunspell dictionary 1 Download the archive http www oxygenxml com spell_checking html with the files of your language dictionary A dictionary has two files with the same name and different extensions a file with dic extension and a file with aff extension 346 Text editor specific actions 2 Ifitis a new dictionary not available as built in dictionary in lt oXygen gt you copy the aff and dic files to the spell subfolder of the lt oXygen gt preferences folder that is the folder APPLICATION DATA FOLDER com oxygenxml spell For example on Windows XP APPLICATION DATA FOLDER is C Documents and Settings LOGIN USER NAMENApplication Data on Windows Vista APPLICATION DATA FOLDER is C Users LOGIN USER NAME AppData Roaming on Mac OS X APPLICATION DATA FOLDER is USER HOME FOLDER Library Preferences 3 Ifitis an existing dictionary you copy the aff and dic files into the folder OX YGEN INSTALL FOLDER dicts 4 Restart the application after copy the dictionary files Adding an AZ Check dictionary AZ Check dictionaries are in the form of dar files located in the directory oXygen
545. splay table cell 1s rendered correctly Table 8 1 Built in Cell Spanning Cell 1 1 Cell 1 2 Cell 1 3 Cell 2 1 Cell spanning 2 rows and 2 columns Cell 3 1 Because in the schema the td tag has the attributes row_span and column_span that are not automatically recognized by lt oXygen gt Author a Java extension will be implemented which will provide information about the cell spanning See the section Configuring a Table Cell Span Provider Because the column widths are specified by the attributes width of the elements customco1 that are not automatically recognized by lt oXygen gt Author it is necessary to implement a Java extension which will provide information about the column widths See the section Configuring a Table Column Width Provider Styling the Inline Elements The bold style is obtained by using the font weight CSS property with the value bold while the italic style is specified by the font style property b font weight bold font style italic Styling Elements from other Namespace In the CSS Level 1 2 and 2 1 there is no way to specify if an element X from the namespace Y should be presented differently from the element X from the namespace Z In the upcoming CSS Level 3 it is possible to differentiate elements by their namespaces lt oXygen gt Author supports this CSS Level 3 functionality For more information see the Namespace Selectors section To match the def
546. splayed in your diff tool instead of one big change that does not allow to see the changes between two versions of the file Change Tracking Track Changes is a way to keep track of the changes you make to a document You can activate change tracking for the current document by choosing Edit Track Changes or by clicking the Track Changes button located on the Author toolbar When Track Changes is enabled your modifications will be highlighted using a distinctive color The name of the author who is currently making changes and the colors can be customized from the Track Changes preferences page 82 Authoring in the tagless editor Figure 5 25 Change Tracking in lt oXygen gt Author Docbook 4 supports also the XHTML tables Sample XHTML Table with fixed width and proportional column widths col span 1 width 2 08 col span 1 width 0 46 Person Name Age Jane 26 Bart 24 Alexander pa John 25 gt They belengare all students of the computer science department irszrtedby John bos Wed Apr 08 16 10 32 EEST 2009 This is a list of useful gt XMLs links When hovering a change the tooltip will display information about the author and modification time If the selection in the Author contains track changes and you Copy it the clipboard will contain the selection with all the changes accepted This filtering will happen only if the selection is not entirely inside a tracked change D Tip
547. ssingml 2006 main http schemas openxmlformats org package 2006 content types 129 Predefined document types e http schemas openxmlformats org drawingm1 2006 main e http schemas openxmlformats org package 2006 metadata core properties http schemas openxmlformats org package 2006 relationships e http schemas openxmlformats org presentationml1 2006 main e http schemas openxmlformats org officeDocument 2006 custom properties http schemas openxmlformats org officeDocument 2006 extended properties e http schemas openxmlformats org spreadsheetm1 2006 main e http schemas openxmlformats org drawingml 2006 chart Schema The NVDL schema used for these documents is located in frameworks ooxml schemas main nvdl where frame works is a subdirectory of the lt oXygen gt install directory The schema can be easily customized to allow user defined extension schemas for use in the OOXML files See the Markup Compatibility and Extensibility htp Awweanentenaiaralaghs TC cunent_work Office 200 pen 720M JA PIEZA TEX Malayo 20Con patibility 7eDend7AExensibiliypdl Ecma PDF document for more details The Open Office ODF document type The OpenDocument format ODF is a free and open file format for electronic office documents such as spreadsheets charts presentations and word processing documents The standard http www oasis open org committees office was developed by the Open Office
548. such declaration MUST NOT be an empty string If you select menu Document Validate gt Check Document Form Alt Shift V WCmd Alt V W or click the toolbar button A Check Document Form lt oXygen gt checks if your document is Namespace Well Formed XML If any error is found the result is returned to the Message Panel Each error is one record in the Result List and is accom panied by an error message Clicking the record will open the document containing the error and highlight the approx imate location Example 4 2 Document which is not Well Formed XML lt root gt lt tag gt lt root gt When Check document form is performed the following error is raised The element type tag must be terminated by the matching end tag lt tag gt To resolve the error click in the result list record which will locate and highlight the errors approximate position Identify which start tag is missing an end tag and insert lt tag gt Example 4 3 Document which is not namespace wellformed lt x y gt lt Xx y gt When Check document form is performed the following error is raised Element or attribute do not match QName production QName NCName NCName Example 4 4 Document which is not namespace valid lt x y gt lt x y gt When Check document form is performed the following error is raised The prefix x for element x y is not bound Also the files contained in the current project and selected with the mouse in t
549. t Provides easy access to common and frequently used functions Each icon is a button that acts as a shortcut to a related function The place where you spend most of your time reading editing applying markup and checking the validity and form of your documents Provides browsing support for the configured connections Provides table content editing support insert a new row delete a table row cell value editing export to XML file 15 Chapter 4 Editing documents Working with Unicode Unicode provides a unique number for every character no matter what the platform no matter what the program no matter what the language Unicode is an internationally recognized standard adopted by industry leaders The Unicode is required by modern standards such as XML Java ECMAScript JavaScript LDAP CORBA 3 0 WML etc and is the official way to implement ISO IEC 10646 It is supported in many operating systems all modern browsers and many other products The emergence of the Unicode Standard and the availability of tools supporting it are among the most significant recent global software technology trends Incorporating Unicode into client server or multi tiered applications and websites offers significant cost savings over the use of legacy character sets As a modern XML Editor lt oXygen gt provides support for the Unicode standard enabling your XML application to be targeted across multiple platforms languages and countr
550. t 2em XML Files sdf_sample xml lt xml version 1 0 encoding UTF 8 gt lt book xmlns http www oxygenxml com sample documentation xmlns xsi http www w3 org 2001 XMLSchema instance xmlns abs http www oxygenxml com sample documentation abstracts gt lt title gt My Technical Book lt title gt lt section gt lt title gt XML lt title gt lt abs def gt Extensible Markup Language lt abs def gt lt para gt In this section of the book I will explain different XML applications lt para gt lt section gt lt section gt lt title gt Accessing XML data lt title gt 230 Author Developer Guide lt section gt lt title gt XSLT lt title gt lt abs def gt Extensible stylesheet language transformation XSLT is a language for transforming XML documents into other XML documents lt abs def gt lt para gt A list of XSL elements and what they do lt para gt lt table gt lt header gt lt td gt XSLT Elements lt td gt lt td gt Description lt td gt lt header gt lt tr gt lt td gt lt b gt xsl stylesheet lt b gt lt td gt lt td gt The lt i gt xsl stylesheet lt i gt element is always the top level element of an XSL stylesheet The nam lt i gt xsl transform lt i gt may be used as a synonym lt td gt lt tr gt lt tr gt lt td gt lt b gt xsl template lt b gt lt td gt lt td gt The lt i gt xsl template lt i gt
551. t ELEMENT root ANY gt lt IENTITY ent Some entity gt gt xml stylesheet type text css href test css Some text A comment CDATA section Some entity Additional Properties Folding elements foldable and not foldable child properties lt oXygen gt Author allows you to declare some elements to be foldable collapsible This is especially useful when working with large documents organized in logical blocks editing a large DocBook article or book for instance To define the element whose content can be folded by the user you must use the property foldable true When collapsing an element it is useful to keep some of its content visible like a short description of the collapsed region The property not foldable child is used to identify the child elements that are kept visible It accepts as value an element name or a list of comma separated element names If the element is marked as foldable fo1d able true but it doesn t have the property not foldable child or none of the specified non foldable children exists then the element will still be foldable In this case the element that will be kept visible when folded will be the before pseudo element S Note Both foldable and not foldable child are non standard properties and are recognized only by lt oXygen gt Author 220 Author Developer Guide Example 8 8 Folding DocBook Elements All the elements below can have a title child element and are considered
552. t Inside The Insert Table Action You will create an action that inserts into the document a table with three rows and three columns The first row is the table header Similarly to the insert section action you will use the InsertFragmentOperation The icon files are Table16 gif for the menu item and Drable2 O gif for the toolbar and are already available These files must be placed in the frameworks sdf directory The action properties ID You can use insert_table Name Insert Insert table Menu access key Enter the t letter Description You can use Adds a section element Toolbar icon Use frameworks sdf Table20 gif Menu icon Insert frameworks sdf Table16 gif Shortcut key You can choose Ctrl Shift t Now let s set up the operation the action uses XPath expression Set it to the value true Note true is equivalent with leaving this field empty Invoke operation You will use InsertFragmentOperation built in operations that inserts an XML fragment at the caret position 163 Author Developer Guide Configure its arguments by setting the values fragment lt table xmlns http www oxygenxml com sample documentation gt lt header gt lt td gt lt td gt lt td gt lt header gt lt tr gt lt td gt lt td gt lt td gt lt tr gt lt tr gt lt td gt lt td gt lt td gt lt tr gt lt table gt insertLocation In our example we will always add tables at the end of the section that
553. t Y gt lt Z gt lt Z gt lt doc gt Considering the selected content that is to be surrounded is the sequence of elements X and Y then the result is lt doc gt lt F gt lt A gt lt X gt lt X gt lt Y gt lt Y gt lt A gt lt B gt lt C gt lt C gt lt B gt lt F gt lt Z gt lt Z gt lt doc gt Because the element A was the first leaf in the fragment it received the selected content The fragment was then inserted in the place of the selection Java API Extending Author Functionality through Java lt oXygen gt Author has a built in set of operations covering the insertion of text and XML fragments see the Author Default Operations and the execution of XPath expressions on the current document edited in Author mode However there are situations in which you need to extend this set For instance if you need to enter an element whose attributes 169 Author Developer Guide should be edited by the user through a graphical user interface Or the users must send the selected element content or even the whole document to a server for some kind of processing or the content authors must extract pieces of inform ation from a server and insert it directly into the edited XML document Or you need to apply an XPath expression on the current Author document and process the nodes of the result nodeset In the following sections you are presenting the Java programming interface API available to the de
554. t in your IDE Create the directory 1ib in the Java project directory and copy init the oxygen jar file from the oXygen_in stallation_directory lib directory 2 Create the class simple documentation framework QueryDatabase0Operation This class must implements the ro sync ecss extensions api AuthorOperation interface import import import import import public ro ro ro ro LOs sync sync sync sync sync ecss ecss ecss ecss ecss extensions extensions extensions extensions extensions api api api api api ArgumentDescriptor ArgumentsMap AuthorAccess AuthorOperation AuthorO0perationException class QueryDatabaseOperation implements AuthorOperation Let s define the arguments of the operation For each of them you will use a St ring constant representing the argument name 173 Author Developer Guide ARG_JDBC_DRIVER jdbc_driver private static final String private static final String ARG_USER user private static final String ARG_PASSWORD password private static final String ARG_SOL sql private static final String You must describe each of the argument name and type To do this implement the getArguments method ARG_CONNECTION connection which will return an array of argument descriptors public ArgumentDescriptor ArgumentDescriptor args new Argumen Descriptor getArguments
555. t with one list item li child element Insert Unordered List inserts an unordered list ul element with one list item li child element Insert Definition List inserts a definition list dl element with one list item a dt child element and a dd child element nsert List Item inserts a new list item for in any of the above two list types Insert Table opens a dialog that allows you to configure the table to be inserted The dialog allows the user to configure the number of rows and columns of the table if the header and footer will be generated and how the table will be framed Insert Row inserts a new table row with empty cells The action is available when the caret position is inside a table Insert Column inserts a new table column with empty cells after the current column The action is available when the caret position is inside a table J insert Cell inserts a new empty cell depending on the current context If the caret is positioned between two cells a new one will be inserted at caret s position If the caret is inside a cell then the new one will be created after the current cell Delete Column deletes the table column where the caret is located Delete Row deletes the table row where the caret is located 123 Predefined document types Join Row Cells joins the content of the selected cells The operation is available if the selected cells are from the same row and they have the sam
556. t A External EAD A External 4a FO A External Pias AA T Sees 4 Wh gt New Edit Duplicate Remove Up Down V Enable DTD XML Schema processing in document type detection A Only for local DTDs XML Schemas Restore Defaults Apply Change framework directory location You can specify a custom frameworks directory from where lt oXygen gt will load the document types User roles You can select between two user roles Content author and Developer When the selected role is Content author you can modify only the properties of the Document Type Associations stored in the user preferences The externally stored associations cannot be modified and you will have to duplicate them in order to further customize these associations The Developer user can change any document type association Document types table The table presents the currently defined document type associations The columns are Document type Contains the name of the document type Enabled When checked the corresponding document type associ ation is enabled it is analyzed when trying to determine the type of a document opened in lt oXygen gt Storage Presents the location where the document type association 1s stored When expanding a Document Type Association its defined rules are presented A rule is described by Namespace Specifies the namespace of the root element from the association rules set any by default I
557. t dialog and enter the following parameters indicating the font for the body text and for the titles Table 10 1 XSL FO Parameters Name Value body font family Arialuni title font family Arialuni TEI Stylesheets Create a transformation scenario that makes use of the tei xsl file from the oXygen install dir frameworks tei xs1 fo directory Also you can use the predefined TEI PDF scenario which is based on this XSLT stylesheet Run a test transformation to make sure the PDF is generated Just like for the Docbook you have to specify to the stylesheet to generate FO output that uses the font Arialuni Click on the Parameters button of the transformation scenario edit dialog and enter the following parameters indicating the font for the body text and for other sections Table 10 2 XSL FO Parameters Name Value bodyFont Arialuni sansFont Arialuni Run the transformation again The characters are now displayed correctly DITA OT Stylesheets For setting a font to the Apache FOP processor in the transformation of a DITA map with an IDIOM FOP transformation there are two files that must be modified e font mappings xml available in folder frameworks dita DITA OT demo fo cfg fo the font face element included in each element physical font having the attribute char set default must contain the name of the font Arialuni in our example instead of the default value 293 Tr
558. ta Source Explorer View ia Data Source Explorer 3 5 Navigator 3 e ae Tamino H A 11Doctypes 3 A clients Con Schema 22 clients 22 clientsnonxml 81 clientsnonxml 2 about ini El agenda js fed copy dtd fo Fax xsl logo aif B test js fog XSIES xsl lt gt clients lt gt p addressBook B B2 lt gt p catalog lt 0 gt PLAY 8 collection H A do 4 6 ino day v Below you can find a description of the contextual menu actions available on the Data Source Explorer levels explained for each connection Please note that you can open in the editor a resource or a schema component by double clicking it 327 Working with Databases Berkeley DB XML Connection Actions available at connection level Refresh performs a refresh of the selected node s subtree Configure Database Sources opens the Data Sources preferences page where you can configure both data sources and connections Add container allows adding a new container Name The name of the new container Container type At creation time every container must have a type defined for it This container type identifies how XML documents are stored in the container As such the container type can only be determined at container creation time you cannot change it on subsequent container opens Containers can have one of the following types specified for them Node container Whole
559. table You can add a row by either a copy paste operation over a row or directly by invoking the action from the contextual menu Table Insert row The icon is amp A shorter way of inserting a new row is to move the selection over the row header and then to press ENTER The row header is the zone in the left of the row that holds the row number The inserted row will be below the selection Inserting a column in a table You can insert a column after the selected one using the action from the contextual menu Table Insert column The icon is Fa Clearing the content of a column You can clear all the cells from a column using the action from the contextual menu Table gt Clear content Adding nodes Using the contextual menu you can add nodes before after or as last child of the currently selected node The sub menus containing detailed actions are Insert beforeInsert afterAppend child Duplicating nodes A quicker way of creating new nodes is to duplicate the existing ones The action is available in the contextual menu Duplicate Refresh layout When using drag and drop to reorganize the document the resulted layout may be different from the expected one For instance the layout may contain a set of sibling tables that could be joined together To force the layout to be re computed you can use the Refresh action The action is available in the contextual menu Refresh selected Start editing a ce
560. tags will be deleted When you click on a marker representing the start or end tag of an element the entire element will be selected The contextual menu displayed when you right click on the marker representing the start or end tag of an element contains Append child Insert Before and Insert After submenus as first entries Editing the XML content By default you can type only in elements which accept text content So if the element is declared as empty or element only in the associated schema you will not be allowed to insert text in it This is also available if you ty to insert CDATA inside an element Instead a warning message will be shown Figure 5 19 Editing in empty element warning E Cannot insert text in anchor empty element content Enable Allow text in empty or element only content option to insert text or press Enter to insert markup d You can disable this behavior by checking the Allow Text in empty or element only content checkbox in the Author preferences page Entire sections or chunks of data can be moved or copied by using the Drag and Drop support The following situations can be encountered e when both the drag and drop sources are Author pages an well formed XML fragment is transferred The section will be balanced before dropping it by adding matching tags when needed e when the drag source is the Author page but the drop target is a text based editor only the text inside the selection will b
561. tained topics that can be reused in different de liverables The extensibility of DITA permits organizations to define specific information structures and still use standard tools to work with them Association rules A file is considered to be a dita topic document when either of the following occurs e root element name is one of the following concept task reference dita topic e public id of the document is one of the public id s for the elements above e the root element of the file has an attribute named DITAArchVersion attribute from the http dita oasis open org architecture 2005 namespace This enhanced case of matching is only applied when the Enable DTD processing option from the Document Type Detection option page is enabled Schema The default schema used for DITA topic documents is located in frameworks dita dtd ditabase dtd where frameworks is a subdirectory of the lt oXygen gt install directory Author extensions The CSS file used for rendering DITA content is located in frameworks dita css dita css Specific actions for DITA topic documents are B Bold surrounds the selected text with b tag 113 Predefined document types T Italic surrounds the selected text with i tag U Underline surrounds the selected text with u tag Note For all of the above actions if there is no selection then a new specific tag will be inserted These actions are available in any document co
562. te was issued by a company you have not chosen to trust View the certificate to determine whether you want to trust the certifying authority v The secunty certificate date is valid A The name on the security certificate is invalid or does not match the name of the site Do you want to proceed View Certificate b Press the button View Certificate c Select the Details tab d Press the button Copy to file This will start the Certificate Export Wizard on Windows e Follow the indications of the wizard to save the certificate to a local file for example server cer 2 Import the local file into the JRE running lt oXygen gt Eclipse plugin 25 Editing documents a Open a text mode console b Goto the lib security subdirectory of your JRE directory that is of the directory where it is installed the JRE running lt oXygen gt Eclipse plugin for example on Windows C Program Files Java jre1 5 0_OWib security c Run the following command bin keytool exe import trustcacerts file local file cer keystore cacerts where local file cer is the file containing the server certificate created during the previous step keytool requires a password before adding the certificate to the JRE keystore The default password is changeit If somebody changed the default password then he is the only one who can perform the import As a workaround you can delete the cacerts file re type the com
563. ted as a Java application that reads a formatting object tree and renders the resulting pages to a specified output D 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 libraries For TIFF images you need the JAI http java sun com products java media jai library For PDF images you need the fop pdf images library http www jeremias maerki ch download fop pdf images These libraries are not bundled with lt oXygen gt JIMI and JAI due to Sun s licensing Using them is as easy as downloading them and creating a external FO processor based on the built in FOP libraries and the extension library The external FO processor created in Preferences will have a command line like java cp S oxygenInstallDir lib xercesImpl jar S oxygenInstallDir lib fop jar S oxygenInstallDir lib 289 Transforming documents avalon framework 4 2 0 jar oxygenInstallDir lib batik all 1 7 jar oxygenInstallDir lib commons i0 1 3 1 Jjar S oxygenInstallDir lib xmlgraphics commons 1 3 1 jar S oxygenInstallDir lib commons logging 1 0 4 jar S oxygenInstallDir lib saxon9ee jar S oxygenInstallDir lib saxon9 dom jar S oxygenInstallDir lib xalan jar oxygenInstallDir lib serializer jar S oxygenInstallDir lib resolver jar S oxygenInstallDir lib fop pdf images 1 3 jar S oxygenInstallDir lib PDFBox 0 7 3 jar org apach
564. ted to XML Editor XSD Editor and XSL Editor It is able to validate the edited document against XML Schema internal DTD included in the XML document external DTD or a custom schema type included in lt oXygen gt Windows edition It is associated to XML Editor XSD Editor and XSL Editor It is able to validate the edited document against XML Schema internal DTD included in the XML document external DTD or a custom schema type not included in lt oXygen gt A Windows distribution of XSV can be downloaded from ftp ftp cogsci ed ac uk pub XS V XSV31 EXE ftp ftp cogsci ed ac uk pub XS V XSV31 EXE A Linux distribution can be downloaded from ftp ftp cogsci ed ac uk pub XSV XSV 3 1 1 noarch rpm ftp ftp cogsci ed ac uk pub XS V XS V 3 1 1 noarch rpm The executable path is configured already in lt oXygen gt for the installation directory oXygen install dir xsv If it is installed in a different directory the predefined executable path must be corrected in Preferences Itis associated to XML Editor and XSD Editor Itis able to validate the edited document against XML Schema or a custom schema type not included in lt oXygen gt It can be downloaded from here http www alphaworks ibm com tech xmlsqc open amp l xml dev t grx p shecheck it comes as a zip file at the time of this writing SQC2 2 1 zip is about 3 megabytes The executable path and working directory are configured already for the SQC installation dire
565. tem 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 Mi crosystems http java sun com products javahelp index html that enables developers and authors to incorporate online help in applets components applications operating systems and devices JavaHelp is a free product and the binaries for JavaHelp can be redistributed Eclipse Help Eclipse Help is the help system incorporated in the Eclipse platform http www eclipse org that enables Eclipse plugin developers to incorporate online help in their plugins Many other target formats are possible these are the most popular The basic condition for transformation to any format 1s that your source document is well formed Always make sure that the XSL used for the transformation is the right one according to the desired output format and with the input source definition For example if you want to transform to HTML format using a DocBook html stylesheet your source xml document should respect the DocBook DTD An XSL stylesheet specifies the presentation of a class of XML documents by describing how an instance of the class 1s transformed into an output document by usin
566. templates TEI PS All New TEI P5 All TEI P5 Bare New TEI P5 Bare TEI PS Lite New TEI P5 Lite TEI PS Math New TEI P5 Math TEI P5 Speech New TEI P5 Speech TEI P5 SVG New TEI P5 with SVG extensions TEI PS XInclude New TEI P5 XInclude aware Catalogs XML catalogs used for TEI P4 are used also for TEI P5 Transformation Scenarios The following default transformations are available TEI P5 XHTML transforms a TEI document into a XHTML document e TEI P5 PDF transforms a TEI document into a PDF document using the Apache FOP engine The MathML document type Mathematical Markup Language MathML is an application of XML for describing mathematical notations and cap turing both its structure and content It aims at integrating mathematical formulae into World Wide Web documents lt oXygen gt offers support for editing and validating MathML 2 0 documents 128 Predefined document types Association rules A file is considered to be a MathML document when the root element name is a math or it s namespace is ht tp www w3 org 1998 Math MathML Schema The schema used for these documents is located in frameworks mathml2 dtd mathml2 dtd where frameworks is a subdirectory of the lt oXygen gt install directory Templates Default templates are available for MathML They are stored in the frameworksDir mathml2 templates folder These templates are available when creating new documents
567. ter submenus of the Outline tree popup menu list the elements which are allowed by the schema associated with the current document as siblings of the current element inserted immediately before respectively after the current element The Cut Copy and Delete items of the popup menu execute the same actions as the Edit menu items with the same name on the elements currently selected in the outline tree Cut Copy Paste You can insert a well formed element before after or as a child of the currently selected element by accessing the Paste before Paste after or Paste as Child actions The Toggle Comment item of the outline tree popup menu encloses the currently selected element of the outline tree in an XML comment if the element is not commented or removes the comment if it is commented Using the Rename Element action the element from the caret position and the elements that have the same name as the current element can be renamed according with the options from the Rename dialog The actions expand collapse the selection and all its children 67 Authoring in the tagless editor i Tip You can Copy Cut or Delete multiple nodes in the Outliner by using the contextual menu after selecting all the nodes in the tree Elements view Figure 5 4 The Elements View lt x Elements 3 para v E E E acronym E action E address E anchor E application E author E authorinitials E beginpage
568. ters in the document an element with the name contained in this list the whitespace is preserved inside that element This is useful when most of the elements must be reformatted with the exception of a few ones which are listed here For the situation when whitespace should be preserved in most elements with the exception of a few elements the names of these elements must be added to the Strip space elements XPath list In addition to simple element names both the Preserve space elements XPath list and the Strip space elements XPath one accept a restricted set of XPath expressions for covering a pattern of XML elements with only one expression The allowed types of expressions are xs documentation the XPath descendant axis can be used only at the beginning of the expression the namespace prefix can be attached to any namespace no namespace binding check is performed when applying the pretty print operation chapter abstract title note the use of the XPath child axis 56 Editing documents Isection title the descendant axis can be followed by the child axis The value of an xml space attribute present in the XML document on which the pretty print operation is applied always takes precedence over the Preserve space elements XPath and the Strip space elements XPath lists Viewing status information Status information generated by the Schema Detection Validation Validate as you type and Transformation threads are fed i
569. text describing the report The lines of text are dis played one below the other so the description will have the same block display To make 1t standout the background color is changed description display block background color EEEEFF color black A line of text in the description A specific aspect is not defined for it just indicate that the display should be block line display block The important element defines important text from the description Because it can be mixed with text its display property must be set to inline To make it easier to spot the text will be emphasized important display inline font weight bold The results element shows the list of test_names and the result for each one To make it easier to read it is displayed as a table with a green border and margins results display table margin 2em border lpx solid green An item in the results element The results are displayed as a table so the entry is a row in the table Thus the display is table row entry display table row The name of the individual test and its result They are cells in the results table with display set to table cell Padding and a border are added to emphasize the table grid test_name passed 139 Author Developer Guide display table cell border lpx solid green padding 20px passed font weight bold The full content of the CSS file test_report cssis re
570. text or on save Default column width characters Current selection color Selection color Border color Background color Foreground color Row header colors Background color Row header colors Current selec tion color Row header colors Selection color Column header colors Background color Column header colors Current selec tion color Column header colors Selection color The content of the document is formatted by applying the Format and Indent action on every switch from the grid editor to the text editor of the same docu ment The default width in characters of a table column of the grid A column can hold an element name and its text content an attribute name and its value If the total width of the grid structure is too large you can resize any column with the mouse but the change is not persistent To make it persistent set the new column width in this user option the The background color used in the focused selected cell of the grid to make it different in the set of selected cells For example when an entire row is selected only one cell of the row is the focused selected one The background color used in the selected cells of the grid except the focused selected cell which uses a different background color The color used for the lines that separate the grid cells The background color of grid cells that are not selected The color of the text used for the element names text content of el
571. the matched templates and for each template the match XPath expression template name number of template modes number of calls execution time Show the list of registered extensions If checked lt oXygen gt will display in the Warnings view a list with all the re gistered extension functions extension elements and extension modules Refuses to write to any file or re If checked the XSLTProc processor will not write any part of the transformation source result to an external file on disk If such an operation is requested by the pro cessed XSLT stylesheet the transformation ends with a runtime error Refuses to create directories If checked the XSLTProc processor will not create any directory during the transformation process If such an operation is requested by the processed XSLT stylesheet the transformation ends with a runtime error MSXML The MSXML preferences panel is opened from menu Window gt Preferences Au thor XML XSLT FO XQuery XSLT MSXML Figure 17 43 The MSXML preferences panel MSXML 3 0 4 0 4 Validate documents during parse phase Do not resolve external definitions during parse phase Strip non significant whitespaces J Show time information Start transformation in this mode The options of the MSXML 3 0 and 4 0 processors are the same as the ones available in the command line for the MSXML processors http msdn microsoft com library default asp url library en us dnxml html msxs
572. the CSS can define the following rule imagedata width width attr width length Figure 8 4 Samples of images in Author document book section title Section 3 Documentation frameworks One of the most important documentation frameworks is Docbook 2 The other is the topic oriented DITA promoted by OASIS OASIS STANDARD Text Grid Author Marking elements as foldable You can specify what elements are collapsible The collapsible elements are rendered having a small triangle icon in the top left corner Clicking on this icon hides or shows the children of the element The section elements will be marked as foldable You will leave only the title child elements visible section foldable true not foldable child title 151 Author Developer Guide Figure 8 5 Folded Sections document My Technical Book Section 1 XML Section 2 Accessing XML data a Section 3 Documentation frameworks dbx Text Grid Author Goad Marking elements as links You can specify what elements are links The text content specified in the be fore pseudo element will be underlined When hovering the mouse over that content the mouse pointer will change to indicate that it can follow the link Clicking on a link will result in the referred resource being opened in an editor The 1ink elements will be marked as links with the href attribute indicating the
573. the New button If you want to create a new scenario based on an existing scenario select the scenario in the list and press the Duplicate button Select the XSLT tab Click the Browse for an input XSL file button The Open dialog is displayed Note During transformations the Editor Status Bar 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 if the transformer offers such support by pressing the Stop transformation button In this case the message displayed in the status bar will be Transformation stopped by user For the specific case of an XQuery transformation if you chose an NXD transformer pressing the Stop transformation button will have no effect as NXD transformers offer no such support 294 Transforming documents PDF Output l 2 8 9 Change directory to oxygen frameworks docbook xsl fo Select docbook xs1 click Open The dialog closes Select the FOP tab Check the Perform FOP option The remaining options are enabled Select the following options a XSLT result as input b PDF as method c Built in Apache FOP as processor Select the Output tab In the Save As field enter the output file name relative to the current dire
574. the current context the position in the editor If you change the schema you can observe that the list of tags to be inserted is changing Figure 4 8 Content completion driven by DocBook DTD lt para gt To apply the stylesheet you have to press the Apply transformation scenario button or to press CTRL SHIFT T META SHIFT T on Mac OS Xj lt para gt lt para gt Here are some useful links regarding XML lt para gt lt il lt i E important An admonition set off from the text E index Important is an admonition set off from the main text In some E indexterm types of documentation the semantics of admonitions are clearly defined Caution might imply the possibility of harm to equipment whereas Warning might imply harm to a person but DocBook makes no such assertions E informalequation E informalexample E informalfigure E informaltable E itemizedlist Category admonitions lt listitem gt lt listitem gt lt para gt lt ulink url http uuww w3c org gt http wuww w3c org lt ulink gt Adding a Processing Instruction The same effect is obtained by configuring a processing instruction that specifies the schema to be used The advantage of this method is that you can configure the Content Completion for each file The processing instruction must be added at the beginning of the document just after the XML prologue lt oxygen RNGSchema file C work relaxng personal rng type xm
575. the document is lt xml version 1 0 encoding UTF 8 gt lt oxygen RNGSchema test rng type xml gt lt test gt lt a xml id al xml base a xml gt test lt a gt 53 Editing documents lt test gt The XInclude support in lt oXygen gt is turned on by default You can toggle it by going to the entry Enable XInclude processing in the menu Window gt Preferences oXygen XML XML Parser When enabled lt oXygen gt will be able to validate and transform documents comprised of parts added using XInclude Working with XML Catalogs When Internet access is not available or the Internet connection is slow the OASIS XML catalogs http www oasis open org committees entity spec html present in the list maintained in the XML Catalog Preferences panel will be scanned trying to map a remote system ID at document validation or a URI reference at document transformation pointing to a resource on a remote Web server to a local copy of the same resource If a match is found then lt oXygen gt will use the local copy of the resource instead of the remote one This enables the XML author to work on his XML project without Internet access or when the connection is slow and waiting until the remote resource is accessed and fetched becomes unacceptable Also XML catalogs make documents machine independent so that they can be shared by many developers by modifying only the XML catalog mappings related to the shared documents
576. the first occurrence of the unknown word The same word will be flagged again if it appears in the document Ignore all Ignores all instances of the unknown word in the whole document Learn Includes the unrecognized word in the list of valid words so that the spell checker will not consider it for correction Options Sets the configuration options of the Spell Checker Begin at caret position When checked the spell checker begins checking from the current cursor posi tion OK Closes the Spell Checker dialog Adding a spell dictionary There are two spell checking engines available in lt oXygen gt Hunspell and AZ Check For the Hunspell checker lt oXygen gt comes with the following built in dictionaries English US English UK French German both old and new orthography Spanish For the AZ Checker the following language dictionaries are available English US English UK English Canada French France French Belgium French Canada French Switzerland German old orthography German new orthography Spanish The format of the spell dictionary files is different for the two engines If you want to add a dictionary for a language that is not supported by the built in dictionaries you have to add the dictionary file as specified below and restart lt oXygen gt for using the new dictionary Adding a Hunspell dictionary The Hunspell spell checker is open source and has LGPL license The format of the Hunspell
577. the installed SQLServer engine User User name to access the SQLServer database engine Password Password to access the SQLServer engine Click OK How to Configure a MySQL Connection 1 2 4 Go to Preferences gt Data Sources In the Connections panel click the New button Enter a unique name for this connection and select one of the previously configured MySQL data sources from the Data Source combo box Fill in the Connection Details URL URL to the installed MySQL engine User User name to access the MySQL database engine Password Password to access the MySQL engine Click OK How to Configure an Oracle 11g Connection l 2 Go to Preferences gt Data Sources In the Connections panel click the New button Enter a unique name for this connection and select one of the previously configured Oracle data sources from the Data Source combo box Fill in the Connection Details URL URL to the installed Oracle engine User User name to access the Oracle database engine Password Password to access the Oracle engine Click OK 315 Working with Databases Note Registering unregistering or updating a schema might involve dropping creating types For schema based XML Type tables or columns in schemas you need privileges like e CREATE ANY TABLE e CREATE ANY INDEX e SELECT ANY TABLE e UPDATE ANY TABLE e INSERT ANY TABLE e DELETE ANY TABLE DROP ANY TABLE e ALTER ANY TABLE DROP ANY IND
578. the interface either by returning the default values given by lt oXygen gt or by contributing to the list of proposals The filter can be applied on elements attributes or on their values Attributes filtering can be implemented using the filterAttributes method and changing the default content completion list of ro sync contentcompletion xml CIAttribute for the element provided by the current ro sync contentcompletion xml WhatAttributesCanGoHereContext context For example the SDFSchemaManagerFilter checks if the element from the current context is the table element and add the frame attribute to the table list of attributes pk Filter attributes of the tabl E public List lt CIAttribute gt filterAt e element tributes List lt CIAttribute gt attributes WhatAttributesCanGoHereContext context If the element from the current context is the table element add the attribute named frame to the list of default content completion proposals if context null ContextElement contextElement context getParentElement if table equals contextHElement getQName CIAttribute frameAttribute new CIAttribute frameAttribute setName frame frameAttribute setRequired false frameAttribute setFixed false frameAttribute setDefaultValue void if attributes null attributes new ArrayList lt CIAttribute gt attributes add frameAttribute return attribut
579. the same network the license management is done by communication between the instances of lt oXygen gt XML Author that are connected to the same local network and that run at the same time Any new instance of lt oXygen gt XML Author that is started after the number of running instances is equal with the number of purchased licenses will display a warning message and will disable the open file action Installation Tf the floating licenses are used on machines connected to different local networks a separate license server must be started and the licenses deployed on it Procedure 2 6 Floating license server setup 1 Download the license server from one of the download URLs included in the registration email message with your floating license key Run the downloaded Windows 32 bit installer or Windows 64 bit installer or unzip the all platforms zip archive kit on your server machine The Windows installer installs the license server as a Windows service it provides the option to start the Windows service automatically at Windows startup and it creates shortcuts in the Start menu group for starting and stopping the Windows service manually If you use the zip archive on Windows you have to run the scripts provided in the archive for installing starting stopping and uninstalling the server as a Windows service If you start the server with the script LicenseServer bat licenseServer sh you can leave the default values for the param
580. them Before dropping them in the appropriate place press and hold the CTRL key META key on Mac The mouse pointer should change to indicate that a copy operation will be performed Move Select the nodes you want to move and drag and drop them in the appropriate place Promote Demote You can move nodes between child and parent nodes which ensures both Promote and Demote operations i Tip You can open and edit linked topics easily by double clicking the references or by right clicking and choosing Open in editor If the referenced file does not exist you will be allowed to create it By right clicking the map root element you can open and edit it in the main editor area for more complex opera tions You can decide to open the reference directly in the Author page and keep this setting as a default 90 Author for DITA S Note Some of the common actions from the main application menu toolbar also apply to the DITA Maps Manager when it has focus These actions are File actions Save Save As Save to URL Save All Print Print preview Close Close others Close all Edit actions Undo Redo Cut Copy Paste Delete The Save all action applies to all editors opened in either lt oXygen gt work area or the DITA Maps Manager Advanced operations Inserting a Topic Reference The topicref element identifies a topic such as a concept task or reference or other resource A topicref can contain other topicref elements
581. thout extension and parent directory S cf current file the absolute file path of the current edited document S currentFileURL current file as URL the absolute file path of the current edited document as URL Stps Path Separator The separator which can be used on different operating systems between libraries specified in the class path 409 Configuring the application timeStamp Time Stamp The current Unix time on the computer which can be used to save transformation results in different output files on each transform Custom editor variables An editor variable can be created by the user and included in any user defined expression where a built in editor variable is also allowed For example a custom editor variable may be necessary for configuring the command line of an external tool the working directory of a custom validator the command line of aa custom XSLT engine a custom FO processor etc All the custom editor variables are listed together with the built in editor variables for example when editing the working directory or the command line of a custom validator the working directory or a custom validator etc Creating a custom editor variable is very simple just specify the name that will be used in user defined expressions the value that will replace the variable name at runtime and a textual description for the user of that variable An editor variable can be created also from a Java system property Fo
582. tion or delete an existing one Delete action Delete action can be invoked on a selected table entry by pressing DEL or BACKSPACE The attributes of an element can be edited also in place in the editor panel by pressing the shortcut Alt Enter which pops up a small window with the same content of the Attributes view In the initial form of the popup only the two text fields Name and Value are displayed the list of all the possible attributes is collapsed Figure 5 6 Edit attributes in place Element imagedata Name v Value y The small arrow button next to the Cancel button expands the list of possible attributes allowed by the schema of the document as in the Attributes panel 69 Authoring in the tagless editor Figure 5 7 Edit attributes in place full version Element imagedata Name fileref iv Value flake jpeg y y Attribute Value ES width contentwidth depth contentdepth align valign scale scalefit entityref fileref flake jpeg v format srccredit id lang remap iv el u IEA The Name field auto completes the name of the attribute the complete name of the attribute is suggested based on the prefix already typed in the field as the user types in the field Adding an attribute that is not in the list of all defined attributes that you can insert at the current caret position according to the associated schema is not possible
583. tion and select one of the previously configured MarkLogic data sources from the Data Source combo box Fill in the Connection Details XDBC Host The host name or ip address of the installed MarkLogic engine Oxygen uses XCC connector to interact with MarkLogic XDBC server and requires the basic authentication schema to be set Starting with version MarkLogic 4 0 the default authentication method when you create a HTTP or WebDAV Server is digest so make sure to change it to basic Port The port number of the MarkLogic engine User User name to access the MarkLogic engine Password Password to access the MarkLogic engine WebDAV The url used for browsing the MarkLogic database in the Data Source Explorer view optional URL Click OK How to configure a Software AG Tamino Connection 1 2 Go to Preferences gt Data Sources In the Connections panel click the New button Enter a unique name for this connection and select one of the previously configured Tamino data sources from the Data Source combo box Fill in the Connection Details XML DB URI URI to the installed Tamino engine User User name to access the Tamino database engine Password Password to access the Tamino database engine Database The name of the database to access from the Tamino database engine Choose the Select button to display all databases on the specified server in an addi tional dialog box You can then choose the desired database This feature works
584. tion and tables ai public AuthorSchemaAwareEditingHandler getAuthorSchemaAwareEditingHandler return new SDFSchemaAwareEditingHandler The unique identifier of the Document Type This identifier will be used to store custom SDF options ef public String getDocumentTypeID return Simple Document Framework document type Bundle description xy public String getDescription return A custom extensions bundle used for the Simple Document Framework 243 Author Developer Guide SDFSchemaManagerFilter java package simple documentation framework import java util Iterator import java util List import ro sync contentcompletion xml CIAttribute import ro sync contentcompletion xml CIElement import ro sync contentcompletion xml CIValue import ro sync contentcompletion xml Context import ro sync contentcompletion xml ContextElement import ro sync contentcompletion xml SchemaManagerFilter import ro sync contentcompletion xml WhatAttributesCanGoHereContext import ro sync contentcompletion xml WhatElementsCanGoHereContext import ro sync contentcompletion xml WhatPossibleValuesHasAttributeContext public class SDFSchemaManagerFilter implements SchemaManagerFilter Override public List lt CIValue gt filterAttributeValues List lt CIValue gt attributeValues WhatPossibleValuesHasAttributeContext context return
585. tion in the left and the Toolbar label in the right then press the Add as child button Now select the Insert table action in the left and the Insert section in the right Press the e Add as sibling button 164 Author Developer Guide When opening a Simple Documentation Framework test document in Author mode the toolbar below will be displayed at the top of the editor Figure 8 12 Author Custom Actions Toolbar D Tip If you have many custom toolbar actions or want to group actions according to their category you can add addi tional toolbars with custom names and split the actions to better suit your purpose Configuring the Main Menu Defined actions can be grouped into customized menus in the lt oXygen gt menu bar For this open the Document Type dialog for the SDF framework and click on the Author tab Next click on the Menu label In the left side you have the list of actions and some special entries Submenu Creates a submenu You can nest an unlimited number of menus Separator Creates a separator into a menu In this way you can logically separate the menu entries In the right side you have the menu tree having the Menu entry as root To change its name click on this label to select it then press the Edit button Enter SD Framework as name and D as menu access key Select the Submenu label in the left an the SD Framework label in the right then press the Add as child button Change the submenu name t
586. tion you defined earlier Press the Choose button then select simple documentation framework Insert ImageOperation 172 Author Developer Guide Figure 8 16 Selecting the Operation Operation x Class simple documentation framework InsertImageOperation v Description Inserts an image element Asks the user for a URL reference Classpath frameworks sdF sdf jar Frameworks sdF bd jar Frameworks sdf mysql jar 4 Frameworks sdf tableCellSpan jar The search classpath is defined in the Classpath tab located below the Rules section Number of classes found 3 This operation has no arguments 7 Add the action to the toolbar using the Toolbar panel To test the action you can open the sdf xm1 sample then place the caret inside a sect ion between two para elements for instance Press the button associated with the action from the toolbar In the dialog select an image URL and press Ok The image is inserted into the document Example 2 Operations with Arguments Report from Database Operation In this example you will create an operation that connects to a relational database and executes an SQL statement The result should be inserted in the edited XML document as a table To make the operation fully configurable it will have arguments for the database connection string the user name the password and the SQL expression 1 Create a new Java projec
587. tions To lower case To upper case Capitalize lines Changing the user interface language lt oXygen gt XML Author comes with the user interface translated in English French German Italian Japanese and Dutch If you want to use lt oXygen gt in other language you have to translate all the messages and labels available in the user interface menu action names button names checkbox texts view titles error messages status bar messages etc and provide a text file with all the translated messages to lt oXygen gt in the form of a Java properties file Such a file contains pairs of the form message key translated message displayed in the user interface In order to install the new set of translated messages you must copy this file to the oXygen install folder lib folder restart lt oXygen gt and set the new language in the lt oXygen gt preferences You can get the keys of all the messages that must be translated from the properties file containing the English translation used in lt oXygen gt To get this file contact us at support oxy genxml com 62 Editing documents Handling read only files If a file marked as read only by the operating system is opened in lt oXygen gt you will not be able to make modifications to it regardless of the page the file was opened in You can check out the read only state of the file by looking in the Properties view If you modify the file s properties from the operating system a
588. title gt lt para gt This is the install guide lt para gt lt xi include xmlns xi http www w3 org 2001 XInclude href introduction xml gt lt xi fallback gt lt para gt lt emphasis gt FIXME MISSING XINCLUDE CONTENT lt emphasis gt lt para gt lt xi fallback gt lt xi include gt lt article gt T T In this example the following is of note e The DOCTYPE Decl defines an entity that references a file containing the information to add the xi namespace to certain elements defined by the DocBook DTD e The href attribute of the xi include element specifies that the introduction xml file will replace the xi include element when the document is parsed e Ifthe introduction xml file cannot be found the parse will use the value of the xi fallback element a message to FIXME If you want to include only a fragment of other file in the master file the fragment must be contained in a tag having an xml id attribute and you must use an XPointer expression pointing to the xml id value For example if the master file is lt xml version 1 0 encoding UTF 8 gt lt oxygen RNGSchema test rng type xml gt lt test gt lt xi include href a xml xpointer al xmlns xi http www w3 org 2001 XInclude gt lt test gt and the a xml file is lt xml version 1 0 encoding UTF 8 gt lt test gt lt a xml id al gt test lt a gt lt test gt after resolving the XPointer reference
589. to be logical sections You mark them as being foldable leaving the t it 1e element visible set book part reference chapter preface article sectl sect2 sect3 sect4 section appendix figure example table foldable true not foldable child title Link elements lt oXygen gt Author allows you to declare some elements to be links This is especially useful when working with many documents which refer each other The links allow for an easy way to get from one document to another Clicking on the link marker will open the referred resource in an editor To define the element which should be considered a link you must use the property 1ink on the before or after pseudo element The value of the property indicates the location of the linked resource Since links are usually indicated by the value of an attribute in most cases it will have the a value similar to attr href Note link is a non standard property and is recognized only by lt oXygen gt Author 221 Author Developer Guide Example 8 9 Docbook Link Elements All the elements below are defined to be links on the before pseudo element and their value is defined by the value of an attribute href before link attr href content Click attr href for opening ulink url before link attr url content Click to open attr url olink targetdoc before link attr targetdoc content Click to open
590. tokens not just in XML A digital signature provides a mechanism for assuring integrity of data the authentication of its signer and the nonre pudiation of the entire signature to an external party e a digital signature must provide a way to verify that the data has not been modified or replaced to ensure integrity e the signature must provide a way to establish the identity of the data s signer for authentication e the signature must provide the ability for the data s integrity and authentication to be provable to a third party for nonrepudiation A public key system is used to create the digital signature and it s also used for verification The signature binds the signer to the document because digitally signing a document requires the originator to create a hash of the message and then encrypt that hash value with his own private key Only the originator has that private key and he is the only one can encrypt the hash so that it can be unencrypted using his public key The recipient upon receiving both the message and the encrypted hash value can decrypt the hash value knowing the originator s public key The recipient must also try to generate the hash value of the message and compare the newly generated hash value with the unencrypted hash value received from the originator If the hash values are identical it proves that the originator created the message because only the actual originator could encrypt the hash value correctly XML
591. tom schema Schema URL file D Projects exml frameworks docboot The components of the dialog are the same as the columns of the table displayed in the scenario edit dialog The URL of the main module can be specified with the help of a file browser for the local file system the a button with the help of the Open FTP SFTP WebDAV dialog opened by the amp button or by inserting an editor variable or a custom editor variable from the following pop up menu Figure 4 23 Insert an editor variable start dir Start directory of custom validator standard params List of standard parameters cfn The current file name without extension currentFileURL The path of the currently edited File URL cFdu The path of current file directory URL Frameworks Oxygen Frameworks directory URL pdu Project directory URL oxygenHome Oxygen installation directory URL home The path to user home directory URL pn Project name env AR_NAME Value of environment variable VAR_NAME system var name Value of system variable var name A second benefit of a validation scenario is that the stylesheet can be validated with several engines to make sure that it can be used in different environments with the same results For example an XSLT stylesheet needs to be applied with Saxon 6 5 Xalan and MSXML 4 0 in different production systems 44 Editing documents Other exampl
592. topic to a map with the following steps 1 In the view DITA Maps Manager click on the action Insert Topic Reference that is available on the toolbar and on the contextual menu The action is available both on the submenu Append Child when you want to insert a topic reference in a map as a child of the current topic reference and on the submenu Insert After when you want to insert it as a sibling of the current topic reference The toolbar action is the same as the action from the submenu Insert After Select a topic file in the file system dialog called Insert Topic Reference Press the Insert button or the Insert and close button in the dialog A reference to the selected topic is added to the current map in the DITA Maps Manager view The button Insert and Close closes the dialog If you clicked the Insert button you can continue inserting new topic references using the Insert button repeatedly in same file system dialog or you can close the dialog using the Close button Organize topics in a map You can understand better how to organize topics in a DITA map by working with a populated map You should open the sample map called flowers ditamap and located in the samples dita folder 1 2 4 Open the file flowers ditamap Select the topic reference Summer Flowers and click the toolbar button with the Down arrow to change the order of the topic references Summer Flowers and Autumn Flowers Make sure Summer Flowers is sel
593. tput stream of the FO processor which will be displayed in a results panel at the bottom of the lt oXygen gt window Error Encoding The encoding used for the error stream of the FO processor which will be displayed in a results panel at the bottom of the lt oXygen gt window Working directory The directory in which the intermediate and final results of the processing will be stored Here you can use one of the following editor variables 394 Configuring the application S homeDir cfd pa S oxygenInstallDir The path to user home directory The path of current file directory If the current file is not a local file the directory will be the user s Desktop directory The project directory The lt oXygen gt installation directory Command line The command line that will start the FO processor specific to each processor Here you can use one of the following editor variables method fo out Ur XPath pa frameworksDir oxygenInstallDir ps The FOP transformation method pdf ps txt The input FO file The output file The project directory The path of the frameworks subdirectory of the lt oXygen gt install directory The lt oXygen gt installation directory The separator which can be used on different oper ating systems between libraries specified in the class path The XPath preferences panel is opened from menu Window Preference
594. ts Attributes by Prefix lt n gt Foreground mm Background C User defined Remove C Draw only the prefix with a separate color One row of the table contains the association between a namespace prefix and the properties to mark start tags and end tags or attribute names in that prefix Note that the marking mechanism does not look at the namespace bound to that prefix If the prefix is bound to different namespaces in different XML elements of the same file all the tags and attribute names with the prefix will be marked with the same color You can edit the following color properties of the selected token Foreground color The Foreground button opens a color dialog that allow setting the color properties for the selected token with one of the methods Swatches HSB or RGB Background color The Background button opens the same color dialog as the Foreground button 373 Configuring the application You can choose that only the prefix to be displayed in the chosen color by checking the Draw only the prefix with a separate color option Open Save The Open Save preferences panel is opened from menu Window gt Preferences gt Author Editor Open Save Figure 17 23 The Open Save preferences panel Open Save Open O Always format O Never Format Always ask Save C Check errors on save Performance C Clear undo buffer on save Format document when long lines exceeds C
595. ts currently selected in the stripe Cut Copy Paste Delete The styles of the copied content is preserved by the Cut and Copy operations for example the display block property or the tabular format of the data from a set of table cells The Paste before Paste after and Paste as Child actions allow the user to insert an well formed element before after or as a child of the currently selected element The Toggle Comment item of the outline tree popup menu encloses the currently selected element of the top stripe in an XML comment if the element is not commented or removes the comment if it is commented Using the Rename Element action the selected element and the elements that have the same name as the current element can be renamed according with the options from the Rename dialog When working on a large document the folding support can be used to collapse some elements content leaving in focus only the ones you need to edit Foldable elements are marked with a small triangle painted in the upper left corner Hovering with the mouse pointer over that marker the entire content of the element is highlighted by a dotted border for quick identification of the foldable area When working on a suite of documents that refer to one another references external entities XInclude DITA conref etc the linking support is useful for navigating between the documents In the predefined customizations that are 71 Authoring in the tagless editor
596. ts must be properly nested All XML documents must have a root element e Attribute values must always be quoted With XML white space is preserved The namespace wellformed rules are e All element and attribute names contain either zero or one colon e No entity names processing instruction targets or notation names contain any colons 36 Editing documents The namespace valid rules are The prefix xml is by definition bound to the namespace name http www w3 org XML 1998 namespace It MAY but need not be declared and MUST NOT be undeclared or bound to any other namespace name Other prefixes MUST NOT be bound to this namespace name The prefix xmlns is used only to declare namespace bindings and is by definition bound to the namespace name ht tp www w3 org 2000 xmlIns It MUST NOT be declared or undeclared Other prefixes MUST NOT be bound to this namespace name All other prefixes beginning with the three letter sequence x m 1 in any case combination are reserved This means that users SHOULD NOT use them except as defined by later specifications and processors MUST NOT treat them as fatal errors e The namespace prefix unless it is xml or xmlns MUST have been declared in a namespace declaration attribute in either the start tag of the element where the prefix is used or in an ancestor element i e an element in whose content the prefixed markup occurs Furthermore the attribute value in the innermost
597. txt Optionally uncheck the XHTML and XML check boxes in the Show As group Click Transform Now The transformation is started HTML Output l 2 7 Change directory to oxygen frameworks docbook xsl html Select docbook xs1 click Open The dialog closes Select the FOP tab Uncheck the Perform FOP option The FOP options are disabled Select the Output tab In the Save As field enter the output file name relative to the current directory YourFileName 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 Click Transform Now The transformation is started HTML Help Output l 2 Change directory to oxygen frameworks docbook xsl htmlhelp Select htmlhelp xs1 click Open The dialog closes 296 Transforming documents Set the XSLT parameter base dir it identifies the output directory If not specified the output directory is system dependent Also set the manifest in base dir to 1 in order to have the project files copied in output as well Select the FOP tab Uncheck the Perform FOP option The FOP options are disabled Click Transform Now The transformation is started At the end of the transformation you should find the html hhp and hhc files in the base dir directory Downloa
598. u may choose to customize as required using the Colors dialog The Syntax Highlight preferences panel is opened from menu Window Preferences gt Author Editor Syntax Highlight Figure 17 21 The Colors preferences panel Syntax Highlight A A Element Mm a Foreground Text E Comment E Doctype Background E Quoted Value _ User defined E Single quoted Value E Entity E Tag Styles E Attribute name _ Bold E Processing Instruction Italic E Equal as Preview XML xsD xsL RNG lt xml version 1 0 encoding UTF 8 gt a lt DOCTYPE mainTag SYSTEM some dtd ENTITY entity gt lt oxygen RNGSchema some rng type xml gt lt mainTag gt lt This is a sample comment gt lt childTag attribute Quoted Value gt lt withTextContent gt Some text content lt withTextContent gt lt withEntityContent gt Some text content with amp tentities lt withEntityContent gt lt otherTag attribute Single quoted Value invalid_text gt lt childTag gt lt CDATA some CData gt lt mainTag gt W 4 gt Restore Defaults Apply Choose one of the supported document types Each document type contains a set of tokens The tokens for XML doc uments are used also in XSD XSL RNG documents so the Preview area has 4 tabs when an XML token is selected in the Element area for viewing the rendered result in all four types of documents XML XSD XSL RNG When a docume
599. ues in parameters are considered relative to the base directory The default value is the directory where the transformed map is located Temporary files directory This directory will be used to store pre processed temporary files until the final output is obtained Output folder The folder where the final output content will be copied Output file options The transformation output can then be opened in a browser or even in the editor if specified The FO Processortab This tab appears only when selecting to generate PDF output using the IDIOM FO Plugin and allows you to choose the FO Processor Figure 6 10 FO Processor configuration tab Edit DITA Scenario Scenario Name sequence PDF2 Idiom FO Plugin Type PDF2 Idiom FO Plugin FO Processor Parameters Filters Advanced Output Processor Built in Apache FOP v Built in Apache FOP XEP You can choose between three processors Apache FOP This processor comes bundled with lt oXygen gt You can find more information about it here XEP The RenderX http www renderx com XEP processor You can add it very easy from here If you select XEP in the combo and XEP was already installed in lt oXygen gt you can see the detected installation path appear under the combo XEP is considered as installed if it was detected from one of the following sources XEP was added as an external FO Processor in the lt oXygen gt preferences See here
600. unusable without a restart of the entire application Note Validation of an XML document against a deeply recursive Relax NG schema may fail with a stack overflow error It happens very rarely and the cause is the unusual depth of the Relax NG pattern recursion needed to match an element of the document against the schema and the depth exceeds the default stack size allocated by the Java virtual machine The error can be overcome by simply setting a larger stack size to the JVM at startup using the Xss parameter for example Xss1m Note Validation of an XML document against a W3C XML Schema or Relax NG Schema XML syntax with embedded ISO Schematron rules allows XPath 2 0 in the expressions of the ISO Schematron rules This ensures that both XPath 1 0 and XPath 2 0 expressions are accepted in the embedded ISO Schematron rules and are enforced by the validation operation For embedded Schematron 1 5 rules the version of XPath is set with a user preference Marking Validation Errors A line with a validation error or warning will be marked in the editor panel by underlining the error region with a red color Also a red sign will mark the position in the document of that line on the right side ruler of the editor panel The same will happen for a validation warning only the color will be yellow instead of red The ruler on the right of the document is designed to display the errors found during the validation process and also to help the u
601. urce from the container e Copy location allows you to copy to clipboard an application specific URL for the resource which can then be used for various actions like opening or transforming the resources 329 Working with Databases eXist Connection Actions available at connection level Refresh performs a refresh of the selected node s subtree e Configure Database Sources opens the Data Sources preferences page where you can configure both data sources and connections Actions available at container level Refresh performs a refresh of the selected node s subtree 2 Add Resource adds a new XML resource to the selected container Add Container creates a new collection in the selected one X Delete removes the selected collection e Rename allows you to change the name of the selected collection e Move allows you to move the selected collection in a different location in the database tree also available through drag and drop Actions available at resource level Refresh performs a refresh of the selected resource S Open opens the selected resource in the editor e Rename allows you to change the name of the selected resource e Move allows you to move the selected resource in a different collection in the database tree also available through drag and drop X Delete removes the selected resource from the collection e Copy location allows you to copy to clipbo
602. using the Insert Topic Reference Dialog you can easily browse for and select the source topic file The Target combo box shows all available topics that can be targeted in the file Selecting a target modifies the Href value to point 91 Author for DITA to it The Format and Scope combos are automatically filled based on the selected file You can specify and enforce a custom navigation title by checking the Navigation title checkbox and entering the desired title The file chooser located in the dialog allows you to easily select the desired topic The selected topic file will be added as a child sibling of the current selected topic reference You can easily insert multiple topic references by keeping the dialog opened and changing the selection in the DITA Maps Manager tree You can also select multiple resources in the file explorer and then insert them all as topic references Another easy way to insert a topic reference is to directly drag and drop topic files from the Oxygen Project or the Explorer right in the DITA Maps tree You can also define keys using the Keys text field on the inserted topicref or keyde f element or instead of using the Href to point to a location you can reference a key definition using the Keyref text field Inserting a Topic Heading The topichead element provides a title only entry in a navigation map as an alternative to the fully linked title provided by the topicref element A topic heading can be i
603. ut formats 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 install the tool chain required to perform the transformation and process the xml files created with lt oXygen gt in accordance with the processor instruc tions PDF 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 software using the free PDF Viewer from Adobe http www adobe com products acrobat readstep html PS 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 digital 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 TXT Text files are Plain ASCII Text and can be opened in any text editor or word processor XML 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
604. v4 supports only CALS table model HTML table model is supported in DocBook v5 4 Caution Column specifications are required for table actions to work properly e Generate IDs allows you to generate ID for the current selection or for the element at caret position if the element appears in ID Generation dialog In this dialog you can specify the elements for which lt oXygen gt should generate an ID You can choose to automat ically generate an ID for these elements by selecting Auto generate ID s for elements You can choose a pattern for the generated ID using the field ID Pattern If the element already has an ID this ID is preserved All actions described above are available in the contextual menu main menu Docbook4 submenu and in the Author custom actions toolbar Templates Default templates are available for DocBook 4 They are stored in frameworksDir docbook templates Docbook 4 folder and they can be used for easily creating a book or article with or without XInclude These templates are available when creating new documents from templates Docbook 4 Article New Docbook 4 Article Docbook 4 Article with XInclude New Docbook 4 XInclude aware Article Docbook 4 Book New Docbook 4 Book Docbook 4 Book with XInclude New Docbook 4 XInclude aware Book Catalogs The default catalog is stored in frameworksDir docbook catalog xml Transformation Scenarios The following default transformation scenarios are availabl
605. ve the field Limit the number of cells empty if you want the entire content of the table to be displayed By default this field is set to 2 000 If a table having more cells than the value set here is displayed in the Table Explorer view a warning dialog will inform you that the table is only partially shown In Oracle XML and Tamino databases a container can hold millions of resources If the node corresponding to such a container in the Data Source Explorer view would display all the contained resources at the same time the performance of the view would be very slow To prevent such a situation only a limited number of the contained resources is displayed as child nodes of the container node Navigation to other contained resources from the same container is enabled by the Up and Down buttons of the Data Source Explorer view This limited number is set in the option Maximum number of children for container nodes The default value is 200 nodes The Show warning when expanding other database schema in the section Convert DB Structure to XML Schema controls if a warning message will be displayed when expanding another database schema and there are tables selected in the current expanded one This applies for the dialog Select database table when invoking Convert DB Structure to XML Schema action New Opens the Connection dialog 400 Configuring the application Figure 17 53 The Connection dialog Connection Name ODEC Connection
606. velopers You will need the Oxygen Author SDK http www oxygenxml com InstData Editor Developer oxygenAuthorSDK zip available on the lt oXygen gt website http www oxygenxml com developer html which includes the source code of the Author operations in the predefined document types and the full documentation in Javadoc format of the public API available for the developer of Author custom actions The next Java examples are making use of AWT classes If you are developing extensions for the lt oXygen gt XML Editor plugin for Eclipse you will have to use their SWT counterparts Itis assumed you already read the Configuring Actions Menus Toolbar section and you are familiar with the lt oXygen gt Author customization You may find the XML schema CSS and XML sample in the Example Files Listings Warning Make sure the Java classes of your custom Author operations are compiled with the same Java version that is used by Otherwise the classes may not be loaded by the Java virtual machine For example if you run with a Java 1 5 virtual machine but the Java classes of your custom Author operations are compiled with a Java 1 6 virtual machine then the custom operations cannot be loaded and used by the Java 1 5 virtual machine Example 1 Step by Step Example Simple Use of a Dialog from an Author Operation Let s start adding functionality for inserting images in the Simple Documentation Framework shortly SDF The images are represented
607. ver param connectionURL The connection URL param user The database user param password The password param sql The SQL statement return The string containing the XML fragment throws SQLException thrown when there is a problem accessing the database or there are erors in the SQL expression throws ClassNotFoundException when the JDBC driver class could not be loaded aA private String getFragment String jdbcDriver String connectionURL String user String password String sql throws SQLException ClassNotFoundException Properties pr new Properties pr put CharacterEncoding UTF8 pr put useUnicode TRUE pr put user user pr put password password Loads the database driver Class forName jdbcDriver Opens the connection Connection connection DriverManager getConnection connectionURL pr java sql Statement statement connection createStatement ResultSet resultSet statement executeQuery sql StringBuffer fragmentBuffer new StringBuffer fragmentBuffer append lt table xmlns http www oxygenxml com sample documentation gt Creates the table header 240 Author Developer Guide fragmentBuffer append lt header gt ResultSetMetaData metaData resultSet getMetaData int columnCount metaData getColumnCount for int i 1 i lt columnCount i
608. with the current document as siblings of the current element inserted immediately before respectively after the current element Edit attributes for the selected node A dialog is presented allowing the user to see and edit the attributes of the selected node See here for more details about editing attributes 49 Editing documents The Toggle comment item of the outline tree popup menu is the same item as in the editor popup menu with the same name It encloses the currently selected element of the outline tree in an XML comment if the element is not commented or un comments it if it is commented The Cut Copy and Delete items of the popup menu execute the same actions as the Edit menu items with the same name on the elements currently selected in the outline tree Cut Copy Paste Document Tag Selection The Outline view 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 Outline view 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 You can also use key search to look for a particular tag name in the Outliner tree Grouping documents in XML projects
609. with wrong spelling the suggestions of the Spelling dialog are available on the context menu of the editor panel in the Spell check suggestions submenu Note Words with lengths in excess of 100 characters are ignored by the spell checker 347 Text editor specific actions Check Spelling in Files The Check Spelling in Files option available from the Project contextual menu enables you to check spelling on multiple documents Figure 16 3 Check Spelling in Files Dialog Check Spelling in Files Scope O All opened files O Directory of the current file O Project files O Specified path Options File filter it x Recurse subdirectories _ Include hidden files Spell Check Options Check all You can choose the following scopes All opened files Spell check in all opened files Directory of the current file Directory of the current edited file Scope of the current DITA Map Scope of the current edited DITA Map Project files All files from the current project Selected project files Selected files from the current project Specified path Specify a custom path You can also choose a file filter decide whether to recurse subdirectories or process hidden files The spell checker processor uses the options available in the Spell Check Preferences panel 348 Chapter 17 Configuring the application Importing Exporting Global Options In the lt oXygen gt preferences
610. xmlschema sche XMLSchema ISOSchematron representation of XML Schema with embedded malSOSchematron css ISO Schematron rules frameworks xmlschema schemaS XMLSchema Schematron representation of XML Schema with embedded chematron css Schematron rules frameworks xmlschema de XMLSchema Schematron representation of XML Schema for general editing fault css The RelaxNG document type This document type is used to associated CSS stylesheets to an RelaxNG file so it can be visualized in the Author page Association rules A file is considered to be an RelaxNG document when the namespace is http relaxng org ns structure 1 0 Author extensions The following CSS alternatives are proposed for visualizing RelaxNG schemas in the Author page frameworks relaxng relaxng Relax NG representation of Relax NG optimized for editing in the Author main css mode frameworks relaxng re RelaxNG XML Syntax ISOSchematron representation of RelaxNG XML laxngISOSchematron css syntax with embedded ISO Schematron rules Embedded Schematron rules are not supported in Relax NG schemas with compact syntax frameworks relaxng relaxng RelaxNG XML Syntax Schematron representation of RelaxNG XML syntax Schematron css with embedded Schematron rules Embedded Schematron rules are not supported in Relax NG schemas with compact syntax The NVDL document type This document type is used to associated CSS stylesheets to
611. y rowSpan new Integer rs catch NumberFormatException ex The attribute value was not a number return rowSpan return true considering the column specifications always available a public boolean hasColumnSpecifications AuthorElement tableElement return true Ignored We do not extract data from the lt code gt table lt code gt element at public void init AuthorElement table 253 Author Developer Guide public String getDescription return Implementation for the Simple Documentation Framework table layout TableColumnWidthProvider java package simple documentation framework extensions import java util ArrayList import java util List port ro sync ecss extensions api AuthorDocumentController port ro sync ecss extensions api AuthorOperationException port ro sync ecss extensions api AuthorTableColumnWidthProvider port ro sync ecss extensions api WidthRepresentation port ro sync ecss extensions api node AttrValue port ro sync ecss extensions api node AuthorElement H H H H pe H 3 53 3 3 383 Simple Documentation Framework table column width provider E public class TableColumnWidthProvider implements AuthorTableColumnWidthProvider Cols private tart offset n H nt colsStartOffset pk Cols end offset private Ju nt colsEndOffset
612. y Transformation button before associating a scenario with the edited document will invoke first the Configure Transformation Scenario dialog and then apply the selected scenario Open the Configure Transformation Scenario dialog using one of the methods previously presented or by selecting XML gt Configure transformation scenario Alt Shift T C Cmd Alt T C on Mac OS 278 Transforming documents Figure 10 1 Configure Transformation Scenario Dialog Configure Transformation Scenario X Scenario type XML transformation with XSLT Scenarios Docbook HTML 9 Docbook HTML Chunk q Docbook PDF Docbook XHTML 9 Docbook XHTML Chunk Docbook HTML personal schema 8 a The Scenario type controls which scenarios are presented to the user The available scenario types are XML transformation with XSLT Represents a transformation that consists in applying an XSLT stylesheet over an XML XML transformation with XQuery Represents a transformation that consists in applying an XQuery over an XML DITA OT transformation Scenarios that use the DITA Open Toolkit DITA OT to transform XML content into an output format More information about configuring an DITA OT trans formation scenario can be found here XSLT transformation Represents a transformation that consists in applying an XSLT stylesheet over an XML file XQuery transformation Represents a transformation that consists
613. y from the toolbar Configuring the Contextual Menu The contextual menu is shown when you right click on Mac OS X it is used the combination ctrl and mouse click in the Author editing area In fact you are configuring the bottom part of the menu since the top part is reserved for a list of generic actions like Copy Paste Undo etc Open the Document Type dialog for the SDF framework and click on the Author tab Next click on the Contextual Menu label Follow the same steps as explained above in the Configuring the Main Menu except changing the menu name the contextual menu has no name Figure 8 15 Configuring the Contextual Menu Schema Classpath Author Templates Catalogs Transformation Extensions reser Actions Menu Contextual menu Toolbar Available actions Current actions Name Description 2 a Contextual Menu Separator Menu separa B Bold Submenu Submenu ae Z Italic Bold Emphasises t e U Underline Delete Column Delete a tabl a Link Delete Row Delete a tabl MEA Ec axis Initial page To test it open the test file and click to open the contextual menu In the lower part there is shown the Table sub menu and the Insert section action Author Default Operations Below are listed all the operations and their arguments InsertFragmentOperation Inserts an XML fragment at the current cursor position The selection i
614. y the code templates and is the default shortcut of the action Document gt Content Completion Show Code Templates 374 Configuring the application The Code Templates preferences panel is opened from menu Window Preferences gt Author Editor Templates Code Templates Figure 17 24 The Code Templates preferences panel Code Templates nig Name Editor Description Aj ad X5D Editor Annotation Documentation agn XSD Editor Attribute Group Name agr XSD Editor Attribute Group Reference all XSD Editor ALL an XSD Editor Attribute Name ana XSD Editor Attribute Name Annotation documentation any XSD Editor ANY v K gt Preview 1 lt xs annotation gt 2 lt xs documentation gt caret lt xs document 3 lt xs annotation gt is gt New Define a new code template You can define a code template for a specific type of editor or for all editor types Edit Edit the selected code template Duplicate Duplicate the selected code template Delete Delete the selected code template Import Import a file with code templates Export Export a file with code templates Document Templates The user can add template files in the templates folder of the lt oXygen gt install directory Directories to be scanned for additional templates can also be specified in the Document Templates option page The Document Templates preferences panel is opened from menu Window gt Preferences gt Author E
615. you have to use the s Reset cache and validate action This action will also re parse the catalogs and reset the schema used for content completion Validate As You Type lt oXygen gt can be configured to mark validation errors in the edited document as you modify it using the keyboard If you enable the Validate as you type option any validation errors and warnings will be highlighted automatically in the editor panel after the configured delay from the last key typed with underline markers in the editor panel and small rectangles on the right side ruler of the editor panel in the same way as for manual validation invoked by the user 39 Editing documents Figure 4 19 Validate as you type on the edited document gt fog personal schema xml 3 fe personal xsd 1 Model 3 1 lt xml version 1 0 encoding UTF 8 gt AM HO 2 lt personnel xmlns xsi noNamespa 45 lt person id Big Boss gt E ib 5 cvc complex type 2 4 a Invalid content was found starting eet utes 6 with element link_error One of email url link is a id ID si http SchemaLocation perso fwww w3 org 7 A person lt gt Content element only 4 note string 95 contr string 4 salary decimal 10 lt email gt chief oxygenxml com lt emai 11 lt link error Model name 12 subordinates one worker two wor email O UNBOUNDED 13 lt person gt url O UNB
616. zino les at A Fas ane Beda dd A e di a 340 Certificates mentine na dro oie 341 SI A A A Matai ine S EN EE EE Sete Ona 342 Verifying the SiS ature i no cess cenntds opt scanty sataee retina 343 16 Texteditor Specific actions rynni a ae ey E eae Ueda dada E Auton De seb ee aed 344 Finding and replacing text in the current file 0 0 0 cece cece ce ence eceeeceeeeeeeeeeeeaeseaeeea seen teas eeae esas 344 The Find All Elements Attributes dialog cece cece cence nce c nce e nce n cen eeeeceeceeeeeeeeaeseaeeeneeage 344 Using Check Spelling iconos sestieude se piste cited woeacepeved shee R branes Inte py seeshep E p EEEE Epa dest 345 Adding a spell dictionary mii dd ade tenet ae 346 Adding a Hunspell dictionary suc eeann ae E a AA voles daecuwssgouczezsseeds 346 Adding an AZ Check dictionary iesenii p e eei e Ee EE EE EN EE EEN RE EES 347 A NN 347 Tonore Words vita A A E E O 347 spell checking a8 YOu type sss O 347 Check Spelling nm Fleitas ew edaly 348 17 Contiguring the appheatioN s soreo eae a tte A vaenmeeeedeeptonesaasbgeunesdas sume sean 349 Importing Exporting Global Options 00 0 0 cece eee ee cece cece a eene cen ceneeeeeeeeeceeeseeeeaeseaeeeu seen eeaeeeges 349 PrefErenCes sita saad ce A A en hes abe aa IA wet as 349 SA a A whee Bea Se case aed cles E ye cnr ia Medals remeber eveceetat 350 Global ii ti anos tee ooopesnness va ned TENE sheen ovens tenes sewed cl wens 350 POMS tii A ES ee NS Doane ai MRR 351 Document Type Assoc

XML Author 11.2 User Manual for Eclipse

Contents

Download Pdf Manuals

Related Search

Related Contents