iobroker.autodoc 0.9.42 → 0.9.44
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -19
- package/admin/i18n/de.json +8 -7
- package/admin/i18n/en.json +8 -7
- package/admin/i18n/es.json +8 -7
- package/admin/i18n/fr.json +8 -7
- package/admin/i18n/it.json +8 -7
- package/admin/i18n/nl.json +8 -7
- package/admin/i18n/pl.json +8 -7
- package/admin/i18n/pt.json +8 -7
- package/admin/i18n/ru.json +8 -7
- package/admin/i18n/uk.json +8 -7
- package/admin/i18n/zh-cn.json +8 -7
- package/admin/jsonConfig.json +12 -0
- package/io-package.json +37 -50
- package/lib/chapterConfigWarnings.js +295 -0
- package/lib/docTemplateConfig.js +1 -0
- package/lib/documentModel.js +3 -0
- package/lib/htmlRenderer.js +1 -1
- package/lib/quickStartGuide.js +26 -13
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Automatically generates structured documentation (HTML, Markdown, JSON) for your ioBroker installation — on demand, on a schedule, or when the system changes.
|
|
6
6
|
|
|
7
|
-
**Version:** 0.9.
|
|
7
|
+
**Version:** 0.9.44
|
|
8
8
|
|
|
9
9
|
**Installation**
|
|
10
10
|
|
|
@@ -126,17 +126,19 @@ flowchart LR
|
|
|
126
126
|
**Tips**
|
|
127
127
|
|
|
128
128
|
- Stick to **supported Mermaid** constructs you have seen working elsewhere; exotic directives may break `mmdc`.
|
|
129
|
-
- **Auto host topology** is separate (`autoMermaidHostGraph`); hide it with
|
|
129
|
+
- **Auto host topology** is separate (`autoMermaidHostGraph`); hide it with **`mermaidAuto`** in **Admin/User** hide lists (see `EXTRA_HIDDEN_CHAPTER_IDS` in `lib/docTemplateConfig.js`). The **manual** Mermaid diagram lives under **`manual`** on **Admin** — hide that chapter if you want it gone. On **User**, field help lists **`mermaid`** and **`mermaidAuto`** separately; on **Onboarding**, use **`mermaid`** for the owner diagram in the welcome area (see that tab’s help).
|
|
130
130
|
|
|
131
131
|
<h3 id="json-cookbook-snippets">JSON cookbook snippets</h3>
|
|
132
132
|
|
|
133
133
|
Admin stores these fields as **strings**; content must be **valid JSON** (`"` keys/strings, no trailing commas). Empty roster means defaults: use **`[]`** where you do not want to override order or hide anything.
|
|
134
134
|
|
|
135
|
+
German **scenario page** (“hide first vs reorder”, copy-paste walkthrough anchored to Step 6): **[`README.de.md` — Wiki — Step 6](https://github.com/crunchip77/ioBroker.autodoc/blob/main/docs/user-guide/README.de.md#wiki-admin-json-cookbook)** (`docs/user-guide/`).
|
|
136
|
+
|
|
135
137
|
**Allowed chapter ids** come from the adapter (`lib/docTemplateConfig.js`):
|
|
136
138
|
|
|
137
139
|
| Profile | Order fields | Hidden fields | Notes |
|
|
138
140
|
| --- | --- | --- | --- |
|
|
139
|
-
| Admin | `adminChapterOrderJson` | `adminHiddenChaptersJson` | Order default: `manual`, `system`,
|
|
141
|
+
| Admin | `adminChapterOrderJson` | `adminHiddenChaptersJson` | Order default: `manual`, `system`, …, `appendices`. Extra hide-only id: **`mermaidAuto`** (auto-host topology). The **manual** Mermaid diagram is part of **`manual`** — omit that chapter entirely to drop it from Admin exports. |
|
|
140
142
|
| User | `userChapterOrderJson` | `userHiddenChaptersJson` | Keys include `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting`. |
|
|
141
143
|
| Onboarding | `onboardingChapterOrderJson` | `onboardingHiddenChaptersJson` | Keys include `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual`. |
|
|
142
144
|
|
|
@@ -226,26 +228,23 @@ For **roadmap and planning**: [`TODO.md`](TODO.md) (open work at the top, full c
|
|
|
226
228
|
- **Gehosteter Checker / iobroker.dev:** häufig **504** oder Timeouts; lokal `npm run adapter-check` kann **E9999** im **`--local`‑Pfad liefern (**CONTRIBUTING**) — Releases an **CI** und **`npm test`** festmachen, nicht nur an der Web-UI.
|
|
227
229
|
- **Roadmap:** laufende Themen vor allem in **[`TODO.md`](TODO.md)** und **[`PLAN.md`](PLAN.md)**; diesen Abschnitt vor dem nächsten Release in eine neue **`### x.y.z`**-Sektion übernehmen oder kürzen.
|
|
228
230
|
|
|
229
|
-
### 0.9.
|
|
230
|
-
|
|
231
|
-
- **npm / process:** Patch **0.9.42** — **no functional change** vs **0.9.41**; `package.json` / `io-package.json` / README **`Version:`** aligned for npm publish only (release-script housekeeping).
|
|
231
|
+
### 0.9.44 (2026-05-14)
|
|
232
232
|
|
|
233
|
-
|
|
233
|
+
- **Chapter JSON & logs:** Each documentation run evaluates Admin/User/Onboarding chapter order and hide JSON. **English** adapter **`warn`** lines report invalid JSON shape, **unknown** chapter ids, and **duplicate** ids, with a pointer to the **[German user guide — JSON cookbook](https://github.com/crunchip77/ioBroker.autodoc/blob/main/docs/user-guide/README.de.md#wiki-admin-json-cookbook)**. Identical warning **lines** are **deduplicated** per adapter **log** reference (process lifetime). Values read only from **legacy** native keys are labeled **`…Json via native …`** in the log. **`lib/chapterConfigWarnings.js`**; wired from **`DocumentModel.buildDocumentModel`**. **`EXTRA_HIDDEN_CHAPTER_IDS`** exported from **`docTemplateConfig`** for hide-list validation.
|
|
234
|
+
- **Admin i18n:** Extended **`?`** help for the six chapter order/hide JSON fields (log + GitHub links under **Which chapters to show (per profile)**) — **DE/FR** translated, **EN** + other locales as fallbacks.
|
|
235
|
+
- **Quick Start (5.x.2):** Room highlight **`HIGHLIGHT_CATEGORY_RANK`** extended (**`leak`**, **`co2`**, **`valve`**, **`weather`**, **`sensor`**, …); function areas with equal **member count** tie-break by **name**.
|
|
236
|
+
- **HTML template:** **`RENDERER_VERSION`** in **`lib/htmlRenderer.js`** bumped so instances that skip “generate on start” still **regenerate once** after the adapter update (**`info.templateVersion`** vs renderer marker).
|
|
237
|
+
- **Docs maintainer:** **`docs/user-guide/assets/SCREENSHOTS.md`** notes that tooltip-only changes often need **no** new PNG.
|
|
234
238
|
|
|
235
|
-
|
|
239
|
+
### 0.9.43 (2026-05-13)
|
|
236
240
|
|
|
237
|
-
|
|
241
|
+
- **Admin / Adapter Checker:** **`common.news`** lists only semver versions that exist as tarballs on **npm** (ioBroker Adapter Checker **E2004**). Removed **`news`** keys **0.9.39**, **0.9.40**, and **0.9.41** — those bumps never shipped to the registry between **0.9.38** and **0.9.42**. Full narrative for **0.9.41–0.9.39** is kept in **`CHANGELOG_OLD.md`** (README changelog window matches the **`common.news`** version set).
|
|
242
|
+
- **`common.news` copy:** **0.9.42** admin news now compares against **0.9.38** (last npm release before **0.9.42**).
|
|
243
|
+
- **Runtime:** unchanged.
|
|
238
244
|
|
|
239
|
-
|
|
240
|
-
- **Lint:** JSDoc **`@param` / `@returns` descriptions** completed for **`lib/docChangeFormat.js`** (clean **`npm run lint`**).
|
|
241
|
-
- **Runtime:** no adapter behaviour or export pipeline change in this patch release.
|
|
242
|
-
|
|
243
|
-
### 0.9.39 (2026-05-13)
|
|
245
|
+
### 0.9.42 (2026-05-13)
|
|
244
246
|
|
|
245
|
-
- **
|
|
246
|
-
- **Docs / links:** **`readme`** in `io-package.json`, **`homepage`** in `package.json`, and Admin **`staticLink`** help URLs use GitHub **`main`** (`blob/main/…`) so default-branch installs match help targets.
|
|
247
|
-
- **Localization & exports:** **Documentation language** drives one-line saved **changelog** rows and **“changes since last run”** / compare text. **`hideAdminDeltaSinceLastRun`** still hides only the yellow **Admin** delta box + matching Admin Markdown subsection. **User / Family:** short plain-language inventory-change notice when the snapshot differs (skipped on first run / no changes); **Onboarding** unchanged.
|
|
248
|
-
- **Docs — wiki & cookbook:** **`docs/user-guide/README(.de).md`** refresh; README [**Mermaid**](#mermaid-cookbook-examples) / [**JSON**](#json-cookbook-snippets) / [**CSS**](#html-custom-css-examples) cookbooks maintained for copy-paste. **Export copy** (Admin HTML/Markdown): **Betrieb — Referenz** disclaimer, **Diagnose** framing, onboarding chapter-order help (**`quickstart`** vs discovery).
|
|
247
|
+
- **npm / process:** Patch **0.9.42** — **no functional change** vs **0.9.38** (previous tarball on npm before **0.9.42**); `package.json` / `io-package.json` / README **`Version:`** aligned for npm publish only (release-script housekeeping).
|
|
249
248
|
|
|
250
249
|
### 0.9.38 (2026-05-12)
|
|
251
250
|
|
|
@@ -270,6 +269,6 @@ For **roadmap and planning**: [`TODO.md`](TODO.md) (open work at the top, full c
|
|
|
270
269
|
|
|
271
270
|
MIT License
|
|
272
271
|
|
|
273
|
-
<!-- Maintainer: Admin staticLinks —
|
|
272
|
+
<!-- Maintainer: Admin staticLinks — under chapter visibility: English README `#json-cookbook-snippets`, Wiki DE `#wiki-admin-json-cookbook`. Schnellzugriff in README.de; SCREENSHOTS table for PNG drift; Sync jsonConfig/i18n if URLs change. -->
|
|
274
273
|
|
|
275
274
|
Copyright (c) 2026 crunchip77 <41550245+crunchip77@users.noreply.github.com>
|
package/admin/i18n/de.json
CHANGED
|
@@ -193,7 +193,7 @@
|
|
|
193
193
|
"AI context hints hint": "Nur für die KI — erscheint nicht in exportierten Dokumenten. Kurze Stichpunkte mit konkreten Fakten (Räume, Zeiten, Abläufe); pauschales Geschwätz hilft dem Modell wenig.\n\nGast-Onboarding: Alltagssprache. Viel Admin- oder IT-Jargon kann bewirken, dass für Besucher neutraler Standardtext statt Rohtext ausgegeben wird. Im User-/Familienprofil gilt dieser Filter nicht.\n\nBeispiele: `- Licht Wohnzimmer aus um 22:30` · `- Gast-WLAN wie auf dem Router`",
|
|
194
194
|
"AI context hints help": "Nur für den KI-Prompt — wird nicht in HTML-/Markdown-Exporte übernommen. Wird bei jedem Lauf an den KI-Anbieter gesendet. Gästeprofil: dichter Admin-/IT-Jargon kann neutralen Standardtext für Besucher erzeugen (grauer Kasten). Lieber klare Fakten, z. B. `- Schlafzimmer-Rollladen um 22:00 zu`.",
|
|
195
195
|
"HTML export & extra sections": "HTML-Export & Zusatzkapitel",
|
|
196
|
-
"Doc layout intro": "HTML (Admin, User, Onboarding): Theme & Logo oben, Kapitelsichtbarkeit und eigene Abschnitte in der Mitte, optionale Schrift / zusätzliches CSS unten.\n\nAusblenden und Reihenfolge gelten für Markdown ebenso, wenn dasselbe Dokumentationsprofil unter Grundeinstellungen gewählt ist.",
|
|
196
|
+
"Doc layout intro": "HTML (Admin, User, Onboarding): Theme & Logo oben, Kapitelsichtbarkeit und eigene Abschnitte in der Mitte, optionale Schrift / zusätzliches CSS unten.\n\nAusblenden und Reihenfolge gelten für Markdown ebenso, wenn dasselbe Dokumentationsprofil unter Grundeinstellungen gewählt ist.\n\nUnter **Sichtbare Kapitel (je Profil)** führen die GitHub-Links zum englischen JSON-Kochbuch (Schnipsel) und zum **deutschen Wiki Schritt 6** (Ausblenden & Reihenfolge mit Rezepttext).",
|
|
197
197
|
"Doc layout pdf hint": "PDF: unter Erweitert (unter Dateisystem-Export). Optional nach jedem Lauf oder jederzeit per `action.exportPdf`.\n\nBraucht `puppeteer` im Adapterordner; schreibt `autodoc-*.pdf` unter Dateien (und bei gesetztem Pfad dorthin).",
|
|
198
198
|
"Advanced HTML styling (optional)": "Fortgeschritten: HTML-Styling (optional)",
|
|
199
199
|
"Advanced HTML styling hint": "Optional / für Erfahrene: Eigene Schrift und CSS verändern die Darstellung der exportierten HTML-Dateien. Tippfehler oder künftige AutoDoc-Updates können das Layout stören — Felder leer lassen, wenn du dir unsicher bist.",
|
|
@@ -217,10 +217,10 @@
|
|
|
217
217
|
"Admin HTML — hide chapters": "Admin-HTML — Kapitel ausblenden",
|
|
218
218
|
"Admin chapter order hint": "Optional: Reihenfolge für Admin-HTML und Admin-Markdown (Inhaltsverzeichnis + Fließtext) im ersten JSON-Feld eintragen (`[]` = eingebaute Reihenfolge). Fehlende Kapitel hängt AutoDoc in Standard-Reihenfolge hinten an. Die vollständige Liste gültiger englischer Kapitel-Ids steht nur in der Hilfe dieses Feldes (Tooltip/`?`) — hier nicht wiederholt.",
|
|
219
219
|
"Admin chapter order (JSON array)": "Reihenfolge Admin-Kapitel (JSON-Array)",
|
|
220
|
-
"Admin chapter order JSON help": "JSON-Array mit Kapitel-Ids, z. B. `[\"system\",\"adapters\",\"manual\"]`. Gültige Ids (exakt Englisch): `manual`, `system`, `adapters`, `rooms`, `scripts`, `schedule`, `userdata`, `aliases`, `maintenance`, `diagnosis`, `troubleshooting`, `custom`, `changelog`, `appendices`. Unbekannte Ids werden übersprungen; fehlende Ids folgen in Standardreihenfolge. `[]` = eingebaute Reihenfolge.",
|
|
220
|
+
"Admin chapter order JSON help": "JSON-Array mit Kapitel-Ids, z. B. `[\"system\",\"adapters\",\"manual\"]`. Gültige Ids (exakt Englisch): `manual`, `system`, `adapters`, `rooms`, `scripts`, `schedule`, `userdata`, `aliases`, `maintenance`, `diagnosis`, `troubleshooting`, `custom`, `changelog`, `appendices`. Unbekannte Ids werden übersprungen; fehlende Ids folgen in Standardreihenfolge. `[]` = eingebaute Reihenfolge.\n\nWenn Reihenfolge oder Ausblenden „nichts bewirkt“: Im **Adapter-Log** nach übersprungenen unbekannten oder doppelten Ids bei jedem Dokumentations-Lauf prüfen. Rezepte: die **zwei GitHub-Links** unter **Sichtbare Kapitel (je Profil)** auf diesem Tab.",
|
|
221
221
|
"Admin hidden chapters hint": "JSON-Liste der Kapitel-Ids, die im Admin-HTML und im Markdown (Profil Admin) ausgeblendet werden, z. B. `[\"diagnosis\",\"custom\"]`. Dieselben gültigen Ids wie bei der Reihenfolge; die vollständige Namensliste nur in der Hilfe zum Feld Reihenfolge Admin-Kapitel weiter unten. Ungültige Einträge werden ignoriert.",
|
|
222
222
|
"Hidden chapter IDs (JSON array)": "Ausgeblendete Kapitel (JSON-Array)",
|
|
223
|
-
"Admin hidden chapters JSON help": "JSON-Array, z. B. `[\"userdata\",\"aliases\"]`. Dieselben gültigen Ids wie bei der Admin-Reihenfolge (siehe dort). `[]` = alle Kapitel anzeigen.",
|
|
223
|
+
"Admin hidden chapters JSON help": "JSON-Array, z. B. `[\"userdata\",\"aliases\"]`. Dieselben gültigen Ids wie bei der Admin-Reihenfolge (siehe dort). `[]` = alle Kapitel anzeigen.\n\nWenn Reihenfolge oder Ausblenden „nichts bewirkt“: Im **Adapter-Log** nach übersprungenen unbekannten oder doppelten Ids bei jedem Dokumentations-Lauf prüfen. Rezepte: die **zwei GitHub-Links** unter **Sichtbare Kapitel (je Profil)** auf diesem Tab.",
|
|
224
224
|
"Custom Markdown sections": "Eigene Markdown-Kapitel",
|
|
225
225
|
"Custom sections JSON hint": "JSON-Array von Objekten: `{ \"title\": \"WLAN\", \"body\": \"Gast …\", \"profiles\": [\"user\",\"onboarding\"] }`. body ist Markdown (kein rohes HTML). profiles optional — weglassen = alle drei HTML-Profile. Max. 12 Kapitel; sehr langer Text wird gekürzt. Typisch: Notfallkontakte, WLAN, Router.",
|
|
226
226
|
"Custom sections (JSON)": "Eigene Kapitel (JSON)",
|
|
@@ -228,23 +228,24 @@
|
|
|
228
228
|
"User/Family HTML — hide chapters": "User/Familie-HTML — Kapitel ausblenden",
|
|
229
229
|
"User hidden chapters hint": "JSON-Array von Kapitel-Ids für User/Familie-HTML und Markdown (Profil User). Erlaubt: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid` (manuelles Mermaid-Diagramm), `mermaidAuto` (automatisches Host-Topologie-Diagramm — im Onboarding nie sichtbar), `adapters`, `custom`, `system`, `troubleshooting`.",
|
|
230
230
|
"User profile — hidden chapter IDs (JSON)": "User-Profil — ausgeblendete Kapitel (JSON)",
|
|
231
|
-
"User hidden chapters JSON help": "JSON-Array, z. B. `[\"scripts\",\"adapters\"]`. Ungültige Ids werden ignoriert. `[]` = alles anzeigen.",
|
|
231
|
+
"User hidden chapters JSON help": "JSON-Array, z. B. `[\"scripts\",\"adapters\"]`. Ungültige Ids werden ignoriert. `[]` = alles anzeigen.\n\nWenn Reihenfolge oder Ausblenden „nichts bewirkt“: Im **Adapter-Log** nach übersprungenen unbekannten oder doppelten Ids bei jedem Dokumentations-Lauf prüfen. Rezepte: die **zwei GitHub-Links** unter **Sichtbare Kapitel (je Profil)** auf diesem Tab.",
|
|
232
232
|
"User chapter order hint": "Optional: Reihenfolge der User/Familie-HTML-Kapitel und des User-Markdowns anpassen. Gültige Ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting` – ungenannte Ids werden in Standardreihenfolge angehängt. Leer `[]` = Standardreihenfolge. `atAGlance` erscheint nur, wenn der strukturierte Schnellstart Daten hat (Discovery); Umsortieren erzeugt diesen Inhalt nicht.",
|
|
233
233
|
"User chapter order (JSON array)": "Reihenfolge User-Kapitel (JSON-Array)",
|
|
234
|
-
"User chapter order JSON help": "JSON-Array mit Kapitel-Ids, z. B. `[\"atAGlance\",\"rooms\",\"manual\",\"adapters\"]`. Gültige Ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting`. Unbekannte Ids werden übersprungen; fehlende Ids folgen in Standardreihenfolge. `[]` = eingebaute Reihenfolge. `atAGlance` nur bei Schnellstart-Inhalt.",
|
|
234
|
+
"User chapter order JSON help": "JSON-Array mit Kapitel-Ids, z. B. `[\"atAGlance\",\"rooms\",\"manual\",\"adapters\"]`. Gültige Ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting`. Unbekannte Ids werden übersprungen; fehlende Ids folgen in Standardreihenfolge. `[]` = eingebaute Reihenfolge. `atAGlance` nur bei Schnellstart-Inhalt.\n\nWenn Reihenfolge oder Ausblenden „nichts bewirkt“: Im **Adapter-Log** nach übersprungenen unbekannten oder doppelten Ids bei jedem Dokumentations-Lauf prüfen. Rezepte: die **zwei GitHub-Links** unter **Sichtbare Kapitel (je Profil)** auf diesem Tab.",
|
|
235
235
|
"Onboarding HTML — hide chapters": "Onboarding-HTML — Kapitel ausblenden",
|
|
236
236
|
"Onboarding hidden chapters hint": "Blöcke im Onboarding-HTML und passende Teile im Markdown (Profil Onboarding) ausblenden. Ids: `welcome`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid` (Diagramm im Begrüßungsbereich), `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, zusätzlich für Markdown `quickstart`, `system`, `manual`.",
|
|
237
237
|
"Onboarding profile — hidden chapter IDs (JSON)": "Onboarding-Profil — ausgeblendete Kapitel (JSON)",
|
|
238
|
-
"Onboarding hidden chapters JSON help": "JSON-Array, z. B. `[\"adapters\",\"stats\"]`. Ungültige Ids werden ignoriert. `[]` = alles anzeigen.",
|
|
238
|
+
"Onboarding hidden chapters JSON help": "JSON-Array, z. B. `[\"adapters\",\"stats\"]`. Ungültige Ids werden ignoriert. `[]` = alles anzeigen.\n\nWenn Reihenfolge oder Ausblenden „nichts bewirkt“: Im **Adapter-Log** nach übersprungenen unbekannten oder doppelten Ids bei jedem Dokumentations-Lauf prüfen. Rezepte: die **zwei GitHub-Links** unter **Sichtbare Kapitel (je Profil)** auf diesem Tab.",
|
|
239
239
|
"Onboarding chapter order hint": "Optional: Reihenfolge der Onboarding/Gast-HTML-Kapitel und des Onboarding-Markdowns anpassen.\n\nGültige Ids: `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual` – ungenannte Ids werden angehängt.\n\nLeer `[]` = Standardreihenfolge.\n\n`quickstart` enthält immer Begrüßung, Adapter-Zahlen und Nächste Schritte; den Discovery-Schnappschuss (Räume / Setup-Zeilen aus der Installation) nur, wenn dafür Daten da sind.",
|
|
240
240
|
"Onboarding chapter order (JSON array)": "Reihenfolge Onboarding-Kapitel (JSON-Array)",
|
|
241
|
-
"Onboarding chapter order JSON help": "JSON-Array mit Kapitel-Ids, z. B. `[\"quickstart\",\"tips\",\"rooms\",\"adapters\"]`. Gültige Ids: `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual`. Unbekannte Ids werden übersprungen; fehlende Ids folgen in Standardreihenfolge. `[]` = eingebaute Reihenfolge. `quickstart`: immer Begrüßung, Zähler, Nächste Schritte; Discovery-Block nur bei `quickStart.hasContent
|
|
241
|
+
"Onboarding chapter order JSON help": "JSON-Array mit Kapitel-Ids, z. B. `[\"quickstart\",\"tips\",\"rooms\",\"adapters\"]`. Gültige Ids: `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual`. Unbekannte Ids werden übersprungen; fehlende Ids folgen in Standardreihenfolge. `[]` = eingebaute Reihenfolge. `quickstart`: immer Begrüßung, Zähler, Nächste Schritte; Discovery-Block nur bei `quickStart.hasContent`.\n\nWenn Reihenfolge oder Ausblenden „nichts bewirkt“: Im **Adapter-Log** nach übersprungenen unbekannten oder doppelten Ids bei jedem Dokumentations-Lauf prüfen. Rezepte: die **zwei GitHub-Links** unter **Sichtbare Kapitel (je Profil)** auf diesem Tab.",
|
|
242
242
|
"Advanced base URL callout": "Gäste / QR / Link kopieren: dieselbe URL wie im Handy-Browser, um den ioBroker-Admin zu öffnen (Schema + Host + Port, ohne / am Ende). Wenn das von Docker-internen Namen oder der öffentlichen Proxy-Adresse abweicht, explizit eintragen — automatische Erkennung scheitert oft in Containern oder hinter HTTPS-Offloading.",
|
|
243
243
|
"copyForForum": "Für Forum kopieren",
|
|
244
244
|
"Docs link README public base URL": "README — Basis-URL / QR (GitHub)",
|
|
245
245
|
"Docs link wiki German config": "Wiki — Instanz-Konfiguration DE (GitHub)",
|
|
246
246
|
"Docs link README Mermaid cookbook": "README — Mermaid-Kochbuch (GitHub)",
|
|
247
247
|
"Docs link README JSON cookbook": "README — JSON-Kochbuch (GitHub)",
|
|
248
|
+
"Docs link wiki DE chapter layout step 6": "Wiki DE — Schritt 6: Ausblenden & Reihenfolge (GitHub)",
|
|
248
249
|
"Docs link README PDF export": "README — PDF-Export / Puppeteer (GitHub)",
|
|
249
250
|
"Docs link README HTML CSS": "README — HTML & CSS-Beispiele (GitHub)",
|
|
250
251
|
"Docs link README documentation overview basic": "Wiki DE — Projekt & Dokumentationssprache (Tab Grundeinstellungen, GitHub)",
|
package/admin/i18n/en.json
CHANGED
|
@@ -192,7 +192,7 @@
|
|
|
192
192
|
"AI context hints hint": "Private to the AI — never appears in exported docs. Use short bullets with concrete facts (rooms, times, routines); vague filler does not help the model.\n\nGuest / onboarding: Everyday language. Heavy admin or IT jargon may force neutral boilerplate for visitors instead of raw AI output (on purpose). User/family profile is not filtered the same way.\n\nExamples: `- Living-room lights off at 22:30` · `- Guest Wi‑Fi label on the router`",
|
|
193
193
|
"AI context hints help": "Prompt-only — not copied into HTML/Markdown exports. Sent to your AI provider each run. Guest profile: dense admin/IT wording here may yield neutral boilerplate for visitors (see grey box). Prefer plain facts, e.g. `- Bedroom blinds close at 22:00`.",
|
|
194
194
|
"HTML export & extra sections": "HTML export & extra sections",
|
|
195
|
-
"Doc layout intro": "HTML (admin, user, onboarding): theme & logo at the top, chapter visibility and custom sections next, optional font / extra CSS at the bottom.\n\nHide lists and chapter order also apply to Markdown when you pick the same documentation profile on the Basic tab.",
|
|
195
|
+
"Doc layout intro": "HTML (admin, user, onboarding): theme & logo at the top, chapter visibility and custom sections next, optional font / extra CSS at the bottom.\n\nHide lists and chapter order also apply to Markdown when you pick the same documentation profile on the Basic tab.\n\nUnder **Which chapters to show (per profile)**, clickable GitHub links open the English JSON cookbook snippets plus the German wiki — step 6 — for hide/order recipes in plain language.",
|
|
196
196
|
"Doc layout pdf hint": "PDF: under Advanced (below disk export). Optional after each run, or anytime via `action.exportPdf`.\n\nRequires `puppeteer` in this adapter folder; writes `autodoc-*.pdf` to Files (and mirrors to your path if set).",
|
|
197
197
|
"Advanced HTML styling (optional)": "Advanced HTML styling (optional)",
|
|
198
198
|
"Advanced HTML styling hint": "Expert / optional: Custom font and CSS change how exported HTML looks. Syntax mistakes or future AutoDoc updates can make the layout look wrong — leave these fields empty if you are unsure.",
|
|
@@ -216,10 +216,10 @@
|
|
|
216
216
|
"Admin HTML — hide chapters": "Admin HTML — hide chapters",
|
|
217
217
|
"Admin chapter order hint": "Optional: reorder Admin HTML and Admin Markdown. Enter chapter ids in the JSON field below (`[]` = built-in order). Ids you omit are appended in the default product order at the end. The full list of valid English ids appears only in that field’s help (click the `?` tooltip) — it is not repeated here.",
|
|
218
218
|
"Admin chapter order (JSON array)": "Admin chapter order (JSON array)",
|
|
219
|
-
"Admin chapter order JSON help": "JSON array of chapter ids, e.g. `[\"system\",\"adapters\",\"manual\"]`. Valid ids (exact English): `manual`, `system`, `adapters`, `rooms`, `scripts`, `schedule`, `userdata`, `aliases`, `maintenance`, `diagnosis`, `troubleshooting`, `custom`, `changelog`, `appendices`. Unknown ids are skipped; omitted ids append in default order. `[]` = built-in order.",
|
|
219
|
+
"Admin chapter order JSON help": "JSON array of chapter ids, e.g. `[\"system\",\"adapters\",\"manual\"]`. Valid ids (exact English): `manual`, `system`, `adapters`, `rooms`, `scripts`, `schedule`, `userdata`, `aliases`, `maintenance`, `diagnosis`, `troubleshooting`, `custom`, `changelog`, `appendices`. Unknown ids are skipped; omitted ids append in default order. `[]` = built-in order.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
220
220
|
"Admin hidden chapters hint": "Chapter ids to omit from Admin HTML and from Markdown when the profile is Admin — e.g. `[\"diagnosis\",\"changelog\",\"custom\"]`. Same valid English ids as for chapter order; the full list is only in the help for Admin chapter order (that JSON field is below on this page). Invalid ids are ignored.",
|
|
221
221
|
"Hidden chapter IDs (JSON array)": "Hidden chapter IDs (JSON array)",
|
|
222
|
-
"Admin hidden chapters JSON help": "JSON array, e.g. `[\"userdata\",\"aliases\"]`. Same valid ids as Admin chapter order (see that field). `[]` = show all chapters.",
|
|
222
|
+
"Admin hidden chapters JSON help": "JSON array, e.g. `[\"userdata\",\"aliases\"]`. Same valid ids as Admin chapter order (see that field). `[]` = show all chapters.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
223
223
|
"Custom Markdown sections": "Custom Markdown sections",
|
|
224
224
|
"Custom sections JSON hint": "JSON array of objects: `{ \"title\": \"Wi-Fi\", \"body\": \"Guest …\", \"profiles\": [\"user\",\"onboarding\"] }`. body is Markdown (no raw HTML). profiles optional — omit to show in all three HTML profiles. Max 12 sections; long text is truncated. Example uses: emergency contacts, Wi-Fi, router model.",
|
|
225
225
|
"Custom sections (JSON)": "Custom sections (JSON)",
|
|
@@ -227,23 +227,24 @@
|
|
|
227
227
|
"User/Family HTML — hide chapters": "User/Family HTML — hide chapters",
|
|
228
228
|
"User hidden chapters hint": "JSON array of chapter ids to hide in User/Family HTML and in Markdown when the documentation profile is User. Example: `[\"scripts\",\"adapters\"]`. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid` (user-defined Mermaid diagram), `mermaidAuto` (auto-generated host topology — not shown in Onboarding), `adapters`, `custom`, `system`, `troubleshooting`.",
|
|
229
229
|
"User profile — hidden chapter IDs (JSON)": "User profile — hidden chapter IDs (JSON)",
|
|
230
|
-
"User hidden chapters JSON help": "JSON array, e.g. `[\"scripts\",\"adapters\"]`. Invalid ids are ignored. `[]` = show all.",
|
|
230
|
+
"User hidden chapters JSON help": "JSON array, e.g. `[\"scripts\",\"adapters\"]`. Invalid ids are ignored. `[]` = show all.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
231
231
|
"User chapter order hint": "Optional: reorder User/Family HTML and User Markdown chapters. Enter chapter ids below in the desired order. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting` — any id you omit is appended in the default order. Empty `[]` = default order. `atAGlance` appears only when the structured Quick Start block has data (discovery); reordering cannot create that content.",
|
|
232
232
|
"User chapter order (JSON array)": "User chapter order (JSON array)",
|
|
233
|
-
"User chapter order JSON help": "JSON array of chapter ids, e.g. `[\"atAGlance\",\"rooms\",\"manual\",\"adapters\"]`. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `atAGlance` outputs only when Quick Start has content.",
|
|
233
|
+
"User chapter order JSON help": "JSON array of chapter ids, e.g. `[\"atAGlance\",\"rooms\",\"manual\",\"adapters\"]`. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `atAGlance` outputs only when Quick Start has content.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
234
234
|
"Onboarding HTML — hide chapters": "Onboarding HTML — hide chapters",
|
|
235
235
|
"Onboarding hidden chapters hint": "Hide blocks in Onboarding HTML and matching parts of Markdown (profile Onboarding). Valid ids: `welcome`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid` (owner diagram in the welcome area), `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, plus for Markdown also `quickstart`, `system`, `manual` (project description/contact in welcome + manual chapter subsections).",
|
|
236
236
|
"Onboarding profile — hidden chapter IDs (JSON)": "Onboarding profile — hidden chapter IDs (JSON)",
|
|
237
|
-
"Onboarding hidden chapters JSON help": "JSON array, e.g. `[\"adapters\",\"stats\"]`. Invalid ids are ignored. `[]` = show all.",
|
|
237
|
+
"Onboarding hidden chapters JSON help": "JSON array, e.g. `[\"adapters\",\"stats\"]`. Invalid ids are ignored. `[]` = show all.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
238
238
|
"Onboarding chapter order hint": "Optional: reorder Onboarding/Guest HTML and Onboarding Markdown chapters.\n\nValid ids: `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual` — any id you omit is appended in the default order.\n\nEmpty `[]` = default order.\n\n`quickstart` always includes the welcome line, adapter counts, and next steps; the discovery snapshot (rooms / setup lines from your installation) appears only when that data exists.",
|
|
239
239
|
"Onboarding chapter order (JSON array)": "Onboarding chapter order (JSON array)",
|
|
240
|
-
"Onboarding chapter order JSON help": "JSON array of chapter ids, e.g. `[\"quickstart\",\"tips\",\"rooms\",\"adapters\"]`. Valid ids: `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `quickstart` always shows welcome, counts, next steps; discovery block only when `quickStart.hasContent
|
|
240
|
+
"Onboarding chapter order JSON help": "JSON array of chapter ids, e.g. `[\"quickstart\",\"tips\",\"rooms\",\"adapters\"]`. Valid ids: `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `quickstart` always shows welcome, counts, next steps; discovery block only when `quickStart.hasContent`.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
241
241
|
"Advanced base URL callout": "Guests & QR / copy link: Enter the URL you would use in a phone browser to open ioBroker Admin (scheme + host + port, no trailing slash). If that differs from Docker-internal hostnames or from a reverse-proxy public name, set it explicitly — auto-detection often fails in containers or behind HTTPS offload.",
|
|
242
242
|
"copyForForum": "Copy for Forum",
|
|
243
243
|
"Docs link README public base URL": "DE user guide — Public base URL / QR (GitHub)",
|
|
244
244
|
"Docs link wiki German config": "German wiki — Tabs overview (DE) (GitHub)",
|
|
245
245
|
"Docs link README Mermaid cookbook": "README — Mermaid cookbook examples (GitHub)",
|
|
246
246
|
"Docs link README JSON cookbook": "README — JSON cookbook snippets (GitHub)",
|
|
247
|
+
"Docs link wiki DE chapter layout step 6": "User guide DE — Step 6: hide & chapter order (GitHub)",
|
|
247
248
|
"Docs link README PDF export": "DE user guide — Optional PDF export / Puppeteer (GitHub)",
|
|
248
249
|
"Docs link README HTML CSS": "README — HTML custom CSS examples (GitHub)",
|
|
249
250
|
"Docs link README documentation overview basic": "DE user guide — Project & documentation language (Basics tab) (GitHub)",
|
package/admin/i18n/es.json
CHANGED
|
@@ -192,7 +192,7 @@
|
|
|
192
192
|
"AI context hints hint": "Private to the AI — never appears in exported docs. Use short bullets with concrete facts (rooms, times, routines); vague filler does not help the model.\n\nGuest / onboarding: Everyday language. Heavy admin or IT jargon may force neutral boilerplate for visitors instead of raw AI output (on purpose). User/family profile is not filtered the same way.\n\nExamples: `- Living-room lights off at 22:30` · `- Guest Wi‑Fi label on the router`",
|
|
193
193
|
"AI context hints help": "Prompt-only — not copied into HTML/Markdown exports. Sent to your AI provider each run. Guest profile: dense admin/IT wording here may yield neutral boilerplate for visitors (see grey box). Prefer plain facts, e.g. `- Bedroom blinds close at 22:00`.",
|
|
194
194
|
"HTML export & extra sections": "HTML export & extra sections",
|
|
195
|
-
"Doc layout intro": "HTML (admin, user, onboarding): theme & logo at the top, chapter visibility and custom sections next, optional font / extra CSS at the bottom.\n\nHide lists and chapter order also apply to Markdown when you pick the same documentation profile on the Basic tab.",
|
|
195
|
+
"Doc layout intro": "HTML (admin, user, onboarding): theme & logo at the top, chapter visibility and custom sections next, optional font / extra CSS at the bottom.\n\nHide lists and chapter order also apply to Markdown when you pick the same documentation profile on the Basic tab.\n\nUnder **Which chapters to show (per profile)**, clickable GitHub links open the English JSON cookbook snippets plus the German wiki — step 6 — for hide/order recipes in plain language.",
|
|
196
196
|
"Doc layout pdf hint": "PDF: under Advanced (below disk export). Optional after each run, or anytime via `action.exportPdf`.\n\nRequires `puppeteer` in this adapter folder; writes `autodoc-*.pdf` to Files (and mirrors to your path if set).",
|
|
197
197
|
"Advanced HTML styling (optional)": "Advanced HTML styling (optional)",
|
|
198
198
|
"Advanced HTML styling hint": "Expert / optional: Custom font and CSS change how exported HTML looks. Syntax mistakes or future AutoDoc updates can make the layout look wrong — leave these fields empty if you are unsure.",
|
|
@@ -216,10 +216,10 @@
|
|
|
216
216
|
"Admin HTML — hide chapters": "Admin HTML — hide chapters",
|
|
217
217
|
"Admin chapter order hint": "Optional: reorder Admin HTML and Admin Markdown. Enter chapter ids in the JSON field below (`[]` = built-in order). Ids you omit are appended in the default product order at the end. The full list of valid English ids appears only in that field’s help (click the `?` tooltip) — it is not repeated here.",
|
|
218
218
|
"Admin chapter order (JSON array)": "Admin chapter order (JSON array)",
|
|
219
|
-
"Admin chapter order JSON help": "JSON array of chapter ids, e.g. `[\"system\",\"adapters\",\"manual\"]`. Valid ids (exact English): `manual`, `system`, `adapters`, `rooms`, `scripts`, `schedule`, `userdata`, `aliases`, `maintenance`, `diagnosis`, `troubleshooting`, `custom`, `changelog`, `appendices`. Unknown ids are skipped; omitted ids append in default order. `[]` = built-in order.",
|
|
219
|
+
"Admin chapter order JSON help": "JSON array of chapter ids, e.g. `[\"system\",\"adapters\",\"manual\"]`. Valid ids (exact English): `manual`, `system`, `adapters`, `rooms`, `scripts`, `schedule`, `userdata`, `aliases`, `maintenance`, `diagnosis`, `troubleshooting`, `custom`, `changelog`, `appendices`. Unknown ids are skipped; omitted ids append in default order. `[]` = built-in order.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
220
220
|
"Admin hidden chapters hint": "Chapter ids to omit from Admin HTML and from Markdown when the profile is Admin — e.g. `[\"diagnosis\",\"changelog\",\"custom\"]`. Same valid English ids as for chapter order; the full list is only in the help for Admin chapter order (that JSON field is below on this page). Invalid ids are ignored.",
|
|
221
221
|
"Hidden chapter IDs (JSON array)": "Hidden chapter IDs (JSON array)",
|
|
222
|
-
"Admin hidden chapters JSON help": "JSON array, e.g. `[\"userdata\",\"aliases\"]`. Same valid ids as Admin chapter order (see that field). `[]` = show all chapters.",
|
|
222
|
+
"Admin hidden chapters JSON help": "JSON array, e.g. `[\"userdata\",\"aliases\"]`. Same valid ids as Admin chapter order (see that field). `[]` = show all chapters.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
223
223
|
"Custom Markdown sections": "Custom Markdown sections",
|
|
224
224
|
"Custom sections JSON hint": "JSON array of objects: `{ \"title\": \"Wi-Fi\", \"body\": \"Guest …\", \"profiles\": [\"user\",\"onboarding\"] }`. body is Markdown (no raw HTML). profiles optional — omit to show in all three HTML profiles. Max 12 sections; long text is truncated. Example uses: emergency contacts, Wi-Fi, router model.",
|
|
225
225
|
"Custom sections (JSON)": "Custom sections (JSON)",
|
|
@@ -227,23 +227,24 @@
|
|
|
227
227
|
"User/Family HTML — hide chapters": "User/Family HTML — hide chapters",
|
|
228
228
|
"User hidden chapters hint": "JSON array of chapter ids to hide in User/Family HTML and in Markdown when the documentation profile is User. Example: `[\"scripts\",\"adapters\"]`. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid` (user-defined Mermaid diagram), `mermaidAuto` (auto-generated host topology — not shown in Onboarding), `adapters`, `custom`, `system`, `troubleshooting`.",
|
|
229
229
|
"User profile — hidden chapter IDs (JSON)": "User profile — hidden chapter IDs (JSON)",
|
|
230
|
-
"User hidden chapters JSON help": "JSON array, e.g. `[\"scripts\",\"adapters\"]`. Invalid ids are ignored. `[]` = show all.",
|
|
230
|
+
"User hidden chapters JSON help": "JSON array, e.g. `[\"scripts\",\"adapters\"]`. Invalid ids are ignored. `[]` = show all.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
231
231
|
"User chapter order hint": "Optional: reorder User/Family HTML and User Markdown chapters. Enter chapter ids below in the desired order. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting` — any id you omit is appended in the default order. Empty `[]` = default order. `atAGlance` appears only when the structured Quick Start block has data (discovery); reordering cannot create that content.",
|
|
232
232
|
"User chapter order (JSON array)": "User chapter order (JSON array)",
|
|
233
|
-
"User chapter order JSON help": "JSON array of chapter ids, e.g. `[\"atAGlance\",\"rooms\",\"manual\",\"adapters\"]`. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `atAGlance` outputs only when Quick Start has content.",
|
|
233
|
+
"User chapter order JSON help": "JSON array of chapter ids, e.g. `[\"atAGlance\",\"rooms\",\"manual\",\"adapters\"]`. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `atAGlance` outputs only when Quick Start has content.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
234
234
|
"Onboarding HTML — hide chapters": "Onboarding HTML — hide chapters",
|
|
235
235
|
"Onboarding hidden chapters hint": "Hide blocks in Onboarding HTML and matching parts of Markdown (profile Onboarding). Valid ids: `welcome`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid` (owner diagram in the welcome area), `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, plus for Markdown also `quickstart`, `system`, `manual` (project description/contact in welcome + manual chapter subsections).",
|
|
236
236
|
"Onboarding profile — hidden chapter IDs (JSON)": "Onboarding profile — hidden chapter IDs (JSON)",
|
|
237
|
-
"Onboarding hidden chapters JSON help": "JSON array, e.g. `[\"adapters\",\"stats\"]`. Invalid ids are ignored. `[]` = show all.",
|
|
237
|
+
"Onboarding hidden chapters JSON help": "JSON array, e.g. `[\"adapters\",\"stats\"]`. Invalid ids are ignored. `[]` = show all.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
238
238
|
"Onboarding chapter order hint": "Optional: reorder Onboarding/Guest HTML and Onboarding Markdown chapters.\n\nValid ids: `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual` — any id you omit is appended in the default order.\n\nEmpty `[]` = default order.\n\n`quickstart` always includes the welcome line, adapter counts, and next steps; the discovery snapshot (rooms / setup lines from your installation) appears only when that data exists.",
|
|
239
239
|
"Onboarding chapter order (JSON array)": "Onboarding chapter order (JSON array)",
|
|
240
|
-
"Onboarding chapter order JSON help": "JSON array of chapter ids, e.g. `[\"quickstart\",\"tips\",\"rooms\",\"adapters\"]`. Valid ids: `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `quickstart` always shows welcome, counts, next steps; discovery block only when `quickStart.hasContent
|
|
240
|
+
"Onboarding chapter order JSON help": "JSON array of chapter ids, e.g. `[\"quickstart\",\"tips\",\"rooms\",\"adapters\"]`. Valid ids: `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `quickstart` always shows welcome, counts, next steps; discovery block only when `quickStart.hasContent`.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
241
241
|
"Advanced base URL callout": "Guests & QR / copy link: Enter the URL you would use in a phone browser to open ioBroker Admin (scheme + host + port, no trailing slash). If that differs from Docker-internal hostnames or from a reverse-proxy public name, set it explicitly — auto-detection often fails in containers or behind HTTPS offload.",
|
|
242
242
|
"copyForForum": "Copy for Forum",
|
|
243
243
|
"Docs link README public base URL": "DE user guide — Public base URL / QR (GitHub)",
|
|
244
244
|
"Docs link wiki German config": "German wiki — Tabs overview (DE) (GitHub)",
|
|
245
245
|
"Docs link README Mermaid cookbook": "README — Mermaid cookbook examples (GitHub)",
|
|
246
246
|
"Docs link README JSON cookbook": "README — JSON cookbook snippets (GitHub)",
|
|
247
|
+
"Docs link wiki DE chapter layout step 6": "User guide DE — Step 6: hide & chapter order (GitHub)",
|
|
247
248
|
"Docs link README PDF export": "DE user guide — Optional PDF export / Puppeteer (GitHub)",
|
|
248
249
|
"Docs link README HTML CSS": "README — HTML custom CSS examples (GitHub)",
|
|
249
250
|
"Docs link README documentation overview basic": "DE user guide — Project & documentation language (Basics tab) (GitHub)",
|
package/admin/i18n/fr.json
CHANGED
|
@@ -191,7 +191,7 @@
|
|
|
191
191
|
"Pdf export after generation help": "Optionnel : après chaque génération réussie, produire autodoc-admin.pdf, autodoc-user.pdf, autodoc-onboarding.pdf via Chromium headless (`puppeteer` dans ce dossier adaptateur). Mêmes drapeaux sandbox que Mermaid CLI. SVG intégré imprime hors ligne ; Mermaid jsDelivr exige le réseau pendant l’étape PDF. Gros documents : durée et RAM/CPU. Manuel : état action.exportPdf sans tout régénérer.",
|
|
192
192
|
"multihostDistribution": "Répartition des hôtes",
|
|
193
193
|
"HTML export & extra sections": "Export HTML & sections supplémentaires",
|
|
194
|
-
"Doc layout intro": "HTML (admin, utilisateur, onboarding) : thème et logo en haut, visibilité des chapitres et sections perso au milieu, police / CSS optionnels en bas.\n\nMasquage et ordre s’appliquent aussi au Markdown avec le profil de documentation choisi dans Paramètres de base.",
|
|
194
|
+
"Doc layout intro": "HTML (admin, utilisateur, onboarding) : thème et logo en haut, visibilité des chapitres et sections perso au milieu, police / CSS optionnels en bas.\n\nMasquage et ordre s’appliquent aussi au Markdown avec le profil de documentation choisi dans Paramètres de base.\n\nSous **Chapitres visibles (par profil)**, des liens GitHub ouvrent le cookbook JSON **(anglais)** puis le wiki **allemand — étape 6** pour masquer/ordonner avec des exemples.",
|
|
195
195
|
"Doc layout pdf hint": "PDF : sous Avancé (sous export disque). Option après chaque génération, ou à tout moment via `action.exportPdf`.\n\nNécessite `puppeteer` dans ce dossier adaptateur ; écrit `autodoc-*.pdf` dans Fichiers (copie aussi si chemin défini).",
|
|
196
196
|
"Advanced HTML styling (optional)": "Mise en forme HTML avancée (optionnel)",
|
|
197
197
|
"Advanced HTML styling hint": "Optionnel / utilisateurs avertis : une police ou du CSS personnalisé modifient le rendu du HTML exporté. Une erreur de syntaxe ou une future mise à jour d’AutoDoc peut casser la mise en page — laissez vide si vous n’êtes pas sûr.",
|
|
@@ -212,10 +212,10 @@
|
|
|
212
212
|
"Admin HTML — hide chapters": "HTML admin — masquer des chapitres",
|
|
213
213
|
"Admin chapter order hint": "Facultatif : ordre des chapitres du HTML admin (et sommaire / corps Markdown admin) dans le premier champ JSON (`[]` = ordre intégré). Les ids omis sont ajoutés après, dans l'ordre produit par défaut. La liste complète des ids anglais valides figure uniquement dans l'aide de ce champ (icône `?`) — pas de doublon ici.",
|
|
214
214
|
"Admin chapter order (JSON array)": "Ordre des chapitres admin (JSON)",
|
|
215
|
-
"Admin chapter order JSON help": "Tableau d’ids de chapitres, ex. `[\"system\",\"adapters\",\"manual\"]`. Ids valides (anglais, exacts) : `manual`, `system`, `adapters`, `rooms`, `scripts`, `schedule`, `userdata`, `aliases`, `maintenance`, `diagnosis`, `troubleshooting`, `custom`, `changelog`, `appendices`. Inconnus ignorés ; non nommés ajoutés à la fin dans l’ordre par défaut. `[]` = ordre intégr
|
|
215
|
+
"Admin chapter order JSON help": "Tableau d’ids de chapitres, ex. `[\"system\",\"adapters\",\"manual\"]`. Ids valides (anglais, exacts) : `manual`, `system`, `adapters`, `rooms`, `scripts`, `schedule`, `userdata`, `aliases`, `maintenance`, `diagnosis`, `troubleshooting`, `custom`, `changelog`, `appendices`. Inconnus ignorés ; non nommés ajoutés à la fin dans l’ordre par défaut. `[]` = ordre intégré.\n\nSi l’ordre ou la liste masquée semble sans effet : consultez le **journal de l’adaptateur** pour les identifiants inconnus ou en double ignorés à chaque génération. Recettes : les **deux liens GitHub** sous **Chapitres visibles (par profil)** dans cet onglet.",
|
|
216
216
|
"Admin hidden chapters hint": "Ids de chapitres à omettre dans le HTML admin et le Markdown (profil admin), ex. `[\"diagnosis\",\"changelog\"]`. Mêmes ids valides que pour l'ordre ; la liste complète est uniquement dans l'aide du champ Ordre des chapitres admin (plus bas sur la page). Entrées invalides ignorées.",
|
|
217
217
|
"Hidden chapter IDs (JSON array)": "Chapitres masqués (JSON)",
|
|
218
|
-
"Admin hidden chapters JSON help": "Tableau JSON de chaînes, ex. `[\"userdata\",\"aliases\"]`. Mêmes ids valides que l’ordre des chapitres admin (liste dans l’aide de ce champ). `[]` = tout afficher.",
|
|
218
|
+
"Admin hidden chapters JSON help": "Tableau JSON de chaînes, ex. `[\"userdata\",\"aliases\"]`. Mêmes ids valides que l’ordre des chapitres admin (liste dans l’aide de ce champ). `[]` = tout afficher.\n\nSi l’ordre ou la liste masquée semble sans effet : consultez le **journal de l’adaptateur** pour les identifiants inconnus ou en double ignorés à chaque génération. Recettes : les **deux liens GitHub** sous **Chapitres visibles (par profil)** dans cet onglet.",
|
|
219
219
|
"Custom Markdown sections": "Chapitres Markdown personnalisés",
|
|
220
220
|
"Custom sections JSON hint": "Tableau d'objets : `{ \"title\": \"Wi-Fi\", \"body\": \"Invités …\", \"profiles\": [\"user\",\"onboarding\"] }`. body en Markdown (pas de HTML brut). profiles facultatif — absent = les trois profils HTML. Max. 12 sections.",
|
|
221
221
|
"Custom sections (JSON)": "Sections personnalisées (JSON)",
|
|
@@ -223,23 +223,24 @@
|
|
|
223
223
|
"User/Family HTML — hide chapters": "HTML utilisateur/famille — masquer des chapitres",
|
|
224
224
|
"User hidden chapters hint": "Tableau JSON d'ids pour le HTML utilisateur/famille et le Markdown (profil utilisateur). Ex. `[\"scripts\"]`. Ids : `manual`, `ai`, `guestHelp`, `atAGlance` (aperçu rapide d’après la découverte ; HTML + Markdown utilisateur), `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid` (diagramme Mermaid sous informations manuelles), `adapters`, `custom`, `system`, `troubleshooting`.",
|
|
225
225
|
"User profile — hidden chapter IDs (JSON)": "Profil utilisateur — chapitres masqués (JSON)",
|
|
226
|
-
"User hidden chapters JSON help": "Tableau JSON de chaînes, ex. `[\"scripts\",\"adapters\"]`. Ids invalides ignorés. `[]` = tout afficher.",
|
|
226
|
+
"User hidden chapters JSON help": "Tableau JSON de chaînes, ex. `[\"scripts\",\"adapters\"]`. Ids invalides ignorés. `[]` = tout afficher.\n\nSi l’ordre ou la liste masquée semble sans effet : consultez le **journal de l’adaptateur** pour les identifiants inconnus ou en double ignorés à chaque génération. Recettes : les **deux liens GitHub** sous **Chapitres visibles (par profil)** dans cet onglet.",
|
|
227
227
|
"Onboarding HTML — hide chapters": "HTML onboarding — masquer des chapitres",
|
|
228
228
|
"Onboarding hidden chapters hint": "Masquer des blocs dans l'HTML onboarding et le Markdown (profil onboarding). Ids : `welcome`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid` (diagramme dans l’accueil), `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, plus pour le Markdown `quickstart`, `system`, `manual`.",
|
|
229
229
|
"Onboarding profile — hidden chapter IDs (JSON)": "Profil onboarding — chapitres masqués (JSON)",
|
|
230
|
-
"Onboarding hidden chapters JSON help": "Tableau JSON de chaînes, ex. `[\"adapters\",\"stats\"]`. Ids invalides ignorés. `[]` = tout afficher.",
|
|
230
|
+
"Onboarding hidden chapters JSON help": "Tableau JSON de chaînes, ex. `[\"adapters\",\"stats\"]`. Ids invalides ignorés. `[]` = tout afficher.\n\nSi l’ordre ou la liste masquée semble sans effet : consultez le **journal de l’adaptateur** pour les identifiants inconnus ou en double ignorés à chaque génération. Recettes : les **deux liens GitHub** sous **Chapitres visibles (par profil)** dans cet onglet.",
|
|
231
231
|
"User chapter order hint": "Optionnel : réordonner les chapitres HTML utilisateur/famille et le Markdown (profil utilisateur). Saisir les ids dans l’ordre souhaité. Ids : `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting` — les ids omises sont ajoutées en ordre par défaut. `[]` = ordre intégré. `atAGlance` n’apparaît que si le bloc Quick Start contient des données ; réordonner ne crée pas ce contenu.",
|
|
232
232
|
"User chapter order (JSON array)": "Ordre des chapitres utilisateur (tableau JSON)",
|
|
233
|
-
"User chapter order JSON help": "Tableau d’ids de chapitres, ex. `[\"atAGlance\",\"rooms\",\"manual\",\"adapters\"]`. Ids valides : `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting`. Inconnus ignorés ; omis ajoutés à la fin dans l’ordre par défaut. `[]` = ordre intégré. `atAGlance` n’apparaît que si le Quick Start contient des données.",
|
|
233
|
+
"User chapter order JSON help": "Tableau d’ids de chapitres, ex. `[\"atAGlance\",\"rooms\",\"manual\",\"adapters\"]`. Ids valides : `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting`. Inconnus ignorés ; omis ajoutés à la fin dans l’ordre par défaut. `[]` = ordre intégré. `atAGlance` n’apparaît que si le Quick Start contient des données.\n\nSi l’ordre ou la liste masquée semble sans effet : consultez le **journal de l’adaptateur** pour les identifiants inconnus ou en double ignorés à chaque génération. Recettes : les **deux liens GitHub** sous **Chapitres visibles (par profil)** dans cet onglet.",
|
|
234
234
|
"Onboarding chapter order hint": "Optionnel : réordonner les chapitres HTML onboarding / invités et le Markdown (profil onboarding).\n\nIds : `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual` — les ids omises sont ajoutées en fin d’ordre par défaut.\n\n`[]` = ordre intégré.\n\n`quickstart` : toujours accueil, compteurs adaptateurs et prochaines étapes ; le bloc découverte (aperçu pièces / lignes setup) seulement si les données existent.",
|
|
235
235
|
"Onboarding chapter order (JSON array)": "Ordre des chapitres onboarding (tableau JSON)",
|
|
236
|
-
"Onboarding chapter order JSON help": "Tableau d’ids de chapitres, ex. `[\"quickstart\",\"tips\",\"rooms\",\"adapters\"]`. Ids valides : `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual`. Inconnus ignorés ; omis ajoutés à la fin dans l’ordre par défaut. `[]` = ordre intégré. `quickstart` affiche toujours accueil, compteurs et prochaines étapes ; le bloc découverte uniquement si `quickStart.hasContent
|
|
236
|
+
"Onboarding chapter order JSON help": "Tableau d’ids de chapitres, ex. `[\"quickstart\",\"tips\",\"rooms\",\"adapters\"]`. Ids valides : `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual`. Inconnus ignorés ; omis ajoutés à la fin dans l’ordre par défaut. `[]` = ordre intégré. `quickstart` affiche toujours accueil, compteurs et prochaines étapes ; le bloc découverte uniquement si `quickStart.hasContent`.\n\nSi l’ordre ou la liste masquée semble sans effet : consultez le **journal de l’adaptateur** pour les identifiants inconnus ou en double ignorés à chaque génération. Recettes : les **deux liens GitHub** sous **Chapitres visibles (par profil)** dans cet onglet.",
|
|
237
237
|
"Advanced base URL callout": "Invités, QR, lien copié : l’URL tapée dans le navigateur du téléphone pour ouvrir l’admin ioBroker (schéma + hôte + port, sans / final). Si elle diffère du nom interne Docker ou du nom public derrière un proxy, la saisir explicitement — la détection auto échoue souvent dans les conteneurs ou avec HTTPS devant.",
|
|
238
238
|
"copyForForum": "Copier pour le forum",
|
|
239
239
|
"Docs link README public base URL": "Wiki DE — URL publique / QR (GitHub)",
|
|
240
240
|
"Docs link wiki German config": "Wiki DE — Aperçu des onglets (GitHub)",
|
|
241
241
|
"Docs link README Mermaid cookbook": "README — Exemples Mermaid (GitHub)",
|
|
242
242
|
"Docs link README JSON cookbook": "README — Snippets JSON (GitHub)",
|
|
243
|
+
"Docs link wiki DE chapter layout step 6": "Guide DE — Étape 6 : masquer & ordre (GitHub)",
|
|
243
244
|
"Docs link README PDF export": "Wiki DE — Export PDF / Puppeteer (GitHub)",
|
|
244
245
|
"Docs link README HTML CSS": "README — CSS HTML (GitHub)",
|
|
245
246
|
"Docs link README documentation overview basic": "Wiki DE — Langue & projet (onglet Réglages de base, GitHub)",
|
package/admin/i18n/it.json
CHANGED
|
@@ -192,7 +192,7 @@
|
|
|
192
192
|
"AI context hints hint": "Private to the AI — never appears in exported docs. Use short bullets with concrete facts (rooms, times, routines); vague filler does not help the model.\n\nGuest / onboarding: Everyday language. Heavy admin or IT jargon may force neutral boilerplate for visitors instead of raw AI output (on purpose). User/family profile is not filtered the same way.\n\nExamples: `- Living-room lights off at 22:30` · `- Guest Wi‑Fi label on the router`",
|
|
193
193
|
"AI context hints help": "Prompt-only — not copied into HTML/Markdown exports. Sent to your AI provider each run. Guest profile: dense admin/IT wording here may yield neutral boilerplate for visitors (see grey box). Prefer plain facts, e.g. `- Bedroom blinds close at 22:00`.",
|
|
194
194
|
"HTML export & extra sections": "HTML export & extra sections",
|
|
195
|
-
"Doc layout intro": "HTML (admin, user, onboarding): theme & logo at the top, chapter visibility and custom sections next, optional font / extra CSS at the bottom.\n\nHide lists and chapter order also apply to Markdown when you pick the same documentation profile on the Basic tab.",
|
|
195
|
+
"Doc layout intro": "HTML (admin, user, onboarding): theme & logo at the top, chapter visibility and custom sections next, optional font / extra CSS at the bottom.\n\nHide lists and chapter order also apply to Markdown when you pick the same documentation profile on the Basic tab.\n\nUnder **Which chapters to show (per profile)**, clickable GitHub links open the English JSON cookbook snippets plus the German wiki — step 6 — for hide/order recipes in plain language.",
|
|
196
196
|
"Doc layout pdf hint": "PDF: under Advanced (below disk export). Optional after each run, or anytime via `action.exportPdf`.\n\nRequires `puppeteer` in this adapter folder; writes `autodoc-*.pdf` to Files (and mirrors to your path if set).",
|
|
197
197
|
"Advanced HTML styling (optional)": "Advanced HTML styling (optional)",
|
|
198
198
|
"Advanced HTML styling hint": "Expert / optional: Custom font and CSS change how exported HTML looks. Syntax mistakes or future AutoDoc updates can make the layout look wrong — leave these fields empty if you are unsure.",
|
|
@@ -216,10 +216,10 @@
|
|
|
216
216
|
"Admin HTML — hide chapters": "Admin HTML — hide chapters",
|
|
217
217
|
"Admin chapter order hint": "Optional: reorder Admin HTML and Admin Markdown. Enter chapter ids in the JSON field below (`[]` = built-in order). Ids you omit are appended in the default product order at the end. The full list of valid English ids appears only in that field’s help (click the `?` tooltip) — it is not repeated here.",
|
|
218
218
|
"Admin chapter order (JSON array)": "Admin chapter order (JSON array)",
|
|
219
|
-
"Admin chapter order JSON help": "JSON array of chapter ids, e.g. `[\"system\",\"adapters\",\"manual\"]`. Valid ids (exact English): `manual`, `system`, `adapters`, `rooms`, `scripts`, `schedule`, `userdata`, `aliases`, `maintenance`, `diagnosis`, `troubleshooting`, `custom`, `changelog`, `appendices`. Unknown ids are skipped; omitted ids append in default order. `[]` = built-in order.",
|
|
219
|
+
"Admin chapter order JSON help": "JSON array of chapter ids, e.g. `[\"system\",\"adapters\",\"manual\"]`. Valid ids (exact English): `manual`, `system`, `adapters`, `rooms`, `scripts`, `schedule`, `userdata`, `aliases`, `maintenance`, `diagnosis`, `troubleshooting`, `custom`, `changelog`, `appendices`. Unknown ids are skipped; omitted ids append in default order. `[]` = built-in order.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
220
220
|
"Admin hidden chapters hint": "Chapter ids to omit from Admin HTML and from Markdown when the profile is Admin — e.g. `[\"diagnosis\",\"changelog\",\"custom\"]`. Same valid English ids as for chapter order; the full list is only in the help for Admin chapter order (that JSON field is below on this page). Invalid ids are ignored.",
|
|
221
221
|
"Hidden chapter IDs (JSON array)": "Hidden chapter IDs (JSON array)",
|
|
222
|
-
"Admin hidden chapters JSON help": "JSON array, e.g. `[\"userdata\",\"aliases\"]`. Same valid ids as Admin chapter order (see that field). `[]` = show all chapters.",
|
|
222
|
+
"Admin hidden chapters JSON help": "JSON array, e.g. `[\"userdata\",\"aliases\"]`. Same valid ids as Admin chapter order (see that field). `[]` = show all chapters.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
223
223
|
"Custom Markdown sections": "Custom Markdown sections",
|
|
224
224
|
"Custom sections JSON hint": "JSON array of objects: `{ \"title\": \"Wi-Fi\", \"body\": \"Guest …\", \"profiles\": [\"user\",\"onboarding\"] }`. body is Markdown (no raw HTML). profiles optional — omit to show in all three HTML profiles. Max 12 sections; long text is truncated. Example uses: emergency contacts, Wi-Fi, router model.",
|
|
225
225
|
"Custom sections (JSON)": "Custom sections (JSON)",
|
|
@@ -227,23 +227,24 @@
|
|
|
227
227
|
"User/Family HTML — hide chapters": "User/Family HTML — hide chapters",
|
|
228
228
|
"User hidden chapters hint": "JSON array of chapter ids to hide in User/Family HTML and in Markdown when the documentation profile is User. Example: `[\"scripts\",\"adapters\"]`. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid` (user-defined Mermaid diagram), `mermaidAuto` (auto-generated host topology — not shown in Onboarding), `adapters`, `custom`, `system`, `troubleshooting`.",
|
|
229
229
|
"User profile — hidden chapter IDs (JSON)": "User profile — hidden chapter IDs (JSON)",
|
|
230
|
-
"User hidden chapters JSON help": "JSON array, e.g. `[\"scripts\",\"adapters\"]`. Invalid ids are ignored. `[]` = show all.",
|
|
230
|
+
"User hidden chapters JSON help": "JSON array, e.g. `[\"scripts\",\"adapters\"]`. Invalid ids are ignored. `[]` = show all.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
231
231
|
"User chapter order hint": "Optional: reorder User/Family HTML and User Markdown chapters. Enter chapter ids below in the desired order. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting` — any id you omit is appended in the default order. Empty `[]` = default order. `atAGlance` appears only when the structured Quick Start block has data (discovery); reordering cannot create that content.",
|
|
232
232
|
"User chapter order (JSON array)": "User chapter order (JSON array)",
|
|
233
|
-
"User chapter order JSON help": "JSON array of chapter ids, e.g. `[\"atAGlance\",\"rooms\",\"manual\",\"adapters\"]`. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `atAGlance` outputs only when Quick Start has content.",
|
|
233
|
+
"User chapter order JSON help": "JSON array of chapter ids, e.g. `[\"atAGlance\",\"rooms\",\"manual\",\"adapters\"]`. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `atAGlance` outputs only when Quick Start has content.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
234
234
|
"Onboarding HTML — hide chapters": "Onboarding HTML — hide chapters",
|
|
235
235
|
"Onboarding hidden chapters hint": "Hide blocks in Onboarding HTML and matching parts of Markdown (profile Onboarding). Valid ids: `welcome`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid` (owner diagram in the welcome area), `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, plus for Markdown also `quickstart`, `system`, `manual` (project description/contact in welcome + manual chapter subsections).",
|
|
236
236
|
"Onboarding profile — hidden chapter IDs (JSON)": "Onboarding profile — hidden chapter IDs (JSON)",
|
|
237
|
-
"Onboarding hidden chapters JSON help": "JSON array, e.g. `[\"adapters\",\"stats\"]`. Invalid ids are ignored. `[]` = show all.",
|
|
237
|
+
"Onboarding hidden chapters JSON help": "JSON array, e.g. `[\"adapters\",\"stats\"]`. Invalid ids are ignored. `[]` = show all.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
238
238
|
"Onboarding chapter order hint": "Optional: reorder Onboarding/Guest HTML and Onboarding Markdown chapters.\n\nValid ids: `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual` — any id you omit is appended in the default order.\n\nEmpty `[]` = default order.\n\n`quickstart` always includes the welcome line, adapter counts, and next steps; the discovery snapshot (rooms / setup lines from your installation) appears only when that data exists.",
|
|
239
239
|
"Onboarding chapter order (JSON array)": "Onboarding chapter order (JSON array)",
|
|
240
|
-
"Onboarding chapter order JSON help": "JSON array of chapter ids, e.g. `[\"quickstart\",\"tips\",\"rooms\",\"adapters\"]`. Valid ids: `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `quickstart` always shows welcome, counts, next steps; discovery block only when `quickStart.hasContent
|
|
240
|
+
"Onboarding chapter order JSON help": "JSON array of chapter ids, e.g. `[\"quickstart\",\"tips\",\"rooms\",\"adapters\"]`. Valid ids: `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `quickstart` always shows welcome, counts, next steps; discovery block only when `quickStart.hasContent`.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
241
241
|
"Advanced base URL callout": "Guests & QR / copy link: Enter the URL you would use in a phone browser to open ioBroker Admin (scheme + host + port, no trailing slash). If that differs from Docker-internal hostnames or from a reverse-proxy public name, set it explicitly — auto-detection often fails in containers or behind HTTPS offload.",
|
|
242
242
|
"copyForForum": "Copy for Forum",
|
|
243
243
|
"Docs link README public base URL": "DE user guide — Public base URL / QR (GitHub)",
|
|
244
244
|
"Docs link wiki German config": "German wiki — Tabs overview (DE) (GitHub)",
|
|
245
245
|
"Docs link README Mermaid cookbook": "README — Mermaid cookbook examples (GitHub)",
|
|
246
246
|
"Docs link README JSON cookbook": "README — JSON cookbook snippets (GitHub)",
|
|
247
|
+
"Docs link wiki DE chapter layout step 6": "User guide DE — Step 6: hide & chapter order (GitHub)",
|
|
247
248
|
"Docs link README PDF export": "DE user guide — Optional PDF export / Puppeteer (GitHub)",
|
|
248
249
|
"Docs link README HTML CSS": "README — HTML custom CSS examples (GitHub)",
|
|
249
250
|
"Docs link README documentation overview basic": "DE user guide — Project & documentation language (Basics tab) (GitHub)",
|
package/admin/i18n/nl.json
CHANGED
|
@@ -192,7 +192,7 @@
|
|
|
192
192
|
"AI context hints hint": "Private to the AI — never appears in exported docs. Use short bullets with concrete facts (rooms, times, routines); vague filler does not help the model.\n\nGuest / onboarding: Everyday language. Heavy admin or IT jargon may force neutral boilerplate for visitors instead of raw AI output (on purpose). User/family profile is not filtered the same way.\n\nExamples: `- Living-room lights off at 22:30` · `- Guest Wi‑Fi label on the router`",
|
|
193
193
|
"AI context hints help": "Prompt-only — not copied into HTML/Markdown exports. Sent to your AI provider each run. Guest profile: dense admin/IT wording here may yield neutral boilerplate for visitors (see grey box). Prefer plain facts, e.g. `- Bedroom blinds close at 22:00`.",
|
|
194
194
|
"HTML export & extra sections": "HTML export & extra sections",
|
|
195
|
-
"Doc layout intro": "HTML (admin, user, onboarding): theme & logo at the top, chapter visibility and custom sections next, optional font / extra CSS at the bottom.\n\nHide lists and chapter order also apply to Markdown when you pick the same documentation profile on the Basic tab.",
|
|
195
|
+
"Doc layout intro": "HTML (admin, user, onboarding): theme & logo at the top, chapter visibility and custom sections next, optional font / extra CSS at the bottom.\n\nHide lists and chapter order also apply to Markdown when you pick the same documentation profile on the Basic tab.\n\nUnder **Which chapters to show (per profile)**, clickable GitHub links open the English JSON cookbook snippets plus the German wiki — step 6 — for hide/order recipes in plain language.",
|
|
196
196
|
"Doc layout pdf hint": "PDF: under Advanced (below disk export). Optional after each run, or anytime via `action.exportPdf`.\n\nRequires `puppeteer` in this adapter folder; writes `autodoc-*.pdf` to Files (and mirrors to your path if set).",
|
|
197
197
|
"Advanced HTML styling (optional)": "Advanced HTML styling (optional)",
|
|
198
198
|
"Advanced HTML styling hint": "Expert / optional: Custom font and CSS change how exported HTML looks. Syntax mistakes or future AutoDoc updates can make the layout look wrong — leave these fields empty if you are unsure.",
|
|
@@ -216,10 +216,10 @@
|
|
|
216
216
|
"Admin HTML — hide chapters": "Admin HTML — hide chapters",
|
|
217
217
|
"Admin chapter order hint": "Optional: reorder Admin HTML and Admin Markdown. Enter chapter ids in the JSON field below (`[]` = built-in order). Ids you omit are appended in the default product order at the end. The full list of valid English ids appears only in that field’s help (click the `?` tooltip) — it is not repeated here.",
|
|
218
218
|
"Admin chapter order (JSON array)": "Admin chapter order (JSON array)",
|
|
219
|
-
"Admin chapter order JSON help": "JSON array of chapter ids, e.g. `[\"system\",\"adapters\",\"manual\"]`. Valid ids (exact English): `manual`, `system`, `adapters`, `rooms`, `scripts`, `schedule`, `userdata`, `aliases`, `maintenance`, `diagnosis`, `troubleshooting`, `custom`, `changelog`, `appendices`. Unknown ids are skipped; omitted ids append in default order. `[]` = built-in order.",
|
|
219
|
+
"Admin chapter order JSON help": "JSON array of chapter ids, e.g. `[\"system\",\"adapters\",\"manual\"]`. Valid ids (exact English): `manual`, `system`, `adapters`, `rooms`, `scripts`, `schedule`, `userdata`, `aliases`, `maintenance`, `diagnosis`, `troubleshooting`, `custom`, `changelog`, `appendices`. Unknown ids are skipped; omitted ids append in default order. `[]` = built-in order.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
220
220
|
"Admin hidden chapters hint": "Chapter ids to omit from Admin HTML and from Markdown when the profile is Admin — e.g. `[\"diagnosis\",\"changelog\",\"custom\"]`. Same valid English ids as for chapter order; the full list is only in the help for Admin chapter order (that JSON field is below on this page). Invalid ids are ignored.",
|
|
221
221
|
"Hidden chapter IDs (JSON array)": "Hidden chapter IDs (JSON array)",
|
|
222
|
-
"Admin hidden chapters JSON help": "JSON array, e.g. `[\"userdata\",\"aliases\"]`. Same valid ids as Admin chapter order (see that field). `[]` = show all chapters.",
|
|
222
|
+
"Admin hidden chapters JSON help": "JSON array, e.g. `[\"userdata\",\"aliases\"]`. Same valid ids as Admin chapter order (see that field). `[]` = show all chapters.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
223
223
|
"Custom Markdown sections": "Custom Markdown sections",
|
|
224
224
|
"Custom sections JSON hint": "JSON array of objects: `{ \"title\": \"Wi-Fi\", \"body\": \"Guest …\", \"profiles\": [\"user\",\"onboarding\"] }`. body is Markdown (no raw HTML). profiles optional — omit to show in all three HTML profiles. Max 12 sections; long text is truncated. Example uses: emergency contacts, Wi-Fi, router model.",
|
|
225
225
|
"Custom sections (JSON)": "Custom sections (JSON)",
|
|
@@ -227,23 +227,24 @@
|
|
|
227
227
|
"User/Family HTML — hide chapters": "User/Family HTML — hide chapters",
|
|
228
228
|
"User hidden chapters hint": "JSON array of chapter ids to hide in User/Family HTML and in Markdown when the documentation profile is User. Example: `[\"scripts\",\"adapters\"]`. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid` (user-defined Mermaid diagram), `mermaidAuto` (auto-generated host topology — not shown in Onboarding), `adapters`, `custom`, `system`, `troubleshooting`.",
|
|
229
229
|
"User profile — hidden chapter IDs (JSON)": "User profile — hidden chapter IDs (JSON)",
|
|
230
|
-
"User hidden chapters JSON help": "JSON array, e.g. `[\"scripts\",\"adapters\"]`. Invalid ids are ignored. `[]` = show all.",
|
|
230
|
+
"User hidden chapters JSON help": "JSON array, e.g. `[\"scripts\",\"adapters\"]`. Invalid ids are ignored. `[]` = show all.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
231
231
|
"User chapter order hint": "Optional: reorder User/Family HTML and User Markdown chapters. Enter chapter ids below in the desired order. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting` — any id you omit is appended in the default order. Empty `[]` = default order. `atAGlance` appears only when the structured Quick Start block has data (discovery); reordering cannot create that content.",
|
|
232
232
|
"User chapter order (JSON array)": "User chapter order (JSON array)",
|
|
233
|
-
"User chapter order JSON help": "JSON array of chapter ids, e.g. `[\"atAGlance\",\"rooms\",\"manual\",\"adapters\"]`. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `atAGlance` outputs only when Quick Start has content.",
|
|
233
|
+
"User chapter order JSON help": "JSON array of chapter ids, e.g. `[\"atAGlance\",\"rooms\",\"manual\",\"adapters\"]`. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `atAGlance` outputs only when Quick Start has content.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
234
234
|
"Onboarding HTML — hide chapters": "Onboarding HTML — hide chapters",
|
|
235
235
|
"Onboarding hidden chapters hint": "Hide blocks in Onboarding HTML and matching parts of Markdown (profile Onboarding). Valid ids: `welcome`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid` (owner diagram in the welcome area), `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, plus for Markdown also `quickstart`, `system`, `manual` (project description/contact in welcome + manual chapter subsections).",
|
|
236
236
|
"Onboarding profile — hidden chapter IDs (JSON)": "Onboarding profile — hidden chapter IDs (JSON)",
|
|
237
|
-
"Onboarding hidden chapters JSON help": "JSON array, e.g. `[\"adapters\",\"stats\"]`. Invalid ids are ignored. `[]` = show all.",
|
|
237
|
+
"Onboarding hidden chapters JSON help": "JSON array, e.g. `[\"adapters\",\"stats\"]`. Invalid ids are ignored. `[]` = show all.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
238
238
|
"Onboarding chapter order hint": "Optional: reorder Onboarding/Guest HTML and Onboarding Markdown chapters.\n\nValid ids: `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual` — any id you omit is appended in the default order.\n\nEmpty `[]` = default order.\n\n`quickstart` always includes the welcome line, adapter counts, and next steps; the discovery snapshot (rooms / setup lines from your installation) appears only when that data exists.",
|
|
239
239
|
"Onboarding chapter order (JSON array)": "Onboarding chapter order (JSON array)",
|
|
240
|
-
"Onboarding chapter order JSON help": "JSON array of chapter ids, e.g. `[\"quickstart\",\"tips\",\"rooms\",\"adapters\"]`. Valid ids: `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `quickstart` always shows welcome, counts, next steps; discovery block only when `quickStart.hasContent
|
|
240
|
+
"Onboarding chapter order JSON help": "JSON array of chapter ids, e.g. `[\"quickstart\",\"tips\",\"rooms\",\"adapters\"]`. Valid ids: `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `quickstart` always shows welcome, counts, next steps; discovery block only when `quickStart.hasContent`.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
241
241
|
"Advanced base URL callout": "Guests & QR / copy link: Enter the URL you would use in a phone browser to open ioBroker Admin (scheme + host + port, no trailing slash). If that differs from Docker-internal hostnames or from a reverse-proxy public name, set it explicitly — auto-detection often fails in containers or behind HTTPS offload.",
|
|
242
242
|
"copyForForum": "Copy for Forum",
|
|
243
243
|
"Docs link README public base URL": "DE user guide — Public base URL / QR (GitHub)",
|
|
244
244
|
"Docs link wiki German config": "German wiki — Tabs overview (DE) (GitHub)",
|
|
245
245
|
"Docs link README Mermaid cookbook": "README — Mermaid cookbook examples (GitHub)",
|
|
246
246
|
"Docs link README JSON cookbook": "README — JSON cookbook snippets (GitHub)",
|
|
247
|
+
"Docs link wiki DE chapter layout step 6": "User guide DE — Step 6: hide & chapter order (GitHub)",
|
|
247
248
|
"Docs link README PDF export": "DE user guide — Optional PDF export / Puppeteer (GitHub)",
|
|
248
249
|
"Docs link README HTML CSS": "README — HTML custom CSS examples (GitHub)",
|
|
249
250
|
"Docs link README documentation overview basic": "DE user guide — Project & documentation language (Basics tab) (GitHub)",
|
package/admin/i18n/pl.json
CHANGED
|
@@ -192,7 +192,7 @@
|
|
|
192
192
|
"AI context hints hint": "Private to the AI — never appears in exported docs. Use short bullets with concrete facts (rooms, times, routines); vague filler does not help the model.\n\nGuest / onboarding: Everyday language. Heavy admin or IT jargon may force neutral boilerplate for visitors instead of raw AI output (on purpose). User/family profile is not filtered the same way.\n\nExamples: `- Living-room lights off at 22:30` · `- Guest Wi‑Fi label on the router`",
|
|
193
193
|
"AI context hints help": "Prompt-only — not copied into HTML/Markdown exports. Sent to your AI provider each run. Guest profile: dense admin/IT wording here may yield neutral boilerplate for visitors (see grey box). Prefer plain facts, e.g. `- Bedroom blinds close at 22:00`.",
|
|
194
194
|
"HTML export & extra sections": "HTML export & extra sections",
|
|
195
|
-
"Doc layout intro": "HTML (admin, user, onboarding): theme & logo at the top, chapter visibility and custom sections next, optional font / extra CSS at the bottom.\n\nHide lists and chapter order also apply to Markdown when you pick the same documentation profile on the Basic tab.",
|
|
195
|
+
"Doc layout intro": "HTML (admin, user, onboarding): theme & logo at the top, chapter visibility and custom sections next, optional font / extra CSS at the bottom.\n\nHide lists and chapter order also apply to Markdown when you pick the same documentation profile on the Basic tab.\n\nUnder **Which chapters to show (per profile)**, clickable GitHub links open the English JSON cookbook snippets plus the German wiki — step 6 — for hide/order recipes in plain language.",
|
|
196
196
|
"Doc layout pdf hint": "PDF: under Advanced (below disk export). Optional after each run, or anytime via `action.exportPdf`.\n\nRequires `puppeteer` in this adapter folder; writes `autodoc-*.pdf` to Files (and mirrors to your path if set).",
|
|
197
197
|
"Advanced HTML styling (optional)": "Advanced HTML styling (optional)",
|
|
198
198
|
"Advanced HTML styling hint": "Expert / optional: Custom font and CSS change how exported HTML looks. Syntax mistakes or future AutoDoc updates can make the layout look wrong — leave these fields empty if you are unsure.",
|
|
@@ -216,10 +216,10 @@
|
|
|
216
216
|
"Admin HTML — hide chapters": "Admin HTML — hide chapters",
|
|
217
217
|
"Admin chapter order hint": "Optional: reorder Admin HTML and Admin Markdown. Enter chapter ids in the JSON field below (`[]` = built-in order). Ids you omit are appended in the default product order at the end. The full list of valid English ids appears only in that field’s help (click the `?` tooltip) — it is not repeated here.",
|
|
218
218
|
"Admin chapter order (JSON array)": "Admin chapter order (JSON array)",
|
|
219
|
-
"Admin chapter order JSON help": "JSON array of chapter ids, e.g. `[\"system\",\"adapters\",\"manual\"]`. Valid ids (exact English): `manual`, `system`, `adapters`, `rooms`, `scripts`, `schedule`, `userdata`, `aliases`, `maintenance`, `diagnosis`, `troubleshooting`, `custom`, `changelog`, `appendices`. Unknown ids are skipped; omitted ids append in default order. `[]` = built-in order.",
|
|
219
|
+
"Admin chapter order JSON help": "JSON array of chapter ids, e.g. `[\"system\",\"adapters\",\"manual\"]`. Valid ids (exact English): `manual`, `system`, `adapters`, `rooms`, `scripts`, `schedule`, `userdata`, `aliases`, `maintenance`, `diagnosis`, `troubleshooting`, `custom`, `changelog`, `appendices`. Unknown ids are skipped; omitted ids append in default order. `[]` = built-in order.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
220
220
|
"Admin hidden chapters hint": "Chapter ids to omit from Admin HTML and from Markdown when the profile is Admin — e.g. `[\"diagnosis\",\"changelog\",\"custom\"]`. Same valid English ids as for chapter order; the full list is only in the help for Admin chapter order (that JSON field is below on this page). Invalid ids are ignored.",
|
|
221
221
|
"Hidden chapter IDs (JSON array)": "Hidden chapter IDs (JSON array)",
|
|
222
|
-
"Admin hidden chapters JSON help": "JSON array, e.g. `[\"userdata\",\"aliases\"]`. Same valid ids as Admin chapter order (see that field). `[]` = show all chapters.",
|
|
222
|
+
"Admin hidden chapters JSON help": "JSON array, e.g. `[\"userdata\",\"aliases\"]`. Same valid ids as Admin chapter order (see that field). `[]` = show all chapters.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
223
223
|
"Custom Markdown sections": "Custom Markdown sections",
|
|
224
224
|
"Custom sections JSON hint": "JSON array of objects: `{ \"title\": \"Wi-Fi\", \"body\": \"Guest …\", \"profiles\": [\"user\",\"onboarding\"] }`. body is Markdown (no raw HTML). profiles optional — omit to show in all three HTML profiles. Max 12 sections; long text is truncated. Example uses: emergency contacts, Wi-Fi, router model.",
|
|
225
225
|
"Custom sections (JSON)": "Custom sections (JSON)",
|
|
@@ -227,23 +227,24 @@
|
|
|
227
227
|
"User/Family HTML — hide chapters": "User/Family HTML — hide chapters",
|
|
228
228
|
"User hidden chapters hint": "JSON array of chapter ids to hide in User/Family HTML and in Markdown when the documentation profile is User. Example: `[\"scripts\",\"adapters\"]`. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid` (user-defined Mermaid diagram), `mermaidAuto` (auto-generated host topology — not shown in Onboarding), `adapters`, `custom`, `system`, `troubleshooting`.",
|
|
229
229
|
"User profile — hidden chapter IDs (JSON)": "User profile — hidden chapter IDs (JSON)",
|
|
230
|
-
"User hidden chapters JSON help": "JSON array, e.g. `[\"scripts\",\"adapters\"]`. Invalid ids are ignored. `[]` = show all.",
|
|
230
|
+
"User hidden chapters JSON help": "JSON array, e.g. `[\"scripts\",\"adapters\"]`. Invalid ids are ignored. `[]` = show all.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
231
231
|
"User chapter order hint": "Optional: reorder User/Family HTML and User Markdown chapters. Enter chapter ids below in the desired order. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting` — any id you omit is appended in the default order. Empty `[]` = default order. `atAGlance` appears only when the structured Quick Start block has data (discovery); reordering cannot create that content.",
|
|
232
232
|
"User chapter order (JSON array)": "User chapter order (JSON array)",
|
|
233
|
-
"User chapter order JSON help": "JSON array of chapter ids, e.g. `[\"atAGlance\",\"rooms\",\"manual\",\"adapters\"]`. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `atAGlance` outputs only when Quick Start has content.",
|
|
233
|
+
"User chapter order JSON help": "JSON array of chapter ids, e.g. `[\"atAGlance\",\"rooms\",\"manual\",\"adapters\"]`. Valid ids: `manual`, `ai`, `guestHelp`, `atAGlance`, `rooms`, `scripts`, `routines`, `ownerPlaybook`, `mermaid`, `adapters`, `custom`, `system`, `troubleshooting`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `atAGlance` outputs only when Quick Start has content.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
234
234
|
"Onboarding HTML — hide chapters": "Onboarding HTML — hide chapters",
|
|
235
235
|
"Onboarding hidden chapters hint": "Hide blocks in Onboarding HTML and matching parts of Markdown (profile Onboarding). Valid ids: `welcome`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid` (owner diagram in the welcome area), `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, plus for Markdown also `quickstart`, `system`, `manual` (project description/contact in welcome + manual chapter subsections).",
|
|
236
236
|
"Onboarding profile — hidden chapter IDs (JSON)": "Onboarding profile — hidden chapter IDs (JSON)",
|
|
237
|
-
"Onboarding hidden chapters JSON help": "JSON array, e.g. `[\"adapters\",\"stats\"]`. Invalid ids are ignored. `[]` = show all.",
|
|
237
|
+
"Onboarding hidden chapters JSON help": "JSON array, e.g. `[\"adapters\",\"stats\"]`. Invalid ids are ignored. `[]` = show all.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
238
238
|
"Onboarding chapter order hint": "Optional: reorder Onboarding/Guest HTML and Onboarding Markdown chapters.\n\nValid ids: `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual` — any id you omit is appended in the default order.\n\nEmpty `[]` = default order.\n\n`quickstart` always includes the welcome line, adapter counts, and next steps; the discovery snapshot (rooms / setup lines from your installation) appears only when that data exists.",
|
|
239
239
|
"Onboarding chapter order (JSON array)": "Onboarding chapter order (JSON array)",
|
|
240
|
-
"Onboarding chapter order JSON help": "JSON array of chapter ids, e.g. `[\"quickstart\",\"tips\",\"rooms\",\"adapters\"]`. Valid ids: `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `quickstart` always shows welcome, counts, next steps; discovery block only when `quickStart.hasContent
|
|
240
|
+
"Onboarding chapter order JSON help": "JSON array of chapter ids, e.g. `[\"quickstart\",\"tips\",\"rooms\",\"adapters\"]`. Valid ids: `welcome`, `quickstart`, `tips`, `guestHelp`, `stats`, `ai`, `capabilities`, `mermaid`, `rooms`, `routines`, `ownerPlaybook`, `automations`, `adapters`, `custom`, `hint`, `system`, `manual`. Unknown ids skipped; omitted ids append in default order. `[]` = built-in order. `quickstart` always shows welcome, counts, next steps; discovery block only when `quickStart.hasContent`.\n\nIf your order or hide list seemingly does nothing: check the adapter log for skipped unknown or duplicate ids on each documentation run. Copy-paste recipes: use the two GitHub links under **Which chapters to show (per profile)** on this tab.",
|
|
241
241
|
"Advanced base URL callout": "Guests & QR / copy link: Enter the URL you would use in a phone browser to open ioBroker Admin (scheme + host + port, no trailing slash). If that differs from Docker-internal hostnames or from a reverse-proxy public name, set it explicitly — auto-detection often fails in containers or behind HTTPS offload.",
|
|
242
242
|
"copyForForum": "Copy for Forum",
|
|
243
243
|
"Docs link README public base URL": "DE user guide — Public base URL / QR (GitHub)",
|
|
244
244
|
"Docs link wiki German config": "German wiki — Tabs overview (DE) (GitHub)",
|
|
245
245
|
"Docs link README Mermaid cookbook": "README — Mermaid cookbook examples (GitHub)",
|
|
246
246
|
"Docs link README JSON cookbook": "README — JSON cookbook snippets (GitHub)",
|
|
247
|
+
"Docs link wiki DE chapter layout step 6": "User guide DE — Step 6: hide & chapter order (GitHub)",
|
|
247
248
|
"Docs link README PDF export": "DE user guide — Optional PDF export / Puppeteer (GitHub)",
|
|
248
249
|
"Docs link README HTML CSS": "README — HTML custom CSS examples (GitHub)",
|
|
249
250
|
"Docs link README documentation overview basic": "DE user guide — Project & documentation language (Basics tab) (GitHub)",
|