From fcad39c09b62e340ce667a851e25c998fe40c53e Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Wed, 17 Mar 2010 13:52:27 -0400 Subject: documentation minor update, add epub, modify some dir paths --- man/man1/sisu.1 | 337 +++++++++++++++++++++++++++----------------------------- 1 file changed, 165 insertions(+), 172 deletions(-) (limited to 'man') diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index 98e83ed7..8a386063 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -2,13 +2,17 @@ .SH NAME sisu \- documents: markup, structuring, publishing in multiple standard formats, and search .SH SYNOPSIS -sisu [\-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] [filename/wildcard ] +sisu [\-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] [filename/wildcard] + .BR -sisu [\-Ddcv] [instruction] +sisu [\-Ddcv] [instruction] [filename/wildcard] + .BR sisu [\-CcFLSVvW] + .BR sisu \-\-v2 [operations] + .BR sisu \-\-v1 [operations] .SH @@ -37,10 +41,11 @@ the citation of text within a document. .BR .B SiSU is developed under an open source, software libre license (GPL3). Its use -case for development is to cope with medium to large document sets with -evolving markup related technologies, which should be prepared once, and for -which you want multiple output formats that can be updated and a common -mechanism for cross\-output\-format citation, and search. +case for development is work with medium to large document sets and cope with +evolving document formats/ representation technologies. Documents are prepared +once, and generated as need be to update the technical presentation or add +additional output formats. Various output formats (including search related +output) share a common mechanism for cross\-output\-format citation. .BR .B SiSU @@ -50,11 +55,11 @@ standards format outputs from documents prepared with markup. From a single lightly prepared document sisu custom builds several standard output formats which share a common (text object) numbering system for citation of content within a document (that also has implications for search). -The sisu engine works with an abstraction of the document\'s structure and +The sisu engine works with an abstraction of the document's structure and content from which it is possible to generate different forms of representation of the document. Significantly .B SiSU -markup is more sparse than html and outputs which include html, LaTeX, +markup is more sparse than html and outputs which include html, EPUB, LaTeX, landscape and portrait pdfs, Open Document Format (ODF), all of which can be added to and updated. .B SiSU @@ -72,14 +77,15 @@ markup applied to a document, .B SiSU custom builds (to take advantage of the strengths of different ways of representing documents) various standard open output formats including plain -text, HTML, XHTML, XML, OpenDocument, LaTeX or PDF files, and populate an SQL -database with objects[^1] (equating generally to paragraph\-sized chunks) so -searches may be performed and matches returned with that degree of granularity -( e.g. your search criteria is met by these documents and at these locations -within each document). Document output formats share a common object numbering -system for locating content. This is particularly suitable for \"published\" -works (finalized texts as opposed to works that are frequently changed or -updated) for which it provides a fixed means of reference of content. +text, HTML, XHTML, XML, EPUB, OpenDocument, LaTeX or PDF files, and populate an +SQL database with objects[^1] (equating generally to paragraph\-sized chunks) +so searches may be performed and matches returned with that degree of +granularity ( e.g. your search criteria is met by these documents and at these +locations within each document). Document output formats share a common object +numbering system for locating content. This is particularly suitable for +"published" works (finalized texts as opposed to works that are frequently +changed or updated) for which it provides a fixed means of reference of +content. .BR In preparing a @@ -94,32 +100,31 @@ the different forms of output requested. .BR .B SiSU works with an abstraction of the document based on its structure which is -comprised of its structure (or frame)[^3] and the objects[^4] it contains, -which enables +comprised of its headings[^3] and objects[^4], which enables .B SiSU to represent the document in many different ways, and to take advantage of the strengths of different ways of presenting documents. The objects are -numbered, and these numbers can be used to provide a common base for citing +numbered, and these numbers can be used to provide a common basis for citing material within a document across the different output format types. This is significant as page numbers are not well suited to the digital age, in web -publishing, changing a browser\'s default font or using a different browser -means that text appears on different pages; and in publishing in different -formats, html, landscape and portrait pdf etc. again page numbers are of no use -to cite text in a manner that is relevant against the different output types. -Dealing with documents at an object level together with object numbering also -has implications for search. +publishing, changing a browser's default font or using a different browser can +mean that text will appear on a different page; and publishing in different +formats, html, landscape and portrait pdf etc. again page numbers are not +useful to cite text. Dealing with documents at an object level together with +object numbering also has implications for search that +.B SiSU +is able to take advantage of. .BR One of the challenges of maintaining documents is to keep them in a format that -would allow users to use them without depending on a proprietary software -popular at the time. Consider the ease of dealing with legacy proprietary -formats today and what guarantee you have that old proprietary formats will -remain (or can be read without proprietary software/equipment) in 15 years -time, or the way the way in which html has evolved over its relatively short -span of existence. +allows use of them independently of proprietary platforms. Consider issues +related to dealing with legacy proprietary formats today and what guarantee you +have that old proprietary formats will remain (or can be read without +proprietary software/equipment) in 15 years time, or the way the way in which +html has evolved over its relatively short span of existence. .B SiSU -provides the flexibility of outputing documents in multiple non\-proprietary -open formats including html, pdf[^5] and the ISO standard ODF.[^6] Whilst +provides the flexibility of producing documents in multiple non\-proprietary +open formats including html, pdf[^5] ODF,[^6] and EPUB.[^7] Whilst .B SiSU relies on software, the markup is uncomplicated and minimalistic which guarantees that future engines can be written to run against it. It is also @@ -129,17 +134,18 @@ can be migrated to other document formats. Further security is provided by the fact that the software itself, .B SiSU is available under GPL3 a licence that guarantees that the source code will -always be open, and free as in libre which means that that code base can be +always be open, and free as in libre, which means that that code base can be used, updated and further developed as required under the terms of its license. Another challenge is to keep up with a moving target. .B SiSU permits new forms of output to be added as they become important, (Open Document Format text was added in 2006 when it became an ISO standard for -office applications and the archival of documents), and existing output to be -updated (html has evolved and the related module has been updated repeatedly -over the years, presumably when the World Wide Web Consortium (w3c) finalises -html 5 which is currently under development, the html module will again be -updated allowing all existing documents to be regenerated as html 5). +office applications and the archival of documents), EPUB was introduced in +2009; and allows the technical representations existing output to be updated +(html has evolved and the related module has been updated repeatedly over the +years, presumably when the World Wide Web Consortium (w3c) finalises html 5 +which is currently under development, the html module will again be updated +allowing all existing documents to be regenerated as html 5). .BR The document formats are written to the file\-system and available for indexing @@ -175,40 +181,20 @@ content prepared in .BR .SH -2.1 SYNOPSIS - -.BR -.B SiSU -\- Structured information, Serialized Units \- a document publishing system - -.BR -sisu [ \ \-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0\-9 \ ] [ \ filename/ \ wildcard -\ ] - -.BR -sisu [ \ \-Ddcv \ ] [ \ instruction \ ] - -.BR -sisu [ \ \-CcFLSVvW \ ] - -.BR -Note: commands should be issued from within the directory that contains the -marked up files, cd to markup directory. - -.SH -2.2 DESCRIPTION +2.1 DESCRIPTION .BR .B SiSU .B SiSU is a document publishing system, that from a simple single marked\-up document, produces multiple of output formats including: plaintext, html, -LaTeX, pdf, xhtml, XML, info, and SQL (PostgreSQL and SQLite), which share -numbered text objects (\"object citation numbering\") and the same document -structure information. For more see: +xhtml, XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and +SQLite), which share numbered text objects ("object citation numbering") and +the same document structure information. For more see: + .SH -2.3 DOCUMENT PROCESSING COMMAND FLAGS +2.2 DOCUMENT PROCESSING COMMAND FLAGS .TP .B \-a [filename/wildcard] @@ -244,9 +230,9 @@ and dtd files are updated if \-CC is used. .TP .B \-c [filename/wildcard] screen toggle ansi screen colour on or off depending on default set (unless -\-c flag is used: if sisurc colour default is set to \'true\', output to screen -will be with colour, if sisurc colour default is set to \'false\' or is -undefined screen output will be without colour). +\-c flag is used: if sisurc colour default is set to 'true', output to screen +will be with colour, if sisurc colour default is set to 'false' or is undefined +screen output will be without colour). .TP .B \-D [instruction] [filename] @@ -318,7 +304,7 @@ that produced it) (digest.txt). \-NV for verbose digest output to screen. .TP .B \-n [filename/wildcard/url] skip the creation of intermediate processing files (document abstraction) if -they already exist, this skips the equivalent of -m which is otherwise assumed +they already exist, this skips the equivalent of \-m which is otherwise assumed by most processing flags. .TP @@ -329,8 +315,8 @@ output basic document in opendocument file format (opendocument.odt). .B \-p [filename/wildcard] produces LaTeX pdf (portrait.pdf & landscape.pdf). Default paper size is set in config file, or document header, or provided with additional command line -parameter, e.g. \-\-papersize\-a4 preset sizes include: \'A4\', U.S. \'letter\' -and \'legal\' and book sizes \'A5\' and \'B5\' (system defaults to A4). +parameter, e.g. \-\-papersize\-a4 preset sizes include: 'A4', U.S. 'letter' and +'legal' and book sizes 'A5' and 'B5' (system defaults to A4). .TP .B \-q [filename/wildcard] @@ -340,7 +326,7 @@ quiet less output to screen. .B \-R [filename/wildcard] copies sisu output files to remote host using rsync. This requires that sisurc.yml has been provided with information on hostname and username, and -that you have your \"keys\" and ssh agent in place. Note the behavior of rsync +that you have your "keys" and ssh agent in place. Note the behavior of rsync different if \-R is used with other flags from if used alone. Alone the rsync \-\-delete parameter is sent, useful for cleaning the remote directory (when \-R is used together with other flags, it is not). Also see \-r @@ -349,7 +335,7 @@ different if \-R is used with other flags from if used alone. Alone the rsync .B \-r [filename/wildcard] copies sisu output files to remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and -that you have your \"keys\" and ssh agent in place. Also see \-R +that you have your "keys" and ssh agent in place. Also see \-R .TP .B \-S @@ -426,11 +412,11 @@ created for each of the processing flag requests. See also \-V .TP .B \-W -starts ruby\'s webrick webserver points at sisu output directories, the +starts ruby's webrick webserver points at sisu output directories, the default port is set to 8081 and can be changed in the resource configuration files. [tip: \ the \ webrick \ server \ requires \ link \ suffixes, \ so \ html \ output \ should \ be \ created \ using \ the \ \-h \ option \ rather \ than \ -\-H; \ also, \ note \ \-F \ webrick \ ]. +\-H \ ; \ also, \ note \ \-F \ webrick \ ]. .TP .B \-w [filename/wildcard] @@ -539,7 +525,7 @@ where database name would be SiSU_[present \ working \ directory \ name \ .TP .B \-D \-\-dropall -kills data\" and drops (postgresql or sqlite) db, tables & indexes [ \ \-d \ +kills data" and drops (postgresql or sqlite) db, tables & indexes [ \ \-d \ \-\-dropall \ sqlite \ equivalent] .BR @@ -565,7 +551,7 @@ in the sisurc.yml file): .TP .B \-0 \-mNhwpAobxXyYv [this \ is \ the \ default \ action \ run \ when \ no \ -options \ are \ give, \ i.e. \ on \ \'sisu \ [filename]\'] +options \ are \ give, \ i.e. \ on \ 'sisu \ [filename]'] .TP .B \-1 @@ -598,9 +584,8 @@ consider \-u for appended url info or \-v for verbose output 5.1 COMMAND LINE WITH FLAGS \- BATCH PROCESSING .BR -In the data directory run sisu \-mh filename or wildcard eg. \"sisu \-h -cisg.sst\" or \"sisu \-h *.{sst,ssm}\" to produce html version of all -documents. +In the data directory run sisu \-mh filename or wildcard eg. "sisu \-h +cisg.sst" or "sisu \-h *.{sst,ssm}" to produce html version of all documents. .BR Running sisu (alone without any flags, filenames or wildcards) brings up the @@ -685,10 +670,10 @@ Available man pages are converted back to html using man2html: An online version of the sisu man page is available here: .BR -* various sisu man pages [^7] +* various sisu man pages [^8] .BR -* sisu.1 [^8] +* sisu.1 [^9] .SH 6.3 SISU BUILT\-IN INTERACTIVE HELP @@ -752,7 +737,7 @@ For lists of alternative help sources, see: .SH -7. INTRODUCTION TO SISU MARKUP[^9] +7. INTRODUCTION TO SISU MARKUP[^10] .BR .SH @@ -760,7 +745,7 @@ For lists of alternative help sources, see: .BR .B SiSU -source documents are plaintext (UTF\-8)[^10] files +source documents are plaintext (UTF\-8)[^11] files .BR All paragraphs are separated by an empty line. @@ -877,7 +862,8 @@ a space and the comment: 8.1 SAMPLE HEADER .BR -This current document has a header similar to this one (without the comments): +This current document is loaded by a master document that has a header similar +to this one: .nf @@ -1226,7 +1212,7 @@ Numbered List (not to be confused with headings/titles, (document structure)) .BR Footnotes and endnotes not distinguished in markup. They are automatically -numbered. Depending on the output file format (html, odf, pdf etc.), the +numbered. Depending on the output file format (html, EPUB, odf, pdf etc.), the document output selected will have either footnotes or endnotes. .BR @@ -1241,7 +1227,7 @@ document output selected will have either footnotes or endnotes. .B resulting output: .BR -[^11] +[^12] .BR .B markup example: @@ -1255,7 +1241,7 @@ document output selected will have either footnotes or endnotes. .B resulting output: .BR -normal text[^12] continues +normal text[^13] continues .BR .B markup example: @@ -1409,7 +1395,7 @@ automatically as a footnote .B resulting output: .BR -about SiSU [^13] markup +aboutSiSU [^14] markup .SH 9.5.3 LINKING IMAGES @@ -1444,7 +1430,7 @@ about SiSU [^13] markup tux.png 64x80 \"Gnu/Linux \- a better way\" .BR -[ \ ruby_logo \ (png \ missing) \ ] [^14] +[ \ ruby_logo \ (png \ missing) \ ] [^15] .BR GnuDebianLinuxRubyBetterWay.png 100x101 \"Way Better \- with Gnu/Linux, Debian @@ -1506,7 +1492,7 @@ information in each column .BR .B markup example: -[^15] +[^16] .nf @@ -2324,7 +2310,7 @@ contain other documents. .BR Note: a secondary file of the composite document is built prior to processing -with the same prefix and the suffix \._sst [^16] +with the same prefix and the suffix \._sst [^17] .BR @@ -2645,20 +2631,20 @@ installed sample skins may be found in: .BR /etc/sisu/skin/doc and - /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg/_sisu/skin/doc + /usr/share/doc/sisu/v2/sisu_markup_samples/samples/_sisu/skin/doc .BR (or equivalent directory) and if sisu\-markup\-samples is installed also under: .BR - /usr/share/doc/sisu/v1/sisu_markup_samples/non\-free/_sisu/skin/doc + /usr/share/doc/sisu\-markup\-samples/v2/samples/_sisu/skin/doc .BR Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: .BR - /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent + /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent directory) .SH @@ -2668,9 +2654,9 @@ list) may be found in: .BR CSS files to modify the appearance of .B SiSU -html, XHTML or XML may be placed in the configuration directory: - \./_sisu/css; ~/.sisu/css or; /etc/sisu/css and these will be copied to the -output directories with the command sisu \-CC. +html, XHTML or XML may be placed in the configuration directory: \./_sisu/css +; ~/.sisu/css or; /etc/sisu/css and these will be copied to the output +directories with the command sisu \-CC. .BR The basic CSS file for html output is html.css, placing a file of that name in @@ -2695,7 +2681,7 @@ The default homepage may use homepage.css or html.css .BR Under consideration is to permit the placement of a CSS file with a different name in directory _sisu/css directory or equivalent, and change the default CSS -file that is looked for in a skin.[^17] +file that is looked for in a skin.[^18] .SH 17. ORGANISING CONTENT @@ -2766,8 +2752,8 @@ directory structure and organisation of content. .BR Custom built pages, including the home page index.html may be placed within the configuration directory _sisu/home/ in any of the locations that is searched -for the configuration directory, namely \./_sisu; ~/_sisu; /etc/sisu From there -they are copied to the root of the output directory with the command: +for the configuration directory, namely \./_sisu ; ~/_sisu ; /etc/sisu From +there they are copied to the root of the output directory with the command: .BR sisu \-CC @@ -2860,8 +2846,8 @@ output formats. .BR .B SiSU -feeds sisu markupd documents into sql type databases PostgreSQL[^18] and/or -SQLite[^19] database together with information related to document structure. +feeds sisu markupd documents into sql type databases PostgreSQL[^19] and/or +SQLite[^20] database together with information related to document structure. .BR This is one of the more interesting output forms, as all the structural data of @@ -2874,7 +2860,7 @@ four tables: subject, (the Dublin Core...); .BR - * another the substantive texts by individual \"paragraph\" (or object) \- + * another the substantive texts by individual "paragraph" (or object) \- along with structural information, each paragraph being identifiable by its paragraph number (if it has one which almost all of them do), and the substantive text of each paragraph quite naturally being searchable (both in @@ -3103,25 +3089,25 @@ removes specified document from sqlite database. INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) .BR -Sample search frontend [^20] A small database and +Sample search frontend [^21] A small database and sample query front\-end (search from) that makes use of the citation system, .I object citation numbering -to demonstrates functionality.[^21] +to demonstrates functionality.[^22] .BR .B 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. +all outputs using object citation numbering, which includes html, XML, EPUB, +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. .BR 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.[^22] +meet the search criteria.[^23] .TP .B sisu \-F \-\-webserv\-webrick @@ -3642,11 +3628,11 @@ is only dependent on the programming language in which it is written .B Ruby , and .B SiSU -will be able to generate html, various XMLs, including ODF (and will also -produce LaTeX). Dependencies required for further actions, though it relies on -the installation of additional dependencies which the source tarball does not -take care of, for things like using a database (postgresql or sqlite)[^23] or -converting LaTeX to pdf. +will be able to generate html, EPUB, various XMLs, including ODF (and will +also produce LaTeX). Dependencies required for further actions, though it +relies on the installation of additional dependencies which the source tarball +does not take care of, for things like using a database (postgresql or +sqlite)[^24] or converting LaTeX to pdf. .BR .B setup.rb @@ -3751,7 +3737,7 @@ change directory to the appropriate one: cd /usr/share/doc/sisu/sisu_markup_samples/dfsg .SH -30.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF +30.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF, EPUB .BR Having moved to the directory that contains the markup samples (see @@ -3829,13 +3815,13 @@ The man pages are also available online, though not always kept as up to date as within the package itself: .BR -* sisu.1 [^24] +* sisu.1 [^25] .BR -* sisu.8 [^25] +* sisu.8 [^26] .BR -* man directory [^26] +* man directory [^27] .SH 30.3.2 BUILT IN HELP @@ -3879,7 +3865,7 @@ Additional markup samples are packaged separately in the file: .BR On .B Debian -they are available in non\-free[^27] to include them it is necessary to +they are available in non\-free[^28] to include them it is necessary to include non\-free in your /etc/apt/source.list or obtain them from the sisu home site. @@ -4110,8 +4096,8 @@ may also contain processing instructions. 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) +browser \ viewing, \ paper \ publication, \ sql \ search \ etc.] (html, epub, +xml, odf, latex, pdf, sql) .BR * for output produces reasonably elegant output of established industry and @@ -4125,6 +4111,9 @@ amongst the output formats currently supported are: .BR * xhtml +.BR + * epub + .BR * XML \- both in sax and dom style xml structures for further development as required @@ -4159,8 +4148,8 @@ 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. +oriented, (pdf, HTML, EPUB, xml, sqlite, postgresql), this numbering system can +be used to reference content. .BR * Granular search within documents. SQL databases are populated at an object @@ -4171,13 +4160,12 @@ 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]. -.BR -* long term maintainability of document collections in a world of changing +.BR * 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 +(open document text) module in 2006, epub in 2009 and in future html5 output +sometime in future, without modification of existing prepared texts .BR * SQL search aside, documents are generated as required and static once @@ -4205,7 +4193,7 @@ may be processed locally to produce the desired document outputs .BR * for basic document generation, the only software dependency is .B Ruby -, and a few standard Unix tools (this covers plaintext, HTML, XML, ODF, +, and a few standard Unix tools (this covers plaintext, HTML, EPUB, 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. @@ -4317,7 +4305,7 @@ Note documentation is prepared in .B SiSU and output is available in multiple formats including amongst others html, -pdf, and odf which may be also be accessed via the html pages[^28] +pdf, odf and epub which may be also be accessed via the html pages[^28] .SH 34.2.1 WWW.SISUDOC.ORG @@ -4416,19 +4404,19 @@ pdf, and odf which may be also be accessed via the html pages[^28] .BR - /usr/share/doc/sisu/html/v2/sisu.1.html + /usr/share/doc/sisu/v2/html/sisu.1.html .BR - /usr/share/doc/sisu/html/v2/sisu_pdf.7.html + /usr/share/doc/sisu/v2/html/sisu_pdf.7.html .BR - /usr/share/doc/sisu/html/v2/sisu_postgresql.7.html + /usr/share/doc/sisu/v2/html/sisu_postgresql.7.html .BR - /usr/share/doc/sisu/html/v2/sisu_sqlite.7.html + /usr/share/doc/sisu/v2/html/sisu_sqlite.7.html .BR - /usr/share/doc/sisu/html/v2/sisu_webrick.1.html + /usr/share/doc/sisu/v2/html/sisu_webrick.1.html .SH 34.3.2 WWW.JUS.UIO.NO/SISU @@ -4461,9 +4449,11 @@ footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. .TP .BI 2. -i.e. the html, pdf, odf outputs are each built individually and optimised for -that form of presentation, rather than for example the html being a saved -version of the odf, or the pdf being a saved version of the html. +i.e. the html, pdf, epub, odf outputs are each built individually and +optimised for that form of presentation, rather than for example the html being +a saved version of the odf, or the pdf being a saved version of the html. + +.BR .TP .BI 3. the different heading levels @@ -4478,7 +4468,14 @@ specification .TP .BI 6. -ISO/IEC 26300:2006 +ISO standard ISO/IEC 26300:2006 + +.BR +.TP +.BI 7. +An open standard format for e-books + +.BR .TP .BI *1. square brackets @@ -4489,23 +4486,23 @@ square brackets .BI +1. square brackets .TP -.BI 7. +.BI 8. .TP -.BI 8. +.BI 9. .TP -.BI 9. +.BI 10. From sometime after SiSU 0.58 it should be possible to describe SiSU markup using SiSU, which though not an original design goal is useful. .TP -.BI 10. +.BI 11. files should be prepared using UTF-8 character encoding .TP -.BI 11. +.BI 12. a footnote or endnote .TP -.BI 12. +.BI 13. self contained endnote marker & endnote in one .TP .BI *. @@ -4520,47 +4517,41 @@ editors notes, numbered asterisk footnote/endnote series .BI +2. editors notes, numbered asterisk footnote/endnote series .TP -.BI 13. +.BI 14. .TP -.BI 14. +.BI 15. .TP -.BI 15. +.BI 16. Table from the Wealth of Networks by Yochai Benkler .TP -.BI 16. +.BI 17. \.ssc (for composite) is under consideration but \._sst makes clear that this is not a regular file to be worked on, and thus less likely that people will have \"accidents\", working on a \.ssc file that is overwritten by subsequent processing. It may be however that when the resulting file is shared \.ssc is an appropriate suffix to use. .TP -.BI 17. -\.B SiSU -has worked this way in the past, though this was dropped as it was thought -the complexity outweighed the flexibility, however, the balance was rather fine -and this behaviour could be reinstated. -.TP -.BI 18. +.BI 19. .TP -.BI 19. +.BI 20. .TP -.BI 20. +.BI 21. .TP -.BI 21. +.BI 22. (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. .TP -.BI 22. +.BI 23. 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 @@ -4568,19 +4559,19 @@ 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. .TP -.BI 23. +.BI 24. There is nothing to stop MySQL support being added in future. .TP -.BI 24. +.BI 25. .TP -.BI 25. +.BI 26. .TP -.BI 26. +.BI 27. .TP -.BI 27. +.BI 28. the .B Debian Free Software guidelines require that everything distributed within @@ -4588,7 +4579,7 @@ Free Software guidelines require that everything distributed within can be changed - and the documents are authors' works that while freely distributable are not freely changeable. .TP -.BI 28. +.BI 29. named index.html or more extensively through sisu_manifest.html .BR @@ -4639,7 +4630,7 @@ Filetype: .TP Source digest: -.I MD5(sisu.ssm.sst)= 2a794c5f8a7df8d6a216025243d432d6 +.I MD5(sisu.ssm.sst)= fd741a3ccf160aa55b942d76bd4e3f2a .TP Generated by: @@ -4651,7 +4642,7 @@ Ruby version: .TP Document (dal) last generated: -.I Fri Mar 05 20:04:20 -0500 2010 +.I Wed Mar 17 13:34:15 -0400 2010 .TP Other versions of this document: @@ -4660,6 +4651,8 @@ manifest: .TP html: .TP +epub: +.TP pdf: .TP pdf: @@ -4669,10 +4662,10 @@ pdf: at: .TP .TP -* Generated by: SiSU 0.70.2 of 2008w50/2 (2008-12-16) +* Generated by: SiSU 2.0.0 of 2010w09/6 (2010-03-06) .TP -* Ruby version: ruby 1.8.7 (2008-08-11 patchlevel 72) [i486-linux] +* Ruby version: ruby 1.8.7 (2010-01-10 patchlevel 249) [i486-linux] .TP -* Last Generated on: Tue Dec 16 00:16:50 -0500 2008 +* Last Generated on: Wed Mar 17 13:34:17 -0400 2010 .TP * SiSU http://www.jus.uio.no/sisu -- cgit v1.2.3