diff options
Diffstat (limited to 'data/doc/sisu/org/sisu_packaging.org')
| -rw-r--r-- | data/doc/sisu/org/sisu_packaging.org | 174 |
1 files changed, 130 insertions, 44 deletions
diff --git a/data/doc/sisu/org/sisu_packaging.org b/data/doc/sisu/org/sisu_packaging.org index 3ef53fe7..66e7b965 100644 --- a/data/doc/sisu/org/sisu_packaging.org +++ b/data/doc/sisu/org/sisu_packaging.org @@ -3,36 +3,34 @@ Developer Notes, Dependencies * description ** short summary: 80 chars -smart text parser for document structuring, multiple format publishing & search +documents - structuring, publishing in multiple formats and search ** longer SiSU is a lightweight markup based, command line oriented, document - structuring, publishing and search framework for document collections. + structuring, publishing and search, static content tool for document + collections. . - With minimal preparation of a plain-text (UTF-8) file, using sisu markup - syntax in a text editor of your choice, SiSU can generate various document - formats (most of which share a common object numbering system for locating - content), including plain text, HTML, XHTML, XML, EPUB, OpenDocument text - (ODF:ODT), LaTeX, PDF files, and populate an SQL database with objects - (roughly paragraph-sized chunks) so searches may be performed and matches - returned with that degree of granularity. Think being able to finely match - text in documents, using object numbers, across different output formats (and - across languages if you have translations of the same document). Search results - can be an index of documents and object numbers within them, your criteria is - met by these documents at these locations within each document (equally - relevant across different output formats and languages). To be clear (if - obvious) page numbers provide none of this functionality. Object numbering 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. Document outputs can also share provided - semantic meta-data. + With minimal preparation of a plain-text (UTF-8) file, using sisu markup syntax + in your text editor of choice, SiSU can generate various document formats, most + of which share a common object numbering system for locating content, including + plain text, HTML, XHTML, XML, EPUB, OpenDocument text (ODF:ODT), LaTeX, PDF + files, and populate an SQL database with objects (roughly paragraph-sized + chunks) so searches may be performed and matches returned with that degree of + granularity. Think of being able to finely match text in documents, using + common object numbers, across different output formats and across languages if + you have translations of the same document. For search, your criteria is met + by these documents at these locations within each document (equally relevant + across different output formats and languages). To be clear (if obvious) page + numbers provide none of this functionality. Object numbering 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. Document outputs can also share provided semantic meta-data. . SiSU also provides concordance files, document content certificates and - manifests of generated output. SiSU provides the means to make book indexes - that make use of its object numbering. + manifests of generated output and the means to make book indexes that make use + of its object numbering. . - A vim syntax highlighting file and an ftplugin with folds for sisu markup is - provided. Vim 7 includes syntax highlighting for SiSU. Some syntax hilighting - is also available for Emacs and a few other editors. + Syntax highlighting and folding (outlining) files are provided for the Vim and + Emacs editors. . Dependencies for various features are taken care of in sisu related packages. The package sisu-complete installs the whole of SiSU. @@ -49,6 +47,7 @@ smart text parser for document structuring, multiple format publishing & search . SiSU works well under po4a translation management, for which an administrative sample Rakefile is provided with sisu_manual under markup-samples. + * Generic Dependencies ** source git clone --depth 1 git://git.sisudoc.org/git/code/sisu.git --branch upstream @@ -67,11 +66,11 @@ $ qi setup --all --dryrun $ sudo ./qi setup --all dryrun ** minimal - needed for ----------------------- -ruby all, provides outputs text, html -xz sisupod -zip unzip epub & odt +*** interpreter +ruby all, provides outputs text, html +*** compression tools +xz sisupod (sisu source) +zip unzip epub & odt *** images imagemagick | graphicsmagick @@ -79,6 +78,87 @@ ruby-rmagick ? ** special requirements +*** ruby requires +(checked for sisu 6.5.0 & 7.0.0) +require 'RMagick' ao_images.rb +require 'base64' xml_fictionbook2.rb +require 'cgi' cgi_pgsql.rb + cgi_sqlite.rb + webrick.rb +require 'date' se_date.rb +require 'dbi' se_load.rb +require 'digest/md5' shared_markup_alt.rb +require 'digest/sha2' shared_markup_alt.rb + shared_markup_alt.rb +require 'fcgi' cgi_pgsql.rb + cgi_sqlite.rb + webrick.rb +require 'fileutils' dbi_discrete.rb + hub.rb + se.rb + se_cleanoutput.rb + se_createsite.rb + se_file_op.rb + se_file_op.rb + se_info_env.rb + se_info_env.rb + se_remotes.rb + src_kdissert_share.rb +require 'find' xml_odf_odt.rb +require 'net/http' remote.rb +require 'open-uri' ao_composite.rb + remote.rb +require 'pathname' hub_options.rb + se_info_env.rb +require 'pg' cgi_pgsql.rb + dbi.rb + se_db.rb +require 'pp' ao_composite.rb + remote.rb +require 'profile' hub.rb +require 'pstore' dp.rb + html.rb + texpdf.rb + texpdf.rb + xhtml_epub2.rb +require 'rbconfig' se_info_system.rb + se_version.rb +require 'rexml/document' sst_from_xml.rb + rexml.rb + rexml.rb +require 'singleton' se.rb + se_clear.rb + se_envcall.rb + se_hub_particulars.rb + se_info_env.rb + se_programs.rb + se_version.rb + se_version.rb +require 'socket' se_remotes.rb +require 'sqlite3' cgi_sqlite.rb + dbi.rb + dbi_discrete.rb + se_db.rb +require 'time' webrick.rb + webrick.rb +require 'timeout' src_po4a_shelf.rb + src_po4a_sst_ao_sst.rb +require 'uri' ao_composite.rb + dp.rb + hub.rb + hub_loop_markup_files.rb +require 'webrick' webrick.rb +require 'yaml' se_get_init.rb + se_get_init.rb + se_get_init.rb + se_get_init.rb + se_version.rb +require 'zlib' xml_odf_odt.rb +require @prog se_load.rb +require termsheet termsheet.rb + +ao_hash_digest.rb sha_ ? (require 'digest/sha2') : (require 'digest/md5') + *** pdf texlive @@ -119,23 +199,27 @@ xunicode.sty *** sql db **** sqlite3 -sqlite3 -ruby-sqlite3 - -ruby-fcgi (fast-cgi) -httpd +sqlite3 sql db, search +ruby-sqlite3 ruby driver **** postgresql -postgresql -ruby-pg +postgresql sql db, search +ruby-pg ruby driver -ruby-fcgi (fast-cgi) -httpd +*** web serve & search + +ruby-fcgi (fast-cgi) search form +httpd web server +(along with sql db) *** qr codes -qrencode +qrencode qr codes based on document metadata + +*** misc + +tree information on document structure *** maintenance/installation ruby-thor | rake @@ -214,24 +298,26 @@ needs more than a shallow clone of depth 1 ** pacman install sudo pacman -S ruby \ - zip unzip xy + zip unzip xy tree sudo pacman -S ruby \ texlive-core texlive-latexextra texlive-fontsextra texlive-langcjk sudo pacman -S ruby \ - sqlite postgresql + sqlite postgresql \ + fastcgi ruby-sqlite ruby-postgrsql # issue with ruby-pg ruby-sqlite ruby-fcgi -** interpreter +** sort +*** interpreter ruby -** compression tools (epub, odf:odt, sisupod) +*** compression tools (epub, odf:odt, sisupod) zip unzip xy -** texlive (pdf) +*** texlive (pdf) sudo pacman -S texlive-core texlive-latexextra sudo pacman -S texlive-core texlive-latexextra texlive-fontsextra texlive-langcjk |