scriptorium 0.0.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc85d4908abe528a86e9d7debab72ffe6db188bc14da0fe8a6a03ac4fa71e739
-  data.tar.gz: d83737681bac36cb0c48e378a401b137b6c9ecbbc4add3c2a9649cdd1ee856d4
+  metadata.gz: da71d5ae85fa244b22a3d7a1ab3868eed54e00c31251cc44eedd06a9763c435c
+  data.tar.gz: 2dd03471532a10fb6a770ac042df3c2ad773eab34dc5f7577ae485841764c802
 SHA512:
-  metadata.gz: f66116f56620ea07e30fccb245f4d6134f256ed3c2b103b18bc00c8babc724a2a6e05bbf347a840fef751faf2778dfe233cf68371f59b9c33ded40c98fd28159
-  data.tar.gz: 04ce8568e5df65eb61439544333ea0c15b751b529dd19ea3bec4fd19e730e8ab75ed4c3cc26f0cbed09e3c4d628d678a271d0d197a2ad0566206f104ff5bfed4
+  metadata.gz: 3f91b41df916bb566d83b231cefc24e3ca3a848b4dfa3111a84cfa8835ab5b59148a2ce2299cbba5889a13870c020211cdbd79b0de9f35c264ee260de643aed8
+  data.tar.gz: 9905b42d39ccf0841d29ab3aa9efe4183855147883e2cdce83346afa6b4db6b33c079fb0196578a701285eaacbb23305c401088c950350d566be6273cd5f4559

data/README.lt3

