Added cite-web.html shortcode

archetypes/default.md

@@ -1,4 +1,5 @@
 +++
 title = "{{ replace .File.ContentBaseName "-" " " | title }}"
+weight = 999
 draft = true
 +++

config/_default/menu.toml

@@ -6,7 +6,7 @@
 [[main]]
   name = "🚧 ISA Documentation"
   weight = 2
-  pageRef = "#"
+  pageRef = "/isa-docs"
 
 [[main]]
   name = "🚧 Software Documentation"

content/_index.md

@@ -31,7 +31,7 @@ layout = "wide"
 </div>
 
 {{< hextra/hero-button    text="🚧 Learn"                  link="#"         style="margin: calc(var(--hx-spacing)*2)" >}}
-{{< hero-button-secondary text="🚧 ISA Documentation"      link="#" style="margin: calc(var(--hx-spacing)*2)" >}}
+{{< hero-button-secondary text="🚧 ISA Documentation"      link="/isa-docs" style="margin: calc(var(--hx-spacing)*2)" >}}
 {{< hero-button-secondary text="🚧 Software Documentation" link="#"         style="margin: calc(var(--hx-spacing)*2)" >}}
 
 <div class="hx:mb-12">&nbsp;</div>

content/isa-docs/_index.md

@@ -0,0 +1,9 @@
++++
+title = "ISA Documentation"
+
+comments = false
+breadcrumbs = false
+toc = false
+
+cascade.type = "docs"
++++

content/isa-docs/lc-1/_index.md

@@ -0,0 +1,5 @@
++++
+title = "Legacy: LC-1"
+weight = 400
+draft = true
++++

content/isa-docs/lc-2/_index.md

@@ -0,0 +1,5 @@
++++
+title = "LC-2"
+weight = 100
+draft = true
++++

content/isa-docs/lc-3.2/_index.md

@@ -0,0 +1,5 @@
++++
+title = "Variant: LC-3.2"
+weight = 500
+draft = true
++++

content/isa-docs/lc-3/_index.md

@@ -0,0 +1,5 @@
++++
+title = "LC-3"
+weight = 200
+draft = true
++++

content/isa-docs/lc-3b/_index.md

@@ -0,0 +1,5 @@
++++
+title = "LC-3b"
+weight = 300
+draft = true
++++

layouts/partials/cite-book.html

@@ -0,0 +1,24 @@
+{{- $author          := .author -}}
+{{- $chapter         := .chapter -}}
+{{- $title           := .title -}}
+{{- $editor          := .editor -}}
+{{- $edition         := .edition -}}
+{{- $publisher       := .publisher -}}
+{{- $year            := .year -}}
+{{- $page            := .page -}}
+{{- $pageEnd         := .pageEnd -}}
+{{- $isbn            := .isbn -}}
+{{- $url             := .url -}}
+{{- $urlArchived     := .urlArchived -}}
+{{- $urlArchivedDate := .urlArchivedDate -}}
+
+{{- if $author }}{{ $author }}, {{ end -}}
+{{- if $chapter }}"{{ $chapter }}" in {{ end -}}
+{{- if $title }}<em>{{ $title }}</em>{{ end -}}
+{{- if $editor }}, ed. {{ $editor }}{{ end -}}
+{{- if $edition }}, {{ $edition }} {{ if $editor }}edn.{{ else }}ed.{{ end }}{{ end -}}
+{{- if or $publisher $year }} ({{ $publisher }}{{ if and $publisher $year }}, {{ end }}{{ $year }}){{ end -}}
+{{- if $page }}, {{ if $pageEnd }}pp. {{ $page }}-{{ $pageEnd }}{{ else }}p. {{ $page }}{{ end }}{{ end -}}
+{{- if $isbn }}. <a href="https://en.wikipedia.org/wiki/Special:BookSources/{{ $isbn }}" target="_blank">ISBN {{ $isbn }}</a>{{ end -}}
+{{- if $url }}. <a href="{{ $url }}" target="_blank">Link</a>{{ end -}}
+{{- if $urlArchived }} (<a href="{{ $urlArchived }}" target="_blank">Archived{{ with $urlArchivedDate }} on {{ . }}{{ end }}</a>){{ end -}}

layouts/shortcodes/cite-book.html

