From a72e66db913de3a2e508080c8b1fc8d1342a899b Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 25 Sep 2007 23:23:03 +0100 Subject: remove generated output from main package --- .../manuals_generated/sisu_manual/sisu_faq/sax.xml | 547 --------------------- 1 file changed, 547 deletions(-) delete mode 100644 data/doc/manuals_generated/sisu_manual/sisu_faq/sax.xml (limited to 'data/doc/manuals_generated/sisu_manual/sisu_faq/sax.xml') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_faq/sax.xml b/data/doc/manuals_generated/sisu_manual/sisu_faq/sax.xml deleted file mode 100644 index 52745cdc..00000000 --- a/data/doc/manuals_generated/sisu_manual/sisu_faq/sax.xml +++ /dev/null @@ -1,547 +0,0 @@ - - - - - - - Title: - - SiSU - FAQ - Frequently Asked/Answered Questions - -
- 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: - - 2006-09-06 - -
- Date available: - - 2006-09-06 - -
- Date issued: - - 2006-09-06 - -
- Date modified: - - 2007-09-16 - -
- Date: - - 2007-09-16 - -
- - - - 1 - - SiSU - FAQ - Frequently Asked/Answered Questions,
Ralph Amissah - - - - 2 - - 1. FAQ - Frequently Asked/Answered Questions - - - - 3 - - 1.1 Why are urls produced with the -v (and -u) flag that point to a web -server on port 8081? - - - - 4 - - Try the following rune: - - - - 5 - - sisu -W - - - - 6 - - 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. - - - - 7 - - 1.2 I cannot find my output, where is it? - - - - 8 - - The following should provide help on output paths: - - - - 9 - - sisu --help env - - - - 10 - - sisu -V [same as the previous command] - - - - 11 - - sisu --help directory - - - - 12 - - sisu --help path - - - - 13 - - sisu -U [filename] - - - - 14 - - man sisu - - - - 15 - - 1.3 I do not get any pdf output, why? - - - - 16 - - SiSU produces LaTeX and pdflatex is run against that to generate -pdf files. - - - - 17 - - If you use Debian the following will install the required -dependencies - - - - 18 - - aptitude install sisu-pdf - - - - 19 - - the following packages are required: tetex-bin, tetex-extra, latex-ucs - - - - 20 - - 1.4 Where is the latex (or some other interim) output? - - - - 21 - - Try adding -M (for maintenance) to your command flags, e.g.: - - - - 22 - - sisu -HpMv [filename] - - - - 23 - - this should result in the interim processing output being retained, and -information being provided on where to find it. - - - - 24 - - sisu --help directory - - - - 25 - - sisu --help path - - - - 26 - - should also provide some relevant information as to where it is placed. - - - - 27 - - 1.5 Why isn't SiSU markup XML - - - - 28 - - I worked with text and (though I find XML immensely valuable) disliked -noise ... better to sidestep the question and say: - - - - 29 - - SiSU currently "understands" three XML input representations - -or more accurately, converts from three forms of XML to native -SiSU 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 in the -man page under the title SiSU VERSION CONVERSION - - - - 30 - - sisu --to-sax [filename/wildcard] - - - - 31 - - sisu --to-dom [filename/wildcard] - - - - 32 - - sisu --to-node [filename/wildcard] - - - - 33 - - 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 I am satisfied that I can convert (both ways) between 3 -forms of XML representation and SiSU markup]. - - - - 34 - - sisu --from-xml2sst [filename/wildcard] - - - - 35 - - 1.6 LaTeX claims to be a document preparation system for high-quality -typesetting. Can the same be said about SiSU? - - - - 36 - - SiSU is not really about type-setting. - - - - 37 - - LaTeX is the ultimate computer instruction type-setting language for -paper based publication. - - - - 38 - - 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. - - - - 39 - - SiSU 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. - - - - 40 - - SiSU 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 "quality" html by generating the html -directly; likewise it populates an SQL database in a useful way with -the document in object sized chunks and its meta-data. But SiSU -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. - - - - 41 - - 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. - - - - 42 - - Where there are large document sets, it provides consistency in -appearance in each output format for the documents. - - - - 43 - - 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 SiSU tries to achieve this -from minimal markup. - - - - 44 - - 1.7 How do I create GIN or GiST index in Postgresql for use in SiSU - - - - 45 - - This at present needs to be done "manually" and it is probably -necessary to 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: - - - - 46 - - "I have tsearch2 slides which introduces tsearch2 <http://www.sai.msu.su/~megera/wiki/tsearch2slides> - - - - 47 - - FTS in PostgreSQL is provided by tsearch2, which should works without -any indices (GiST or GIN) ! Indices provide performance, not -functionality. - - - - 48 - - In your example I'd do ( simple way, just for demo): - - - - 49 - - 0. compile, install tsearch2 and load tsearch2 into your -database - - - - 50 - - cd contrib/tsearch2; -make&&make&&install&&make installcheck; psql DB -< tsearch2.sql - - - - 51 - - 1. Add column fts, which holds tsvector - - - - 52 - - alter table documents add column fts tsvector; - - - - 53 - - 2. Fill fts column - - - - 54 - - update document set fts = to_tsvector(clean); - - - - 55 - - 3. create index - just for performance ! - - - - 56 - - create index fts_gin_idx on document using gin(fts); - - - - 57 - - 4. Run vacuum - - - - 58 - - vacuum analyze document; - - - - 59 - - That's all. - - - - 60 - - Now you can search: - - - - 61 - - 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; - - - - 62 - - 1.8 Where is version 1.0? - - - - 63 - - SiSU 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. - - - - 64 - - The feature set for html,1 LaTeX/pdf and opendocument is in -place. XML, and plaintext are in order. - - - 1 - - html w3c compliance has been largely met. - - - - - 65 - - html and LaTeX/pdf may be regarded as reference copy outputs - - - - 66 - - With regard to the populating of sql databases (postgresql and sqlite), -there is a bit to be done. - - - - 67 - - We are still almost there. - - - - 0 - - Endnotes - - - - -- cgit v1.2.3