From 2397b53655f3b91bf85aa56d2a8cb149d98f4b6b Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sun, 25 Jun 2023 13:26:05 -0400 Subject: bespoke html, homepage index.html --- .gitignore | 2 + flake.lock | 25 +- org/config_git.org | 2 + spine-bespoke-output/html/homepage.index.html | 539 ++++++++++++++++++++++++++ 4 files changed, 554 insertions(+), 14 deletions(-) create mode 100644 spine-bespoke-output/html/homepage.index.html diff --git a/.gitignore b/.gitignore index 59710bd..b23a5b0 100644 --- a/.gitignore +++ b/.gitignore @@ -57,6 +57,8 @@ !markup/pod/*/tools/po4a/po/*/*.sst.po !markup/pod/*/tools/po4a/po/*/*.ssm.po !markup/pod/*/tools/po4a/po/*/*.ssi.po +!spine-bespoke-output +!spine-bespoke-output/** .dub/** **/.dub/** tmp/** diff --git a/flake.lock b/flake.lock index 684c05b..1d6820a 100644 --- a/flake.lock +++ b/flake.lock @@ -41,11 +41,11 @@ "systems": "systems_2" }, "locked": { - "lastModified": 1687171271, - "narHash": "sha256-BJlq+ozK2B1sJDQXS3tzJM5a+oVZmi1q0FlBK/Xqv7M=", + "lastModified": 1687709756, + "narHash": "sha256-Y5wKlQSkgEK2weWdOu4J3riRd+kV/VCgHsqLNTTWQ/0=", "owner": "numtide", "repo": "flake-utils", - "rev": "abfb11bd1aec8ced1c9bb9adfe68018230f4fb3c", + "rev": "dbabf0ca0c0c4bce6ea5eaf65af5cb694d2082c7", "type": "github" }, "original": { @@ -59,11 +59,11 @@ "systems": "systems_3" }, "locked": { - "lastModified": 1687171271, - "narHash": "sha256-BJlq+ozK2B1sJDQXS3tzJM5a+oVZmi1q0FlBK/Xqv7M=", + "lastModified": 1687709756, + "narHash": "sha256-Y5wKlQSkgEK2weWdOu4J3riRd+kV/VCgHsqLNTTWQ/0=", "owner": "numtide", "repo": "flake-utils", - "rev": "abfb11bd1aec8ced1c9bb9adfe68018230f4fb3c", + "rev": "dbabf0ca0c0c4bce6ea5eaf65af5cb694d2082c7", "type": "github" }, "original": { @@ -74,11 +74,11 @@ }, "nixpkgs": { "locked": { - "lastModified": 1687518131, - "narHash": "sha256-KirltRIc4SFfk8bTNudIqgKAALH5oqpW3PefmkfWK5M=", + "lastModified": 1687669787, + "narHash": "sha256-8sAwpYmQ1/bFwTMVyCFzrg7WjlNDdoStLFSY5btNRcQ=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "3d8a93602bc54ece7a4e689d9aea1a574e2bbc24", + "rev": "dc2afced518559f1c962b5824599b2c99c7684e3", "type": "github" }, "original": { @@ -104,11 +104,8 @@ ] }, "locked": { - "lastModified": 1687558377, - "narHash": "sha256-9jalMMTAuW6J8K+5x9UFBpS/Ri33htiwx50uGnc+Lzs=", - "ref": "refs/heads/main", - "rev": "badd5fe16d04828bdd6d38b9ec3f237555760e0c", - "revCount": 584, + "lastModified": 1687650848, + "narHash": "sha256-VgP6I0KgKSCBXYZy8TZxRk5I5Vn0MjyfHPkwYOeTtRU=", "type": "git", "url": "file:///home/ralph/grotto/repo/git.repo/projects/doc-reform/code/software/spine" }, diff --git a/org/config_git.org b/org/config_git.org index f62055f..a76f0e8 100644 --- a/org/config_git.org +++ b/org/config_git.org @@ -79,6 +79,8 @@ !markup/pod/*/tools/po4a/po/*/*.sst.po !markup/pod/*/tools/po4a/po/*/*.ssm.po !markup/pod/*/tools/po4a/po/*/*.ssi.po +!spine-bespoke-output +!spine-bespoke-output/** .dub/** ,**/.dub/** tmp/** diff --git a/spine-bespoke-output/html/homepage.index.html b/spine-bespoke-output/html/homepage.index.html new file mode 100644 index 0000000..abf0a68 --- /dev/null +++ b/spine-bespoke-output/html/homepage.index.html @@ -0,0 +1,539 @@ + + + + + ≅ SiSU project sisudoc.org + + + + + +

≅ - SiSU for documents - structuring, publishing in multiple +formats & search

+ +

ℹ - A short description

+ +

+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 also made searchable at an object +level through an SQL database. +

+ +

+ +SiSU markup helps define (delineate) text objects which are numbered +sequentially by the program for object citation. Breaking the document into +objects provides interesting possibilities. These object numbers provide the +possibility of citing/locating text precisely across different document formats +and different languages (assuming the document has been translated). For search +it also makes it possible to identify precisely where within in each document +search criteria is met in the form of an index. Additionally the use of objects +(and that objects are numbered) frees the possibility to represent the document +in the manner considered most suitable to a specific document format (whilst +retaining its structural (and citation) integrity). + +

+ +

Δ - SiSU project source

+ +

+ + Δ SiSU projects repo (git) +
+ - + https://git.sisudoc.org +
+

+ +

+ + Δ SiSU (scribe): document publishing (multiple formats + search) +
+ - + https://git.sisudoc.org/sisu +
+

+ +

+ + Δ SiSU markup samples in document pods for sisu (scribe) +
+ - + https://git.sisudoc.org/sisu-markup +
+

+ +

⌘ - SiSU Spine markup sample output

+ +

+To give an idea of how this works here is a small collection of documents marked +up for and generated by the software. The curation of topics for a collection of +specialized related documents would benefit from a consistently applied bespoke +ontology or thesaurus.
The documents presented are documents that have been +released under various creative commons licences, in the public domain, or the +author's work, with the exception of one that is under GPL and the old abandoned +Debian live-manual +

+ +

+ + ⌘ Authors + + (software curated from provided document header metadata)
+ - + https://sisudoc.org/spine/authors.html + +

+ +

+ + ⌘ Topics + + (software curated from provided document header metadata)
+ - + https://sisudoc.org/spine/topics.html + +

+ +

፨ - SiSU Spine search

+

+ + ፨ Search + + (granular search of text objects)
+ - + https://sisudoc.org/spine_search + +

+ +
+ + + +
+ +

ℹ - SiSU description

+ +

+Here is a description that has been used for the original sisu (scribe): +

+ +

+With minimal preparation of a plain-text (UTF-8) file, using sisu markup syntax +in your text editor of choice, SiSU can generate various document formats, most +of which share a common object numbering system for locating content, including +plain text, HTML, XHTML, XML, EPUB, OpenDocument text (ODF:ODT), LaTeX, PDF +files, and populate an SQL database with objects (roughly paragraph-sized +chunks) so searches may be performed and matches returned with that degree of +granularity. Think of being able to finely match text in documents, using common +object numbers, across different output formats (same object identifier for pdf, +epub or html) and across languages if you have translations of the same document +(same object identifier across languages). For search, your criteria is met by +these documents at these locations within each document (equally relevant across +different output formats and languages). To be clear (if obvious) page numbers +provide none of this functionality. Object numbering is particularly suitable +for "published" works (finalized texts as opposed to works that are frequently +changed or updated) for which it provides a fixed means of reference of content. +Document outputs can also share provided semantic meta-data. +

+ +

...

+ +

+SiSU is less about document layout than it is about finding a way using little +markup to construct an abstract representation of a document that makes it +possible to produce multiple representations of it which may be rather different +from each other and used for different purposes, whether layout and publishing, +scrollworthy online viewing/ reading, or content search. To be able to take +advantage from its minimal preparation starting point of some of the strengths +of rather different established ways of representing documents for different +purposes, whether for search (relational database, or indexed flat files +generated for that purpose whether of complete documents, or say of files made +up of objects), online or other electronic viewing (e.g. html, xml, epub), or +paper publication (e.g. pdf via latex)... +

+ +

+The solution arrived at is to extract structural information about the document +(document sections and headings within the document, available through pattern +matching or markup) and tracking objects (which primarily are defined units of +text such as paragraphs, headings, tables, verse, etc. but also images) which +can be reconstituted as the same documents with relevant object identification +numbers so text (objects) can be referenced across different output formats and +presentations. +

+ +

+SiSU generates tables of content, and through its markup the means for metadata +to be provided for the generation of book style indexes for a document (that +again due to document object numbers are the same and equally relevant across +all document formats). Per document classifying/organizing metadata can also be +provided for automated document curation. +

+ +

+... there have also been working experiments with sisu markup source, two way +conversion/representation of sisu document markup source in mind-mapping +(software kdissert was used for its strong focus on producing documents (now +apparently called semantik)); also po4a software for translators has been used +successfuly in its regular text mode for sisu markup in translation, (which is +more an attribute of po4a than of sisu, but) which is of interest due to +sisu/spine's object citation numbering being available across translations. Open +Document Format text (odf:odt), has been an output, but much more interesting +(and requested by potential users of sisu/spine) would be the ability of a word +processor to save text/a document in sisu markup, making alternative document +processing and presentations with sisu possible. +

+ +

+also worth mention, in the relatively long history of this project, there has +been work done on extracting hash representations of each object, that could +hypothetically be shared to prove the content of a document without sharing its +content, or of identifying which objects change; these hashes can also be used +as unique identifiers in a database or as identifying filenames if individual +objects are saved. +

+ +

+SiSU has evolved, the current implementation focuses on one primary use-case, +books and literary writings. However the concept on which it is based has wider +application. Here is a prevously posted souvenir from my encounter with an IBM +software evaluator in London June 2004 that came about through a chance +encounter with an IBM manager at a Linux Expo, who was curious about my interest +in Gnu/Linux with my legal background... on hearing that I also wrote software, +he suggested, maybe IBM should have a look at it. I was interested, the meeting +was set up... with an IBM, Software Innovations evaluator
His response after +the meeting: +

+ +

+"Ralph
Good to meet with you today, I was very impressed with your +software.
[colleague's name (also posted to an IBM colleague)] - in +summary - Ralph has built an application that runs on linux and takes ASCII +documents and pulls them apart in to the smallest constituent parts, storing +them as XML, PDF and HTML, the HTML are hyperlinked up so the document can be +browsed in its full form. the format and text data created is stored in a +database.
This has potential in any place that needs the power of full text +search whilst holding the structural concepts of the document i.e. legal, +pharma, education, research.. which ones we need to figure out, ..." +

+ +

+Special interest was expressed in the search implications of SiSU. To +paraphrase, the company has document management systems dealing with hundreds of +thousands of texts, these tell you which documents match your search criteria, +but cannot inform you where within a text these matches were found without +opening the documents. This is achieved through defining document objects and +making them the building block of the document, trackable document objects (that +can be placed back in the context of the document or corpus of documents if part +of a collection). SiSU's early design was to - abstract documents to their +structure, and identified objects, numbered in a citable way (as pointed out +document object hashes can be of use for the purpose). +

+ +

ℹ - SiSU Spine

+ +

+SiSU Spine is the new generator for documents prepared in sisu markup, written +in D as opposed to the original sisu which was first shared in Ruby. +

+ +

+Spine code has not as yet been made publicly available. +

+ +

+As compared with the original sisu generator sisu spine: +

+ +

+- Spine uses the same document markup for the document body, but uses yaml for +document headers (which contains document metadata and configuration details), +the original sisu has a bespoke markup for headers. +

+ +

+- Spine (written in D) is considerably faster at generating native output than +sisu (written in Ruby), on last test at least 60 times faster (what took 1 +minute takes 1 second; 1 hour a minute :-) (admittedly some time ago, ruby has +been getting faster, hopefully this is not over over promising). +

+ +

+- Spine produces fewer document outputs types than sisu (html, epub, (odt, +latex) and populates sql db for search) +

+ +

+- As regards non-native output, so far Spine has greater separation of what it +does and largely leaves calling the external program to the user, e.g.: latex +output is a native output in the sense that it is generated directly by spine, +but the pdfs that can be produced from these are produced through use of an +external program xelatex, which produces fine output but is a very much slower +process. +

+ +

+- (where both produce the same output type, generally) Spine generally produces +more up to date output format representations. +

+ +
+

+ralph.amissah www since 1993 ;-) +

+ +
+

Some external links of interest

+ +

Development

+

Programming

+

+ [ + D - (dlang) general purpose, multi-paradigm, fast C like programming language + ] + [ + dub - package registry + ] + [ + community discussion (mail list frontend) + ]
+

+

+ [ + Ruby + ] + [ + Gems + ]
+ [ + Crystal + ]
+

+

SQL DB

+

+ [ + Sqlite - an sql database engine + ]
+ [ + PostgreSQL + ]
+

+

Markup

+

+ [ + HTML + ] + [ + multipage current spec + ] + [ + dom current spec + ]
+ [ + Epub + ]
+ [ + css - cascading style sheets + ]
+

+

+ [ + OpenDocument Format + ]
+

+

+ [ + LaTeX + ]
+

+

+ [ + po4a - maintain translations + ]
+

+

Operating System Distributions

+

+ [ + NixOS - linux based operating system built on the Nix declarative, reproducible and reliable, build system + ] + [ + nixpkgs (packages @ github) + ] + [ + package search + ] + [ + community discussion (discourse) + ]
+ Gnu [ + Guix + ] + [ + packages + ] +
+

+

+ [ + Debian - the universal operating system distribution + ]
+ [ + Devuan + ]
+

+

+ [ + Arch Linux + ] + [ + Arch Wiki + ]
+

+ +
+ +

Extraneous (external) links of personal interest

+ +

Workspace

+ +
Shell
+

+ [ + zsh + ]
+ [ + starship - customizable cross-shell prompt + ]
+

+
Terminal
+

+ [ + tilix + ] + [ + alacritty + ]
+

+
Terminal Multiplexer
+

+ [ + tmux (github) + ] + [ + screen + ]
+

+
Window Manager
+

+ [ + i3wm + ] + [ + sway + ]
+

+
Text Editors
+

+ Gnu Emacs + [ + Doom Emacs (github) + ] + [ + Org-Mode - your life in plain text & literate programming + ] + [ + Evil-Mode + ]
+

+

+ [ + Vim + ] + [ + NeoVim + ]
+

+
Source Control Manager
+

+ [ + Git + ]
+

+
Browsers
+

+ [ + vieb + ] + [ + vimb + ]
+ [ + brave + ]
+

+ +

Search

+

+ [ + DuckDuckGo + ] + [ + YubNub + ]
+

+ +

eMail

+

+ [ + Migadu + ]
+

+

+ [ + NotmuchMail + ]
+

+ +

Forges

+

+ [ + Sourcehut + ]
+

+

+ [ + CodeBerg + ]
+

+

+ [ + GitHub + ] + [ + GitLab + ]
+

+ +

Software Archives

+

+ [ + Software Heritage - the universal software archive + ]
+

+ +
+

+ralph.amissah www since 1993 ;-) +

+ + + -- cgit v1.2.3