aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_hyperestraier.ssi
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2007-09-23 05:16:21 +0100
committerRalph Amissah <ralph@amissah.com>2007-09-23 05:16:21 +0100
commit50d45c6deb0afd2e4222d2e33a45487a9d1fa676 (patch)
tree100c62d678f009139999bf77c26c81653a721eeb /data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_hyperestraier.ssi
parentsisu-0.58.3 + md5s (diff)
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
Diffstat (limited to 'data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_hyperestraier.ssi')
-rw-r--r--data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_hyperestraier.ssi116
1 files changed, 116 insertions, 0 deletions
diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_hyperestraier.ssi b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_hyperestraier.ssi
new file mode 100644
index 00000000..b63d8c04
--- /dev/null
+++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_hyperestraier.ssi
@@ -0,0 +1,116 @@
+% SiSU insert 0.58
+
+@title: SiSU - SiSU information Structuring Universe
+
+@subtitle: Search [0.58]
+
+@creator: Ralph Amissah
+
+@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
+
+@type: information
+
+@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
+
+@date.created: 2002-08-28
+
+@date.issued: 2002-08-28
+
+@date.available: 2002-08-28
+
+@date.modified: 2007-09-16
+
+@date: 2007-09-16
+
+@level: new=C; break=1; num_top=1
+
+@skin: skin_sisu_manual
+
+@bold: /Gnu|Debian|Ruby|SiSU/
+
+@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/
+{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html
+{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU
+{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/
+{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/
+{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
+{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
+{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html
+{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/
+{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/
+
+:A~? @title @creator
+
+:B~? SiSU Search
+
+:C~? Search
+
+1~search_hyperestraier Hyperestraier
+
+See the documentation for hyperestraier:
+
+_1 http://hyperestraier.sourceforge.net/
+
+_1 /usr/share/doc/hyperestraier/index.html
+
+_1 man estcmd
+
+on sisu_hyperestraier:
+
+_1 man sisu_hyperestraier
+
+_1 /usr/share/doc/sisu/sisu_markup/sisu_hyperestraier/index.html
+
+NOTE: the examples that follow assume that sisu output is placed in the directory /home/ralph/sisu_www
+
+(A) to generate the index within the webserver directory to be indexed:
+
+_1 estcmd gather -sd [index name] [directory path to index]
+
+the following are examples that will need to be tailored according to your needs:
+
+_1 cd /home/ralph/sisu_www
+
+_1 estcmd gather -sd casket /home/ralph/sisu_www
+
+you may use the 'find' command together with 'egrep' to limit indexing to particular document collection directories within the web server directory:
+
+_1 find /home/ralph/sisu_www -type f | egrep '/home/ralph/sisu_www/sisu/.+?.html$' |estcmd gather -sd casket -
+
+Check which directories in the webserver/output directory (~/sisu_www or elsewhere depending on configuration) you wish to include in the search index.
+
+As sisu duplicates output in multiple file formats, it it is probably preferable to limit the estraier index to html output, and as it may also be desirable to exclude files 'plain.txt', 'toc.html' and 'concordance.html', as these duplicate information held in other html output e.g.
+
+_1 find /home/ralph/sisu_www -type f | egrep '/sisu_www/(sisu|bookmarks)/.+?.html$' | egrep -v '(doc|concordance).html$' |estcmd gather -sd casket -
+
+from your current document preparation/markup directory, you would construct a rune along the following lines:
+
+_1 find /home/ralph/sisu_www -type f | egrep '/home/ralph/sisu_www/([specify first directory for inclusion]|[specify second directory for inclusion]|[another directory for inclusion? ...])/.+?.html$' | egrep -v '(doc|concordance).html$' |estcmd gather -sd /home/ralph/sisu_www/casket -
+
+(B) to set up the search form
+
+(i) copy estseek.cgi to your cgi directory and set file permissions to 755:
+
+_1 sudo cp -vi /usr/lib/estraier/estseek.cgi /usr/lib/cgi-bin
+
+_1 sudo chmod -v 755 /usr/lib/cgi-bin/estseek.cgi
+
+_1 sudo cp -v /usr/share/hyperestraier/estseek.* /usr/lib/cgi-bin
+
+_1 [see estraier documentation for paths]
+
+(ii) edit estseek.conf, with attention to the lines starting 'indexname:' and 'replace:':
+
+_1 indexname: /home/ralph/sisu_www/casket
+
+_1 replace: ^file:///home/ralph/sisu_www{{!}}http://localhost
+
+_1 replace: /index.html?${{!}}/
+
+(C) to test using webrick, start webrick:
+
+_1 sisu -W
+
+and try open the url: http://localhost:8081/cgi-bin/estseek.cgi
+
+