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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
|
project_name: Spine, Doc Reform
description: [
"documents, structuring, processing, publishing",
search,
object numbering,
static content generator,
sisu markup
]
author:
name: Ralph Amissah
email: ralph.amissah@gmail.com
copyright: "(C) 2015 - 2023 Ralph Amissah, All Rights Reserved."
license: "AGPL 3 or later"
homepage: [
"https://www.doc_reform.org",
"https://www.sisudoc.org"
]
# Installation, Compilation
SiSU spine is written in the programming language D for which there are 3 compilers:
- dmd
- ldc
- gdc
D projects tend to use dub as project manager
https://code.dlang.org/packages/dub
https://code.dlang.org/packages/dub
https://github.com/dlang/dub/blob/master/source/dub/commandline.d
dub --compiler=ldc2 -color --config=ldc -b release
dub --compiler=dmd -color --config=dmd
dub --compiler=gdc-10 -color --config=gdc -b release
make ldc
make dmd
there has been some coalescence around the Meson build system
https://mesonbuild.com/
meson
ninja -C build
meson setup --wipe build && ninja -v -C build
make meson
dub --force --compiler=ldc2 && sudo cp -v cgi-bin/spine-search /usr/lib/cgi-bin/.
# Configuration
Configuration files are yaml files
The following paths are searched:
~/.dr/config_local_site
~/path_to_pod_root/.dr/config_local_site
e.g. processing
~spineMarkupSamples/pod/*
will search:
~spineMarkupSamples/pod/.dr/config_local_site
~/.dr/config_local_site
to specify an alternative configuration file to use on the command line (in this
example named "my_config"):
spine -v --html --config=~spineMarkupSamples/pod/.dr/my_config
here is a sample configuration file:
flag:
act0: "--html"
act1: "--html --epub"
output:
path: "/var/www/html"
default:
language: "en"
papersize: "a4"
text_wrap: "80"
digest: "sha256"
webserv:
http: "http"
host: "localhost"
data_http: "http"
data_host: "localhost"
data_root_url: "http://localhost"
data_root_path: "/var/www/html"
data_root_part: ""
images_root_part: "image"
cgi_search_form_title: "≅ SiSU Spine search ፨"
cgi_http: "http"
cgi_host: "localhost"
cgi_bin_url: "http://localhost/cgi-bin"
cgi_bin_subpath: "/cgi-bin"
cgi_bin_path: "/usr/lib/cgi-bin"
cgi_search_script: "spine-search"
cgi_search_script_raw_fn_d: "spine_search.d"
cgi_port: ""
cgi_user: ""
cgi_action: "http://localhost/cgi-bin/spine-search"
db_sqlite: "spine.search.db"
db_pg_table: ""
db_pg_user: ""
# Commands
for a list of commands from the program type:
spine -h
at the time of writing this provides the following output:
--abstraction document abstraction
--assert set optional assertions on
--cgi-search-form-codegen generates (pre-compiled) d code for search of specified db
--cgi-sqlite-search-filename =[filename]
--concordance file for document
--config =/path/to/config/file/including/filename
--dark alternative dark theme
--debug debug
--digest hash digest for each object
--epub process epub output
--curate extract info on authors & topics from document header metadata
--curate-authors extract info on authors from document header metadata
--curate-topics extract info on topics from document header metadata
--hide-ocn object cite numbers
--html process html output
--html-link-curate place links back to curate in segmented html
--html-link-search html embedded search submission
--html-seg process html output
--html-scroll process html output
--lang =[lang code e.g. =en or =en,es]
--latex output for pdfs
--latex-color-links mono or color links for pdfs
--light default light theme
--manifest process manifest output
--ocn-off object cite numbers
--odf open document format text (--odt)
--odt open document format text
--output =/path/to/output/dir specify where to place output
--parallel parallelisation
--parallel-subprocesses nested parallelisation
--pdf latex output for pdfs
--pdf-color-links mono or color links for pdfs
--pod spine (doc reform) pod source content bundled
-q --quiet output to terminal
--section-backmatter document backmatter (default)
--section-biblio document biblio (default)
--section-blurb document blurb (default)
--section-body document body (default)
--section-bookindex document bookindex (default)
--section-endnotes document endnotes (default)
--section-glossary document glossary (default)
--section-toc table of contents (default)
--serial serial processing
--skip-output skip output
--show-config show config
--show-make show make
--show-metadata show metadata
--show-summary show summary
--source document markup source
--sqlite-discrete process discrete sqlite output
--sqlite-db-create create db, create tables
--sqlite-db-drop drop tables & db
--sqlite-db-recreate create db, create tables
--sqlite-delete sqlite output
--sqlite-db-filename =[filename].sql.db
--sqlite-insert sqlite output
--sqlite-update sqlite output
--text text output
--theme-dark alternative dark theme
--theme-light default light theme
--txt text output
-v --verbose output to terminal
--very-verbose output to terminal
--workon (reserved for some matters under development & testing)
--xhtml xhtml output
-h --help This help information.
# Examples
## curate
if you have a document collection with documents that have metadata headers a
summary of the collection can be made using the curate command
spine -v --curate --output=`echo ~webDocRoot` ~spineMarkupSamples/pod/*
spine -v --curate ~spineMarkupSamples/pod/*
spine -v --html --html-link-search --html-link-curate --curate --output=`echo ~webDocRoot` ~spineMarkupSamples/pod/*
spine -v --html --html-link-search --html-link-curate --curate ~spineMarkupSamples/pod/*
## sqlite
if configuartion has been set specify just
- the desired output and
- the markup document/pod(s) to process
spine -v --html ~spineMarkupSamples/markup/pod/sisu-manual
if configuartion has not been set or to overide the set configration specify
- the output path as well as
- the desired output and
- the markup document/pod(s) to process
note: ~webDocRoot should be the path to web doc root, provide a suitable output path.
spine -v --html --html-link-search --html-link-curate --output=`echo ~webDocRoot` ~spineMarkupSamples/pod/*
spine -v --html --html-link-search --html-link-curate --epub --output=`echo ~webDocRoot` ~spineMarkupSamples/pod/*
spine -v --html --epub --latex --odt --curate --output=`echo ~webDocRoot` ~spineMarkupSamples/pod/*
### create db
if there is no sqlite db you first need to create one, to do so
- the name of the db and
- the root path for document output
must be specified:
spine -v \
--sqlite-db-create --sqlite-db-filename="spine.search.db" \
--output=/var/www/html \
~spineMarkupSamples/pod/*
spine -v --sqlite-db-create --sqlite-db-filename="spine.search.db" --output=`echo ~webDocRoot`
if you have a configration file providing this information that is to be used
for a document collection you can point to the document collection:
spine -v --sqlite-db-create ~spineMarkupSamples/pod
### populate db
must specify:
- the name of the db and
- the root path for document output
spine -v --sqlite-update \
--sqlite-db-filename="spine.search.db" \
--output=/var/www/html \
~spineMarkupSamples/pod/*
spine -v --sqlite-update --sqlite-db-filename="spine.search.db" --output=`echo ~webDocRoot` ~spineMarkupSamples/pod/*
if you have a configration file providing this information that is to be used
for a document collection you can point to the document collection:
spine -v --sqlite-update ~spineMarkupSamples/pod/*
### generate a cgi search form in d
spine -v --cgi-search-form-codegen \
--output=/var/www/html \
~spineMarkupSamples/pod
spine -v --cgi-search-form-codegen --config=~spineMarkupSamples/pod
spine -v --cgi-search-form-codegen --config=~spineMarkupSamples/pod/.dr/config_local_site
spine --cgi-search-form-codegen --output=`echo ~webDocRoot` ~spineMarkupSamples/pod
spine --cgi-search-form-codegen --cgi-sqlite-search-filename="spine_search" --output=`echo ~webDocRoot`
spine -v --cgi-search-form-codegen \
--sqlite-db-filename="spine.search.db" \
--cgi-sqlite-search-filename="spine-search" \
--output=/var/www/html \
~spineMarkupSamples/pod
#### compile the cgi search form
cd /var/www/html/cgi # /var/www/html (default document root)
cd ~webDocRoot/cgi
the directory ~webDocRoot/cgi/src should contain two files
- spine_search.d (or whatever you named it)
- cgi.d (by Adam Rupee)
dub --force --compiler=ldc2 && sudo cp -v cgi-bin/spine-search /usr/lib/cgi-bin/.
should compile spine-search in ~webDocRoot/cgi/cgi-bin and copy it to the
cgi-bin directory
spine -v --sqlite-db-create --sqlite-db-filename="spine.search.db" --cgi-sqlite-search-filename="spine-search" --output=`echo ~webDocRoot`
spine -v --sqlite-db-create ~spineMarkupSamples/pod
spine -v --html --html-link-search --cgi-sqlite-search-filename="spine-search" --output=`echo ~webDocRoot` ~spineMarkupSamples/pod/*
spine -v --html --html-link-search --output=`echo ~webDocRoot` ~spineMarkupSamples/pod/*
spine -v --html --html-link-search --cgi-sqlite-search-filename="spine-search" --html-link-curate --curate --output=`echo ~webDocRoot` ~spineMarkupSamples/pod/*
### create db & search form
spine -v \
--sqlite-db-create --sqlite-db-filename="spine.search.db" \
--cgi-search-form-codegen --cgi-sqlite-search-filename="spine-search" \
--output=/var/www/html \
~spineMarkupSamples/pod/*
### html with links to search form
spine -v --html \
--html-link-search \
--output=`echo ~webDocRoot` \
~spineMarkupSamples/pod/*
|
