blob: 51ef0a6881bf59a9255b8d64f16c17e6f9b8d11f [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="content-type"
content="text/html; charset=ISO-8859-1">
<title>xml.openoffice.org</title>
</head>
<body>
<h1>XMerge AportisDoc Plugin</h1>
<br>
<h2><font color="#cc0000">Overview</font></h2>
<br>
The AportisDoc plugin converts text data between OpenOffice Writer
format and AportisDoc's binary Palm DataBase file format. <br>
<br>
The AportisDoc format is a plain-text format and does not support any formatting
options.<br>
<br>
<table cellpadding="4" cellspacing="1" bgcolor="#f0f0f0" width="50%">
<tbody>
<tr align="center">
<th bgcolor="#00315a"><font color="#ffffff"
face="Arial, Helvetica" size="2"><b>Category</b></font></th>
<th bgcolor="#00315a"><font color="#ffffff"
face="Arial, Helvetica" size="2"><b>Feature</b></font></th>
<th bgcolor="#00315a" width="20%"><font color="#ffffff"
face="Arial, Helvetica" size="2"><b>Supported</b></font></th>
</tr>
<tr>
<td valign="top" bgcolor="#99ccff" align="center">&nbsp;<font
color="#00315a" face="Arial, Helvetica" size="2"><b>Document Elements</b></font><br>
</td>
<td valign="top" bgcolor="#99ccff"><br>
</td>
<td width="20%" valign="top" bgcolor="#99ccff"><br>
</td>
</tr>
<tr>
<td valign="top"><br>
</td>
<td valign="top"><font face="Arial, Helvetica" size="2">Paragraphs<br>
</font> </td>
<td width="20%" valign="top"><font face="Arial, Helvetica"
size="2">yes<br>
</font> </td>
</tr>
<tr>
<td valign="top"><br>
</td>
<td valign="top"><font face="Arial, Helvetica" size="2">Styles<br>
</font> </td>
<td width="20%" valign="top"><font face="Arial, Helvetica"
size="2">no<br>
</font> </td>
</tr>
<tr>
<td valign="top"><br>
</td>
<td valign="top"><font face="Arial, Helvetica" size="2">Tables<br>
</font> </td>
<td width="20%" valign="top"><font face="Arial, Helvetica"
size="2">no<br>
</font> </td>
</tr>
<tr>
<td valign="top"><br>
</td>
<td valign="top"><font face="Arial, Helvetica" size="2">Lists<br>
</font> </td>
<td width="20%" valign="top"><font face="Arial, Helvetica"
size="2">no<br>
</font> </td>
</tr>
<tr>
<td valign="top"><br>
</td>
<td valign="top"><font face="Arial, Helvetica" size="2">Images</font><br>
</td>
<td valign="top"><font face="Arial, Helvetica" size="2">no</font><br>
</td>
</tr>
</tbody>
</table>
<br>
<h2><font color="#cc0000">Using the AportisDoc plugin</font></h2>
<br>
The AportisDoc plugin is invoked in the same manner as all other
XMerge plugins. &nbsp; Once the framework has been made aware of the
plugin, the only thing needed to use it is to specify its MIME type
as a source or destination type for conversion. &nbsp;The MIME type is
specified in the <code>converter.xml</code> file included in the <code>aportisdoc.jar</code>
file. &nbsp;Currently, this is set to <code>application/x-aportisdoc</code>
.<br>
<br>
For example, to use the AportisDoc plugin in conjunction with the
test driver supplied with the XMerge framework:<br>
<br>
<blockquote>
<pre>% java org.openoffice.xmerge.test.Driver -from staroffice/sxw -to application/x-aportisdoc Test.sxw<br><br>% java.org.openoffice.xmerge.test.Driver -from application/x-aportisdoc -to staroffice/sxw Test.pdb<br></pre>
</blockquote>
<br>
<h2><font color="#cc0000">Features</font></h2>
The plugin currently supports conversion to plain-text only, as
this is what AportisDoc supports.<br>
<br>
<br>
<img src="images/origdoc.jpg" alt="StarWriter Document image"
width="817" height="592" border="1">
<br>
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp; <i>Original
StarWriter Document </i><br>
<br>
Converts to<br>
<br>
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <img
src="images/pdborig.jpg" alt="pdborig" width="269" height="409"
border="1">
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp;&nbsp; <img src="images/pdbmod.jpg" alt="pdbmod"
width="269" height="409" border="1">
<br>
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; <i>&nbsp;&nbsp;&nbsp;
Converted Document&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp; Converted
Document with Edits</i><br>
<br>
<h2><font color="#cc0000">Merging&nbsp;</font></h2>
&nbsp; &nbsp;When changes have been made on the small device, the user
can either choose to convert the modified AportisDoc Palm Database to a
reduced content and style StarWriter file, or the user can choose to merge
the content changes made with the original StarWriter Document. In this
way, new edits can be retained whilst also retaining document styles and
formatting . To merge the modified AportisDoc DataBase, the XMerge test
driver program may be used again.<br>
<br>
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;
<div align="center">
<pre>% java.org.openoffice.xmerge.test.Driver -from application/x-aportisdoc -to staroffice/sxw -merge Test.sxw Test.pdb</pre>
</div>
<br>
&nbsp;&nbsp;&nbsp; <br>
&nbsp;<br>
<img src="images/moddoc.jpg" alt="StarWriter Document modified"
width="822" height="565" border="1">
<br>
<div align="left">
<blockquote>&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp;<i> &nbsp; Original StarWriter Document with Merged &nbsp;Edits</i><br>
</blockquote>
</div>
<h2><font color="#cc0000">Building the plugin</font></h2>
The AportisDoc plugin is built as part of the XMerge framework. &nbsp;Its
classes are stored in <code>aportisdoc.jar</code>. &nbsp;See <a
href="http://xml.openoffice.org/xmerge/index.html#build"> Building XMerge</a>
for more instructions.<br>
<br>
<br>
<br>
<br>
<br>
<br>
</body>
</html>