Jak prawidłowo zamieszczać YAML, inny kod lub logi w postach na forum

Przede wszystkim NIE należy używać cytowania!

nie cytować 2024-01-23_22-33


Niestety podstawowy znacznik bloku kodu nie znajduje się w podręcznym menu (obecnie już jest, ale i tak warto znać metody używania tego bez użycia menu - choćby do użytku na githubie) - są to w najprostszym przypadku dwie identyczne osobne linijki - jedna przed blokiem kodu, a druga za nim, w obu wystarczy umieścić po trzy odwrotne apostrofy, to ten znak który na standardowej amerykańskiej klawiaturze (czytaj: “polskiej-programisty”) jest na klawiszu, który obrysowałem na zielono:

klawisz tyldy 2024-01-23_22-56
tradycyjnie ten klawisz bywa zwany klawiszem tyldy, mimo, że tylda ~ jest dostępna na “drugiej układce” tj. z shiftem - mówiąc prosto chodzi o coś takiego: ```
tyle, że umieszczone w osobnej linii. (ze względów technicznych nie można tego napisać by było równocześnie widoczne w poście, a blok kodu w bloku kodu w innym formatowaniu wygląda i tak źle…)

edit
NIE chodzi o zwykły apostrof, ani o cudzysłów… (czyli żaden z tych dwóch, które mamy wspólnie na klawiszu zwykle w okolicach Entera)

edit: Po aktualizacji forum można skorzystać z podręcznego menu do ujęcia kodu wieloliniowego w znaczniki “półautomatycznie” - zaznaczamy cały blok kodu (jeden) i używamy narzędzia Tekst formatowany dostępnego jako pierwsze narzędzie “pod trybikiem”, jeśli mamy więcej bloków kodu czynność powtarzamy dla każdego z nich
trybik-2024-02-09_15-10

Stosowanie tego formatowania jest bardzo ważne, bo YAML (w którym każda spacja jest ważna) nie umieszczony w znacznikach kodu zostaje całkowicie zniszczony mechanizmami markdown.

Oto przykład - tu w znacznikach

items:
  - things:
      thing1: huey
      things2: dewey
      thing3: louie
  - other things:
      key: value

a tu to samo bez nich

items:

  • things:
    thing1: huey
    things2: dewey
    thing3: louie
  • other things:
    key: value

Chyba nie wymaga to komentarza…


W menu ukrytym od ikoną trybika są dostępne inne narzędzia, w tym narzędzie Tekst sformatowany które dodaje pojedyncze odwrotne apostrofy tak aby objęły zaznaczenie, można je wykorzystać aby oznaczyć np. jakieś polecenie, które mieści się w jednej linii i jest stosunkowo krótkie.
Oto przykład na takie wyróżnienie ha os update --version 11.4 niestety to narzędzie nie nadaje się do jakiegokolwiek kodu zawierającego więcej niż jedną linijkę, ani do niczego realnie długiego.


W postach na forum generalnie działa formatowanie Markdown


Od biedy można też użyć BBCode (to dla starych forumowych wyjadaczy - zgodność ze znacznikami stosowanymi od wieków)


Do formatowania można też używać zwykłych znaczników HTML.


ALE

Zalecam Markdown, on działa też na githubie i na wszystkich innych forach bazujących na Discourse (w tym oficjalnym forum HA czy forum AIS).

Wykorzystanie zaawansowane przykład kolorowania kodu

3 polubienia
Licznik energii dwukierunkowy VCX DTS-1946 + ESPHome + Home Asistant
Eastron 630+usr-dr302
Zigbee2MQTT z SONOFF Zigbee 3.0 Dongle Plus problem z uruchomieniem
Pamięć sieciowa - Dysk usb na routerze Tplink - problem
Kolejny termostat w ha
UPS Green Cell I integracja z NUT
ZHA - jak wyłączyć, odinstalować?
Grzanie wody z nadwyżki z PV
Komponent wM-Bus do ESPHome (SzczepanLeon) wersja 3.x - wątek ogólny
Home assistant node red RPi5
Brak dongla w sprzęcie HA
Integracja falownika solplanet z Home Assistant
Komponent wM-Bus do ESPHome (SzczepanLeon) wersja 4.x - wątek ogólny
Nie działa automatyzacja oparta na temperaturze i czasie
Komponent wM-Bus do ESPHome wersja 5.x - wątek ogólny
HA i Tasmota - automatyzacja - czas reakcji
HA i Tasmota - automatyzacja - czas reakcji
Esp-01S ESPHome i programator
HA i Viessmann 050 b0ka
Apator Naxom OP-04 WMBUS -> HOWTO
ESP32 z podstawką - problem z połączeniem
Zakładka Energia w HA i brakujące pomiary jak je uwidocznić
Licznik energii cieplnej Kamstrup Multical 402
Odczyt stanu encji
Komponent wM-Bus do ESPHome (SzczepanLeon) - minomess - liczniki wody
Przycisk (chwilowy) reset
Rolety sterowane autonomicznie + HA
Energa Mój Licznik - custom component
Tasmota parsowanie danych z Modbus
Komponent wM-Bus do ESPHome (SzczepanLeon) wersja 4.x - wątek ogólny
ESPHome OTA Hasło
Aqara Smart Lock U200 problemy z działaniem Matter w HA
Dzielenie/Splitting konfiguracji
ESPHome Moduł przekaźnika z ESP-01S - problem z wykrywaniem urządzeń
EspHome modbus I/O N4D3E16
Prośba o wsparcie gdzie jest blad w konfigu Button-Card
Problem z aktualizacją systemu
Rekuperacja Vents Group ze sterownikiem A11 - integracaja przez uniwersalny moduł sterowania UMS 1
Integracja klimatyzacji Gree z Home Assistant (lokalnie)
Problem z includowaniem pliku YAML
Batmon w HA z MQTT
Brak automatyzacji - chyba coś popsułem w configuration.yaml
Integracja Modbus i licznik energii SDM630
Alternatywa: “odchudzony” komponent ESPHome (wM-BUS) – tylko RF→MQTT, dekodowanie poza ESP ( HA )
Esphome w zewnętrznej sieci -> mqtt + bridge - błąd komunikacji
HA+G13s+RDN=ładowanie pieców akumulacyjnych
OneMeter - monitoring zużycia energii
Eastron 630+usr-dr302
Automatyzacja, jeśli pobór energii spadnie poniżej wartości przez 3 min
Licznik dzialajacych glowic termostatycznych
Problem z odczytaniem stanu sterownika rolet Aqara
Licznik energii dwukierunkowy VCX DTS-1946 + ESPHome + Home Asistant
Rekuperator Thessla, problem z modbusem
Automatyzacja kotłowni na bazie ESPHome
RTL 433 - problemy z instalacją i konfiguracją
Uzupełnianie message o informacje z payload
Tasmota + NSPanel + AppDaemon nie aktualizuje Dashboardu?
Problem z automatyzacją otwierania furtki za pomocą czujnika kamery
Panel Energia - problem z dodaniem encji
Switch do MQTT?
Uruchomienie Sonoff Dongle-E (EFR32MG21) na Proxmox
Brak możliwości akualizacji YAML
Problem w uruchomieniu dodatku Zigbee2Mqtt
Komponent wM-Bus do ESPHome (SzczepanLeon) wersja 3.x - wątek ogólny
HA i KNX - możliwości integracji różnych urządzeń
Wysłanie image entity w powiadomieniu
Tani asystent głosowy na bazie Voice Assistant PE od HA
Tani asystent głosowy na bazie Voice Assistant PE od HA
Ciepłomierz - licznik impulsow
Eastron 630+usr-dr302
Pomoc dla raczkującego
ESPhome nie kompiluje
Karta bramy na dashboard
ESPHome Problem po aktualizacji 2024.6.0
Klient <nieznany> zamknął połączenie
Automatyzacje różnica urządzenie - stan numeryczny
Automatyzacja ogrzewania Yaml dodanie zmiennej
Migracja z MariaDB do SQLite i zmniejszanie rozmiaru bazy danych - mam z tym problem :)
Brak znalezionych jakichkolwiek urządzeń
Brak możliwości akualizacji YAML
Wemos d1 i sterowanie 3 przekaznikami
Kamery w HA- problem z encja
Encja Temperatury
Falownik Growatt - ShineWiFi-X i Grott (proxi)
Zigbee sonoff usb 3.0 dongle plus Brak Urzadzenia
Brak encji light dla żarówki led
Encje temperatur i wizualizacja
BroadLink rm+pro rolety
Zigbee2mqtt przestaje sie komunikować
TUYA - gniazdka
Ustawianie licznika / pomocnika
Problem z połączeniem się z HomeAssistant
Jak wybudzać ekran tabletu
Komponent wM-Bus do ESPHome (SzczepanLeon) wersja 3.x - wątek ogólny
ESP32 problem z konfiguracją
Problem z Zigbee2MQTT - mapa urządzień
BMS Daly PZEM-004T Podłączanie do jednego WT32-ETH01 Kilka UART-ów
Jak uporządkować dane karty custom:button-card
ENIGMA2 w home assistant
Zliczanie czasu działania włącznika
Jak uporządkować dane karty custom:button-card
Klimatyzacja HAIER - jak zintegrować z HA
Problem z konfiguracja Wemos D1mini
Przekaźnik bistabilny GPIO
Integracja klimatyzatora AUX J-Smart
Dwa UPSy Volt Polska i NUT
Dashboard interaktywny 3D
Dlaczego HA nie pokazuje urządzenia połączonego przez zigbee i Zigbee2MQTT?
Inwerter Selfa integracja z HA
Licznik ORNO z RS-485 przestał działać od wersji HA core 2024.3.3
Zmiana przycisków otwierania/zamykania okien
Zmiana koloru kafelki na dashbordzie kiedy pralka zacznie pracować
MQTT - Lan Kontroler LK4 - brak encji w HA
Integracja falownika solplanet z Home Assistant
Awaria Zigbee nie mogę znaleźć rozwiązania
Music Assistant błąd youtub music
Esp32 z wyświetlaczem LCD st7789v i wmbus
ESPhome warunki if, else
Odczyt stanu binary_sensor on boot w ESPHOME
Automatyzacja warunek po godzinie
ESPHOME + stycznik impulsowy - nie odczytuje stanu
Espressif ESP32-S3-BOX-3
Problem z urządzeniem Sonoff Zbmini
Athom E14 Color Bulb komponent WLED efekt w ESPHome
Encja switch z http
Komponent wM-Bus do ESPHome (SzczepanLeon) wersja 3.x - wątek ogólny
HA Modbus TCP + Siemens S7-1200
Jak ustawić aby powiadomienie było tylko 1 raz w ciągu
Esphome przełączanie stron wyswietlacza Lcd2004
Bilans energii godzinowy
Przesiadka z Raspberry na proxmox
Nie widzę urządzeń jak chcę zrobić automatyzację
ESPHome - falownik / inwerter Anenji
Czujnik parametrów środowiska BME680 i ESPHome
Światło zewnętrzne po zachodzie słońca
Czujnik poziomu cieczy mojdomek.eu i jego integracja za pomocą rest
Światło zewnętrzne po zachodzie słońca
HA i sterowanie kotłem gazowym Vaillant VC 206/5-5
Klimatyzacja HAIER - jak zintegrować z HA
Pamięć sieciowa - Dysk usb na routerze Tplink - problem
ESPHOME + stycznik impulsowy - nie odczytuje stanu
Sensor otwarcia stan wyłącznika włączony - wyłączony
Komponent wM-Bus do ESPHome wersja 4.x - vitkuv fork (ESP32-S3)
Modbus RS485 Podstawowa konfiguracja problem z komunikacją z HA
Monitoring Sofar Solar + RS485
Fox Gate jak dodać do Home Assistant
Rekuperator Thessla, problem z modbusem
Czujnik temperatury i wilgotności z zewnętrzną sondą
MQTT - "Connection refused" i brak kluczy
Zigbee2MQTT przestaje działać po pewnym czasie
Assist Microphone - nie działa wybudzanie słowem
Dziwny problem przy kompilacji ESP
Restart dodatku, np. eWeLink
Shelly addon ds18b20 komunikacja mqtt
Komponent wM-Bus do ESPHome (SzczepanLeon) wersja 3.x - wątek ogólny
Utrata danych w panelu energia
Pomocnicy/helpers a konfiguracja yaml
[Sprzedam] UltimateReader - czytnik wM-Bus
Dzienne i miesięczne zużycie
Aktualizacja configuration.yaml
Żyroskop i akcelerometr InvenSense/TDK MPU6050 na ESP32-S3
Odczyt stanu binary_sensor on boot w ESPHOME
WANAS Combo 430 - integracja z rekuperatorem po Modbus RTU (RS485)
Home Assistant integracja climate
Powiadomienie poranne z poziomu automatyzacji HA.Szablon
Tasmota łączy z HA ale on jej nie widzi
ESP32 i podwójne zliczanie impulsów
HA Sterowanie Piecem Vaillant VC20CS/1-5 + VRC 720
Zigbee2MQTT z SONOFF Zigbee 3.0 Dongle Plus problem z uruchomieniem

Jakby co, “tekst preformatowany” nie jest już pod trybikiem tylko na głównym pasku edytora iwygląda tak
</>

U jednych jest osobnym elementem menu, a u innych nie - to zależy od wielu czynników.


nie będziemy robili licytacji których przypadków jest więcej (zależy to głównie od rozdzielczości ekranu i przeglądarki).

Miałem też dodać kiedyś, że w przypadku szczególnie długich fragmentów kodu lub zawierających wiodące komentarze rozpoznawanie formatu często nie jest skuteczne (co w sumie jest istotne tylko względem kolorowania tekstu)
więc jeśli chcemy mieć ładnie pokolorowany YAML to jako znacznik otwierający powinno być coś takiego

```yaml