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

Diff of /psiconv/trunk/README

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

Revision 2 Revision 36
38 38
39THE LIBRARY 39THE LIBRARY
40=========== 40===========
41 41
42libpsiconv is a library of routines that you can link against your own 42libpsiconv is a library of routines that you can link against your own
43application. It allows you to read Psion 5 files, and helps you output 43application. It allows you to read Psion 5 files. Note that it comes
44more commonly used files. Note that it comes under the GNU General 44under the GNU General Public License; that means that you can only link
45Public License; that means that you can only link it to programs which 45it to programs which are also covered by that license. You can contact
46are also covered by that license. You can contact me if you need other 46me if you need other license terms.
47license terms.
48
49Libpsiconv consists of two parts. The parser reads the Psion file into its
50internal data structures. The generator reads these data structures and
51generates an output file in some other format. Libpsiconv is written to make
52it easy to add generators, without having to modify the parser side.
53Actually, it is a lot easier to write a generator than to modify the parser!
54 47
55The parser is quite good at the moment. Page layout codes are not yet 48The parser is quite good at the moment. Page layout codes are not yet
56read, but almost everything that is described in the documents in the 49read, but almost everything that is described in the documents in the
57format directory is supported by it. Of course, it can also not yet 50format directory is supported by it. Of course, it can also not yet
58cope with inserted objects (ie. documents in some other format) and 51cope with inserted objects (ie. documents in some other format) and
59other as of yet undocumented things. 52other as of yet undocumented things.
60
61The current HTML target is not very ideal. HTML is just not made to
62represent detailed layout considerations: it is a document description
63language. Still, the output is quite readable already. Of course, headers
64and footers are not displayed, because there is no notion of pages in
65HTML. Tabs are also difficult; they are not supported yet. This can be
66solved using tables, but it is quite hard to do it correctly. Some other
67things are just approximated too.
68
69The HTML4 target uses style sheets. You need a not-too-old browser for
70this to display correctly. Generally, the output of this generator is
71of higher quality than the normal HTML generator's.
72
73A plain TEXT target just grabs all text, without any futher conversions.
74
75I would very much like to add other targets, like (La)TeX, RTF (Rich Text
76Format) and XML (for AbiWord). If other people want to work on this, please
77let me know! Of course, you could also write your own conversion applications
78just using my data format description. Native import/export filters for
79some word processors would be very welcome!
80 53
81Documentation is scarce; please examine the source code or the example 54Documentation is scarce; please examine the source code or the example
82psiconv program. Some things may also be found in the doc subdirectory. 55psiconv program. Some things may also be found in the doc subdirectory.
83 56
84 57
89more commonly used formats. It is linked against libpsiconv, and can 62more commonly used formats. It is linked against libpsiconv, and can
90handle anything that it can. 63handle anything that it can.
91 64
92Please enter `psiconv --help' if you want to know about its syntax. 65Please enter `psiconv --help' if you want to know about its syntax.
93 66
67The current HTML3 target is not very ideal. HTML is just not made to
68represent detailed layout considerations: it is a document description
69language. Still, the output is quite readable already. Of course, headers
70and 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
72solved using tables, but it is quite hard to do it correctly. Some other
73things are just approximated too.
74
75The HTML4 target uses style sheets. You need a not-too-old browser for
76this to display correctly. Generally, the output of this generator is
77of higher quality than the normal HTML generator's.
78
79A plain TEXT target just grabs all text, without any futher conversions.
80
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
85you compiled ImageMagick, this is betwee 20 and 50 different formats.
86Your favorite one should be somewhere...
87
88I would very much like to add other targets, like (La)TeX, RTF (Rich Text
89Format) and XML (for AbiWord). If other people want to work on this, please
90let me know! Of course, you could also write your own conversion applications
91just using my data format description. Native import/export filters for
92some word processors would be very welcome!
93
94Psiconv is licensed under the GPL. Please read the included file COPYING 94Psiconv is licensed under the GPL. Please read the included file COPYING
95for exact licensing information. Please contact me if you need some other 95for exact licensing information. Please contact me if you need some other
96licensing terms. 96licensing terms.
97 97
98 98
100============================ 100============================
101 101
102Starting with version 0.2, psiconv should keep all namespaces unpoluted. 102Starting with version 0.2, psiconv should keep all namespaces unpoluted.
103Starting with version 0.4, the conversion routines are linked into a 103Starting with version 0.4, the conversion routines are linked into a
104(static or shared) library. Version 0.5 has autoconf and libtool support, 104(static or shared) library. Version 0.5 has autoconf and libtool support,
105and should run on many more platforms. 105and should run on many more platforms. Version 0.6 has support for
106graphics.
106 107
107High on the TODO list are input routines for Sketch, MBM and Record files. 108High on the TODO list are input routines for Record files.
108Sheet files will be next. I am running into some trouble understanding 109Sheet files will be next. I am running into some trouble understanding
109Data 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
110all. This is more long-term though. 111all. This is more long-term though.
111On the output side, I hope RTF will soon be done. This will allow most 112On the output side, I hope RTF will soon be done. This will allow most
112office tools to read the Psion files. 113office tools to read the Psion files.

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

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