Return-Path:
+For the following instructions to work, ensure that the DocBook stylesheets have been enabled. See the User Guide if this has not already been done. Currently the stylesheets only support <article> and <chapter> as top-level elements.
+The Stylist and Navigator also need to be displayed:
+
+
+
+
+
+
Propchange: incubator/ooo/ooo-site/trunk/content/xml/xmerge/docbook/supported_tag_table.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ooo/ooo-site/trunk/content/xml/xmerge/docbook/tag_usage.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/xml/xmerge/docbook/tag_usage.html?rev=1208093&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/xml/xmerge/docbook/tag_usage.html (added)
+++ incubator/ooo/ooo-site/trunk/content/xml/xmerge/docbook/tag_usage.html Tue Nov 29 21:37:58 2011
@@ -0,0 +1,317 @@
+
+
+
+
+
+ DocBook Categories
+ Tag Name
+ Import
+ Round Trip
+ OOorg Mapping
+
+
+
+
+ General
+ <abstract>
+ X
+ X
+ In-Line
+
+
+
+
+ Personal Information
+ <address>
+ X
+ X
+ In-Line
+
+
+
+
+ Personal Information
+ <affiliation>
+ X
+ X
+ In-Line
+
+
+
+
+ Component
+ <appendix>
+ X
+ X
+ Top-Level Element
+
+
+
+
+ Operating Environment
+ <application>
+ X
+ X
+ In-Line
+
+
+
+
+ Meta Information
+ <articleinfo>
+ X
+ X
+ Meta Information
+
+
+
+
+ Component
+ <article>
+ X
+ X
+ Top-Level Element
+
+
+
+
+ Author
+ <author>
+ X
+ X
+ In-Line
+
+
+
+
+ Author
+ <authorblurb>
+
+
+ In-Line
+
+
+
+
+ Author
+ <authorgroup>
+ X
+ X
+ Nested Element
+
+
+
+
+ Top Level
+ <book>
+
+
+ Top-Level Element
+
+
+
+
+ Meta Information
+ <bookinfo>
+
+
+ Meta Information
+
+
+
+
+ In Line
+ <caption>
+ X
+ X
+ In-Line
+
+
+
+
+ Component
+ <chapter>
+ X
+ X
+ Top-Level Element
+
+
+
+
+ Meta Information
+ <chapterinfo>
+ X
+ X
+ Meta Information
+
+
+
+
+ In Line
+ <citetitle>
+
+
+ In-Line
+
+
+
+
+ Personal Information
+ <city>
+
+
+ In-Line
+
+
+
+
+ Table
+ <colspec>
+ X
+ X
+ Table
+
+
+
+
+ Operating Environment
+ <command>
+ X
+ X
+ In-Line
+
+
+
+
+ In Line
+ <comment>
+
+
+ In-Line
+
+
+
+
+ Operating Environment
+ <computeroutput>
+ X
+ X
+ In-Line
+
+
+
+
+ Copyright Legal
+ <copyright>
+ X
+ X
+ In-Line
+
+
+
+
+ Personal Information
+ <country>
+
+
+ In-Line
+
+
+
+
+ Meta Information
+ <edition>
+
+
+ In-Line
+
+
+
+
+ Meta Information
+ <date>
+
+
+ In-Line
+
+
+
+
+ Personal Information
+ <email>
+ X
+ X
+ In-Line
+
+
+
+
+ In Line
+ <emphasis>
+ X
+ X
+ In-Line
+
+
+
+
+ Table
+ <entry>
+ X
+ X
+ Table
+
+
+
+
+ General
+ <example>
+
+
+ In-Line
+
+
+
+
+ Graphics
+ <figure>
+
+
+ Graphics
+
+
+
+
+ Operating Environment
+ <filename>
+
+
+ In-Line
+
+
+
+
+ Personal Information
+ <firstname>
+
+
+ In-Line
+
+
+
+
+ General
+ <firstterm>
+
+
+ In-Line
+
+
+
+
+ General
+ <footnote>
+
+
+ Link
+
+
+
+
+ Operating Environment
+ <function>
+
+
+ In-Line
+
+
+
+
+ Glossary
+ <glossary>
+
+
+ Nested Element
+
+
+
+
+ Glossary
+ <glossdef>
+
+
+ In-Line
+
+
+
+
+ Glossary
+ <glossterm>
+
+
+ In-Line
+
+
+
+
+ Graphics
+ <graphic>
+
+
+ Graphics
+
+
+
+
+ User Interfaces
+ <guibutton>
+ X
+ X
+ In-Line
+
+
+
+
+ User Interfaces
+ <guiicon>
+ X
+ X
+ In-Line
+
+
+
+
+ User Interfaces
+ <guilabel>
+ X
+ X
+ In-Line
+
+
+
+
+ User Interfaces
+ <guimenu>
+ X
+ X
+ In-Line
+
+
+
+
+ User Interfaces
+ <guimenuitem>
+ X
+ X
+ In-Line
+
+
+
+
+ User Interfaces
+ <guisubmenu>
+ X
+ X
+ In-Line
+
+
+
+
+ In Line
+ <highlight>
+
+
+ In-Line
+
+
+
+
+ Copyright Legal
+ <holder>
+
+
+ In-Line
+
+
+
+
+ Graphics
+ <imageobject>
+
+
+ Graphics
+
+
+
+
+ Graphics
+ <imagedata>
+
+
+ Graphics
+
+
+
+
+ Index
+ <index>
+ X
+ X
+ Index
+
+
+
+
+ Index
+ <indexentry>
+ X
+ X
+ Index
+
+
+
+
+ Index
+ <indexterm>
+ X
+ X
+ Index
+
+
+
+
+ General
+ <informalexample>
+
+
+ In-Line
+
+
+
+
+ Table
+ <informaltable>
+
+
+ Table
+
+
+
+
+ Graphics
+ <inlinegraphic>
+
+
+ Graphics
+
+
+
+
+ Graphics
+ <inlinemediaobject>
+
+
+ Graphics
+
+
+
+
+ List
+ <itemizedlist>
+ X
+ X
+ Lists
+
+
+
+
+ User Interfaces
+ <keycap>
+ X
+ X
+ In-Line
+
+
+
+
+ User Interfaces
+ <keycombo>
+ X
+ X
+ In-Line
+
+
+
+
+ User Interfaces
+ <keysym>
+ X
+ X
+ In-Line
+
+
+
+
+ Copyright Legal
+ <legalnotice>
+
+
+ Nested Element
+
+
+
+
+ Link
+ <link>
+ X
+ X
+ Link
+
+
+
+
+ List
+ <listitem>
+
+
+ Lists
+
+
+
+
+ Formatting
+ <literal>
+
+
+ In-Line
+
+
+
+
+ Formatting
+ <literallayout>
+
+
+ In-Line
+
+
+
+
+ Formatting
+ <markup>
+
+
+ In-Line
+
+
+
+
+ Graphics
+ <mediaobject>
+
+
+ Graphics
+
+
+
+
+ List
+ <member>
+
+
+ Lists
+
+
+
+
+ User Interfaces
+ <menuchoice>
+ X
+ X
+ Nested Element
+
+
+
+
+ Admonition
+ <note>
+
+
+ Link
+
+
+
+
+ Personal Information
+ <orgname>
+ X
+ X
+ In-Line
+
+
+
+
+ Link
+ <olink>
+ X
+ X
+ Link
+
+
+
+
+ Operating Environment
+ <option>
+
+
+ In-Line
+
+
+
+
+ List
+ <orderedlist>
+ X
+ X
+ Lists
+
+
+
+
+ General
+ <para>
+ X
+ X
+ In-Line
+
+
+
+
+
+ <part>
+
+
+ Top-Level Element
+
+
+
+
+ Meta Information
+ <partintro>
+
+
+ Top-Level Element
+
+
+
+
+ In Line
+ <phrase>
+
+
+ In-Line
+
+
+
+
+ Personal Information
+ <postcode>
+
+
+ In-Line
+
+
+
+
+ Component
+ <preface>
+
+
+ Top-Level Element
+
+
+
+
+ Index
+ <primary>
+ X
+ X
+ Index
+
+
+
+
+ Index
+ <primaryie>
+ X
+ X
+ Index
+
+
+
+
+ Procedure
+ <procedure>
+
+
+ In-Line
+
+
+
+
+ Meta Information
+ <publisher>
+
+
+ Nested Element
+
+
+
+
+ Meta Information
+ <releaseinfo>
+
+
+ Meta Information
+
+
+
+
+ In Line
+ <remark>
+
+
+ In-Line
+
+
+
+
+ General
+ <replaceable>
+
+
+ In-Line
+
+
+
+
+ Revision
+ <revhistory>
+
+
+ Nested Element
+
+
+
+
+ Revision
+ <revision>
+
+
+ Nested Element
+
+
+
+
+ Revision
+ <revnumber>
+
+
+ Nested Element
+
+
+
+
+ Table
+ <row>
+ X
+ X
+ Table
+
+
+
+
+ Graphics
+ <screeninfo>
+
+
+ Graphics
+
+
+
+
+ Graphics
+ <screenshot>
+
+
+ Graphics
+
+
+
+
+ Index
+ <secondary>
+ X
+ X
+ Index
+
+
+
+
+ Index
+ <secondaryie>
+ X
+ X
+ Index
+
+
+
+
+ Sections
+ <sect1>
+ X
+ X
+ Sections
+
+
+
+
+ Sections
+ <sect2>
+ X
+ X
+ Sections
+
+
+
+
+ Sections
+ <sect3>
+ X
+ X
+ Sections
+
+
+
+
+ Sections
+ <sect4>
+ X
+ X
+ Sections
+
+
+
+
+ Sections
+ <sect5>
+
+
+ Sections
+
+
+
+
+ Index
+ <see>
+
+
+ Index
+
+
+
+
+ Index
+ <seealso>
+
+
+ Index
+
+
+
+
+ Procedure
+ <step>
+
+
+ In-Line
+
+
+
+
+ In Line
+ <subscript>
+ X
+ X
+ In-Line
+
+
+
+
+ In Line
+ <superscript>
+ X
+ X
+ In-Line
+
+
+
+
+ Personal Information
+ <surname>
+
+
+ In-Line
+
+
+
+
+ Operating Environment
+ <systemitem>
+
+
+ In-Line
+
+
+
+
+ Table
+ <table>
+ X
+ X
+ Table
+
+
+
+
+ Table
+ <tbody>
+ X
+ X
+ Table
+
+
+
+
+ List
+ <term>
+ X
+ X
+ Lists
+
+
+
+
+ Index
+ <tertiary>
+
+
+ Index
+
+
+
+
+ Index
+ <tertiaryie>
+
+
+ Index
+
+
+
+
+ Graphics
+ <textobject>
+
+
+ Graphics
+
+
+
+
+ Table
+ <tgroup>
+ X
+ X
+ Table
+
+
+
+
+ Table
+ <thead>
+ X
+ X
+ Table
+
+
+
+
+ Admonition
+ <tip>
+
+
+ In-Line
+
+
+
+
+ General
+ <title>
+ X
+ X
+ In-Line
+
+
+
+
+ Link
+ <ulink>
+ X
+ X
+ Link
+
+
+
+
+ User Interfaces
+ <userinput>
+
+
+ In-Line
+
+
+
+
+ List
+ <variablelist>
+ X
+ X
+ Lists
+
+
+
+
+ List
+ <varlistentry>
+ X
+ X
+ Lists
+
+
+
+
+ Admonition
+ <warning>
+
+
+ In-Line
+
+
+
+
+ Link
+ <xref>
+ X
+ X
+ Link
+
+
+
+Personal Information
+ <year>
+
+
+ In-Line
+ DocBook tags in OpenOffice.org
+
+
+Contents
+
+
+
+
+
+
+
+
+
+
+ In the File Open dialog select the appropriate DocBook filter (Article or Chapter) in the File Type combo-box. An existing DocBook document can then be imported to OpenOffice.org. +
+ +
+ Similarly, in the File Save As dialog select the appropriate DocBook filter in the File Type combo-box.
+ NOTE: It is possible with the current filter to import an article and export it as a chapter, or go from chapter to article.
+
+ It is possible to create and save a new DocBook document in OpenOffice.org. +
+ The info sections currently supported match the top-level elements: <articleinfo> and <chapterinfo> +
++ The ArticleInfo can contain the meta information about the Article, such as author details and copyright. +
Early in the DocBook project there were difficulties mapping nested DocBook XML elements to the internal OpenOffice.org XML format. An example of how nested tags are now supported is the menuchoice element that can contain several guimenu elements. +
+
+ NOTE: This is the initial fix for the problem of nesting DocBook XML tags in OpenOffice.org. The main purpose was to retain the information on a round-trip import and export of a DocBook document. It is not ideally suited to creating DocBook content in OpenOffice.org.
+
+ OpenOffice.org bookmarks with reserved names are used to represent the parent element when nesting tags. The convention used is to follow the element name by an underscore and a number. The first element in the document will be numbered 0 (e.g. menuchoice_0) and subsequent elements of the same type will increment this number (e.g. menuchoice_1 menuchoice_2 etc.). For another example of how to use nested tags, see Meta Information where an Authorgroup is used to contain Author's. +
+ + +DocBook in-line elements are, in general, mapped to OpenOffice.org Custom Styles. +
++ The following instructions show how to create a DocBook subscript element. +
Initially the DocBook project used OpenOffice.org sections to enforce the nesting of DocBook sections. Feedback has shown that authors wish to use the common word processing styles such as Heading1, Heading2, etc. The following instructions describe how to create a <sect1> that contains a <sect2> +
+
+ Formal and Informal DocBook tables are represented by a standard OpenOffice.org tables.
+
+ Creating a Table
+
An <informaltable> is constructed in the same fashion as the formal table above, the only difference is that the table Caption is not specified.
+ + ++ The various DocBook lists are represented by custom and standard OpenOffice.org list styles. +
+The different methods of linking available in DocBook are supported in OpenOffice.org +
+ + + ++
+
+ There is support for <xref> with a linkend attribute. If the element to be referenced does not already have an id attribute then an id can be created with an OpenOffice.org cross-reference.
+ Create an id attribute for a <sect1>
+
+ The filter has round trip support for importing and exporting DocBook links. +
+ + ++
++ TBD +
+ ++
+ NOTE: After discussions with authors the decision was made to only support simplified indexterms in the future. Few authors use spanning indexterms with startofrange and endofrange values or reference elements with a zone attribute. +
+ ++ At present it is not possible to create a DocBook index in OpenOffice.org. However, the import and export filters should retain any index tags in an existing DocBook document. +
+ + + + Propchange: incubator/ooo/ooo-site/trunk/content/xml/xmerge/docbook/tag_usage.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/ooo/ooo-site/trunk/content/xml/xmerge/docbook/temp_test_only.html URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/xml/xmerge/docbook/temp_test_only.html?rev=1208093&view=auto ============================================================================== --- incubator/ooo/ooo-site/trunk/content/xml/xmerge/docbook/temp_test_only.html (added) +++ incubator/ooo/ooo-site/trunk/content/xml/xmerge/docbook/temp_test_only.html Tue Nov 29 21:37:58 2011 @@ -0,0 +1,252 @@ + + +Goal is to explore the possibility of using OpenOffice.org as a WYSIWYG editor of XML content. +The principle is to edit structured documents using styles. These styles are then transformed to XML tags on export.
+ +This page shows how to enable and use the DocBook filters. It also shows the location of the stylesheets so that users can download and use the latest transformations.
+ + +Initially the project used OpenOffice.org sections to enforce nesting of DocBook sections. +Feedback has shown that authors wish to use the common word processing styles such as Heading1, Heading2, etc. The stylesheets and templates shipped with OOo1.1 Beta use OpenOffice.org sections. +Links are available below for stylesheets which use OOo headings and instructions on how to install these stylesheets. +Stylesheets currently only support DocBook Articles. Book and Chapter support is planned.
+ + +Currently stylesheets are packaged in a JAR. The content of the JAR is explained later in this document. It is planned that future OOo will be able to use the import and export XSLTs directly.
+ + +To see what is available and get an impression of how it works look at :
+ + +
Note : See also Eric Bellot's OOo2sdbk
+ + + +The DocBook filters are installed during OpenOffice.org setup by selecting "Custom Installation" and in the "Optional Components" section, selecting the "Mobile Device Filters".
+ +To enable the DocBook filter, the following file must be edited:
<OOo Install Dir>/share/registry/data/org/openoffice/Office/TypeDetection.xcu;
Once the filter has been enabled, run OOo to see DocBook available in the OpenOffice.org "File of Type" comb-box in both the Open and Save/As dialogs. Hint : Type D in the "File of Type" combo-box maybe more than once.
+ +NOTE : In order for the Java based filters to work correctly, and Java Runtime Environment needs to be specified during setup. +JRE1.4 or greater is recommended as it contains an XML Parser (Crimson) and an XSLT processor (Xalan). +JRE1.3 can also be used, if a parser e.g. Xerces or Crimson, and the Xalan XSLT processor are made available.
+ + + + +Review the UserGuide for information on using the filter.
+ + + + +The docbook filter uses the XMerge framework's XSLT processing functionality. The docbook.jar contains a set of two XSLT style-sheets, one for transforming from docbook to OpenOffice and one for transforming from OpenOffice to docbook.
+ +The file also contains a converter.xml file in the META-INF directory that contains information describing the supported mime-types, the style-sheet names and the XMerge plugin that it uses.
+ +To make changes:
+The two stylesheets can now be edited as required, or download the latest copies from here.
+ +Repacking the jar:
+For example, to use the new XSLT stylesheets, replace the stylesheets in temp with the downloaded versions. The converter.xml file contains info regarding the file conversions that the filter supports. This information is used by XMerge when a conversion has been requested.
+Click here to obtain a list of currently supported DocBook tags.
+ + +These are limitations which should be highlighted but are not blockers. In fact, sufficient interest in this project should drive requirements for enhancements.
+ +- No support in OOo for user as to which styles (tags) to use when. Must create and follow guidelines.
+ +- No validation for export.
+ + +