@@ -0,0 +1,52 @@
+{{- /*
+cite-book - Chicago Notes style book citation shortcode.
+Renders a fully formatted Chicago Notes citation for a book, with optional
+chapter, editor, edition, publisher, page range, ISBN (linked to Wikipedia
+BookSources), original URL, and archived URL. All fields are optional except
+author and title.
+
+@param {string} author             Author(s) in "Lastname, Firstname" format.
+@param {string} chapter            Chapter title, if citing a specific chapter.
+@param {string} title              Book title (rendered in italics).
+@param {string} editor             Editor(s) of the volume, if applicable.
+@param {string} edition            Edition (e.g. "3rd", "2nd").
+@param {string} publisher          Publisher name.
+@param {string} year               Publication year.
+@param {string} page               Page number (single) or start of range.
+@param {string} page-end           End of page range (if citing multiple pages).
+@param {string} isbn               ISBN (linked to Wikipedia BookSources).
+@param {string} url                Original URL of the resource.
+@param {string} url-archived       Archived version URL (e.g. Wayback Machine).
+@param {string} url-archived-date  Date of archival (e.g. "2024-01-15").
+
+@example {{< cite-book
+  author="Patt, Yale N. and Patel, Sanjay J."
+  chapter="Appendix A: The LC-2 ISA"
+  title="Introduction to Computing Systems: from Bits and Gates to C and Beyond"
+  edition="1st"
+  publisher="McGraw-Hill"
+  year="2001"
+  page="429"
+  page-end="449"
+  isbn="978-0072376906"
+  url="http://www.mhhe.com/patt"
+  url-archived="https://web.archive.org/web/20170615060857/http://www.mhhe.com/engcs/compsci/patt/"
+  url-archived-date="June 15, 2017"
+>}}
+*/ -}}
+
+{{ partial "cite-book.html" (dict
+  "author"           (.Get "author")
+  "chapter"          (.Get "chapter")
+  "title"            (.Get "title")
+  "editor"           (.Get "editor")
+  "edition"          (.Get "edition")
+  "publisher"        (.Get "publisher")
+  "year"             (.Get "year")
+  "page"             (.Get "page")
+  "pageEnd"          (.Get "page-end")
+  "isbn"             (.Get "isbn")
+  "url"              (.Get "url")
+  "urlArchived"      (.Get "url-archived")
+  "urlArchivedDate"  (.Get "url-archived-date")
+) }}

layouts/shortcodes/cite-ics.html

@@ -0,0 +1,73 @@
+{{- /*
+cite-ics - Shortcode for citing Introduction to Computing Systems by Patt & Patel.
+Pre-fills author, title, publisher, year, ISBN, and URLs based on the edition.
+
+@param {string} edition   Edition of the book ("1", "2", or "3").
+@param {string} chapter   Chapter title.
+@param {string} page      Page number (single) or start of range.
+@param {string} page-end  End of page range (if citing multiple pages).
+
+@example {{< cite-ics edition="1" chapter="Appendix A: The LC-2 ISA" page="429" page-end="449" >}}
+*/ -}}
+
+{{- $edition := .Get "edition" -}}
+{{- $chapter := .Get "chapter" -}}
+{{- $page    := .Get "page" -}}
+{{- $pageEnd := .Get "page-end" -}}
+
+{{- $author    := "Patt, Yale N. and Patel, Sanjay J." -}}
+{{- $publisher := "McGraw-Hill" -}}
+
+{{- $editionString   := "" -}}
+{{- $title           := "" -}}
+{{- $year            := "" -}}
+{{- $isbn            := "" -}}
+{{- $url             := "" -}}
+{{- $urlArchived     := "" -}}
+{{- $urlArchivedDate := "" -}}
+
+{{- if eq $edition "1" -}}
+  {{- $editionString   = "1st" -}}
+
+  {{- $title           = "Introduction to Computing Systems: from Bits and Gates to C and Beyond" -}}
+  {{- $year            = "2001" -}}
+  {{- $isbn            = "978-0072376906" -}}
+  {{- $url             = "http://www.mhhe.com/patt" -}}
+  {{- $urlArchived     = "https://web.archive.org/web/20170615060857/http://www.mhhe.com/engcs/compsci/patt/" -}}
+  {{- $urlArchivedDate = "June 15, 2017" -}}
+{{- else if eq $edition "2" -}}
+  {{- $editionString   = "2nd" -}}
+
+  {{- /* https://icourse.club/uploads/files/647434676ec33b68392bf82c3a014751e8e2345a.pdf */ -}}
+
+  {{- $title           = "Introduction to Computing Systems: from Bits and Gates to C and Beyond" -}}
+  {{- $year            = "2004" -}}
+  {{- $isbn            = "978-0071245012" -}}
+  {{- $url             = "http://www.mhhe.com/patt2" -}}
+{{- else if eq $edition "3" -}}
+  {{- $editionString   = "3rd" -}}
+
+  {{- /* https://icourse.club/uploads/files/96a2b94d4be48285f2605d843a1e6db37da9a944.pdf */ -}}
+
+  {{- $title           = "Introduction to Computing Systems: from Bits and Gates to C/C++ and Beyond" -}}
+  {{- $year            = "2020" -}}
+  {{- $isbn            = "978-1260150537" -}}
+  {{- $url             = "http://www.mhhe.com/patt3" -}}
+{{- else -}}
+  {{ errorf "cite-ics: edition must be 1, 2, or 3, got '%s'" $edition }}
+{{- end -}}
+
+{{ partial "cite-book.html" (dict
+  "author"          $author
+  "title"           $title
+  "chapter"         $chapter
+  "edition"         $editionString
+  "publisher"       $publisher
+  "year"            $year
+  "page"            $page
+  "pageEnd"         $pageEnd
+  "isbn"            $isbn
+  "url"             $url
+  "urlArchived"     $urlArchived
+  "urlArchivedDate" $urlArchivedDate
+) }}

