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_introduction/sisu_feature_summary.html | 781 +++++++++++++++++++++ 1 file changed, 781 insertions(+) create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_feature_summary.html (limited to 'data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_feature_summary.html') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_feature_summary.html b/data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_feature_summary.html new file mode 100644 index 00000000..5622b1ae --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_feature_summary.html @@ -0,0 +1,781 @@ + + + + + + sisu_feature_summary - + SiSU + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + +

+ +

SiSU -->

+

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

+

+ + + A-Z + + +

+ +

+

+

+ + + + + + +

+

+

+ + + + +

+ SiSU +

+

+ Commands [0.58] +

+

+ Ralph Amissah + +

+

+ copy @ + + SiSU + +

+ + +

+ +

+

+ 1 +

+

+ + +

+ +

+

+ 2 +

+

+ + +

+ +

+

+ 3 +

+

+ + +

+ +

+

+ + +

+

+ + 3. Summary of features +

+

+

+ 19 +

+

+ + +

+

+ sparse/minimal markup (clean utf-8 source texts). Documents are prepared in a single UTF-8 file using a minimalistic mnemonic syntax. Typical literature, documents like "War and Peace" require almost no markup, and most of the headers are optional. +

+

+ 20 +

+

+ + +

+

+ markup is easily readable/parsable by the human eye, (basic markup is simpler and more sparse than the most basic HTML), [this may also be converted to XML representations of the same input/source document]. +

+

+ 21 +

+

+ + +

+

+ markup defines document structure (this may be done once in a header pattern-match description, or for heading levels individually); basic text attributes (bold, italics, underscore, strike-through etc.) as required; and semantic information related to the document (header information, extended beyond the Dublin core and easily further extended as required); the headers may also contain processing instructions. SiSU markup is primarily an abstraction of document structure and document metadata to permit taking advantage of the basic strengths of existing alternative practical standard ways of representing documents [be that browser viewing, paper publication, sql search etc.] (html, xml, odf, latex, pdf, sql) +

+

+ 22 +

+

+ + +

+

+ for output produces reasonably elegant output of established industry and institutionally accepted open standard formats.[3] takes advantage of the different strengths of various standard formats for representing documents, amongst the output formats currently supported are: +

+

+ 23 +

+

+ + +

+

+ html - both as a single scrollable text and a segmented document +

+

+ 24 +

+

+ + +

+

+

+ 25 +

+

+ + +

+

+ XML - both in sax and dom style xml structures for further development as required +

+

+ 26 +

+

+ + +

+

+ ODF - open document format, the iso standard for document storage +

+

+ 27 +

+

+ + +

+

+ LaTeX - used to generate pdf +

+

+ 28 +

+

+ + +

+

+ pdf (via LaTeX) +

+

+ 29 +

+

+ + +

+

+ sql - population of an sql database, (at the same object level that is used to cite text within a document) +

+

+ 30 +

+

+ + +

+

+ Also produces: concordance files; document content certificates (md5 or sha256 digests of headings, paragraphs, images etc.) and html manifests (and sitemaps of content). (b) takes advantage of the strengths implicit in these very different output types, (e.g. PDFs produced using typesetting of LaTeX, databases populated with documents at an individual object/paragraph level, making possible granular search (and related possibilities)) +

+

+ 31 +

+

+ + +

+

+ ensuring content can be cited in a meaningful way regardless of selected output format. Online publishing (and publishing in multiple document formats) lacks a useful way of citing text internally within documents (important to academics generally and to lawyers) as page numbers are meaningless across browsers and formats. sisu seeks to provide a common way of pinpoint the text within a document, (which can be utilized for citation and by search engines). The outputs share a common numbering system that is meaningful (to man and machine) across all digital outputs whether paper, screen, or database oriented, (pdf, HTML, xml, sqlite, postgresql), this numbering system can be used to reference content. +

+

+ 32 +

+

+ + +

+

+ Granular search within documents. SQL databases are populated at an object level (roughly headings, paragraphs, verse, tables) and become searchable with that degree of granularity, the output information provides the object/paragraph numbers which are relevant across all generated outputs; it is also possible to look at just the matching paragraphs of the documents in the database; [output indexing also work well with search indexing tools like hyperestraier]. +

+

+ 33 +

+

+ + +

+

+ long term maintainability of document collections in a world of changing formats, having a very sparsely marked-up source document base. there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added. e.g. addition of odf (open document text) module in 2006 and in future html5 output sometime in future, without modification of existing prepared texts +

+

+ 34 +

+

+ + +

+

+ SQL search aside, documents are generated as required and static once generated. +

+

+ 35 +

+

+ + +

+

+ documents produced are static files, and may be batch processed, this needs to be done only once but may be repeated for various reasons as desired (updated content, addition of new output formats, updated technology document presentations/representations) +

+

+ 36 +

+

+ + +

+

+ document source (plaintext utf-8) if shared on the net may be used as input and processed locally to produce the different document outputs +

+

+ 37 +

+

+ + +

+

+ document source may be bundled together (automatically) with associated documents (multiple language versions or master document with inclusions) and images and sent as a zip file called a sisupod, if shared on the net these too may be processed locally to produce the desired document outputs +

+

+ 38 +

+

+ + +

+

+ generated document outputs may automatically be posted to remote sites. +

+

+ 39 +

+

+ + +

+

+ for basic document generation, the only software dependency is Ruby, and a few standard Unix tools (this covers plaintext, HTML, XML, ODF, LaTeX). To use a database you of course need that, and to convert the LaTeX generated to pdf, a latex processor like tetex or texlive. +

+

+ 40 +

+

+ + +

+

+ as a developers tool it is flexible and extensible +

+

+ 41 +

+

+ + +

+

+ Syntax highlighting for SiSU markup is available for a number of text editors. +

+

+ 42 +

+

+ + +

+

+ SiSU is less about document layout than about finding a way with little markup to be able to construct an abstract representation of a document that makes it possible to produce multiple representations of it which may be rather different from each other and used for different purposes, whether layout and publishing, or search of content +

+

+ 43 +

+

+ + +

+

+ i.e. to be able to take advantage from this minimal preparation starting point of some of the strengths of rather different established ways of representing documents for different purposes, whether for search (relational database, or indexed flat files generated for that purpose whether of complete documents, or say of files made up of objects), online viewing (e.g. html, xml, pdf), or paper publication (e.g. pdf)... +

+

+ 44 +

+

+ + +

+

+ the solution arrived at is by extracting structural information about the document (about headings within the document) and by tracking objects (which are serialized and also given hash values) in the manner described. It makes possible representations that are quite different from those offered at present. For example objects could be saved individually and identified by their hashes, with an index of how the objects relate to each other to form a document. +

+

+ 45 +

+

+^

+ + + +

+ +

SiSU -->

+

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

+

+ + + A-Z + + +

+ +

+

+

+ + + + + + +

+

+

+ + + + +

+ + + + + + + + +

+ +
+ + + + + +	+ + + 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. + +
+ + + + + +	+ + + 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! + + +

+ + + + + +

+
+ + + +
+ +
+

+ + +SiSU manual + +

+ + + + +

SiSU introduction

+

+

+

SiSU configuration

+

+

SiSU help sources

+ +
+

+ + +SiSU + +

+ + + + +

What does SiSU do? Summary

+

SiSU Book Samples and Markup Examples

+

+

+

+

+

+

Wikipedia entry

+

+

Ruby Application Archive

+ + +

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