summaryrefslogtreecommitdiffstats
path: root/data/doc/sisu/markup-samples/sisu_manual/sisu_config.ssi
blob: 3c29f9951ff036aa1a91fd377418cb719c546f3c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
% SiSU insert 2.0

@title: SiSU
 :subtitle: Configuration

@creator:
 :author: Amissah, Ralph

@date:
 :published: 2007-09-16
 :created: 2002-08-28
 :issued: 2002-08-28
 :available: 2002-08-28
 :modified: 2011-12-12

@rights:
 :copyright: Copyright (C) Ralph Amissah 2007
 :license: GPL 3 (part of SiSU documentation)

:A~? Configuration

:B~? Configure Environment

1~config Configuration

2~ Configuration files

3~ 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:

_1 ./_sisu/v4/sisurc.yml

_1 ./_sisu/sisurc.yml

_1 ~/.sisu/v4/sisurc.yml

_1 ~/.sisu/sisurc.yml

_1 /etc/sisu/v4/sisurc.yml

_1 /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

3~ sisu_document_make

Most sisu document headers relate to metadata, the exception is the @make: header which provides processing related information. The default contents of the @make header may be set by placing them in a file sisu_document_make.

The search order is as for resource configuration:

_1 ./_sisu/v4/sisu_document_make

_1 ./_sisu/sisu_document_make

_1 ~/.sisu/v4/sisu_document_make

_1 ~/.sisu/sisu_document_make

_1 /etc/sisu/v4/sisu_document_make

_1 /etc/sisu/sisu_document_make

A sample sisu_document_make can be found in the _sisu/ directory under along with the provided sisu markup samples.