@@ -0,0 +1,324 @@
+*Scriptorium is a major refactoring (rewrite) of Runeblog, which had an unwieldy and
+fragile code base. The plan now is to develop with more of a test-first approach (and
+with AI support from ChatGPT and Gemini).
+
+<hr>
+
+
+.h2 Scriptorium Project Summary
+.h3 ChatGPT checkpoint - July 8, 2025
+_[This file was a ChatGPT summary hand-edited and reuploaded to improve memory/response.]
+
+.h4 1. Purpose, Assumptions, and Philosophy
+.list
+  Scriptorium is a minimalist, Ruby-based blogging engine and static site generator, serving as a clean-slate rewrite of the older Runeblog project.
+  Avoids complexity, external dependencies, and hidden magic.
+  Designed for users who prefer plain text and transparent, hackable systems.
+  Useful first for the software author, then hackers who blog, then possibly others
+.end
+
+.h4 2. Technologies Used (or Avoided)
+.list
+  Ruby is the primary language.
+  Minitest for testing.
+  Livetext for content and templating.
+  Avoids YAML, Liquid, databases, JS frameworks.
+  Filesystem used in lieu of a database
+.end
+
+.h4 3. Understanding Livetext
+.list
+  Lightweight markup processor.
+  Supports variable injection, custom directives, and flexible transformation to HTML.
+  Also supports: include, raw copy, function definitions
+  There is a plan for a later rewrite
+.end
+
+.h4 4. General Terminology
+.list
+  *containers   Named layout parts of a view’s front page (e.g., header, main, right, footer), generated from corresponding config text files.
+  *post         A finalized blog entry with metadata, body content, and a unique ID; stored in the posts/ directory.
+  *draft        A Livetext (.lt3) source file in the drafts/ directory, created before a post is finished.
+  *repo         A Scriptorium::Repo instance representing a blog workspace, with standard directory structure, config files, and one or more views.
+  *view         A named subset of the repo that acts as a blog/blog-like publication; includes its own output/, config/, and staging/ directories.
+  *theme        A named collection of templates (HTML and Livetext) that define the look and layout of posts and index pages for a view.
+  *slug         A URL-safe, hyphenated version of a post’s title, prefixed with its 4-digit ID, e.g., 0001-my-title.html.
+  *output       A view-local directory holding generated HTML files, including post HTML and containers like header.html and main.html.
+  *meta.txt     A key-value file under posts/NNNN/ holding post metadata (title, slug, pubdate, views, etc.).
+  *post_index   A generated file in output/ listing recent posts in a view; usually post_index.html, composed of index-entry templates.
+.end
+
+.h4 5. Git Repository Structure
+<pre>
+      .
+      ├── README.md
+      ├── doc
+      ├── lib
+      │   ├── scriptorium
+      │   │   ├── exceptions.rb
+      │   │   ├── helpers.rb
+      │   │   ├── layout.rb
+      │   │   ├── post.rb
+      │   │   ├── repo.rb
+      │   │   ├── standard_files.rb
+      │   │   ├── theme.rb
+      │   │   ├── version.rb
+      │   │   └── view.rb
+      │   ├── scriptorium.rb
+      │   └── skeleton.rb
+      ├── scriptorium.gemspec
+      ├── test
+      │   ├── integration
+      │   │   └── integration_test.rb
+      │   ├── post
+      │   │   └── unit.rb
+      │   ├── repo
+      │   │   └── unit.rb
+      │   └── test_helpers.rb
+      └── themes
+          └── standard
+              ├── README.txt
+              ├── assets
+              ├── config.txt
+              ├── header
+              ├── initial
+              │   └── post.lt3
+              ├── layout
+              │   ├── config
+              │   │   ├── footer.txt
+              │   │   ├── header.txt
+              │   │   ├── left.txt
+              │   │   ├── main.txt
+              │   │   └── right.txt
+              │   ├── gen
+              │   │   ├── layout.css
+              │   │   ├── layout.html
+              │   │   └── text.css
+              │   └── layout.txt
+              └── templates
+                  ├── index.lt3
+                  ├── post.lt3
+                  └── widget.lt3
+</pre>
+
+
+.h4 6. Blog Repository Structure
+_[This is a snapshot of a test run.]
+<pre>
+
+      ./scriptorium-TEST
+      ├── assets
+      ├── config
+      │   ├── currentview.txt
+      │   └── last_post_num.txt
+      ├── drafts
+      ├── posts
+      │   ├── 0001
+      │   │   ├── assets
+      │   │   ├── body.html
+      │   │   ├── draft.lt3
+      │   │   └── meta.txt
+      │   ├── 0002
+      │   │   ├── assets
+      │   │   ├── body.html
+      │   │   ├── draft.lt3
+      │   │   └── meta.txt
+      │   ├── 0003
+      │   │   ├── assets
+      │   │   ├── body.html
+      │   │   ├── draft.lt3
+      │   │   └── meta.txt
+      │   ├── 0004
+      │   │   ├── assets
+      │   │   ├── body.html
+      │   │   ├── draft.lt3
+      │   │   └── meta.txt
+      │   ├── 0005
+      │   │   ├── assets
+      │   │   ├── body.html
+      │   │   ├── draft.lt3
+      │   │   └── meta.txt
+      │   ├── 0006
+      │   │   ├── assets
+      │   │   ├── body.html
+      │   │   ├── draft.lt3
+      │   │   └── meta.txt
+      │   ├── 0007
+      │   │   ├── assets
+      │   │   ├── body.html
+      │   │   ├── draft.lt3
+      │   │   └── meta.txt
+      │   ├── 0008
+      │   │   ├── assets
+      │   │   ├── body.html
+      │   │   ├── draft.lt3
+      │   │   └── meta.txt
+      │   ├── 0009
+      │   │   ├── assets
+      │   │   ├── body.html
+      │   │   ├── draft.lt3
+      │   │   └── meta.txt
+      │   ├── 0010
+      │   │   ├── assets
+      │   │   ├── body.html
+      │   │   ├── draft.lt3
+      │   │   └── meta.txt
+      │   ├── 0011
+      │   │   ├── assets
+      │   │   ├── body.html
+      │   │   ├── draft.lt3
+      │   │   └── meta.txt
+      │   ├── 0012
+      │   │   ├── assets
+      │   │   ├── body.html
+      │   │   ├── draft.lt3
+      │   │   └── meta.txt
+      │   └── 0013
+      │       ├── assets
+      │       └── draft.lt3
+      ├── themes
+      │   └── standard
+      │       ├── README.txt
+      │       ├── assets
+      │       ├── config.txt
+      │       ├── header
+      │       ├── initial
+      │       │   └── post.lt3
+      │       ├── layout
+      │       │   ├── config
+      │       │   │   ├── footer.txt
+      │       │   │   ├── header.txt
+      │       │   │   ├── left.txt
+      │       │   │   ├── main.txt
+      │       │   │   └── right.txt
+      │       │   ├── gen
+      │       │   │   ├── layout.css
+      │       │   │   ├── layout.html
+      │       │   │   └── text.css
+      │       │   └── layout.txt
+      │       └── templates
+      │           ├── index.lt3
+      │           ├── index_entry.lt3
+      │           ├── post.lt3
+      │           └── widget.lt3
+      └── views
+          ├── blog1
+          │   ├── config
+          │   │   ├── footer.txt
+          │   │   ├── header.txt
+          │   │   ├── layout.txt
+          │   │   ├── left.txt
+          │   │   ├── main.txt
+          │   │   └── right.txt
+          │   ├── config.txt
+          │   ├── layout
+          │   │   ├── footer.html
+          │   │   ├── header.html
+          │   │   ├── left.html
+          │   │   ├── main.html
+          │   │   └── right.html
+          │   ├── output
+          │   │   ├── panes
+          │   │   │   ├── footer.html
+          │   │   │   ├── header.html
+          │   │   │   ├── left.html
+          │   │   │   ├── main.html
+          │   │   │   └── right.html
+          │   │   └── posts
+          │   │       ├── 0001-random-post-7270.html
+          │   │       ├── 0004-random-post-466.html
+          │   │       ├── 0006-random-post-1685.html
+          │   │       ├── 0007-random-post-6949.html
+          │   │       ├── 0008-random-post-5311.html
+          │   │       ├── 0009-random-post-6420.html
+          │   │       └── 0010-random-post-4555.html
+          │   └── staging
+          .
+          .   (skipped blog2 and blog3 for brevity)
+          .
+          └── sample
+              ├── config
+              │   ├── footer.txt
+              │   ├── header.txt
+              │   ├── layout.txt
+              │   ├── left.txt
+              │   ├── main.txt
+              │   └── right.txt
+              ├── config.txt
+              ├── layout
+              │   ├── footer.html
+              │   ├── header.html
+              │   ├── left.html
+              │   ├── main.html
+              │   └── right.html
+              ├── output
+              │   ├── panes
+              │   │   ├── footer.html
+              │   │   ├── header.html
+              │   │   ├── left.html
+              │   │   ├── main.html
+              │   │   └── right.html
+              │   └── posts
+              └── staging
+</pre>
+
+.h4 7. State of Progress
+.list
+  Basic classes in place: Repo, View, Post, Theme, etc.
+  Unit tests for Repo (22 assertions) and Post (70 assertions)
+  Integration tests (257 assertions)
+  Can create a blog repo, views, posts
+  Theme "standard" is honored
+  Can generate a rudimentary "front page"
+  Working on: &lt;head&gt; generation, Bootstrap integration, etc.
+.end
+
+.h4 8. Near-term high-level to-do list
+_[This is planned by August 31, 2025.]
+.list
+  Improved handling of blog header and &lt;head&gt; tag
+  Support for top-level menu
+  Improvements in Livetext blog plugin
+  Widget base class
+  Widgets: At least Featured, Links, and Pages
+  Isolate and codify all of API
+  Interactive (text) UI
+  Setup/config wizard(s)
+  Basic user docs
+.end
+
+.h4 9. Notes on future to-do items
+.list
+  Improve the customized scriptorium plugin for Livetext
+  Define header far better (title, banner, navbar...)
+  Implement deployment, preview, and live view
+  Add concept of theme components (like mini-themes)
+  Support theme cloning
+  Support single-page post for viewing in isolation
+  Support permalinks
+  Support redirection (if needed) as posts change
+  Add user interfaces
+    -  simple command line calls
+    -  interactive text-oriented (TUI)
+    -  curses-like TUI based on RubyText
+    -  web-based (on localhost)
+  Add "wizards" for each UI: startup, add view, theming...
+  Add actual AI assistant
+  Codify a widget interface
+  Code widgets 
+    -  Highlights (list featured posts)
+    -  Search (search within this blog/view)
+    -  Tags (a tag cloud)
+    -  Links (external links manager)
+    -  Calendar (posts by year/month/day)
+    -  Pages (local static pages unrelated to blog posts)
+  Add some level of support for Markdown (for others, not me)
+  Possibly add Atom/RSS support
+  Integrate Bootstrap calls as needed
+  Add support for reposting to Facebook, X (others?)
+  Add support for discussion threads on a subreddit
+  Create documentation:
+    -  User level (incl. basic Livetext, usage, theme creation)
+    -  Project contributor level
+    -  Widget creator level
+.end