layouts/shortcodes/cite-web.html

@@ -0,0 +1,46 @@
+{{- /*
+cite-web - Chicago Notes style web citation shortcode.
+Renders a fully formatted Chicago Notes citation for a web resource, with
+optional author, site name, publication date, access date, archived URL and
+archived date. All fields are optional except title and url.
+
+@param {string} author             Author(s) in "Lastname, Firstname" format.
+@param {string} title              Page title (rendered in quotes).
+@param {string} site               Website or organization name.
+@param {string} date               Publication or last updated date.
+@param {string} url                URL of the resource (required).
+@param {string} format             File format of the resource, if applicable (e.g. "PDF", "DOC").
+@param {string} accessed           Date the page was accessed.
+@param {string} url-archived       Archived version URL (e.g. Wayback Machine).
+@param {string} url-archived-date  Date of archival (e.g. "June 15, 2017").
+
+@example {{< cite-web
+  author="Patt, Yale N."
+  title="The LC-3b ISA"
+  site="University of Texas"
+  date="May 22, 2021"
+  url="https://users.ece.utexas.edu/~patt/21s.460n/handouts/appA.pdf"
+  format="PDF"
+  accessed="May 29, 2026"
+  url-archived="https://web.archive.org/web/20250327170520/https://users.ece.utexas.edu/~patt/21s.460n/handouts/appA.pdf"
+  url-archived-date="March 27, 2025"
+>}}
+*/ -}}
+
+{{- $author          := .Get "author" -}}
+{{- $title           := .Get "title" -}}
+{{- $site            := .Get "site" -}}
+{{- $date            := .Get "date" -}}
+{{- $url             := .Get "url" -}}
+{{- $format          := .Get "format" -}}
+{{- $accessed        := .Get "accessed" -}}
+{{- $urlArchived     := .Get "url-archived" -}}
+{{- $urlArchivedDate := .Get "url-archived-date" -}}
+
+{{- if $author }}{{ $author }}. {{ end -}}
+{{- if $title }}"{{ $title }}."{{ end -}}
+{{- if $site }} {{ $site }}.{{ end -}}
+{{- if $date }} {{ $date }}.{{ end -}}
+{{- if $url }} <a href="{{ $url }}" target="_blank">{{ $url }}</a>{{ with $format }} ({{ . }}){{ end }}.{{ end -}}
+{{- if $accessed }} Accessed {{ $accessed }}.{{ end -}}
+{{- if $urlArchived }} (<a href="{{ $urlArchived }}" target="_blank">Archived{{ with $urlArchivedDate }} on {{ . }}{{ end }}</a>){{ end -}}