From 50d45c6deb0afd2e4222d2e33a45487a9d1fa676 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sun, 23 Sep 2007 05:16:21 +0100 Subject: primarily todo with sisu documentation, changelog reproduced below: * start documenting sisu using sisu * sisu markup source files in data/doc/sisu/sisu_markup_samples/sisu_manual/ /usr/share/doc/sisu/sisu_markup_samples/sisu_manual/ * default output [sisu -3] in data/doc/manuals_generated/sisu_manual/ /usr/share/doc/manuals_generated/sisu_manual/ (adds substantially to the size of sisu package!) * help related edits * manpage, work on ability to generate manpages, improved * param, exclude footnote mark count when occurs within code block * plaintext changes made * shared_txt, line wrap visited * file:// link option introduced (in addition to existing https?:// and ftp://) a bit arbitrarily, diff here, [double check changes in sysenv and hub] * minor adjustments * html url match refinement * css added tiny_center * plaintext * endnotes fix * footnote adjustment to make more easily distinguishable from substantive text * flag -a only [flags -A -e -E dropped] controlled by modifiers --unix/msdos --footnote/endnote * defaults, homepage * renamed homepage (instead of index) implications for modifying skins, which need likewise to have any homepage entry renamed * added link to sisu_manual in homepage * css the css for the default homepage is renamed homepage.css (instead of index.css) [consider removing this and relying on html.css] * ruby version < ruby1.9 * place stop on installation and working with for now [ruby String.strip broken in ruby 1.9.0 (2007-09-10 patchlevel 0) [i486-linux], 2007-09-18:38/2] * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * debian * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * sisu-doc new sub-package for sisu documentation debian/control and sisu-doc.install --- .../sisu_manual/sisu_search/search_cgi.html | 694 +++++++++++++++++++++ 1 file changed, 694 insertions(+) create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_search/search_cgi.html (limited to 'data/doc/manuals_generated/sisu_manual/sisu_search/search_cgi.html') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_search/search_cgi.html b/data/doc/manuals_generated/sisu_manual/sisu_search/search_cgi.html new file mode 100644 index 00000000..9ab8cbec --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_search/search_cgi.html @@ -0,0 +1,694 @@ + + + + + + search_cgi - + SiSU - SiSU information Structuring Universe + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ +
SiSU -->
+
+ + + + + + + + + + + + + + + + + +
+ + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+
+ + + + + + +
+ + << previous + + + + TOC + + + + next >> + + +
+
+ + + + +
+ + < + + + + ^ + + + + > + +

+ SiSU - SiSU information Structuring Universe +

+

+ Search [0.58] +

+

+ Ralph Amissah + +

+

+ copy @ + + SiSU + +

+ + +
+

+ SiSU - SiSU information Structuring Universe - Search [0.58],
Ralph Amissah +

+
  +

+   1 +

+
+ + +
+ +   +

+   2 +

+
+ + +
+ +   +
+ + +
+

+ + 5. Introduction +

+
+

+   60 +

+
+ + 5.1 Search - database frontend sample, utilising database and SiSU features, including object citation numbering (backend currently PostgreSQL) + +
+ + 5.2 Search Form + +
+ + +
+ +

+ 5.1 Search - database frontend sample, utilising database and SiSU features, including object citation numbering (backend currently PostgreSQL) +

+
+

+   61 +

+
+ + +
+

+ Sample search frontend   3  A small database and sample query front-end (search from) that makes use of the citation system, object citation numbering to demonstrates functionality.  4  +

+
+

+   62 +

+
+ + +
+

+ SiSU can provide information on which documents are matched and at what locations within each document the matches are found. These results are relevant across all outputs using object citation numbering, which includes html, XML, LaTeX, PDF and indeed the SQL database. You can then refer to one of the other outputs or in the SQL database expand the text within the matched objects (paragraphs) in the documents matched. +

+
+

+   63 +

+
+ + +
+

+ Note you may set results either for documents matched and object number locations within each matched document meeting the search criteria; or display the names of the documents matched along with the objects (paragraphs) that meet the search criteria.  5  +

+
+

+   64 +

+
+ + +
+

+ sisu -F --webserv-webrick
builds a cgi web search frontend for the database created +

