diff options
Diffstat (limited to 'data/doc/sisu/html/sisu_configuration.1.html')
| -rw-r--r-- | data/doc/sisu/html/sisu_configuration.1.html | 254 |
1 files changed, 0 insertions, 254 deletions
diff --git a/data/doc/sisu/html/sisu_configuration.1.html b/data/doc/sisu/html/sisu_configuration.1.html deleted file mode 100644 index e3be86fe..00000000 --- a/data/doc/sisu/html/sisu_configuration.1.html +++ /dev/null @@ -1,254 +0,0 @@ -<!-- manual page source format generated by PolyglotMan v3.2, --> -<!-- available at http://polyglotman.sourceforge.net/ --> - -<html> -<head> -<title>"sisu_configuration"("1") manual page</title> -</head> -<body bgcolor='white'> -<a href='#toc'>Table of Contents</a><p> -SISU - CONFIGURATION, RALPH AMISSAH -<p> CONFIGURATION OF ENVIRONMENT -<p> 1. CONFIGURATION - -<p> 1.1 DETERMINING THE CURRENT CONFIGURATION -<p> Information on the current -configuration of <b>SiSU</b> should be available with the help command: -<p> sisu --v<br> - -<p> which is an alias for: -<p> sisu --help env<br> - -<p> Either of these should be executed from within a directory that contains -sisu markup source documents. -<p> 1.2 CONFIGURATION FILES (CONFIG.YML) -<p> <b>SiSU</b> -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. -<p> The <b>SiSU</b> configuration file is a yaml file, which -means indentation is significant. -<p> <b>SiSU</b> resource configuration is determined -by looking at the following files if they exist: -<p> ./_sisu/sisurc.yml<br> - -<p> ~/.sisu/sisurc.yml<br> - -<p> /etc/sisu/sisurc.yml<br> - -<p> The search is in the order listed, and the first one found is used. -<p> - In the absence of instructions in any of these it falls back to the internal -program defaults. -<p> Configuration determines the output and processing directories -and the database access details. -<p> If <b>SiSU</b> is installed a sample sisurc.yml - -<p>may be found in /etc/sisu/sisurc.yml -<p> CONFIGURATION OF DOCUMENTS -<p> 2. SKINS - -<p> Skins modify the default appearance of document output on a document, -directory, or site wide basis. Skins are looked for in the following locations: - -<p> ./_sisu/skin<br> - -<p> ~/.sisu/skin<br> - -<p> /etc/sisu/skin<br> - -<p> <b>Within the skin directory</b> are the following the default sub-directories -for document skins: -<p> ./skin/doc<br> - -<p> ./skin/dir<br> - -<p> ./skin/site<br> - -<p> A skin is placed in the appropriate directory and the file named skin_[name].rb - -<p> The skin itself is a ruby file which modifies the default appearances -set in the program. -<p> 2.1 DOCUMENT SKIN -<p> Documents take on a document skin, -if the header of the document specifies a skin to be used. -<p> -<p> <br> -<pre> @skin: skin_united_nations -</pre> -<p> 2.2 DIRECTORY SKIN -<p> 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). -<p> 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. - -<p> 2.3 SITE SKIN -<p> A site skin, modifies the program default skin. -<p> 2.4 SAMPLE - -<p>SKINS -<p> With <b>SiSU</b> installed sample skins may be found in: -<p> /etc/sisu/skin/doc -and<br> - /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc<br> - -<p> (or equivalent directory) and if sisu-markup-samples is installed also -under: -<p> /usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc<br> - -<p> Samples of list.yml and promo.yml (which are used to create the right -column list) may be found in: -<p> /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml -(or equivalent<br> - directory)<br> - -<p> 3. HOMEPAGES -<p> <b>SiSU</b> is about the ability to auto-generate documents. Home -pages are regarded as custom built items, and are not created by <b>SiSU</b> -<b>SiSU</b> 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: -<p> 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) - -<p> 2. through providing what you want as the home page in a skin, -<p> 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. -<p> 3.1 HOME PAGE AND OTHER CUSTOM BUILT - -<p>PAGES IN A SUB-DIRECTORY -<p> 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: -<p> sisu -CC<br> - -<p> 3.2 HOME PAGE WITHIN A SKIN -<p> Skins are described in a separate section, -but basically are a file written in the programming language <b>Ruby</b> 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. -<p> - 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 - -<p>poems in skin_poems.rb -<p> -<p> <br> -<pre> 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 -</pre> -<p> DOCUMENT INFORMATION (METADATA) -<p> METADATA -<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/sisu_manifest.html</a> -> - -<p> <b>Dublin Core</b> (DC) -<p> <i>DC</i> tags included with this document are provided here. - -<p> DC Title: <i>SiSU</i> - Configuration -<p> DC Creator: <i>Ralph</i> Amissah -<p> DC Rights: - -<p><i>Ralph</i> Amissah -<p> DC Type: <i>information</i> -<p> DC Date created: <i>2002-08-28</i> -<p> DC Date -issued: <i>2002-08-28</i> -<p> DC Date available: <i>2007-08-28</i> -<p> DC Date modified: <i>2007-08-30</i> - -<p> DC Date: <i>2007-08-30</i> -<p> <b>Version Information</b> -<p> Sourcefile: <i>sisu_configuration._sst</i> - -<p> Filetype: <i>SiSU</i> text insert 0.58 -<p> Sourcefile Digest, MD5(sisu_configuration._sst)= - -<p><i>491d3da039162d60ae0e2951aa260915</i> -<p> 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)= - -<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> -<p> <b>Generated</b> -<p> Document (metaverse) last -generated: <i>Mon</i> Sep 24 15:36:17 +0100 2007 -<p> Generated by: <i>SiSU</i> <i>0.59.0</i> of -2007w38/0 (2007-09-23) -<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) - [i486-linux] -<p> -<p> -<dl> - -<dt>Other versions of this document: </dt> -<dd></dd> - -<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_configuration/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_configuration/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_configuration/sisu_manifest.html</a> -</a> -> -</dt> -<dd></dd> - -<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_configuration/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_configuration/toc.html'>http://www.jus.uio.no/sisu/sisu_configuration/toc.html</a> -</a> -> </dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_configuration/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_configuration/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_configuration/portrait.pdf</a> -</a> -> -</dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_configuration/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_configuration/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_configuration/landscape.pdf</a> -</a> -> </dt> -<dd> </dd> - -<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -</a> -> -</dt> -<dd></dd> - -<dt>* Generated by: SiSU 0.59.0 of 2007w38/0 (2007-09-23) </dt> -<dd></dd> - -<dt>* Ruby version: ruby -1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> -<dd></dd> - -<dt>* Last Generated on: Mon Sep 24 -15:36:32 +0100 2007 </dt> -<dd></dd> - -<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> - </dt> -<dd></dd> -</dl> -<p> -</body> -</html> |