moved documentation in doc directory
authorDobrica Pavlinusic <dpavlin@rot13.org>
Sat, 29 Nov 2003 18:38:02 +0000 (18:38 +0000)
committerDobrica Pavlinusic <dpavlin@rot13.org>
Sat, 29 Nov 2003 18:38:02 +0000 (18:38 +0000)
git-svn-id: file:///home/dpavlin/private/svn/webpac/trunk@185 13eb9ef6-21d5-0310-b721-a9d68796d827

CPAN.modules [deleted file]
README.links [deleted file]
README.marc [deleted file]
README.profile [deleted file]
doc/CPAN.modules [new file with mode: 0644]
doc/links.txt [new file with mode: 0644]
doc/marc.txt [new file with mode: 0644]
doc/profile.txt [new file with mode: 0644]

diff --git a/CPAN.modules b/CPAN.modules
deleted file mode 100644 (file)
index 752ff62..0000000
+++ /dev/null
@@ -1,20 +0,0 @@
-CPAN modules to consider using:
-
-AnyData::Format::XML 
-Data::DumpXML 
-Data::DumpXML::Parser 
-XML::Simple
-XML::Writer
-
-other perl modules which are used:
-
-Text::Unaccent from http://www.senga.org/unac/
-
-Modules which are used:
-CGI::Application
-HTML::Pager
-HTML::Template
-HTML::FillInForm
-Spreadsheet::ParseExcel
-MARC
-Text::CSV
diff --git a/README.links b/README.links
deleted file mode 100644 (file)
index ac5ed9f..0000000
+++ /dev/null
@@ -1,35 +0,0 @@
-This file describes how to make links within WebPac to other records.
-
-Usual usages include links in ISIS files (when one record relates to another).
-Values for search can be anything. It can be name of Authors (if you want
-to see all books by same author) or it can be some field which references
-some other field in ISIS (often used for links "includes also" when included
-item is another record in isis).
-
-Usage:
-
-
-<format name="xxx"> tag defines format (with %s placeholders for
-values) which will prodoce output. It's useful for producing links in html
-like <a href="?rm=results&show_full=1&f=f900&v=%s">%s</a>
-
-Explanation of parametars in upper a href:
-
-       rm=results      show results page
-       show_full=1     show detailed informations about records
-                       (if you omit this one, you will get just headline)
-       f=swish_field   reference to swish field
-       v=value         value which will be searched (WebPac *WILL NOT*
-                       add wildcard (*) at end! If you need it, add it
-                       in format!)
-
-<isis> tag has following additional attributes:
-       format_name="xxx" which is name of format defined earlier
-       format_delimiter="xxx" which will be used to split formatted
-               content to values which will be interpolated
-               insetead of %s in link format (Be carefull not to include
-               excessive whitespaces if you are generating html).
-
-WebPac will keep <a href=""></a> and <br> like constructs. If you use some
-other html, you will have to change back2html.pm!
-
diff --git a/README.marc b/README.marc
deleted file mode 100644 (file)
index 92a7ca0..0000000
+++ /dev/null
@@ -1,19 +0,0 @@
-MARC files are read using MARC.pm module from CPAN.
-
-There is one subtle difference to ISIS files: while in import_xml/isis* you
-can specify field '700' and indexer will include all subfields for field 700,
-in MARC files, you have to specify explicitly which codes are you going to
-use (e.g. '700a 700b').
-
-Also, since we have strange MARC files here, you might need to do character
-recoding yourself (truth is that in Croatia we have old 7-bit character set
-called CROASCII which uses some of special characters '~^}]{[|\`@' to
-represent chars with carrons. You might image how much confusion has this
-caused to programmers).
-
-Best way to do characters recoding is using filter function, so
-filter/croascii.pm is example of just that technique.
-
-While you can re-use most of ISIS xml file to produce MARC xml file, you must know that all fields in MARC must have three digits (ISIS also supports fields 10 and 11 which might be of use just to us; see comment in parse_format.pm).
-
-2003-10-08 Dobrica Pavlinusic
diff --git a/README.profile b/README.profile
deleted file mode 100644 (file)
index 343b9a3..0000000
+++ /dev/null
@@ -1,46 +0,0 @@
-Here is a quick overview how cacheing of formats saved a day. Here are
-outputs of make profile.
-
-Before cacheing:
-
-Total Elapsed Time = 130.4098 Seconds
-  User+System Time = 126.7298 Seconds
-Exclusive Times
-%Time ExclSec CumulS #Calls sec/call Csec/c  Name
- 54.6   69.30 167.83  13875   0.0050 0.0121  main::data2xml
- 30.4   38.60 69.833 743146   0.0001 0.0001  main::parse_iso_format
- 14.3   18.15 22.102 201297   0.0000 0.0000  main::isis_sf
- 10.6   13.50 13.502 200394   0.0000 0.0000  Text::Iconv::convert
- 4.64   5.882  9.130 201297   0.0000 0.0000  main::cnv_cp
- 3.32   4.208  4.208 130848   0.0000 0.0000  main::xmlify
- 3.18   4.032 13.813 155421   0.0000 0.0000  main::x
- 3.12   3.949  3.949 475311   0.0000 0.0000  OpenIsis::subfields
- 3.08   3.906  3.906 116974   0.0000 0.0000  Text::Unaccent::unac_string
- 3.02   3.827 73.660 743146   0.0000 0.0001  main::parse_format
- 2.42   3.070  3.070  24922   0.0001 0.0001  DBI::st::execute
- 1.53   1.933  3.142 104893   0.0000 0.0000  main::mkformat
- 0.92   1.172  1.172  13875   0.0001 0.0001  OpenIsis::read
- 0.59   0.752  0.752  28993   0.0000 0.0000  index_DBI::insert
- 0.33   0.420  3.540      1   0.4201 3.5396  index_DBI::close
-
-After format cache implementation: (filters also load only once)
-
-Total Elapsed Time = 69.53874 Seconds
-  User+System Time = 68.58874 Seconds
-Exclusive Times
-%Time ExclSec CumulS #Calls sec/call Csec/c  Name
- 65.3   44.84 90.453  13875   0.0032 0.0065  main::data2xml
- 24.2   16.65 28.905 391769   0.0000 0.0001  main::parse_iso_format
- 13.8   9.479  9.479 151026   0.0000 0.0000  Text::Iconv::convert
- 10.9   7.540  9.619 109406   0.0000 0.0000  main::isis_sf
- 5.04   3.454 11.252 131626   0.0000 0.0000  main::x
- 3.37   2.313 31.218 391769   0.0000 0.0001  main::parse_format
- 3.28   2.249  2.249  55675   0.0000 0.0000  main::xmlify
- 3.03   2.079  2.079 280696   0.0000 0.0000  OpenIsis::subfields
- 2.39   1.642  1.642  13875   0.0001 0.0001  OpenIsis::read
- 1.86   1.279  2.629 180129   0.0000 0.0000  main::cnv_cp
- 0.47   0.324  0.324   2757   0.0001 0.0001  DBI::st::execute
- 0.40   0.276  0.276  41801   0.0000 0.0000  main::unac_string
- 0.34   0.232  0.573  43784   0.0000 0.0000  main::mkformat
- 0.22   0.150  0.387     23   0.0065 0.0168  main::BEGIN
- 0.21   0.142  0.142  13875   0.0000 0.0000  main::progress
diff --git a/doc/CPAN.modules b/doc/CPAN.modules
new file mode 100644 (file)
index 0000000..752ff62
--- /dev/null
@@ -0,0 +1,20 @@
+CPAN modules to consider using:
+
+AnyData::Format::XML 
+Data::DumpXML 
+Data::DumpXML::Parser 
+XML::Simple
+XML::Writer
+
+other perl modules which are used:
+
+Text::Unaccent from http://www.senga.org/unac/
+
+Modules which are used:
+CGI::Application
+HTML::Pager
+HTML::Template
+HTML::FillInForm
+Spreadsheet::ParseExcel
+MARC
+Text::CSV
diff --git a/doc/links.txt b/doc/links.txt
new file mode 100644 (file)
index 0000000..ac5ed9f
--- /dev/null
@@ -0,0 +1,35 @@
+This file describes how to make links within WebPac to other records.
+
+Usual usages include links in ISIS files (when one record relates to another).
+Values for search can be anything. It can be name of Authors (if you want
+to see all books by same author) or it can be some field which references
+some other field in ISIS (often used for links "includes also" when included
+item is another record in isis).
+
+Usage:
+
+
+<format name="xxx"> tag defines format (with %s placeholders for
+values) which will prodoce output. It's useful for producing links in html
+like <a href="?rm=results&show_full=1&f=f900&v=%s">%s</a>
+
+Explanation of parametars in upper a href:
+
+       rm=results      show results page
+       show_full=1     show detailed informations about records
+                       (if you omit this one, you will get just headline)
+       f=swish_field   reference to swish field
+       v=value         value which will be searched (WebPac *WILL NOT*
+                       add wildcard (*) at end! If you need it, add it
+                       in format!)
+
+<isis> tag has following additional attributes:
+       format_name="xxx" which is name of format defined earlier
+       format_delimiter="xxx" which will be used to split formatted
+               content to values which will be interpolated
+               insetead of %s in link format (Be carefull not to include
+               excessive whitespaces if you are generating html).
+
+WebPac will keep <a href=""></a> and <br> like constructs. If you use some
+other html, you will have to change back2html.pm!
+
diff --git a/doc/marc.txt b/doc/marc.txt
new file mode 100644 (file)
index 0000000..92a7ca0
--- /dev/null
@@ -0,0 +1,19 @@
+MARC files are read using MARC.pm module from CPAN.
+
+There is one subtle difference to ISIS files: while in import_xml/isis* you
+can specify field '700' and indexer will include all subfields for field 700,
+in MARC files, you have to specify explicitly which codes are you going to
+use (e.g. '700a 700b').
+
+Also, since we have strange MARC files here, you might need to do character
+recoding yourself (truth is that in Croatia we have old 7-bit character set
+called CROASCII which uses some of special characters '~^}]{[|\`@' to
+represent chars with carrons. You might image how much confusion has this
+caused to programmers).
+
+Best way to do characters recoding is using filter function, so
+filter/croascii.pm is example of just that technique.
+
+While you can re-use most of ISIS xml file to produce MARC xml file, you must know that all fields in MARC must have three digits (ISIS also supports fields 10 and 11 which might be of use just to us; see comment in parse_format.pm).
+
+2003-10-08 Dobrica Pavlinusic
diff --git a/doc/profile.txt b/doc/profile.txt
new file mode 100644 (file)
index 0000000..343b9a3
--- /dev/null
@@ -0,0 +1,46 @@
+Here is a quick overview how cacheing of formats saved a day. Here are
+outputs of make profile.
+
+Before cacheing:
+
+Total Elapsed Time = 130.4098 Seconds
+  User+System Time = 126.7298 Seconds
+Exclusive Times
+%Time ExclSec CumulS #Calls sec/call Csec/c  Name
+ 54.6   69.30 167.83  13875   0.0050 0.0121  main::data2xml
+ 30.4   38.60 69.833 743146   0.0001 0.0001  main::parse_iso_format
+ 14.3   18.15 22.102 201297   0.0000 0.0000  main::isis_sf
+ 10.6   13.50 13.502 200394   0.0000 0.0000  Text::Iconv::convert
+ 4.64   5.882  9.130 201297   0.0000 0.0000  main::cnv_cp
+ 3.32   4.208  4.208 130848   0.0000 0.0000  main::xmlify
+ 3.18   4.032 13.813 155421   0.0000 0.0000  main::x
+ 3.12   3.949  3.949 475311   0.0000 0.0000  OpenIsis::subfields
+ 3.08   3.906  3.906 116974   0.0000 0.0000  Text::Unaccent::unac_string
+ 3.02   3.827 73.660 743146   0.0000 0.0001  main::parse_format
+ 2.42   3.070  3.070  24922   0.0001 0.0001  DBI::st::execute
+ 1.53   1.933  3.142 104893   0.0000 0.0000  main::mkformat
+ 0.92   1.172  1.172  13875   0.0001 0.0001  OpenIsis::read
+ 0.59   0.752  0.752  28993   0.0000 0.0000  index_DBI::insert
+ 0.33   0.420  3.540      1   0.4201 3.5396  index_DBI::close
+
+After format cache implementation: (filters also load only once)
+
+Total Elapsed Time = 69.53874 Seconds
+  User+System Time = 68.58874 Seconds
+Exclusive Times
+%Time ExclSec CumulS #Calls sec/call Csec/c  Name
+ 65.3   44.84 90.453  13875   0.0032 0.0065  main::data2xml
+ 24.2   16.65 28.905 391769   0.0000 0.0001  main::parse_iso_format
+ 13.8   9.479  9.479 151026   0.0000 0.0000  Text::Iconv::convert
+ 10.9   7.540  9.619 109406   0.0000 0.0000  main::isis_sf
+ 5.04   3.454 11.252 131626   0.0000 0.0000  main::x
+ 3.37   2.313 31.218 391769   0.0000 0.0001  main::parse_format
+ 3.28   2.249  2.249  55675   0.0000 0.0000  main::xmlify
+ 3.03   2.079  2.079 280696   0.0000 0.0000  OpenIsis::subfields
+ 2.39   1.642  1.642  13875   0.0001 0.0001  OpenIsis::read
+ 1.86   1.279  2.629 180129   0.0000 0.0000  main::cnv_cp
+ 0.47   0.324  0.324   2757   0.0001 0.0001  DBI::st::execute
+ 0.40   0.276  0.276  41801   0.0000 0.0000  main::unac_string
+ 0.34   0.232  0.573  43784   0.0000 0.0000  main::mkformat
+ 0.22   0.150  0.387     23   0.0065 0.0168  main::BEGIN
+ 0.21   0.142  0.142  13875   0.0000 0.0000  main::progress