diff options
Diffstat (limited to 'org/spine_info.org')
| -rw-r--r-- | org/spine_info.org | 470 |
1 files changed, 329 insertions, 141 deletions
diff --git a/org/spine_info.org b/org/spine_info.org index a23f110..1f55127 100644 --- a/org/spine_info.org +++ b/org/spine_info.org @@ -21,21 +21,64 @@ * README :readme: ** tangle +*** org + +#+HEADER: :tangle "../README" +#+BEGIN_SRC text +<<sisu_spine_readme_org_header>> + +<<sisu_spine_readme_info>> + +<<sisu_spine_readme_install_org>> + +<<sisu_spine_readme_configuration_org>> + +<<sisu_spine_readme_commands_org>> + +<<sisu_spine_readme_examples_org>> +#+END_SRC + +*** md #+HEADER: :tangle "../README.md" #+BEGIN_SRC text <<sisu_spine_readme_info>> -<<sisu_spine_readme_description>> -<<sisu_spine_readme_install>> -<<sisu_spine_readme_configuration>> -<<sisu_spine_readme_commands>> -<<sisu_spine_readme_examples>> + +<<sisu_spine_readme_install_md>> + +<<sisu_spine_readme_configuration_md>> + +<<sisu_spine_readme_commands_md>> + +<<sisu_spine_readme_examples_md>> +#+END_SRC + +** org header + +#+NAME: sisu_spine_readme_org_header +#+BEGIN_SRC text +-*- mode: org -*- +#+TITLE: spine (doc_reform) (project) README +#+DESCRIPTION: README for spine +#+FILETAGS: :spine:build:tools: +#+AUTHOR: Ralph Amissah +#+EMAIL: [[mailto:ralph.amissah@gmail.com][ralph.amissah@gmail.com]] +#+COPYRIGHT: Copyright (C) 2015 - 2021 Ralph Amissah +#+LANGUAGE: en +#+STARTUP: content hideblocks hidestars noindent entitiespretty +#+OPTIONS: H:3 num:nil toc:t \n:nil @:t ::t |:t ^:nil _:nil -:t f:t *:t <:t +#+PROPERTY: header-args :exports code +#+PROPERTY: header-args+ :noweb yes +#+PROPERTY: header-args+ :eval no +#+PROPERTY: header-args+ :results no +#+PROPERTY: header-args+ :cache no +#+PROPERTY: header-args+ :padline no #+END_SRC ** project name #+NAME: sisu_spine_readme_info -#+BEGIN_SRC markdown +#+BEGIN_SRC yaml project_name: Spine, Doc Reform description: [ @@ -60,18 +103,42 @@ project_name: Spine, Doc Reform ] #+END_SRC -** short description +** short description (currently UNUSED) #+NAME: sisu_spine_readme_description #+BEGIN_SRC text #+END_SRC ** installation +*** org + +#+NAME: sisu_spine_readme_install_org +#+BEGIN_SRC text +,* <<sisu_spine_readme_install_heading>> -#+NAME: sisu_spine_readme_install +<<sisu_spine_readme_install_body>> +#+END_SRC + +*** md + +#+NAME: sisu_spine_readme_install_md #+BEGIN_SRC markdown -# Installation, Compilation +# <<sisu_spine_readme_install_heading>> +<<sisu_spine_readme_install_body>> +#+END_SRC + +*** heading + +#+NAME: sisu_spine_readme_install_heading +#+BEGIN_SRC text +Installation, Compilation +#+END_SRC + +*** text body + +#+NAME: sisu_spine_readme_install_body +#+BEGIN_SRC markdown SiSU spine is written in the programming language D for which there are 3 compilers: - dmd @@ -105,15 +172,38 @@ https://mesonbuild.com/ make meson dub --force --compiler=ldc2 && sudo cp -v cgi-bin/spine-search /usr/lib/cgi-bin/. - #+END_SRC ** configuration +*** org + +#+NAME: sisu_spine_readme_configuration_org +#+BEGIN_SRC text +,* <<sisu_spine_readme_configuration_heading>> -#+NAME: sisu_spine_readme_configuration +<<sisu_spine_readme_configuration_body>> +#+END_SRC + +*** md + +#+NAME: sisu_spine_readme_configuration_md #+BEGIN_SRC markdown -# Configuration +# <<sisu_spine_readme_configuration_heading>> + +<<sisu_spine_readme_configuration_body>> +#+END_SRC + +*** heading +#+NAME: sisu_spine_readme_configuration_heading +#+BEGIN_SRC text +Configuration +#+END_SRC + +*** text body + +#+NAME: sisu_spine_readme_configuration_body +#+BEGIN_SRC markdown Configuration files are yaml files The following paths are searched: @@ -171,15 +261,38 @@ webserv: db_sqlite: "spine.search.db" db_pg_table: "" db_pg_user: "" - #+END_SRC ** commands help +*** org + +#+NAME: sisu_spine_readme_commands_org +#+BEGIN_SRC text +,* <<sisu_spine_readme_commands_heading>> + +<<sisu_spine_readme_commands_body>> +#+END_SRC + +*** md -#+NAME: sisu_spine_readme_commands +#+NAME: sisu_spine_readme_commands_md #+BEGIN_SRC markdown -# Commands +# <<sisu_spine_readme_commands_heading>> + +<<sisu_spine_readme_commands_body>> +#+END_SRC +*** heading + +#+NAME: sisu_spine_readme_commands_heading +#+BEGIN_SRC text +Commands +#+END_SRC + +*** text body + +#+NAME: sisu_spine_readme_commands_body +#+BEGIN_SRC markdown for a list of commands from the program type: spine -h @@ -252,36 +365,91 @@ at the time of writing this provides the following output: --workon (reserved for some matters under development & testing) --xhtml xhtml output -h --help This help information. - #+END_SRC ** command examples +*** text body org -#+NAME: sisu_spine_readme_examples +#+NAME: sisu_spine_readme_examples_org #+BEGIN_SRC markdown -# Examples +,* Examples -if configuartion has been set specify just -- the desired output and -- the markup document/pod(s) to process +,** curate - spine -v --html ~spineMarkupSamples/markup/pod/sisu-manual +<<sisu_spine_readme_examples_curate_text>> -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 +,** sqlite -note: ~webDocRoot should be the path to web doc root, provide a suitable output path. +<<sisu_spine_readme_examples_sqlite_text>> - spine -v --html --html-link-search --html-link-curate --output=`echo ~webDocRoot` ~spineMarkupSamples/pod/* +,*** create db - spine -v --html --html-link-search --html-link-curate --epub --output=`echo ~webDocRoot` ~spineMarkupSamples/pod/* +<<sisu_spine_readme_examples_create_db_text>> - spine -v --html --epub --latex --odt --curate --output=`echo ~webDocRoot` ~spineMarkupSamples/pod/* +,*** populate db + +<<sisu_spine_readme_examples_populate_db_text>> + +,*** generate a cgi search form in d + + <<sisu_spine_readme_examples_search_db_cgi_text>> + +,**** compile the cgi search form + +<<sisu_spine_readme_examples_compile_search_db_cgi_text>> + +,*** create db & search form + + <<sisu_spine_readme_examples_create_db_and_search_form_text>> + +,*** html with links to search form + + <<sisu_spine_readme_examples_html_with_links_to_search_form_text>> +#+END_SRC + +*** text body md + +#+NAME: sisu_spine_readme_examples_md +#+BEGIN_SRC markdown +# Examples ## curate +<<sisu_spine_readme_examples_curate_text>> + +## sqlite + +<<sisu_spine_readme_examples_sqlite_text>> + +### create db + +<<sisu_spine_readme_examples_create_db_text>> + +### populate db + +<<sisu_spine_readme_examples_populate_db_text>> + +### generate a cgi search form in d + + <<sisu_spine_readme_examples_search_db_cgi_text>> + +#### compile the cgi search form + +<<sisu_spine_readme_examples_compile_search_db_cgi_text>> + +### create db & search form + + <<sisu_spine_readme_examples_create_db_and_search_form_text>> + +### html with links to search form + + <<sisu_spine_readme_examples_html_with_links_to_search_form_text>> +#+END_SRC + +*** text body content + +#+NAME: sisu_spine_readme_examples_curate_text +#+BEGIN_SRC text if you have a document collection with documents that have metadata headers a summary of the collection can be made using the curate command @@ -292,11 +460,32 @@ summary of the collection can be made using the curate command 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/* +#+END_SRC -## sqlite +#+NAME: sisu_spine_readme_examples_sqlite_text +#+BEGIN_SRC text +if configuartion has been set specify just +- the desired output and +- the markup document/pod(s) to process -### create db + 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/* +#+END_SRC + +#+NAME: sisu_spine_readme_examples_create_db_text +#+BEGIN_SRC text 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 @@ -313,9 +502,10 @@ 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 +#+END_SRC -### populate db - +#+NAME: sisu_spine_readme_examples_populate_db_text +#+BEGIN_SRC text must specify: - the name of the db and - the root path for document output @@ -331,29 +521,31 @@ 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/* +#+END_SRC -### generate a cgi search form in d - - spine -v --cgi-search-form-codegen \ - --output=/var/www/html \ - ~spineMarkupSamples/pod +#+NAME: sisu_spine_readme_examples_search_db_cgi_text +#+BEGIN_SRC text +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 - spine -v --cgi-search-form-codegen --config=~spineMarkupSamples/pod/.dr/config_local_site +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 --output=`echo ~webDocRoot` ~spineMarkupSamples/pod - spine --cgi-search-form-codegen --cgi-sqlite-search-filename="spine_search" --output=`echo ~webDocRoot` +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 +spine -v --cgi-search-form-codegen \ + --sqlite-db-filename="spine.search.db" \ + --cgi-sqlite-search-filename="spine-search" \ + --output=/var/www/html \ + ~spineMarkupSamples/pod +#+END_SRC +#+NAME: sisu_spine_readme_examples_compile_search_db_cgi_text +#+BEGIN_SRC text cd /var/www/html/cgi # /var/www/html (default document root) cd ~webDocRoot/cgi @@ -376,49 +568,23 @@ cgi-bin directory 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/* - #+END_SRC -* +README+ - -#+HEADER: :NO-tangle "../README" -#+BEGIN_SRC txt -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 - 2021 Ralph Amissah, All Rights Reserved." - - license: "AGPL 3 or later" +#+NAME: sisu_spine_readme_examples_create_db_and_search_form_text +#+BEGIN_SRC text +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/* +#+END_SRC - homepage: [ - "https://www.doc_reform.org", - "https://www.sisudoc.org" - ] +#+NAME: sisu_spine_readme_examples_html_with_links_to_search_form_text +#+BEGIN_SRC text +spine -v --html \ + --html-link-search \ + --output=`echo ~webDocRoot` \ + ~spineMarkupSamples/pod/* #+END_SRC * manpage :manpage: @@ -4550,10 +4716,15 @@ matches are found. #+HEADER: :tangle "../COPYRIGHT" #+BEGIN_SRC txt -<<sisu_spine_copyright>> -<<sisu_spine_license_agpl3>> -<<sisu_spine_summary>> +- Name: spine - SiSU Spine, Doc Reform + <<sisu_spine_copyright>> + + <<sisu_spine_license_agpl3>> + + <<sisu_spine_summary>> + <<sisu_spine_markup_samples>> + <<sisu_spine_dependencies>> #+END_SRC @@ -4561,10 +4732,15 @@ matches are found. #+HEADER: :tangle "../src/COPYRIGHT" #+BEGIN_SRC txt -<<sisu_spine_copyright>> -<<sisu_spine_license_agpl3>> -<<sisu_spine_summary>> +- Name: spine - SiSU Spine, Doc Reform + <<sisu_spine_copyright>> + + <<sisu_spine_license_agpl3>> + + <<sisu_spine_summary>> + <<sisu_spine_markup_samples>> + <<sisu_spine_dependencies>> #+END_SRC @@ -4572,10 +4748,15 @@ matches are found. #+HEADER: :tangle "../src/doc_reform/COPYRIGHT" #+BEGIN_SRC txt -<<sisu_spine_copyright>> -<<sisu_spine_license_agpl3>> -<<sisu_spine_summary>> +- Name: spine - SiSU Spine, Doc Reform + <<sisu_spine_copyright>> + + <<sisu_spine_license_agpl3>> + + <<sisu_spine_summary>> + <<sisu_spine_markup_samples>> + <<sisu_spine_dependencies>> #+END_SRC @@ -4589,8 +4770,11 @@ matches are found. #+HEADER: :tangle "./COPYRIGHT" #+BEGIN_SRC txt -<<sisu_spine_copyright>> -<<sisu_spine_summary>> +- Name: spine - SiSU Spine, Doc Reform + <<sisu_spine_copyright>> + + <<sisu_spine_summary>> + <<sisu_spine_markup_samples>> #+END_SRC @@ -4606,15 +4790,13 @@ matches are found. #+NAME: sisu_spine_copyright #+BEGIN_SRC txt -- Name: spine - SiSU Spine, Doc Reform - - Description: documents, structuring, processing, publishing, search - - static content generator +- Description: documents, structuring, processing, publishing, search + - static content generator - - Author: Ralph Amissah - [ralph.amissah@gmail.com] - - - Copyright: (C) 2015 - 2021 Ralph Amissah +- Author: Ralph Amissah + [ralph.amissah@gmail.com] +- Copyright: (C) 2015 - 2021 Ralph Amissah #+END_SRC *** license @@ -4622,48 +4804,46 @@ matches are found. #+NAME: sisu_spine_license_agpl3 #+BEGIN_SRC txt - - code under src/* src/doc_reform/* - - License: AGPL 3 or later: - - Spine, Doc Reform (SiSU), a framework for document structuring, publishing and - search +- code under src/* src/doc_reform/* + - License: AGPL 3 or later: - Copyright (C) Ralph Amissah + Spine, Doc Reform (SiSU), a framework for document structuring, publishing and + search - This program is free software: you can redistribute it and/or modify it - under the terms of the GNU AFERO General Public License as published by - the Free Software Foundation, either version 3 of the License, or (at your - option) any later version. + Copyright (C) Ralph Amissah - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY - or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License - for more details. + This program is free software: you can redistribute it and/or modify it + under the terms of the GNU AFERO General Public License as published by + the Free Software Foundation, either version 3 of the License, or (at your + option) any later version. - You should have received a copy of the GNU General Public License along - with this program. If not, see [https://www.gnu.org/licenses/]. + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + for more details. - If you have Internet connection, the latest version of the AGPL should be - available at these locations: - [https://www.fsf.org/licensing/licenses/agpl.html] - [https://www.gnu.org/licenses/agpl.html] + You should have received a copy of the GNU General Public License along + with this program. If not, see [https://www.gnu.org/licenses/]. + If you have Internet connection, the latest version of the AGPL should be + available at these locations: + [https://www.fsf.org/licensing/licenses/agpl.html] + [https://www.gnu.org/licenses/agpl.html] #+END_SRC *** spine_summary #+NAME: sisu_spine_summary #+BEGIN_SRC txt - - Spine, Doc Reform (related to SiSU) uses standard: - - docReform markup syntax (based on SiSU markup) - - standard SiSU markup syntax with modified headers and minor - modifications - - docReform object numbering (based on SiSU object citation numbering) - - standard SiSU document object numbering - - - Homepages: - [https://www.sisudoc.org] - +- Spine, Doc Reform (related to SiSU) uses standard: + - docReform markup syntax (based on SiSU markup) + - standard SiSU markup syntax with modified headers and minor + modifications + - docReform object numbering (based on SiSU object citation numbering) + - standard SiSU document object numbering + +- Homepages: + [https://www.sisudoc.org] #+END_SRC #+BEGIN_SRC txt @@ -4682,7 +4862,6 @@ matches are found. - Spine, Doc Reform (SiSU) markup samples Individual document content Copyright (Author) [as stated in document header] Individual document content License (Author) [as stated in document header] - #+END_SRC *** dependencies @@ -4710,6 +4889,9 @@ matches are found. [https://github.com/dlang-community/d2sqlite3] [https://code.dlang.org/packages/d2sqlite3] + - src/ext_depends/d2sqlite3 + - sundry/spine_search_cgi/src/ext_depends_cgi/d2sqlite3 + - Name: dyaml - Description: D:YAML is an open source YAML parser and emitter library for the D programming language. @@ -4728,6 +4910,8 @@ matches are found. [https://github.com/dlang-community/D-YAML] [https://code.dlang.org/packages/dyaml] + - src/ext_depends/D-YAML + - Name: imageformats - Description: @@ -4745,6 +4929,8 @@ matches are found. [https://github.com/lgvz/imageformats] [https://code.dlang.org/packages/imageformats] + - src/ext_depends/imageformats + - Name: tinyendian (dyaml dependency) - Description: TinyEndian is a minimal endianness library for the D programming language. @@ -4763,6 +4949,8 @@ matches are found. [https://github.com/dlang-community/tinyendian] [https://code.dlang.org/packages/tinyendian] + - src/ext_depends/tinyendian + - Name: cgi.d - Description: @@ -4771,7 +4959,7 @@ matches are found. - Copyright: (C) 2008 - 2021 Adam D. Ruppe - - code: cgi.d (copy in ./sundry/spine_search_cgi/src/ext_depends_cgi/arsd) + - code: cgi.d aria2c https://raw.githubusercontent.com/adamdruppe/arsd/master/cgi.d - License: BSL-1.0 @@ -4782,6 +4970,7 @@ matches are found. - Homepages: [https://github.com/adamdruppe/arsd] + - sundry/spine_search_cgi/src/ext_depends_cgi/arsd - Name: dub2nix - Description: @@ -4796,7 +4985,6 @@ matches are found. - Homepages: [https://github.com/lionello/dub2nix] - #+END_SRC * CHANGELOG :changelog: |