feat: add scilog how-to

docs/how-to/general/send-messages-to-scilog.md

@@ -0,0 +1,118 @@
+---
+related:
+  - title: Core Services
+    url: learn/system-architecture/overview/core-services.md
+---
+
+# Send messages to SciLog
+
+!!! Info "Overview"
+    Send text, tags, and attachments from the BEC IPython client to a configured [SciLog](https://scilog.psi.ch) messaging service.
+
+## Prerequisites
+
+- You have a running BEC IPython client session.
+- SciLog messaging is enabled for your deployment or session.
+
+!!! tip "Logbook selection"
+
+    BEC automatically configures SciLog to use the logbook associated with the currently active pgroup.
+
+## 1. Create and send a simple message
+
+Create a new SciLog message object from the BEC client and send it:
+
+```py
+msg = bec.messaging.scilog.new()
+msg.add_text("Beamline is ready for alignment.")
+msg.send()
+```
+
+You can also create and send a short message in one line:
+
+```py
+bec.messaging.scilog.new("Beamline checks completed.").send()
+```
+
+## 2. Add formatting and tags
+
+SciLog messages support formatted text and tags:
+
+```py
+msg = bec.messaging.scilog.new()
+msg.add_text("Alignment warning", bold=True, color="yellow")
+msg.add_text(" Check the slit positions before continuing.")
+msg.add_tags(["alignment", "warning"])
+msg.send()
+```
+
+`add_text()` supports:
+
+- `bold=True`
+- `italic=True`
+- `color="red"`, `"yellow"`, `"green"`, `"blue"`, or `"pink"`
+
+BEC adds the default `bec` tag automatically if you do not provide tags yourself.
+
+If you want to change the default tags for the current client session, set them explicitly:
+
+```py
+bec.messaging.scilog.set_default_tags(["bec", "beamline-x", "commissioning"])
+```
+
+## 3. Attach a file
+
+Add attachments from a local path before sending the message:
+
+```py
+msg = bec.messaging.scilog.new("Attached: latest detector snapshot.")
+msg.add_attachment("/path/to/snapshot.png")
+msg.send()
+```
+
+For image attachments, you can also provide display dimensions:
+
+```py
+msg = bec.messaging.scilog.new("Overview image")
+msg.add_attachment("/path/to/overview.png", width=800, height=450)
+msg.send()
+```
+
+Attachments must exist on disk and must be smaller than 5 MB.
+
+## 4. Combine text, tags, and attachments
+
+SciLog messages are built from ordered elements. BEC keeps the order in which you add content, so you can structure a message as text, image, text or in any other sequence that fits your note.
+
+In practice, you will often send all parts together:
+
+```py
+msg = bec.messaging.scilog.new()
+msg.add_text("Beam position before correction:")
+msg.add_attachment("/path/to/before.png", width=700)
+msg.add_text("Beam position after correction:")
+msg.add_attachment("/path/to/after.png", width=700)
+msg.send()
+```
+
+You can also combine formatted text, tags, and attachments in one message:
+
+```py
+msg = bec.messaging.scilog.new()
+msg.add_text("Scan quality check failed.", bold=True, color="red")
+msg.add_text(" See the attached plot for details.")
+msg.add_tags(["quality-check", "scan"])
+msg.add_attachment("/path/to/scan_summary.pdf")
+msg.send()
+```
+
+!!! success "Congratulations!"
+
+    You can now send SciLog messages from the BEC IPython client, add tags, and attach files when needed.
+
+## Common pitfalls
+
+- `bec.messaging.scilog.new()` raises an error if SciLog messaging is not enabled for the current deployment or session.
+- `add_attachment(...)` fails if the file does not exist or is larger than 5 MB.
+- Default tags are added automatically. If you call `set_default_tags(...)`, those tags are used for later messages in the current client session.
+

zensical.toml

@@ -95,6 +95,9 @@ nav = [
     { "Customize BEC" = [
       { "Add Custom NeXuS Structure" = "how-to/customize-bec/add-a-custom-nexus-structure.md" },
     ] },
+    { "Messaging Services" = [
+      { "Send Messages to SciLog" = "how-to/general/send-messages-to-scilog.md" },
+    ] },
   ] },
   { Learn = [
     { "System Architecture" = [