Bs1 bibliography (#295)

* Initial attempt to create individual pages for the Bibliography entries.
1. The "main" Bibliography page is not (yet) modified to reference these.
2. This fails when hugo tries to render the html for the generated .md files.

The error from Hugo (it reports 4 then seems to hang):
ERROR render of "/home/matt/Interlisp/Interlisp.github.io/content/en/history/bibliography/2LJ5ITDD.md" failed: "/home/matt/.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/google/[email protected]/layouts/docs/single.html:2:3": execute of template failed: template: docs/single.html:2:3: executing "main" at <.Render>: error calling Render: failed to execute template content.html: "/home/matt/.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/google/[email protected]/layouts/_default/content.html:10:4": execute of template failed: template: content.html:10:4: executing "content.html" at <.Content>: error calling Content: "/home/matt/Interlisp/Interlisp.github.io/content/en/history/bibliography/2LJ5ITDD.md:8:1": failed to render shortcode "bibItem": failed to process shortcode: "/home/matt/Interlisp/Interlisp.github.io/layouts/shortcodes/bibItem.html:168:23": execute of template failed: template: _shortcodes/bibitem.html:168:23: executing "_shortcodes/bibitem.html" at <.params.bibItem>: can't evaluate field params in type *hugolib.ShortcodeWithPage

* Improved, but still work in progress.
This now creates the files but has some difficulties.
The main Bibliography page hasn't been changed.

* Update github action to set bibSplit.pl executable

* Publications Page -- work in progress

* WIP

* WIP

* Bibliography WIP

Crude listing generated in /pulications folder.

* Initial implementation of list of all bibliography entries

Primitive first pass.  Provides a chronological list of all
bibliography entires providing titles, authors, date and an
abbreviated start of the abstract (limted to 24 words). In
addition, a link is enclosed that goes to the markdown file
that represents the bibliography entry.

Currently, there is nothing implemented to show the contents of
the md file.

There is no bibliography css implemented to format the list items.

This provides an initial proof of concept.  A simple framework that
can be extended and styled to get us where we want to go.

* Initial implementation of list of all bibliography entries

Primitive first pass.  Provides a chronological list of all
bibliography entires providing titles, authors, date and an
abbreviated start of the abstract (limted to 24 words). In
addition, a link is enclosed that goes to the markdown file
that represents the bibliography entry.

Currently, there is nothing implemented to show the contents of
the md file.

There is no bibliography css implemented to format the list items.

This provides an initial proof of concept.  A simple framework that
can be extended and styled to get us where we want to go.

* Updates to bibliography page

The bibliography md files are build using the update_bibliography.sh
script.  bib-fns.jq provides functions to reformat the Zotero JSON.
bibSplit.pl creates the md file and a data file containing the JSON
for each page.  Future work will remove the JSON data files once all the
content is encompassed in the md file.

Added new document type bibliography to generate the list of
bibliography entries.  layouts/bibliography/list.html provides this
functionality.  It also currently includes some light css to format the
output.  The css will eventually be moved into a standalone file within
the Hugo ecosystem.

Removed the original publication type and its associated files in
layouts.

Removed some HugoBlox files.  They were left over from an early attempt
to create a bibliography using HugoBlox as a template.

Updated gh-pages.yml, the GHA, to cache the md pages and JSON files.
Rewrote the caching to make it more efficient and easier to follow.

* Update bibliography entry to link to Zotero

The Read Me link now points to the Zotero entry for
each item.

* Add missing edits.

* Update Zotero link wording and open in new tab

* Fixed a few Hugo syntax errors.
Changed the de-html & re-html encoding to remove unnecessary encoding of html entities.
bibSplit.pl errors go to STDERR
update_bibliography.sh redirects those errors to bibSplit.err file.

I cannot find Hugo documentation showing why _ in truncated abstract renders as ellipsis.

* Updates to author tags

Authors are now stored as a list of strings in the YAML, one author per
line in the list.

Previously all the authors were consolidated into a single string.

* Start of building out individual bibliography pages
                                                         Create baseof.html - framework for bibliography screen          single.html - layout of individual entry                                                                   Updated list.html - with baseof, <br>s added at beginning of file are no                                          longer needed.                                                                                                    Updated bibSplit.pl specify each page as a bibliography page.

* Continued work on creating individual entries.

Build out parsing of json to get needed items
and putting the items into the generated pages.

* Finish individual bibliography entry creation

Individual bibliography entries are created for
all document types.  Customized the entries shown
based on Zotero entries.  Added url, left placeholder
for citation.

Updated list of bibliography entries to link to
individual entries.

* Taxonomy initial work.  Still WIP

* Some edge case cleanups.
A hack for bulleted list in Abstracts.
Some rearranging for consistency between the list and single views.
Other tweaks for my preferences.

* Taxonomy support for filtering bibliographical entries

Add bibliographical support for item_type (the type of
bibliographic entry) and author.

Provide support for filtering bibliographic list by both
types of tags.

* Turn off saving of the 00-rawItems.json and tags.json files.

* Added command line processing to avoid needing to edit the file while debugging changes.
Included usage information.
The previous behavior (no command line options) is unchanged.
(No modification to invocation required.)

* Remove storing of individual .json files and unused files.

Clean out some old files js & scss from earlier bibliography work.

* Cleanup versions in go.sum

* Remove cite placeholder.

---------

Co-authored-by: Matt Heffron <[email protected]>

Author: stumbo

.github/workflows/gh-pages.yml

@@ -57,27 +57,25 @@ jobs:
       cacheHit: ${{ steps.cache-zotero-bib.outputs.cache-hit }}
 
     runs-on: ubuntu-latest
-    concurrency:
-      group:  ${{ github.workflow }}-${{ github.ref }}
     steps:
 
       - name: Get Zotero Version Information
         id: zoteroVersion
         uses: fjogeleit/http-request-action@v1
         with:
-          url: "https://api.zotero.org/groups/2914042/items?format=versions"
-          method: "GET"
+          url: https://api.zotero.org/groups/2914042/items?format=versions
+          method: GET
 
       - name: Cache Zotero Bibliography
-        id: cache-zotero-bib
-        uses: actions/cache@v4
-        env:
-          cache-name: cache-zotero_bib
+        id: cache-zotero
+        uses: actions/cache/restore@v4
         with:
-          path: ~/data
-          key: ${{ fromJson(steps.zoteroVersion.outputs.headers).last-modified-version }}
-          restore-keys: |
-            ${{ fromJson(steps.zoteroVersion.outputs.headers).last-modified-version }}
+          lookup-only: true
+          path: |
+            static/data/bibliography.json
+            static/data/bibItems
+            content/en/history/bibliography
+          key: bib-${{ fromJson(steps.zoteroVersion.outputs.headers).last-modified-version }}
 
   # ----------------------------------------------------------------------------
   # Build the website.  This job is conditional, we will always run it on a
@@ -94,31 +92,23 @@ jobs:
           fetch-depth: 0
 
       - name: Cache Zotero Bibliography
-        id: cache-zotero-bib
+        id: cache-bib
         uses: actions/cache@v4
-        env:
-          cache-name: cache-zotero_bib
         with:
-          path: ~/data
-          key: ${{ needs.check.outputs.zoteroVersion }}
-          restore-keys: |
-            ${{ needs.check.outputs.zoteroVersion }}
+          path: |
+            static/data/bibliography.json
+            static/data/bibItems
+            content/en/history/bibliography
+          key: bib-${{ needs.check.outputs.zoteroVersion }}
 
       - name: Install Bibliography
-        env:
-          CACHE_HIT: ${{ steps.cache-zotero-bib.outputs.cache-hit }}
+        if: steps.cache-bib.outputs.cache-hit != 'true'
         run: |
-          if [[ "$CACHE_HIT" == 'true' ]]; then
-            echo "Use Cache"
-            sudo cp --recursive ~/data ${GITHUB_WORKSPACE}/static
-            ls -la ${GITHUB_WORKSPACE}/static/data
-          else
             echo "Retrieve bibliography"
             cd scripts
             chmod +x ./update_bibliography.sh
+            chmod +x ./bibSplit.pl
             ./update_bibliography.sh
-            sudo cp --recursive ${GITHUB_WORKSPACE}/static/data ~/data
-          fi 
 
       # Install Hugo Extended
       #    
@@ -162,4 +152,4 @@ jobs:
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4
-      
+      

.gitignore

@@ -18,3 +18,9 @@ _gen/
 .hugo_build.lock
 .idea
 data/bibliography.json
+static/data/bibliography.json
+static/data/bibItems/
+/docs
+/scripts/*.json
+/content/en/history/bibliography/**
+!/content/en/history/bibliography/_index.md

config/_default/hugo.yaml

@@ -35,9 +35,9 @@ defaultContentLanguageInSubdir: false
 enableMissingTranslationPlaceholders: true
 
 # Disable rendering of the specified page kinds 
-disableKinds: 
- - taxonomy
- - term
+#disableKinds: 
+# - term
+# Note terms are needed for taxonomies to work
 
 outputs:
   home:

config/_default/languages.yaml

@@ -5,9 +5,14 @@
 # See:  https://gohugo.io/content-management/multilingual/
 #
 en:
-  languageName: English"
+  languageName: English
+  languageCode: en-us
   # Weight used for sorting.
   weight: 1
   contentDir: content/en
   params:
-    description: "Dedicated to restoring and preserving the Interlisp experience"
+    description: "Dedicated to restoring and preserving the Interlisp experience"
+
+    # Languages
+#   Create a section for each of your site's languages.
+#   Documentation: https://docs.hugoblox.com/reference/language/

config/_default/module.yaml

@@ -8,4 +8,4 @@
     - path: "github.com/google/docsy"
       disable: false
     - path: "github.com/google/docsy/dependencies"
-      disable: false
+      disable: false

config/_default/params.yaml

@@ -108,7 +108,27 @@ links:
 #   icon: "fa fa-envelope"
 #   desc: "Discuss development issues around the project"
 
-taxonomies:
+taxonomy:
+  taxonomyCloud:
+    - authors
+  taxonomyCloudTitle:
+    - Authors
+  taxonomyPageHeader:
+    - authors
+    - item_type
+
+#related:
+#  threshold: 80
+#  includeNewer: true
+#  toLower: true
+#  indices:
+#    - name: item_type
+#      weight: 5
+#    - name: tags
+#      weight: 100
+#    - name: categories
+#      weight: 70
+      
 # Nothing defined
 
 # User Interface Configuration options
@@ -154,7 +174,7 @@ ui:
   sidebar_cache_limit: 100
 
   # We have almost 200 attributes; don't truncate the sidebar to max 50 contents.
-  sidebar_menu_truncate:  1000
+  sidebar_menu_truncate:  0
 
   #  Set to true to disable breadcrumb navigation.
   breadcrumb_disable: false
@@ -167,3 +187,4 @@ ui:
 # Identify the custom css files
 custom_css:
   - "css/custom.css"
+

config/_default/permalinks.yaml

@@ -6,4 +6,9 @@
 # 
 # see: https://gohugo.io/content-management/urls/#permalinks
 #
-blog: /:section/:year/:month/:day/:slug/
+blog: '/:section/:year/:month/:day/:slug/'
+
+authors: '/author/:slug/'
+tags: '/tag/:slug/'
+categories: '/category/:slug/'
+publication_types: '/publication-type/:slug/'

config/_default/services.yaml

@@ -0,0 +1,5 @@
+rss:
+  limit: -1
+  title: "Interlisp.org RSS Feed"
+  description: "The latest news from Interlisp.org"
+  link: "https://interlisp.org"

config/_default/taxonomies.yaml

@@ -0,0 +1,4 @@
+tag: tags
+category: categories
+author: authors
+item_type: item_type

content/en/history/bibliography/_index.md

@@ -1,14 +1,12 @@
 ---
 title: Bibliography
+heading: Interlisp Bibliography
+type: bibliography
+cascade:
+    type: bibliography
 weight: 5
-type: docs
 aliases:
  - /bibliography/
 
 ---
-
-## Interlisp Bibliography
-
 (This bibliography is kept in sync with our [Zotero](https://www.zotero.org/) collection [Library](https://www.zotero.org/groups/2914042/interlisp/library).
-
-{{< bibTable >}}