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

Diff of /psiconv/trunk/README

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

Revision 152 Revision 358
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
39 39
40THE LIBRARY 40THE LIBRARY
41=========== 41===========
42 42
43libpsiconv 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
44application. 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
45under 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
46it 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
47me if you need other license terms. 47contact me if you need other license terms.
48 48
49The following formats can be read at this moment: 49The following formats are supported at this moment:
50 Word Word processor files 50 Word (R+W) Word processor files
51 TextEd OPL editor files 51 TextEd (R+W) OPL editor files
52 Sketch Picture files 52 Sketch (R+W) Picture files
53 MBM Alternate picture format; several pictures can be combined in it 53 MBM (R+W) Alternate picture format; can contain several pictures
54 ClipArt Internal picture format; several pictures can be combined in it 54 ClipArt (R+W) Internal picture format; can contain several pictures
55 55 Sheet (R) Spreadsheet files
56The parser is quite good at the moment. Page layout codes are not yet
57read, but almost everything that is described in the documents in the
58format directory is supported by it; but it can not yet cope with
59inserted objects (ie. documents in some other format).
60 56
61Documentation is scarce; please examine the source code or the example 57Documentation is scarce; please examine the source code or the example
62psiconv program. Some things may also be found in the doc subdirectory. 58psiconv program. Some things may also be found in the doc subdirectory.
63 59
64 60
69more commonly used formats. It is linked against libpsiconv, and can 65more commonly used formats. It is linked against libpsiconv, and can
70handle anything that it can. 66handle anything that it can.
71 67
72Please enter `psiconv --help' if you want to know about its syntax. 68Please enter `psiconv --help' if you want to know about its syntax.
73 69
74The 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
75represent detailed layout considerations: it is a document description 71represent detailed layout considerations: it is a document description
76language. Still, the output is quite readable already. Of course, headers 72language. Still, the output is quite readable already. Of course, headers
77and 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
78HTML. 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
79solved 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
80things are just approximated too. 76things are just approximated too.
81 77
82The 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
83this to display correctly. Generally, the output of this generator is 79browser for this to display correctly. Generally, the output of this
84of higher quality than the normal HTML generator's. 80generator is of higher quality than the normal HTML generator's.
85 81
86A plain TEXT target just grabs all text, without any futher conversions. 82A plain TEXT target just grabs all text, without any futher conversions.
87
88The RTF target is not finished yet; in fact, it is no usable at all
89right now.
90 83
91All ImageMagick graphic output formats are supported; depending on how 84All ImageMagick graphic output formats are supported; depending on how
92you compiled ImageMagick, this is betwee 20 and 50 different formats. 85you compiled ImageMagick, this is betwee 20 and 50 different formats.
93Your favorite one should be somewhere in there... 86Your favorite one should be somewhere in there...
94 87
95I 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
96Format) 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
97let me know! Of course, you could also write your own conversion applications 90office applications like AbiWord, Gnumeric and the Gimp.
98just using my data format description. Native import/export filters for
99some word processors would be very welcome!
100 91
101Psiconv is licensed under the GPL. Please read the included file COPYING 92Psiconv is licensed under the GPL. Please read the included file COPYING
102for exact licensing information. Please contact me if you need some other 93for exact licensing information. Please contact me if you need some other
103licensing terms. 94licensing terms.
104 95
105 96
106NEWS AND FUTURE DEVELOPMENTS 97NEWS AND FUTURE DEVELOPMENTS
107============================ 98============================
108 99
109Starting with version 0.2, psiconv should keep all namespaces unpoluted. 100Starting with version 0.2, psiconv should keep all namespaces unpolluted.
110Starting with version 0.4, the conversion routines are linked into a 101Starting with version 0.4, the conversion routines are linked into a
111(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,
112and 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
113graphics. 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.
114 107
115High on the TODO list are input routines for Record files. 108High on the TODO list are input routines for Record files. I am running into
116Sheet files will be next. I am running into some trouble understanding 109some trouble understanding Data and Agenda files, but with a little luck, I'll
117Data and Agenda files, but with a little luck, I'll figure it out after
118all. This is more long-term though. 110figure it out after all. This is more long-term though.
119On the output side, I hope RTF will soon be done. This will allow most
120office tools to read the Psion files.
121 111
122 112
123INSTALLATION 113INSTALLATION
124============ 114============
125 115

Legend:
Removed from v.152  
changed lines
  Added in v.358

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