efilrst:0.1.0 (#906)

Author: jmigual

packages/preview/efilrst/0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Joan Marcè i Igual
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/preview/efilrst/0.1.0/README.md

@@ -0,0 +1,39 @@
+# Typst efilrst
+A simple referenceable list library for Typst. If you ever wanted to reference elements in a list by a key, this library is for you. The name comes from "reflist" but sorted alphabetically because we are not allowed to use descriptive names for packages in Typst 🤷🏻‍♂️.
+
+## Example
+
+```typst
+
+#import "@preview/efilrst:0.1.0" as efilrst
+#show ref: efilrst.show-rule
+
+#efilrst.reflist(
+  [My cool constraint A],<c:a>,
+  [My also cool constraint B],<c:b>,
+  [My non-refernceable constraint C],
+  list_style: "C1)",
+  ref_style: "C1",
+  name: "Constraint"
+)
+
+See how my @c:a is better than @c:b.
+```
+
+This generates the following output:
+
+![Example of the typst output. The last sentence reads "See how my Constraint C1 is better than Constraint C2"](img/image.png)
+
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Changelog
+
+### 0.1.0
+
+- Initial release
+
+
+

packages/preview/efilrst/0.1.0/examples/basic.pdf

@@ -0,0 +1,16 @@
+#import "../src/lib.typ" as efilrst
+
+#show ref: efilrst.show-rule
+
+
+#efilrst.reflist(
+  [My cool constraint A],<c:a>,
+  [My also cool constraint B],<c:b>,
+  [My non-refernceable constraint C],
+  list-style: "C1)",
+  ref-style: "C1",
+  name: "Constraint"
+)
+
+See how my @c:a is better than @c:b.
+

packages/preview/efilrst/0.1.0/examples/basic.typ

@@ -0,0 +1,45 @@
+#let reflist(..children, name: "", list-style: "1)", ref-style: "1") = {
+  // Gather children in body-label pairs
+  let childrenArray = children.pos()
+  let childrenPairs = ()
+  
+  for (n, val) in childrenArray.enumerate() {
+    if (type(val) == content) {
+      childrenPairs.push((val, none))
+    } else if (type(val) == label and n > 0) {
+      let (body, lbl) = childrenPairs.last()
+      childrenPairs.last() = (body, val)
+    }
+  }
+  
+  // Insert a metadata to be labeled
+  let children = childrenPairs.enumerate().map(
+    ((n, (body, lbl))) => if (type(lbl) == label) {
+      let num_text = numbering(ref-style, n+1)
+      let m = metadata((reflist_type: "reflist", reflist_n: num_text, reflist_name: name))
+      [#body#m#lbl]
+    }
+    else [
+      #body
+    ]
+  )
+
+  enum(numbering: list-style, ..children)
+}
+
+
+#let show-rule(it) = {
+  if (it.element != none 
+      and it.element.func() == metadata 
+      and type(it.element.value) == dictionary 
+      and it.element.value.at("reflist_type", default: none) == "reflist") {
+    let itv = it.element.value
+    let sup = if (it.supplement != auto) { it.supplement } else { itv.reflist_name }
+    link(it.element.location(), [#sup #itv.reflist_n])
+  } else {
+    it
+  }
+}
+
+
+

packages/preview/efilrst/0.1.0/img/image.png

@@ -0,0 +1,11 @@
+[package]
+name = "efilrst"
+version = "0.1.0"
+entrypoint = "src/lib.typ"
+authors = ["Joan Marcè i Igual <@jmigual>"]
+license = "MIT"
+repository = "https://github.com/jmigual/typst-efilrst"
+keywords = ["typst", "list", "referenceable"]
+compiler = "0.11.0"
+description = "A simple referenceable list library for typst."
+exclude = ["examples/*", "img/*"]