From c6bb389484a7009313602fc0eec643fb87ed699b Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 21 May 2024 15:25:55 -0400 Subject: spine search info --- README.md | 106 +++++++++++++++++++++++++++++++++++++++----------------------- 1 file changed, 67 insertions(+), 39 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7bc70b8..fe1195d 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,68 @@ -project_name: sisudoc-spine-search - - description: [ - "documents, structuring, processing, publishing", - search, - object numbering, - cgi search form for static content generator, - sisu markup - ] - - author: - name: Ralph Amissah - email: ralph.amissah@gmail.com - - copyright: "(C) 2015 - 2024 Ralph Amissah, All Rights Reserved." - - license: "AGPL 3 or later" - - homepage: [ - "https://www.sisudoc.org", - "https://www.doc-reform.org" - ] - -## Build Configuration - - - -## Installation, Compilation - -Development of sisudoc-spine started in 2015 on a Debian linux box. - -Development since 2020 has been on a NixOS linux box, my laptop. If you are -fortunate enough to be using the same the build instructions should be presented -on entering the sisudoc-spine directory. It should be little problem building on -other linuxes with the right dependencies. At one time, debconf-18 I was -persuaded to try meson, and for a couple of years maintained a meson build, that -dropped out of use before or on my making the switch to nixos in 2020. - -❯❯ D compiler and build manager +project_name: "sisudoc-spine-search" + +description: + - "documents, structuring, processing, publishing" + - "search" + - "object numbering" + - "cgi search form for static content generator" + - "sisu markup" + +author: + name: "Ralph Amissah" + email: ralph.amissah@gmail.com + +copyright: "(C) 2015 - 2024 Ralph Amissah, All Rights Reserved." + +license: + - "project code: AGPL 3 or later" + +homepage: + - "https://sisudoc.org" + - "https://doc-reform.org" + +git: + - "https://git.sisudoc.org" + +# Summary + +This is a sample cgi search form for access to an sqlite3 db built and populated +by sisudoc-spine. As such you probably need the whold of the sisudoc.org spine +project. + +SiSU is an object-centric, lightweight markup based, document structuring, +parser, publishing and search tool for document collections. It is command line +oriented and generates static content that is currently made searchable at an +object level through an SQL database. Markup helps define (delineate) objects +(primarily various types of text block) which are tracked in sequence, +substantive objects being numbered sequentially by the program for object +citation. + +Development of sisudoc-spine started in 2015 on a Debian linux box as a +replacement for sisu (written in Ruby, starting 2000, and Perl from 1997). +(Using Nix and NixOS since 2020). + +# Build Configuration + +sisudoc-spine-search-cgi example form is served from a web-server that has been +configured for cgi. To get this example to work, you will need to edit the file +in ./views/configuration.txt to match the configuration of your web-server and +in particular: the the web server url; the name of the cgi script and; the name +and location of the sqlite database. The following is an example +./views/configuration.txt file. + +struct Cfg { + string http_request_type = "http"; + string http_host = "localhost"; + string www_url_doc_subroot = "/spine"; + string cgi_filename = "spine_search"; + string cgi_search_form_title = "≅ SiSU Spine search ፨"; + string db_sqlite_path = "/var/www/sqlite"; + string db_sqlite_filename = "spine.search.db"; +} +enum _cfg = Cfg(); + +# Compilation, Installation +## D compiler (dmd, ldc2) & D build manager (dub) SiSU spine is written in the programming language D for which there are 3 compilers: dmd, ldc, gdc @@ -50,6 +76,8 @@ The default build tools used are dub with ldc2 (dub is also tested) ## make a directory and clone the sisudoc-spine project +Make a directory and clone the sisudoc-spine project + mkdir ~/git.sisudoc cd ~/git.sisudoc -- cgit v1.2.3