/[public]/psiconv/trunk/README
ViewVC logotype

Diff of /psiconv/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 36 Revision 200
1INTRODUCTION 1INTRODUCTION
2============ 2============
3 3
4This package is meant to make the Psion 5 series of PDAs, as well as other 4This package is meant to make the Psion 5 series of PDAs, as well as other
5small computers running Epoc 32, more usable to non-Windows users. But even 5small computers running EPOC 32, more usable to non-Windows users. But even
6they may profit from the data I collected. 6they may profit from the data I collected.
7 7
8The package consists of several parts: 8The package consists of several parts:
9 * Documentation about Psion 5 data formats; 9 * Documentation about Psion 5 data formats;
10 * A library which can be linked against application that have to read 10 * A library which can be linked against application that have to read
11 (and in the future, perhaps write) Psion 5 files; 11 and write Psion 5 files;
12 * An example command-line program which reads Psion files and writes 12 * An example command-line program which reads Psion files and writes
13 more commonly used formats. 13 more commonly used formats.
14 14
15 15
16DATA FORMATS 16DATA FORMATS
18 18
19As far as I know, and have gathered from the newsgroups, Psion does not want 19As far as I know, and have gathered from the newsgroups, Psion does not want
20or is not able to release the data formats of the saved files of their 20or is not able to release the data formats of the saved files of their
21internal applications. I am trying to reverse engineer these data formats 21internal applications. I am trying to reverse engineer these data formats
22and to document them for general use. At this moment, I understand their 22and to document them for general use. At this moment, I understand their
23Word, TextEd, Sketch, MBM and Record files. I want this information to 23Word, Sheet, TextEd, Sketch, MBM, Clipart and Record files, as well as a
24few other less important formats. I want this information to be available
24be available to everyone, in order to write better file conversion utilities 25to everyone, in order to write better file conversion utilities for popular
25for popular (non-)Windows programs. 26(non-)Windows programs.
26 27
27All documentation is written in Psion 5 Word. Fortunately, the utilities 28All documentation is written in Psion 5 Word. Fortunately, the utilities
28in this package can translate it to HTML and other formats. 29in this package can translate it to HTML and other formats.
29 30
30Unlike all other files in this package, the *.psi files in the directory 31Unlike all other files in this package, the *.psi files in the directory
38 39
39THE LIBRARY 40THE LIBRARY
40=========== 41===========
41 42
42libpsiconv is a library of routines that you can link against your own 43libpsiconv is a library of routines that you can link against your own
43application. It allows you to read Psion 5 files. Note that it comes 44application. It allows you to read and write Psion 5 files. Note that
44under the GNU General Public License; that means that you can only link 45it comes under the GNU General Public License; that means that you can
45it to programs which are also covered by that license. You can contact 46only link it to programs which are also covered by that license. You can
46me if you need other license terms. 47contact me if you need other license terms.
47 48
48The parser is quite good at the moment. Page layout codes are not yet 49The following formats are supported at this moment:
49read, but almost everything that is described in the documents in the 50 Word (R+W) Word processor files
50format directory is supported by it. Of course, it can also not yet 51 TextEd (R+W) OPL editor files
51cope with inserted objects (ie. documents in some other format) and 52 Sketch (R+W) Picture files
52other as of yet undocumented things. 53 MBM (R+W) Alternate picture format; can contain several pictures
54 ClipArt (R+W) Internal picture format; can contain several pictures
55 Sheet (R) Spreadsheet files
53 56
54Documentation is scarce; please examine the source code or the example 57Documentation is scarce; please examine the source code or the example
55psiconv program. Some things may also be found in the doc subdirectory. 58psiconv program. Some things may also be found in the doc subdirectory.
56 59
57 60
62more commonly used formats. It is linked against libpsiconv, and can 65more commonly used formats. It is linked against libpsiconv, and can
63handle anything that it can. 66handle anything that it can.
64 67
65Please enter `psiconv --help' if you want to know about its syntax. 68Please enter `psiconv --help' if you want to know about its syntax.
66 69
67The current HTML3 target is not very ideal. HTML is just not made to 70The current HTML4 target is not very ideal. HTML is just not made to
68represent detailed layout considerations: it is a document description 71represent detailed layout considerations: it is a document description
69language. Still, the output is quite readable already. Of course, headers 72language. Still, the output is quite readable already. Of course, headers
70and footers are not displayed, because there is no notion of pages in 73and footers are not displayed, because there is no notion of pages in
71HTML. Tabs are also difficult; they are not supported yet. This can be 74HTML. Tabs are also difficult; they are not supported yet. This can be
72solved using tables, but it is quite hard to do it correctly. Some other 75solved using tables, but it is quite hard to do it correctly. Some other
73things are just approximated too. 76things are just approximated too.
74 77
75The HTML4 target uses style sheets. You need a not-too-old browser for 78The XHTML target uses cascading style sheets (CSS). You need a not-too-old
76this to display correctly. Generally, the output of this generator is 79browser for this to display correctly. Generally, the output of this
77of higher quality than the normal HTML generator's. 80generator is of higher quality than the normal HTML generator's.
78 81
79A plain TEXT target just grabs all text, without any futher conversions. 82A plain TEXT target just grabs all text, without any futher conversions.
80 83
81The RTF target is not finished yet; in fact, it is no usable at all
82right now.
83
84All ImageMagick graphic output formats are supported; depending on how 84All ImageMagick graphic output formats are supported; depending on how
85you compiled ImageMagick, this is betwee 20 and 50 different formats. 85you compiled ImageMagick, this is betwee 20 and 50 different formats.
86Your favorite one should be somewhere... 86Your favorite one should be somewhere in there...
87 87
88I would very much like to add other targets, like (La)TeX, RTF (Rich Text 88In the past, my focus was on extending the number of output targets for
89Format) and XML (for AbiWord). If other people want to work on this, please 89this program; at the moment, I belief more in import/export filters for
90let me know! Of course, you could also write your own conversion applications 90office applications like AbiWord, Gnumeric and the Gimp.
91just using my data format description. Native import/export filters for
92some word processors would be very welcome!
93 91
94Psiconv is licensed under the GPL. Please read the included file COPYING 92Psiconv is licensed under the GPL. Please read the included file COPYING
95for exact licensing information. Please contact me if you need some other 93for exact licensing information. Please contact me if you need some other
96licensing terms. 94licensing terms.
97 95
101 99
102Starting with version 0.2, psiconv should keep all namespaces unpoluted. 100Starting with version 0.2, psiconv should keep all namespaces unpoluted.
103Starting with version 0.4, the conversion routines are linked into a 101Starting with version 0.4, the conversion routines are linked into a
104(static or shared) library. Version 0.5 has autoconf and libtool support, 102(static or shared) library. Version 0.5 has autoconf and libtool support,
105and should run on many more platforms. Version 0.6 has support for 103and should run on many more platforms. Version 0.6 has support for
106graphics. 104graphics. Version 0.8 can generate files and add Sheet support. Version
1050.9 uses Unicode inside, add the psiconv.conf file and has many more
106enhancements.
107 107
108High on the TODO list are input routines for Record files. 108High on the TODO list are input routines for Record files.
109Sheet files will be next. I am running into some trouble understanding 109Sheet files will be next. I am running into some trouble understanding
110Data and Agenda files, but with a little luck, I'll figure it out after 110Data and Agenda files, but with a little luck, I'll figure it out after
111all. This is more long-term though. 111all. This is more long-term though.
112On the output side, I hope RTF will soon be done. This will allow most
113office tools to read the Psion files.
114 112
115 113
116INSTALLATION 114INSTALLATION
117============ 115============
118 116

Legend:
Removed from v.36  
changed lines
  Added in v.200

frodo@frodo.looijaard.name
ViewVC Help
Powered by ViewVC 1.1.26