diff options
Diffstat (limited to 'data/doc/sisu/html/sisu_faq.8.html')
| -rw-r--r-- | data/doc/sisu/html/sisu_faq.8.html | 275 |
1 files changed, 275 insertions, 0 deletions
diff --git a/data/doc/sisu/html/sisu_faq.8.html b/data/doc/sisu/html/sisu_faq.8.html new file mode 100644 index 00000000..d480b195 --- /dev/null +++ b/data/doc/sisu/html/sisu_faq.8.html @@ -0,0 +1,275 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_faq"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> +SISU - SISU INFORMATION STRUCTURING UNIVERSE / STRUCTURED INFORMATION, SERIALIZED +UNITS - FAQ - FREQUENTLY ASKED/ANSWERED QUESTIONS, RALPH AMISSAH +<p> 1. FAQ +- FREQUENTLY ASKED/ANSWERED QUESTIONS +<p> 1.1 WHY ARE URLS PRODUCED WITH THE +-V (AND -U) FLAG THAT POINT TO A WEB SERVER ON PORT 8081? +<p> Try the following +rune: +<p> * sisu -W +<p> This should start the ruby webserver. It should be done +after having produced some output as it scans the output directory for +what to serve. +<p> 1.2 I CANNOT FIND MY OUTPUT, WHERE IS IT? +<p> The following +should provide help on output paths: +<p> * sisu --help env +<p> * sisu -V [same + as the previous command] +<p> * sisu --help directory +<p> * sisu --help path +<p> * +sisu -U [filename] +<p> * man sisu +<p> 1.3 I DO NOT GET ANY PDF OUTPUT, WHY? +<p> +<b>SiSU</b> produces LaTeX and pdflatex is run against that to generate pdf files. + +<p> If you use <b>Debian</b> the following will install the required dependencies + +<p> * aptitude install sisu-pdf +<p> the following packages are required: tetex-bin, +tetex-extra, latex-ucs +<p> 1.4 WHERE IS THE LATEX (OR SOME OTHER INTERIM) OUTPUT? + +<p> Try adding -M (for maintenance) to your command flags, e.g.: +<p> * sisu -HpMv + [filename] +<p> this should result in the interim processing output being +retained, and information being provided on where to find it. +<p> * sisu --help + +<p>directory +<p> * sisu --help path +<p> should also provide some relevant information +as to where it is placed. +<p> 1.5 WHY ISN’T SISU MARKUP XML +<p> I worked with text +and (though I find XML immensely valuable) disliked noise +<p> <b>SiSU</b> currently +accurately, converts from three forms of XML to native <b>SiSU</b> markup for +processing. The three types correspond to SAX (structure described), DOM +(structure embedded, whole document must be read before structure is correctly +discernable) and node based (a tree) forms of XML document structure representation. +Problem is I use them very seldom and check that all is as it should be +with them seldom, so I would not be surprised if something breaks there, +but as far as I know they are working. I will check and add an XML markup +help page before the next release. There already is a bit of information + +<p>in the man page under the title <b>SiSU</b> VERSION CONVERSION +<p> sisu --to-sax + [filename/wildcard]<br> + +<p> sisu --to-dom [filename/wildcard]<br> + +<p> sisu --to-node [filename/wildcard]<br> + +<p> The XML should be well formed... must check, but lacks sensible headers. +Suggestions welcome as to what to make of them. [For the present time Structured +information, Serialized Units" I am satisfied that I can convert (both + ways) between 3 Structured information, Serialized Units" forms of XML + representation and <b> SiSU</b> markup]. +<p> sisu --from-xml2sst [filename/wildcard]<br> + +<p> 1.6 LATEX CLAIMS TO BE A DOCUMENT PREPARATION SYSTEM FOR HIGH-QUALITY TYPESETTING. +CAN THE SAME BE SAID ABOUT SISU? +<p> <b>SiSU</b> is not really about type-setting. + +<p> LaTeX is the ultimate computer instruction type-setting language for paper +based publication. +<p> LaTeX is able to control just about everything that +happens on page and pixel, position letters kerning, space variation between +characters, words, paragraphs etc. formula. +<p> <b>SiSU</b> is not really about type-setting +at all. It is about a lightweight markup instruction that provides enough +information for an abstraction of the documents structure and objects, +from which different forms of representation of the document can be generated. + +<p> <b>SiSU</b> with very little markup instruction is able to produce relatively +high quality pdf by virtue of being able to generate usable default LaTeX; +it produces populates an SQL database in a useful way with the document +in object sized chunks and its meta-data. But <b>SiSU</b> works on an abstraction +of the document’s structure and content and custom builds suitable uniform +output. The html for browser viewing and pdf for paper viewing/publishing +are rather different things with different needs for layout - as indeed +is what is needed to store information in a database in searchable objects. + +<p> The pdfs or html produced for example by open office based on open document +format and other office/word processor suits usually attempt to have similar +looking outputs - your document rendered in html looks much the same, or +in pdf... sisu is less this way, it seeks to have a starting point with as +little information about appearance as possible, and to come up with the +best possible appearance for each output that can be derived based on this +minimal information. +<p> Where there are large document sets, it provides +consistency in appearance in each output format for the documents. +<p> The +excuse for going this way is, it is a waste of time to think much about +appearance when working on substantive content, it is the substantive content +that is relevant, not the way it looks beyond the basic informational tags +- and yet you want to be able to take advantage of as many useful different +ways of representing documents as are available, and for various types +of output to to be/look as good as it can for each medium/format in which +it is presented, (with different mediums having different focuses) and +<b>SiSU</b> tries to achieve this from minimal markup. +<p> 1.7 HOW DO I CREATE GIN + +<p>OR GIST INDEX IN POSTGRESQL FOR USE IN SISU +<p> This at present needs to +be done alter the sample search form. The following is a helpful response +from one of the contributors of GiN to Postgresql Oleg Bartunov 2006-12-06: + +<p> I have tsearch2 slides which introduces tsearch2 <<a href='http://www.sai.msu.su/~megera/wiki/tsearch2slides'>http://www.sai.msu.su/~megera/wiki/tsearch2slides</a> +> + +<p> FTS in PostgreSQL is provided by tsearch2, which should works without +any indices (GiST or GIN) ! Indices provide performance, not functionality. + +<p> In your example I’d do ( simple way, just for demo): +<p> <b>0.</b> compile, install + +<p>tsearch2 and load tsearch2 into your database +<p> cd contrib/tsearch2; +make&&make&&install&&make installcheck; psql DB &lt;<br> + tsearch2.sql<br> + +<p> <b>1.</b> Add column fts, which holds tsvector +<p> alter table documents add +column fts tsvector;<br> + +<p> <b>2.</b> Fill fts column +<p> update document set fts = to_tsvector(clean);<br> + +<p> <b>3.</b> create index - just for performance ! +<p> create index fts_gin_idx +on document using gin(fts);<br> + +<p> <b>4.</b> Run vacuum +<p> vacuum analyze document;<br> + +<p> That’s all. +<p> Now you can search: +<p> select lid, metadata_tid, rank_cd(fts, +q,2)as rank from document, plainto_tsquery(’markup syntax’) q where q @@ +fts order by rank desc limit 10; +<p> 1.8 WHERE IS VERSION 1.0? +<p> <b>SiSU</b> works +pretty well as it is supposed to. Version 1.0 will have the current markup, +and directory structure. At this point it is largely a matter of choice +as to when the name change is made. +<p> The feature set for html,[^1] LaTeX/pdf +and opendocument is in place. XML, and plaintext are in order. +<p> html and + +<p>LaTeX/pdf may be regarded as reference copy outputs +<p> With regard to the +populating of sql databases (postgresql and sqlite), there is a bit to +be done. +<p> We are still almost there. +<p> DOCUMENT INFORMATION (METADATA) +<p> +METADATA +<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_faq/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_faq/sisu_manifest.html</a> +> + +<p> <b>Dublin Core</b> (DC) +<p> <i>DC</i> tags included with this document are provided here. + +<p> DC Title: <i>SiSU</i> - SiSU information Structuring Universe / Structured information, +Serialized Units - FAQ - Frequently Asked/Answered Questions +<p> DC Creator: + +<p><i>Ralph</i> Amissah +<p> DC Rights: <i>Copyright</i> (C) Ralph Amissah 2007, part of SiSU +documentation, License GPL 3 +<p> DC Type: <i>information</i> +<p> DC Date created: + +<p><i>2006-09-06</i> +<p> DC Date available: <i>2006-09-06</i> +<p> DC Date issued: <i>2006-09-06</i> +<p> DC +Date modified: <i>2007-09-16</i> +<p> DC Date: <i>2007-09-16</i> +<p> <b>Version Information</b> +<p> Sourcefile: + +<p><i>sisu_faq.sst</i> +<p> Filetype: <i>SiSU</i> text 0.57 +<p> Sourcefile Digest, MD5(sisu_faq.sst)= + +<p><i>4ba78b1270b9d994054c1ff06d58765d</i> +<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:14:01 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [i486-linux] +<p> +<ol> +<b>.</b><li>html w3c compliance has been largely met. +<p> </dd> + +<dt>Other versions of +this document: </dt> +<dd></dd> + +<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_faq/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_faq/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_faq/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_faq/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_faq/toc.html'>http://www.jus.uio.no/sisu/sisu_faq/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_faq/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_faq/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_faq/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_faq/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_faq/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_faq/landscape.pdf</a> +</a> +> </dt> +<dd> </dd> + +<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +</a> +> +</dt> +<dd></dd> + +<dt>* Generated by: SiSU 0.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:07 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> +<p> +</body> +</html> |