+
+

+   65 +

+
+ + +
+

+ The following is feedback on the setup on a machine provided by the help command: +

+
+

+   66 +

+
+ + +
+

+ sisu --help sql +

+
+

+   67 +

+
+ + +
+

+   Postgresql
    user:             ralph
    current db set:   SiSU_sisu
    port:             5432
    dbi connect:      DBI:Pg:database=SiSU_sisu;port=5432

  sqlite
    current db set:   /home/ralph/sisu_www/sisu/sisu_sqlite.db
    dbi connect       DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db +

+
+

+   68 +

+
+ + +
+

+ Note on databases built +

+
+

+   69 +

+
+ + +
+

+ By default, [unless otherwise specified] databases are built on a directory basis, from collections of documents within that directory. The name of the directory you choose to work from is used as the database name, i.e. if you are working in a directory called /home/ralph/ebook the database SiSU_ebook is used. [otherwise a manual mapping for the collection is necessary] +

+
+

+   70 +

+
+ + +
+ +

+ 5.2 Search Form +

+
+

+   71 +

+
+ + +
+

+ sisu -F
generates a sample search form, which must be copied to the web-server cgi directory +

+
+

+   72 +

+
+ + +
+

+ sisu -F --webserv-webrick
generates a sample search form for use with the webrick server, which must be copied to the web-server cgi directory +

+
+

+   73 +

+
+ + +
+

+ sisu -Fv
as above, and provides some information on setting up hyperestraier +

+
+

+   74 +

+
+ + +
+

+ sisu -W
starts the webrick server which should be available wherever sisu is properly installed +

+
+

+   75 +

+
+ + +
+

+ The generated search form must be copied manually to the webserver directory as instructed +

+
+

+   76 +

+

+^

+ + +
+

+  3. <http://search.sisudoc.org> +

+
  +
+ + +
+

+  4. (which could be extended further with current back-end). As regards scaling of the database, it is as scalable as the database (here Postgresql) and hardware allow. +

+
  +
+ + +
+

+  5. of this feature when demonstrated to an IBM software innovations evaluator in 2004 he said to paraphrase: this could be of interest to us. We have large document management systems, you can search hundreds of thousands of documents and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found. +

+
  +
 
+ + + +
+ +
SiSU -->
+
+ + + + + + + + + + + + + + + + + +
+ + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+
+ + + + + + +
+ + << previous + + + + TOC + + + + next >> + + +
+
+ + + + +
+ + < + + + + ^ + + + + > + +

+ + + + + + + + +
+ +
+

+ + SiSU + +

+
+ +

+ Output generated by + + SiSU + + 0.59.0 2007-09-23 (2007w38/0) +
+ + SiSU + + Copyright © Ralph Amissah + 1997, current 2007. + All Rights Reserved. +
+ + SiSU + + is software for document structuring, publishing and search, +
+ + www.jus.uio.no/sisu + + and + + www.sisudoc.org + +
+ w3 since October 3 1993 + + ralph@amissah.com + +

+
+

+ SiSU using: +
Standard SiSU markup syntax, +
Standard SiSU meta-markup syntax, and the +
Standard SiSU object citation numbering and system, (object/text positioning system) +
+ Copyright © Ralph Amissah 1997, current 2007. + All Rights Reserved. +

+
+

+ + GPLv3 + +

+
+

+ + SiSU + + is released under + GPLv3 + or later, + <http://www.gnu.org/licenses/gpl.html> +

+
+

+ SiSU, developed using + + Ruby + + on + + Debian/Gnu/Linux + + software infrastructure, + with the usual GPL (or OSS) suspects. +
+ Better - "performance, reliability, scalability, security & total cost of ownership" + [not to mention flexibility & choice] use of and adherence to open standards (where practical and fair) and it is software libre. +
+ Get With the Future + + Way Better! + +

+
+ + + + + +
+
+ + +
+ + +
+ + + + idx + txt + + +
+
+ +
+

+ + +SiSU manual + +

+ + + + + + + + + + + +
+

+ + +SiSU + +

+ + + + + + + + + + + + + + + + +
+ \ No newline at end of file -- cgit v1.2.3