Mathemensch/circuiteria
2
0
Fork 0
forked from HEL/circuiteria
Code Pull Requests Activity

Merge branch 'dev' into comp/electrical

Browse Source
This commit is contained in:
Louis Heredero
2025-03-31 13:05:43 +02:00
parent ac3e577020 2bb7e3b5a9
commit b7dd2cb718
31 changed files with 63 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
manual.typ
View File

@ -1,5 +1,5 @@
#import "@preview/tidy:0.3.0"
#import "@preview/cetz:0.2.2": draw, canvas
#import "@preview/tidy:0.4.1"
#import "@preview/cetz:0.3.2": draw, canvas
#import "src/lib.typ"
#import "doc/examples.typ"
#import "src/circuit.typ": circuit
@ -13,7 +13,7 @@
numbering("1.1", ..num)
})
#{
outline(indent: true, depth: 3)
outline(indent: auto, depth: 3)
}
#show link: set text(blue)
@ -48,7 +48,7 @@
#set page(numbering: "1/1", header: align(right)[circuiteria #sym.dash.em v#lib.version])
#set page(
header: locate(loc => {
header: context {
let txt = [circuiteria #sym.dash.em v#lib.version]
let cnt = counter(heading)
let cnt-val = cnt.get()
@ -66,8 +66,8 @@
#rect(width: 100%, height: .5em, radius: .25em, stroke: none, fill: util.colors.values().at(i))
]
)
}),
footer: locate(loc => {
},
footer: context {
let cnt = counter(heading)
let cnt-val = cnt.get()
if cnt-val.len() < 2 { return }
@ -81,12 +81,12 @@
],
counter(page).display("1/1", both: true)
)
})
}
)
#let doc-ref(target, full: false, var: false) = {
let (module, func) = target.split(".")
let label-name = module + func
let label-name = module + "-" + func
let display-name = func
if full {
display-name = target
@ -95,7 +95,7 @@
label-name += "()"
display-name += "()"
}
link(label(label-name))[#display-name]
link(label(label-name), raw(display-name))
}
= Introduction
@ -104,11 +104,21 @@ This package provides a way to make beautiful block circuit diagrams using the C
= Usage
Simply import #link("src/lib.typ") and call the `circuit` function:
Simply import Circuiteria and call the `circuit` function:
#pad(left: 1em)[```typ
#import "src/lib.typ"
#lib.circuit({
import lib: *
#import "@preview/circuiteria:0.2.0"
#circuiteria.circuit({
import circuiteria: *
...
})
```]
== Project installation
If you have installed Circuiteria directly in your project, import #link("src/lib.typ") and call the `circuit` function:
#pad(left: 1em)[```typ
#import "src/lib.typ" as circuiteria
#circuiteria.circuit({
import circuiteria: *
...
})
```]
@ -118,6 +128,7 @@ Simply import #link("src/lib.typ") and call the `circuit` function:
#let circuit-docs = tidy.parse-module(
read("src/circuit.typ"),
name: "circuit",
old-syntax: true,
require-all-parameters: true
)
#tidy.show-module(circuit-docs)
@ -127,6 +138,7 @@ Simply import #link("src/lib.typ") and call the `circuit` function:
#let util-docs = tidy.parse-module(
read("src/util.typ"),
name: "util",
old-syntax: true,
require-all-parameters: true,
scope: (
util: util,
@ -141,6 +153,7 @@ Simply import #link("src/lib.typ") and call the `circuit` function:
#let wire-docs = tidy.parse-module(
read("src/wire.typ"),
name: "wire",
old-syntax: true,
require-all-parameters: true,
scope: (
wire: wire,
@ -162,6 +175,7 @@ Simply import #link("src/lib.typ") and call the `circuit` function:
read("src/elements/multiplexer.typ") + "\n" +
read("src/elements/group.typ"),
name: "element",
old-syntax: true,
scope: (
element: element,
circuit: circuit,
@ -184,6 +198,7 @@ Simply import #link("src/lib.typ") and call the `circuit` function:
read("src/elements/logic/or.typ") + "\n" +
read("src/elements/logic/xor.typ"),
name: "gates",
old-syntax: true,
scope: (
element: element,
circuit: circuit,