From a72e66db913de3a2e508080c8b1fc8d1342a899b Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 25 Sep 2007 23:23:03 +0100 Subject: remove generated output from main package --- .../sisu_manual/sisu_configuration/scroll.xhtml | 467 --------------------- 1 file changed, 467 deletions(-) delete mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/scroll.xhtml (limited to 'data/doc/manuals_generated/sisu_manual/sisu_configuration/scroll.xhtml') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/scroll.xhtml b/data/doc/manuals_generated/sisu_manual/sisu_configuration/scroll.xhtml deleted file mode 100644 index 38260ae7..00000000 --- a/data/doc/manuals_generated/sisu_manual/sisu_configuration/scroll.xhtml +++ /dev/null @@ -1,467 +0,0 @@ - - - - - - - - Title: - - SiSU - Configuration - -
- 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 - -
- - - - - SiSU - Configuration,
Ralph Amissah - - 1 - - - - Configuration of Environment - - 2 - - - - 1. Configuration - - 3 - - - - 1.1 Determining the Current Configuration - - 4 - - - - Information on the current configuration of SiSU should be -available with the help command: - - 5 - - - - sisu -v - - 6 - - - - which is an alias for: - - 7 - - - - sisu --help env - - 8 - - - - Either of these should be executed from within a directory that -contains sisu markup source documents. - - 9 - - - - 1.2 Configuration files (config.yml) - - 10 - - - - 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. - - 11 - - - - The SiSU configuration file is a yaml file, which means -indentation is significant. - - 12 - - - - SiSU resource configuration is determined by looking at the -following files if they exist: - - 13 - - - - ./_sisu/sisurc.yml - - 14 - - - - ~/.sisu/sisurc.yml - - 15 - - - - /etc/sisu/sisurc.yml - - 16 - - - - The search is in the order listed, and the first one found is used. - - 17 - - - - In the absence of instructions in any of these it falls back to the -internal program defaults. - - 18 - - - - Configuration determines the output and processing directories and the -database access details. - - 19 - - - - If SiSU is installed a sample sisurc.yml may be found in -/etc/sisu/sisurc.yml - - 20 - - - - Configuration of Documents - - 21 - - - - 2. Skins - - 22 - - - - Skins modify the default appearance of document output on a document, -directory, or site wide basis. Skins are looked for in the following -locations: - - 23 - - - - ./_sisu/skin - - 24 - - - - ~/.sisu/skin - - 25 - - - - /etc/sisu/skin - - 26 - - - - Within the skin directory are the following the default -sub-directories for document skins: - - 27 - - - - ./skin/doc - - 28 - - - - ./skin/dir - - 29 - - - - ./skin/site - - 30 - - - - A skin is placed in the appropriate directory and the file named -skin_[name].rb - - 31 - - - - The skin itself is a ruby file which modifies the default appearances -set in the program. - - 32 - - - - 2.1 Document Skin - - 33 - - - - Documents take on a document skin, if the header of the document -specifies a skin to be used. - - 34 - - - 35 - -      @skin: skin_united_nations     - - - - - 2.2 Directory Skin - - 36 - - - - 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). - - 37 - - - - 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. - - 38 - - - - 2.3 Site Skin - - 39 - - - - A site skin, modifies the program default skin. - - 40 - - - - 2.4 Sample Skins - - 41 - - - - With SiSU installed sample skins may be found in: - - 42 - - - - /etc/sisu/skin/doc and -/usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc - - 43 - - - - (or equivalent directory) and if sisu-markup-samples is installed also -under: - - 44 - - - - /usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc - - 45 - - - - Samples of list.yml and promo.yml (which are used to create the right -column list) may be found in: - - 46 - - - - /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or -equivalent directory) - - 47 - - - - 3. Homepages - - 48 - - - - 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: - - 49 - - - - 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) - - 50 - - - - 2. through providing what you want as the home page in a skin, - - 51 - - - - 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. - - 52 - - - - 3.1 Home page and other custom built pages in a sub-directory - - 53 - - - - 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: - - 54 - - - - sisu -CC - - 55 - - - - 3.2 Home page within a skin - - 56 - - - - 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. - - 57 - - - - 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 - - 58 - - - 59 - -        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     - - - - -- cgit v1.2.3