diff --git a/flake.lock b/flake.lock index e53effa..1b9fb28 100644 --- a/flake.lock +++ b/flake.lock @@ -1,23 +1,39 @@ { "nodes": { "crane": { + "locked": { + "lastModified": 1727060013, + "narHash": "sha256-/fC5YlJy4IoAW9GhkJiwyzk0K/gQd9Qi4rRcoweyG9E=", + "owner": "ipetkov", + "repo": "crane", + "rev": "6b40cc876c929bfe1e3a24bf538ce3b5622646ba", + "type": "github" + }, + "original": { + "owner": "ipetkov", + "repo": "crane", + "type": "github" + } + }, + "fenix": { "inputs": { "nixpkgs": [ "typst-dev", "nixpkgs" - ] + ], + "rust-analyzer-src": "rust-analyzer-src" }, "locked": { - "lastModified": 1698166613, - "narHash": "sha256-y4rdN4flxRiROqNi1waMYIZj/Fs7L2OrszFk/1ry9vU=", - "owner": "ipetkov", - "repo": "crane", - "rev": "b7db46f0f1751f7b1d1911f6be7daf568ad5bc65", + "lastModified": 1727245890, + "narHash": "sha256-B4gUhZxqdn24PqL7z7ZuvLOS84HVskhKRByWdgA4/RI=", + "owner": "nix-community", + "repo": "fenix", + "rev": "de3acda8b67b92abeeb35ac236924afd959874ad", "type": "github" }, "original": { - "owner": "ipetkov", - "repo": "crane", + "owner": "nix-community", + "repo": "fenix", "type": "github" } }, @@ -26,11 +42,11 @@ "nixpkgs-lib": "nixpkgs-lib" }, "locked": { - "lastModified": 1726153070, - "narHash": "sha256-HO4zgY0ekfwO5bX0QH/3kJ/h4KvUDFZg8YpkNwIbg1U=", + "lastModified": 1727826117, + "narHash": "sha256-K5ZLCyfO/Zj9mPFldf3iwS6oZStJcU4tSpiXTMYaaL0=", "owner": "hercules-ci", "repo": "flake-parts", - "rev": "bcef6817a8b2aa20a5a6dbb19b43e63c5bf8619a", + "rev": "3d04084d54bedc3d6b8b736c70ef449225c361b1", "type": "github" }, "original": { @@ -44,25 +60,26 @@ "nixpkgs-lib": "nixpkgs-lib_2" }, "locked": { - "lastModified": 1696343447, - "narHash": "sha256-B2xAZKLkkeRFG5XcHHSXXcP7To9Xzr59KXeZiRf4vdQ=", + "lastModified": 1726153070, + "narHash": "sha256-HO4zgY0ekfwO5bX0QH/3kJ/h4KvUDFZg8YpkNwIbg1U=", "owner": "hercules-ci", "repo": "flake-parts", - "rev": "c9afaba3dfa4085dbd2ccb38dfade5141e33d9d4", + "rev": "bcef6817a8b2aa20a5a6dbb19b43e63c5bf8619a", "type": "github" }, "original": { - "id": "flake-parts", - "type": "indirect" + "owner": "hercules-ci", + "repo": "flake-parts", + "type": "github" } }, "nixpkgs": { "locked": { - "lastModified": 1726642912, - "narHash": "sha256-wiZzKGHRAhItEuoE599Wm3ic+Lg/NykuBvhb+awf7N8=", + "lastModified": 1729413321, + "narHash": "sha256-I4tuhRpZFa6Fu6dcH9Dlo5LlH17peT79vx1y1SpeKt0=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "395c52d142ec1df377acd67db6d4a22950b02a98", + "rev": "1997e4aa514312c1af7e2bda7fad1644e778ff26", "type": "github" }, "original": { @@ -74,41 +91,35 @@ }, "nixpkgs-lib": { "locked": { - "lastModified": 1725233747, - "narHash": "sha256-Ss8QWLXdr2JCBPcYChJhz4xJm+h/xjl4G0c0XlP6a74=", + "lastModified": 1727825735, + "narHash": "sha256-0xHYkMkeLVQAMa7gvkddbPqpxph+hDzdu1XdGPJR+Os=", "type": "tarball", - "url": "https://github.com/NixOS/nixpkgs/archive/356624c12086a18f2ea2825fed34523d60ccc4e3.tar.gz" + "url": "https://github.com/NixOS/nixpkgs/archive/fb192fec7cc7a4c26d51779e9bab07ce6fa5597a.tar.gz" }, "original": { "type": "tarball", - "url": "https://github.com/NixOS/nixpkgs/archive/356624c12086a18f2ea2825fed34523d60ccc4e3.tar.gz" + "url": "https://github.com/NixOS/nixpkgs/archive/fb192fec7cc7a4c26d51779e9bab07ce6fa5597a.tar.gz" } }, "nixpkgs-lib_2": { "locked": { - "dir": "lib", - "lastModified": 1696019113, - "narHash": "sha256-X3+DKYWJm93DRSdC5M6K5hLqzSya9BjibtBsuARoPco=", - "owner": "NixOS", - "repo": "nixpkgs", - "rev": "f5892ddac112a1e9b3612c39af1b72987ee5783a", - "type": "github" + "lastModified": 1725233747, + "narHash": "sha256-Ss8QWLXdr2JCBPcYChJhz4xJm+h/xjl4G0c0XlP6a74=", + "type": "tarball", + "url": "https://github.com/NixOS/nixpkgs/archive/356624c12086a18f2ea2825fed34523d60ccc4e3.tar.gz" }, "original": { - "dir": "lib", - "owner": "NixOS", - "ref": "nixos-unstable", - "repo": "nixpkgs", - "type": "github" + "type": "tarball", + "url": "https://github.com/NixOS/nixpkgs/archive/356624c12086a18f2ea2825fed34523d60ccc4e3.tar.gz" } }, "nixpkgs-unstable": { "locked": { - "lastModified": 1726583932, - "narHash": "sha256-zACxiQx8knB3F8+Ze+1BpiYrI+CbhxyWpcSID9kVhkQ=", + "lastModified": 1729428082, + "narHash": "sha256-xb4/Y+Y7ZlkQaA5rXnrXplDzdt2Jfgdmar3+qkb56UA=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "658e7223191d2598641d50ee4e898126768fe847", + "rev": "ca30f584e18024baf39c395001262ed936f27ebd", "type": "github" }, "original": { @@ -120,11 +131,11 @@ }, "nixpkgs_2": { "locked": { - "lastModified": 1720957393, - "narHash": "sha256-oedh2RwpjEa+TNxhg5Je9Ch6d3W1NKi7DbRO1ziHemA=", + "lastModified": 1726937504, + "narHash": "sha256-bvGoiQBvponpZh8ClUcmJ6QnsNKw0EMrCQJARK3bI1c=", "owner": "nixos", "repo": "nixpkgs", - "rev": "693bc46d169f5af9c992095736e82c3488bf7dbb", + "rev": "9357f4f23713673f310988025d9dc261c20e70c6", "type": "github" }, "original": { @@ -136,11 +147,11 @@ }, "pkgs-by-name-for-flake-parts": { "locked": { - "lastModified": 1726843639, - "narHash": "sha256-3ztPGGVbSyGHAycwJbgzpH0JoeC+tvU1pFjOuBGyHSE=", + "lastModified": 1727519927, + "narHash": "sha256-3SNX6BuaisoX9PKYI+fh3geZ3jBgKKkAtHcWuHRU0+o=", "owner": "drupol", "repo": "pkgs-by-name-for-flake-parts", - "rev": "d7f356eba1e202e850f6abb10c9cd8bf3f5db8a0", + "rev": "91debb07d81ff25b8e3b48914b6abd6f11dc26e2", "type": "github" }, "original": { @@ -160,6 +171,35 @@ "typst-packages": "typst-packages" } }, + "rust-analyzer-src": { + "flake": false, + "locked": { + "lastModified": 1727104575, + "narHash": "sha256-lB/ZS0SnHyE8Z3G8DIL/QJPg6w6x5ZhgVO2pBqnz89g=", + "owner": "rust-lang", + "repo": "rust-analyzer", + "rev": "3d0343251fe084b335b55c17a52bb4a3527b1bd0", + "type": "github" + }, + "original": { + "owner": "rust-lang", + "ref": "nightly", + "repo": "rust-analyzer", + "type": "github" + } + }, + "rust-manifest": { + "flake": false, + "locked": { + "narHash": "sha256-tB9BZB6nRHDk5ELIVlGYlIjViLKBjQl52nC1avhcCwA=", + "type": "file", + "url": "https://static.rust-lang.org/dist/channel-rust-1.81.0.toml" + }, + "original": { + "type": "file", + "url": "https://static.rust-lang.org/dist/channel-rust-1.81.0.toml" + } + }, "systems": { "locked": { "lastModified": 1681028828, @@ -193,16 +233,18 @@ "typst-dev": { "inputs": { "crane": "crane", + "fenix": "fenix", "flake-parts": "flake-parts_2", "nixpkgs": "nixpkgs_2", + "rust-manifest": "rust-manifest", "systems": "systems_2" }, "locked": { - "lastModified": 1726588455, - "narHash": "sha256-4Xace2ql8MEVPXYWQicf2QdfipNuXRFcITE4iaKCm/o=", + "lastModified": 1729603552, + "narHash": "sha256-UZByrRxXQ/I0eCTk4Hh1wXVms6bNYLN09AIJMx5D5FE=", "owner": "typst", "repo": "typst", - "rev": "92ec56601831b9c454dbeaf28dba84e2769c7726", + "rev": "b8034a343831e8609aec2ec81eb7eeda57aa5d81", "type": "github" }, "original": { @@ -214,11 +256,11 @@ "typst-packages": { "flake": false, "locked": { - "lastModified": 1726771917, - "narHash": "sha256-Xy3cVxw7CKIGIj0kfBRmxQ/0iGyj8OMdTFlaCdT6LaE=", + "lastModified": 1729608754, + "narHash": "sha256-iJkICZYj4BcRAHfXbXcYyLh3RO+oyICR1eMOXWyWufU=", "owner": "typst", "repo": "packages", - "rev": "b27156611758e4439a774d484b206a18e7aee6b0", + "rev": "8feafc65720edaf3a85105c3cb94c9ab039925c2", "type": "github" }, "original": { diff --git a/src/thesis/1-introduction.typ b/src/thesis/1-introduction.typ index 1fbc6cf..9db097c 100644 --- a/src/thesis/1-introduction.typ +++ b/src/thesis/1-introduction.typ @@ -6,7 +6,6 @@ #import "theme/leftblank.typ": * #import "theme/acknowledgement.typ": * #import "theme/abstract.typ": * -#import "theme/glossary.typ": * #import "theme/infos.typ": * #chapterquote( diff --git a/src/thesis/2-related-work.typ b/src/thesis/2-related-work.typ index 0f450d0..c539a5e 100644 --- a/src/thesis/2-related-work.typ +++ b/src/thesis/2-related-work.typ @@ -5,7 +5,6 @@ #import "theme/disclaimer.typ": * #import "theme/acknowledgement.typ": * #import "theme/abstract.typ": * -#import "theme/glossary.typ": * #import "theme/infos.typ": * = Related work diff --git a/src/thesis/2-reproducibility.typ b/src/thesis/2-reproducibility.typ index 3753f1d..18299ff 100644 --- a/src/thesis/2-reproducibility.typ +++ b/src/thesis/2-reproducibility.typ @@ -6,7 +6,6 @@ #import "theme/leftblank.typ": * #import "theme/acknowledgement.typ": * #import "theme/abstract.typ": * -#import "theme/glossary.typ": * #import "theme/infos.typ": * #import "theme/definition.typ": * diff --git a/src/thesis/3-tools.typ b/src/thesis/3-tools.typ index 129e3ce..7ab3b45 100644 --- a/src/thesis/3-tools.typ +++ b/src/thesis/3-tools.typ @@ -6,7 +6,6 @@ #import "theme/leftblank.typ": * #import "theme/acknowledgement.typ": * #import "theme/abstract.typ": * -#import "theme/glossary.typ": * #import "theme/infos.typ": * #import "theme/definition.typ": * diff --git a/src/thesis/4-conclusion.typ b/src/thesis/4-conclusion.typ index 2e71d81..e2ae6f2 100644 --- a/src/thesis/4-conclusion.typ +++ b/src/thesis/4-conclusion.typ @@ -6,7 +6,6 @@ #import "theme/leftblank.typ": * #import "theme/acknowledgement.typ": * #import "theme/abstract.typ": * -#import "theme/glossary.typ": * #import "theme/infos.typ": * #chapterquote( diff --git a/src/thesis/accessibility.typ b/src/thesis/accessibility.typ index 13d1d8f..be3bdac 100644 --- a/src/thesis/accessibility.typ +++ b/src/thesis/accessibility.typ @@ -1,4 +1,4 @@ -#import "theme/glossary.typ": * +#import "imports/preamble.typ": * #pagebreak(weak: true) diff --git a/src/thesis/extra.typ b/src/thesis/extra.typ index afd421d..f404b0f 100644 --- a/src/thesis/extra.typ +++ b/src/thesis/extra.typ @@ -1,4 +1,4 @@ -#import "theme/glossary.typ": * +#import "imports/preamble.typ": * #heading("Open Source", level: 1, outlined: false) diff --git a/src/thesis/glossary.typ b/src/thesis/glossary.typ deleted file mode 100644 index aea82c5..0000000 --- a/src/thesis/glossary.typ +++ /dev/null @@ -1,199 +0,0 @@ -#import "theme/glossary.typ": * - -#glossary(terms: ( - ( - key: "CC BY 4.0", - short: "CC BY 4.0", - long: "Creative Commons Attribution 4.0 International", - desc: [The Creative Commons Attribution 4.0 International License #cite(,form:"normal") is a widely used license that allows others to distribute, remix, adapt, and build upon your work, even commercially, as long as they credit you for the original creation. This is the most flexible of the CC licenses.], - ), - ( - key: "CDN", - short: "CDN", - long: "Content Delivery Network", - desc: [A content delivery network is a system of distributed servers that deliver web content to a user based on the geographic locations of the user, the origin of the webpage and a content delivery server, making the delivery of content more efficient.], - ), - ( - key: "CICD", - short: "CI/CD", - long: "Continuous Integration/Continuous Deployment", - desc: [Continuous Integration (CI) is a software development practice where developers regularly merge their code changes into a central repository, after which automated builds and tests are run. Continuous Deployment (CD) is a software release process that uses automated testing to validate that changes are safe to deploy to production.], - ), - ( - key: "CPU", - short: "CPU", - long: "Central Processing Unit", - desc: [The CPU is the primary component of a computer that processes instructions. It runs the operating system and applications, constantly receiving input from the user or active software programs. It processes the data and produces outputs. ARM and X86 are two common CPU architectures.], - ), - ( - key: "CRA", - short: "CRA", - long: "Cyber Resilience Act", - desc: [The Cyber Resilience Act #cite(,form:"normal") is a proposed European Union regulation that aims to improve the cybersecurity of digital products and services. It includes provisions for #link()[software supply chain] security, incident reporting, and security certification.], - ), - ( - key: "CS", - short: "CS", - long: "Computer Science", - desc: [The discipline of Computer Science includes the study of algorithms and data structures, computer and network design, modelling data and information processes, and artificial intelligence. Computer Science draws some of its foundations from mathematics and engineering and therefore incorporates techniques from areas such as queueing theory, probability and statistics, and electronic circuit design.], - ), - ( - key: "CycloneDX", - short: "CycloneDX", - desc: [@cyclonedx is an open-format standard baked by the OWASP foundation and Ecma Technical Committee designed to provide comprehensive and interoperable information about the components used within software projects like software bill of materials and advanced supply chain capabilities for cyber risk reduction.], - ), - ( - key: "DevOps", - short: "DevOps", - desc: [DevOps is a set of practices that combines software development (Dev) and IT operations (Ops). It aims to shorten the systems development life cycle and provide #gls("CICD").], - ), - ( - key: "DevSecOps", - short: "DevSecOps", - desc: [ - DevSecOps is an extension of #gls("DevOps") practices that integrates security (Sec) measures at every stage of the software development lifecycle, ensuring that security is a fundamental aspect of development and operations processes. - ], - ), - ( - key: "DSL", - short: "DSL", - long: "Domain Specific Language", - desc: [A domain-specific language is a computer language specialised to a particular application domain. This is in contrast to a general-purpose language, which is broadly applicable across various domains.], - ), - ( - key: "FHS", - short: "FHS", - long: "Filesystem Hierarchy Standard", - desc: [The Filesystem Hierarchy Standard is a reference document that describe the conventions used for the layout of Unix-like operating systems. This includes names, locations, and permissions of many file and directories.], - ), - ( - key: "HL3", - short: "HL3", - long: "Hippocratic Licence 3.0", - desc: [The Hippocratic Licence 3.0 #cite(,form:"normal") is a software license that ensures that software is not used to contribute to human rights abuses or other unethical practices. It is designed to protect users and communities from the potential misuse of software.], - ), - ( - key: "IDE", - short: "IDE", - long: "Integrated Development Environment", - plural: "IDEs", - longplural: "Integrated Development Environments", - desc: [An integrated development environment is a software application that provides comprehensive facilities to computer programmers for software development.], - ), - ( - key: "IEEE", - short: "IEEE", - long: "Institute of Electrical and Electronics Engineers", - desc: [The Institute of Electrical and Electronics Engineers #cite(, form:"normal"), established in 1963, is the world's largest technical professional organisation dedicated to advancing technology for the benefit of humanity. It serves as a professional association for electronic engineering, electrical engineering, and related disciplines.], - ), - ( - key: "MD5", - short: "MD5", - long: "Message Digest 5", - desc: [The MD5 message-digest algorithm is a widely used hash function producing a 128-bit hash value. MD5 was designed by Ronald Rivest in 1991 to replace an earlier hash function MD4, and was specified in 1992 as RFC 1321.], - ), - ( - key: "OCI", - short: "OCI", - long: "Open Container Initiative", - desc: [OCI stands for @opencontainerinitiative, an open governance project for the purpose of creating open industry standards around container formats and runtime. An "OCI image" is a container image that conforms to the OCI image format specification.], - ), - ( - key: "OS", - short: "OS", - long: "Operating System", - plural: "OSes", - longplural: "Operating Systems", - desc: [An operating system is system software that manages computer hardware and software resources, and provides common services for computer programs.], - ), - ( - key: "PDF", - short: "PDF", - long: "Portable Document Format", - desc: [A file format developed by Adobe in the 1990s to present documents, including text formatting and images, in a manner independent of application software, hardware, and operating systems.], - ), - ( - key: "POSIX", - short: "POSIX", - long: "Portable Operating System Interface", - desc: [POSIX is a family of standards specified by the #gls("IEEE") for maintaining compatibility between operating systems.], - ), - ( - key: "PURL", - short: "PURL", - plural: "PURLs", - long: "Package URL", - desc: [A PURL #cite(,form:"normal") is a #gls("URL") string used to identify and locate a software package in a mostly universal and uniform way across programing languages, package managers, packaging conventions, tools, APIs and databases.], - ), - ( - key: "REPL", - short: "REPL", - long: "Read-Eval-Print Loop", - desc: [A read-eval-print loop is an interactive computer programming environment that takes single user inputs, evaluates them, and returns the result to the user.], - ), - ( - key: "SBOM", - short: "SBOM", - plural: "SBOMs", - long: "Software Bill of Materials", - desc: [The software bill of materials is a comprehensive inventory of all components, including libraries, dependencies and versions, that constitute a software product, used for tracking and managing software supply chain security.], - ), - ( - key: "SPDX", - short: "SPDX", - long: "Software Package Data Exchange", - desc: [The @spdx format, created and maintained by the - Linux Foundation, is a standardised way of documenting and communicating the - components, licenses, and copyrights of software packages. It provides a - consistent method for tracking and sharing information about software contents, - particularly in open-source and collaborative environments.], - ), - ( - key: "SHA1", - short: "SHA-1", - long: "Secure Hash Algorithm 1", - desc: [SHA-1 is a hash function which takes an input and produces a 160-bit (20-byte) hash value known as a message digest – typically rendered as 40 hexadecimal digits. It was designed by the United States National Security Agency (NSA), and is a U.S. Federal Information Processing Standard.], - ), - ( - key: "SHA2", - short: "SHA-2", - long: "Secure Hash Algorithm 2", - desc: [SHA-2 is a set of cryptographic hash functions designed by the United States National Security Agency (NSA). It consists of six hash functions with digests (hash values) that are 224, 256, 384 or 512 bits: SHA-224, SHA-256, SHA-384, SHA-512, SHA-512/224, SHA-512/256.], - ), - ( - key: "SE", - short: "SE", - long: "Software Engineering", - desc: [Software Engineering is a computing discipline. It is the systematic application of engineering approaches to the development of software.], - ), - ( - key: "SemVer", - short: "SemVer", - long: "Semantic Versioning", - desc: [Semantic Versioning #cite(, form: "normal") is a versioning scheme for software that uses a three-part version number: `MAJOR.MINOR.PATCH`.], - ), - ( - key: "SRI", - short: "SRI", - long: "Subresource Integrity", - desc: [Subresource Integrity #cite(, form: "normal") is a security feature that allows web developers to ensure that resources they fetch are delivered without unexpected manipulation.], - ), - ( - key: "SVG", - short: "SVG", - long: "Scalable Vector Graphics", - desc: [SVG is an XML-based vector image format.], - ), - ( - key: "SWHID", - short: "SWHID", - long: "Software Heritage Identifier", - desc: [The Software Heritage Identifier #cite(,form:"normal") is a unique identifier for software artifacts, such as source code, that is used to track and reference software across different platforms and systems.], - ), - ( - key: "URL", - short: "URL", - long: "Uniform Resource Locator", - desc: [A URL is a reference to a web resource that specifies its location on a computer network and a mechanism for retrieving it.], - ), -)) diff --git a/src/thesis/imports/preamble.typ b/src/thesis/imports/preamble.typ index fadad8f..ba55a64 100644 --- a/src/thesis/imports/preamble.typ +++ b/src/thesis/imports/preamble.typ @@ -1,8 +1,9 @@ #import "@preview/diagraph:0.3.0": * #import "@preview/codelst:2.0.1": sourcecode, sourcefile -#import "@preview/glossarium:0.4.1": make-glossary, print-glossary, gls, glspl +#import "@preview/glossarium:0.5.0": make-glossary, register-glossary, print-glossary, gls, glspl +#show: make-glossary #import "@preview/xarrow:0.3.1": xarrow, xarrowSquiggly, xarrowTwoHead #import "@preview/hydra:0.4.0": * -#import "@preview/cetz:0.2.2" +#import "@preview/cetz:0.3.1" #import "colors.typ": * #import "workarounds.typ": * diff --git a/src/thesis/main.typ b/src/thesis/main.typ index 1a76032..80ffdaf 100644 --- a/src/thesis/main.typ +++ b/src/thesis/main.typ @@ -34,9 +34,205 @@ disclaimer: include "disclaimer.typ", acknowledgement: include "acknowledgement.typ", abstract: include "abstract.typ", - glossary: include "glossary.typ", accessibility: include "accessibility.typ", - extra: include "extra.typ" + extra: include "extra.typ", + terms: ( + ( + key: "CC BY 4.0", + short: "CC BY 4.0", + long: "Creative Commons Attribution 4.0 International", + description: [The Creative Commons Attribution 4.0 International License #cite(,form:"normal") is a widely used license that allows others to distribute, remix, adapt, and build upon your work, even commercially, as long as they credit you for the original creation. This is the most flexible of the CC licenses.], + ), + ( + key: "CDN", + short: "CDN", + long: "Content Delivery Network", + description: [A content delivery network is a system of distributed servers that deliver web content to a user based on the geographic locations of the user, the origin of the webpage and a content delivery server, making the delivery of content more efficient.], + ), + ( + key: "CICD", + short: "CI/CD", + long: "Continuous Integration/Continuous Deployment", + description: [Continuous Integration (CI) is a software development practice where developers regularly merge their code changes into a central repository, after which automated builds and tests are run. Continuous Deployment (CD) is a software release process that uses automated testing to validate that changes are safe to deploy to production.], + ), + ( + key: "CPU", + short: "CPU", + long: "Central Processing Unit", + description: [The CPU is the primary component of a computer that processes instructions. It runs the operating system and applications, constantly receiving input from the user or active software programs. It processes the data and produces outputs. ARM and X86 are two common CPU architectures.], + ), + ( + key: "CRA", + short: "CRA", + long: "Cyber Resilience Act", + description: [The Cyber Resilience Act #cite(,form:"normal") is a proposed European Union regulation that aims to improve the cybersecurity of digital products and services. It includes provisions for #link()[software supply chain] security, incident reporting, and security certification.], + ), + ( + key: "CS", + short: "CS", + long: "Computer Science", + description: [The discipline of Computer Science includes the study of algorithms and data structures, computer and network design, modelling data and information processes, and artificial intelligence. Computer Science draws some of its foundations from mathematics and engineering and therefore incorporates techniques from areas such as queueing theory, probability and statistics, and electronic circuit design.], + ), + ( + key: "CycloneDX", + short: "CycloneDX", + description: [@cyclonedx is an open-format standard baked by the OWASP foundation and Ecma Technical Committee designed to provide comprehensive and interoperable information about the components used within software projects like software bill of materials and advanced supply chain capabilities for cyber risk reduction.], + ), + ( + key: "DevOps", + short: "DevOps", + description: [DevOps is a set of practices that combines software development (Dev) and IT operations (Ops). It aims to shorten the systems development life cycle and provide #gls("CICD").], + ), + ( + key: "DevSecOps", + short: "DevSecOps", + description: [ + DevSecOps is an extension of #gls("DevOps") practices that integrates security (Sec) measures at every stage of the software development lifecycle, ensuring that security is a fundamental aspect of development and operations processes. + ], + ), + ( + key: "DSL", + short: "DSL", + long: "Domain Specific Language", + description: [A domain-specific language is a computer language specialised to a particular application domain. This is in contrast to a general-purpose language, which is broadly applicable across various domains.], + ), + ( + key: "FHS", + short: "FHS", + long: "Filesystem Hierarchy Standard", + description: [The Filesystem Hierarchy Standard is a reference document that describe the conventions used for the layout of Unix-like operating systems. This includes names, locations, and permissions of many file and directories.], + ), + ( + key: "HL3", + short: "HL3", + long: "Hippocratic Licence 3.0", + description: [The Hippocratic Licence 3.0 #cite(,form:"normal") is a software license that ensures that software is not used to contribute to human rights abuses or other unethical practices. It is designed to protect users and communities from the potential misuse of software.], + ), + ( + key: "IDE", + short: "IDE", + long: "Integrated Development Environment", + plural: "IDEs", + longplural: "Integrated Development Environments", + desc: [An integrated development environment is a software application that provides comprehensive facilities to computer programmers for software development.], + ), + ( + key: "IEEE", + short: "IEEE", + long: "Institute of Electrical and Electronics Engineers", + description: [The Institute of Electrical and Electronics Engineers #cite(, form:"normal"), established in 1963, is the world's largest technical professional organisation dedicated to advancing technology for the benefit of humanity. It serves as a professional association for electronic engineering, electrical engineering, and related disciplines.], + ), + ( + key: "MD5", + short: "MD5", + long: "Message Digest 5", + description: [The MD5 message-digest algorithm is a widely used hash function producing a 128-bit hash value. MD5 was designed by Ronald Rivest in 1991 to replace an earlier hash function MD4, and was specified in 1992 as RFC 1321.], + ), + ( + key: "OCI", + short: "OCI", + long: "Open Container Initiative", + description: [OCI stands for @opencontainerinitiative, an open governance project for the purpose of creating open industry standards around container formats and runtime. An "OCI image" is a container image that conforms to the OCI image format specification.], + ), + ( + key: "OS", + short: "OS", + long: "Operating System", + plural: "OSes", + longplural: "Operating Systems", + description: [An operating system is system software that manages computer hardware and software resources, and provides common services for computer programs.], + ), + ( + key: "PDF", + short: "PDF", + long: "Portable Document Format", + description: [A file format developed by Adobe in the 1990s to present documents, including text formatting and images, in a manner independent of application software, hardware, and operating systems.], + ), + ( + key: "POSIX", + short: "POSIX", + long: "Portable Operating System Interface", + description: [POSIX is a family of standards specified by the #gls("IEEE") for maintaining compatibility between operating systems.], + ), + ( + key: "PURL", + short: "PURL", + plural: "PURLs", + long: "Package URL", + description: [A PURL #cite(,form:"normal") is a #gls("URL") string used to identify and locate a software package in a mostly universal and uniform way across programing languages, package managers, packaging conventions, tools, APIs and databases.], + ), + ( + key: "REPL", + short: "REPL", + long: "Read-Eval-Print Loop", + description: [A read-eval-print loop is an interactive computer programming environment that takes single user inputs, evaluates them, and returns the result to the user.], + ), + ( + key: "SBOM", + short: "SBOM", + plural: "SBOMs", + long: "Software Bill of Materials", + description: [The software bill of materials is a comprehensive inventory of all components, including libraries, dependencies and versions, that constitute a software product, used for tracking and managing software supply chain security.], + ), + ( + key: "SPDX", + short: "SPDX", + long: "Software Package Data Exchange", + description: [The @spdx format, created and maintained by the + Linux Foundation, is a standardised way of documenting and communicating the + components, licenses, and copyrights of software packages. It provides a + consistent method for tracking and sharing information about software contents, + particularly in open-source and collaborative environments.], + ), + ( + key: "SHA1", + short: "SHA-1", + long: "Secure Hash Algorithm 1", + description: [SHA-1 is a hash function which takes an input and produces a 160-bit (20-byte) hash value known as a message digest – typically rendered as 40 hexadecimal digits. It was designed by the United States National Security Agency (NSA), and is a U.S. Federal Information Processing Standard.], + ), + ( + key: "SHA2", + short: "SHA-2", + long: "Secure Hash Algorithm 2", + description: [SHA-2 is a set of cryptographic hash functions designed by the United States National Security Agency (NSA). It consists of six hash functions with digests (hash values) that are 224, 256, 384 or 512 bits: SHA-224, SHA-256, SHA-384, SHA-512, SHA-512/224, SHA-512/256.], + ), + ( + key: "SE", + short: "SE", + long: "Software Engineering", + description: [Software Engineering is a computing discipline. It is the systematic application of engineering approaches to the development of software.], + ), + ( + key: "SemVer", + short: "SemVer", + long: "Semantic Versioning", + description: [Semantic Versioning #cite(, form: "normal") is a versioning scheme for software that uses a three-part version number: `MAJOR.MINOR.PATCH`.], + ), + ( + key: "SRI", + short: "SRI", + long: "Subresource Integrity", + description: [Subresource Integrity #cite(, form: "normal") is a security feature that allows web developers to ensure that resources they fetch are delivered without unexpected manipulation.], + ), + ( + key: "SVG", + short: "SVG", + long: "Scalable Vector Graphics", + description: [SVG is an XML-based vector image format.], + ), + ( + key: "SWHID", + short: "SWHID", + long: "Software Heritage Identifier", + description: [The Software Heritage Identifier #cite(,form:"normal") is a unique identifier for software artifacts, such as source code, that is used to track and reference software across different platforms and systems.], + ), + ( + key: "URL", + short: "URL", + long: "Uniform Resource Locator", + description: [A URL is a reference to a web resource that specifies its location on a computer network and a mechanism for retrieving it.], + ), + ), ) #include "1-introduction.typ" diff --git a/src/thesis/theme/glossary.typ b/src/thesis/theme/glossary.typ deleted file mode 100644 index 4cb936c..0000000 --- a/src/thesis/theme/glossary.typ +++ /dev/null @@ -1,20 +0,0 @@ -#import "../imports/preamble.typ": * -#import "common/metadata.typ": * - -#let glossary( - title: "Glossary", - terms: (), -) = { - pagebreak(weak: true) - - [ - #{ - heading(level: 1, title, outlined: false) - } - ] - - - v(10mm) - - print-glossary(show-all: true, terms) -} diff --git a/src/thesis/theme/template.typ b/src/thesis/theme/template.typ index 7911741..764e6f3 100644 --- a/src/thesis/theme/template.typ +++ b/src/thesis/theme/template.typ @@ -8,9 +8,9 @@ #import selectors: * #let getHeader() = { - locate(loc => { + context { let page-counter = counter(page) - let current = page-counter.at(loc).first() + let current = page-counter.at(here()).first() let chapter = hydra( 1, @@ -36,13 +36,13 @@ if (chapter != none) { [#line(length: 100%, stroke: .2pt + rgb("#000000").lighten(65%))] } - }) + } } #let getFooter() = { - locate(loc => { + context { let page-counter = counter(page) - let current = page-counter.at(loc).first() + let current = page-counter.at(here()).first() let items = ([#current], h(1fr), emph(title)) if calc.even(current) { @@ -50,7 +50,7 @@ } else { items.rev() }.join() - }) + } } #let chapterquote( @@ -61,7 +61,7 @@ ) = { pagebreak() - place(top + left, dx: 45pt, dy:45pt)[ + place(top + left, dx: 45pt, dy: 45pt)[ #rect(width: 50pt, height: 50pt, fill: rgb(125, 125, 125)) ] @@ -109,11 +109,13 @@ disclaimer: none, acknowledgement: none, abstract: none, - glossary: none, accessibility: none, extra: none, + terms: (), body, ) = { + register-glossary(terms) + // --- Page configuration --- set page( margin: page-margin, @@ -154,7 +156,7 @@ // --- Paragraphs --- // Source: https://typst.app/docs/guides/guide-for-latex-users/ set par(justify: true) - show par: set block(spacing: 1em) + set par(spacing: 1em) show ref: it => { let el = it.element @@ -208,7 +210,19 @@ leftblank(weak: false) [#accessibility] [#extra] - [#glossary] + { + pagebreak(weak: true) + + [ + #{ + heading(level: 1, "Glossary", outlined: false) + } + ] + + v(10mm) + + print-glossary(show-all: true, terms) + } leftblank(weak: false) @@ -271,7 +285,9 @@ show math.equation: set text(weight: 400) // --- Figures --- - show figure.caption: it => [*#it.supplement #it.counter.display()*: #it.body] + show figure.caption: it => ( + context [*#it.supplement #it.counter.display()*: #it.body] + ) show figure.where(kind: "table"): set figure.caption(position: top) body }