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_manual/sisu_remote/scroll.xhtml | 262 +++++++++++++++++++++ 1 file changed, 262 insertions(+) create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_remote/scroll.xhtml (limited to 'data/doc/manuals_generated/sisu_manual/sisu_remote/scroll.xhtml') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_remote/scroll.xhtml b/data/doc/manuals_generated/sisu_manual/sisu_remote/scroll.xhtml new file mode 100644 index 00000000..1a80e3c9 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_remote/scroll.xhtml @@ -0,0 +1,262 @@ + + + + + + + + Title: + + SiSU - Remote Operations [0.58] + +
+ 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: + + 2002-08-28 + +
+ Date issued: + + 2002-08-28 + +
+ Date available: + + 2002-08-28 + +
+ Date modified: + + 2007-09-16 + +
+ Date: + + 2007-09-16 + +
+ + + + + SiSU - Remote Operations [0.58],
Ralph Amissah + + 1 + + + + SiSU Remote Operations + + 2 + + + + 1. Remote Source Documents + + 3 + + + + SiSU processing instructions can be run against remote source +documents by providing the url of the documents against which the +processing instructions are to be carried out. The remote SiSU +documents can either be sisu marked up files in plaintext .sst or .ssm +or; zipped sisu files, sisupod.zip or filename.ssp + + 4 + + + + .sst / .ssm - sisu text files + + 5 + + + + SiSU can be run against source text files on a remote machine, +provide the processing instruction and the url. The source file and any +associated parts (such as images) will be downloaded and generated +locally. + + 6 + + + 7 + +      sisu -3 http://[provide url to valid .sst or .ssm file]     + + + + + Any of the source documents in the sisu examples page can be used in +this way, see <http://www.jus.uio.no/sisu/SiSU/2.html> +and use the url for the desired document. + + 8 + + + + NOTE: to set up a remote machine to serve SiSU documents in this +way, images should be in the directory relative to the document source +../_sisu/image + + 9 + + + + sisupod - zipped sisu files + + 10 + + + + A sisupod is the zipped content of a sisu marked up text or texts and +any other associated parts to the document such as images. + + 11 + + + + SiSU can be run against a sisupod on a (local or) remote +machine, provide the processing instruction and the url, the sisupod +will be downloaded and the documents it contains generated locally. + + 12 + + + 13 + +      sisu -3 http://[provide url to valid sisupod.zip or .ssp file]     + + + + + Any of the source documents in the sisu examples page can be used in +this way, see <http://www.jus.uio.no/sisu/SiSU/2.html> +and use the url for the desired document. + + 14 + + + + Remote Document Output + + 15 + + + + 2. Remote Output + + 16 + + + + Once properly configured SiSU output can be automatically posted +once generated to a designated remote machine using either rsync, or +scp. + + 17 + + + + In order to do this some ssh authentication agent and keychain or +similar tool will need to be configured. Once that is done the +placement on a remote host can be done seamlessly with the -r (for scp) +or -R (for rsync) flag, which may be used in conjunction with other +processing flags, e.g. + + 18 + + + 19 + +      sisu -3R sisu_remote.sst     + + + + + 2.1 commands + + 20 + + + + -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 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 + + 21 + + + + -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 + + 22 + + + + 2.2 configuration + + 23 + + + + [expand on the setting up of an ssh-agent / keychain] + + 24 + + + + 3. Remote Servers + + 25 + + + + As SiSU is generally operated using the command line, and works +within a Unix type environment, SiSU the program and all +documents can just as easily be on a remote server, to which you are +logged on using a terminal, and commands and operations would be pretty +much the same as they would be on your local machine. + + 26 + + + -- cgit v1.2.3