diff options
Diffstat (limited to 'data/doc/manuals_generated/sisu_manual/sisu_configuration/plain.txt')
| -rw-r--r-- | data/doc/manuals_generated/sisu_manual/sisu_configuration/plain.txt | 349 |
1 files changed, 349 insertions, 0 deletions
diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/plain.txt b/data/doc/manuals_generated/sisu_manual/sisu_configuration/plain.txt new file mode 100644 index 00000000..a4dcb9b7 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_configuration/plain.txt @@ -0,0 +1,349 @@ +SISU - CONFIGURATION [0.58], +RALPH AMISSAH +******************************************* + +CONFIGURATION OF ENVIRONMENT +============================ + +1. CONFIGURATION +---------------- + +1.1 DETERMINING THE CURRENT CONFIGURATION +......................................... + +Information on the current configuration of *SiSU* should be available with the +help command: + + + sisu -v + + +which is an alias for: + + + sisu --help env + + +Either of these should be executed from within a directory that contains sisu +markup source documents. + + +1.2 CONFIGURATION FILES (CONFIG.YML) +.................................... + +*SiSU* configration parameters are adjusted in the configuration file, which +can be used to override the defaults set. This includes such things as which +directory interim processing should be done in and where the generated output +should be placed. + + +The *SiSU* configuration file is a yaml file, which means indentation is +significant. + + +*SiSU* resource configuration is determined by looking at the following files +if they exist: + + + ./_sisu/sisurc.yml + + + ~/.sisu/sisurc.yml + + + /etc/sisu/sisurc.yml + + +The search is in the order listed, and the first one found is used. + + +In the absence of instructions in any of these it falls back to the internal +program defaults. + + +Configuration determines the output and processing directories and the database +access details. + + +If *SiSU* is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml + + +CONFIGURATION OF DOCUMENTS +========================== + +2. SKINS +-------- + +Skins modify the default appearance of document output on a document, +directory, or site wide basis. Skins are looked for in the following locations: + + + ./_sisu/skin + + + ~/.sisu/skin + + + /etc/sisu/skin + + +*Within the skin directory* are the following the default sub-directories for +document skins: + + + ./skin/doc + + + ./skin/dir + + + ./skin/site + + +A skin is placed in the appropriate directory and the file named skin_[name].rb + + +The skin itself is a ruby file which modifies the default appearances set in +the program. + + +2.1 DOCUMENT SKIN +................. + +Documents take on a document skin, if the header of the document specifies a +skin to be used. + + + + @skin: skin_united_nations + +2.2 DIRECTORY SKIN +.................. + +A directory may be mapped on to a particular skin, so all documents within that +directory take on a particular appearance. If a skin exists in the skin/dir +with the same name as the document directory, it will automatically be used for +each of the documents in that directory, (except where a document specifies the +use of another skin, in the skin/doc directory). + + +A personal habit is to place all skins within the doc directory, and symbolic +links as needed from the site, or dir directories as required. + + +2.3 SITE SKIN +............. + +A site skin, modifies the program default skin. + + +2.4 SAMPLE SKINS +................ + +With *SiSU* installed sample skins may be found in: + + + /etc/sisu/skin/doc and + /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc + + +(or equivalent directory) and if sisu-markup-samples is installed also under: + + + /usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc + + +Samples of list.yml and promo.yml (which are used to create the right column +list) may be found in: + + + /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent + directory) + + +3. HOMEPAGES +------------ + +*SiSU* is about the ability to auto-generate documents. Home pages are regarded +as custom built items, and are not created by *SiSU*. More accurately, *SiSU* +has a default home page, which will not be appropriate for use with other +sites, and the means to provide your own home page instead in one of two ways +as part of a site's configuration, these being: + + +1. through placing your home page and other custom built documents in the +subdirectory _sisu/home/ (this probably being the easier and more convenient +option) + + +2. through providing what you want as the home page in a skin, + + +Document sets are contained in directories, usually organised by site or +subject. Each directory can/should have its own homepage. See the section on +directory structure and organisation of content. + + +3.1 HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB-DIRECTORY +............................................................. + +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: + + + sisu -CC + + +3.2 HOME PAGE WITHIN A SKIN +........................... + +Skins are described in a separate section, but basically are a file written in +the programming language *Ruby* that may be provided to change the defaults +that are provided with sisu with respect to individual documents, a directories +contents or for a site. + + +If you wish to provide a homepage within a skin the skin should be in the +directory _sisu/skin/dir and have the name of the directory for which it is to +become the home page. Documents in the directory commercial_law would have the +homepage modified in skin_commercial law.rb; or the directory poems in +skin_poems.rb + + + + class Home + def homepage + # place the html content of your homepage here, this will become index.html + <<HOME <html> + <head></head> + <doc> + <p>this is my new homepage.</p> + </doc> + </html> + HOME + end + end + +DOCUMENT INFORMATION (METADATA) +******************************* + +METADATA +-------- + +Document Manifest @ +<http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/sisu_manifest.html> + + +*Dublin Core* (DC) + + +/DC tags included with this document are provided here./ + + +DC Title: _SiSU - Configuration [0.58]_ + + +DC Creator: _Ralph Amissah_ + + +DC Rights: _Ralph Amissah_ + + +DC Type: _information_ + + +DC Date created: _2002-08-28_ + + +DC Date issued: _2002-08-28_ + + +DC Date available: _2007-08-28_ + + +DC Date modified: _2007-08-30_ + + +DC Date: _2007-08-30_ + + +*Version Information* + + +Sourcefile: _sisu_configuration._sst_ + + +Filetype: _SiSU text insert 0.58_ + + +Sourcefile Digest, MD5(sisu_configuration._sst)= +_2a18ae8bbfec534c6e064d666ffbe20d_ + + +Skin_Digest: +MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= +_20fc43cf3eb6590bc3399a1aef65c5a9_ + + +*Generated* + + +Document (metaverse) last generated: _Sun Sep 23 04:11:03 +0100 2007_ + + +Generated by: _SiSU_ _0.59.0_ of 2007w38/0 (2007-09-23) + + +Ruby version: _ ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]_ + + + +============================================================================== + + title: SiSU - Configuration [0.58] + + creator: Ralph Amissah + + rights: Ralph Amissah + + 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: 2007-08-28 + + date.modified: 2007-08-30 + + date: 2007-08-30 + + + + + +============================================================================== +nil + +Other versions of this document: +manifest: + http://www.jus.uio.no/sisu/sisu_configuration/sisu_manifest.html +html: + http://www.jus.uio.no/sisu/sisu_configuration/toc.html +pdf: + http://www.jus.uio.no/sisu/sisu_configuration/portrait.pdf + http://www.jus.uio.no/sisu/sisu_configuration/landscape.pdf +plaintext (plain text): + http://www.jus.uio.no/sisu/sisu_configuration/plain.txt +at: + http://www.jus.uio.no/sisu +* Generated by: SiSU 0.59.0 of 2007w38/0 (2007-09-23) +* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] +* Last Generated on: Sun Sep 23 04:11:51 +0100 2007 +* SiSU http://www.jus.uio.no/sisu |