1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
=============
Domesday 0.2
=============
[formerly called Index Generator]
Domesday Book (du:mzdei) a detailed survey of English counties compiled
(1086-7) by order of William I, in two volumes, one covering Essex,
Suffolk, and Norfolk, the other covering the rest of England (excluding
Northumberland, Durhan, Cumberland and N. Westmorland). It records the
extent, value and ownership of estates, local customs, and a census of
householders.
This is an early release of Domesday, a site indexing program. It is probably
not suitable for general use, but please give it a try and send us bug reports
and suggestions so that we can make improvements for future releases.
Features
--------
- Extracts file information from the following file types:
+ HTML (most varieties)
+ PDF
+ GIF
+ PNG
+ JPG
+ MP3
+ Debian packages
- Ability to index files on local file system based on directory listings
- Ability to index files from a remote server, such that indices can be created
for sites with dynamic content
- Can create Hierarchical site maps
- Can create Ordered indices (such as A-Z indices)
- Full Internationalisation support (can work with content in most character
encodings)
- Full Localisation support - Translating a few files will make all aspects of
the program appear in a different language.
- Object orientated design allows great expansion possibilities. In particular,
adding new file parsers is a simple task.
- non-interactive operation - can be run from a shedueled task
- Cross platform code.
Requirements
------------
Java
Jakarta oro library
gnu.regexp library (this will not be needed in future versions)
Apache ant
Directories
-----------
src/ - this contains the main java source code.
src/testconfig.ig - this is an example of a project settings file.
contrib/domesday.vim - This is a vim syntax file for syntax highlighting of
project files.
src/gui - this is source for the gui which is not in working order (see below)
doc-user/ - these are manual pages for the main program and the project settings
file format. view them with man ./filename.
Installation
------------
run ./installer.pl
Running Domesday
----------------
First, you have to create a project file to define where to look for files and
how to format the output. A sample project file is given in src/testconfig.ig.
Additional information can be found in the manual page domesday.project(5).
Then, you generate the index using the command
domesday <project-file-name>
Other options (such as non-interactive running) are detailed in the domesday(1)
manual page.
GUI
---
Unlike previous versions of IndexGenerator, Domesday is primarily a text based
program which uses project settings files.
We are, however, developing a gui which will allow all settings to be created
and then call the text mode program with a more friendly interface. This will
include extensive online documentation.
The gui is currently in a state where you can set most settings and generate the
index, however there are a number of features which are still to be implemented
and also a number of known bugs.
If you are interested in helping out with the gui - sending comments, testing,
coding, translating - please do so. Send an email to the development mailing
list.
To use the gui:
Download the latest library tarball from http://tildemh.com/tmp/domesday/. This
contains required libraries. Extract it to src/gui/lib
Ensure that you have already compiled the main domesday program.
Type `export LD_LIBRARY_PATH=_wherever_/src/gui/lib/`
Enter the src/gui directory and type make. If this fails, edit Makefile and
change the java classpath to point to the correct locations.
To run the gui, type make test.
If you run into trouble, please email us.
Feedback
--------
We really need to hear feedback on this early release. Please send all your
comments, suggestions bug reports, patches to indexgenerator-devel@lists.sf.net
If you are interested in helping develop Domesday, please also get in contact
with us:
- Helping create the gui (java/gtk)
- writing new file parsers
- writing test code and performing robustness testing
- writing documentation
- creating translations
indexgenerator-devel@lists.sf.net
|
