dsldevkit · joaodinissf · May 26, 2026 · May 26, 2026 · May 26, 2026 · May 27, 2026
diff --git a/com.avaloq.tools.ddk.check.core/META-INF/MANIFEST.MF b/com.avaloq.tools.ddk.check.core/META-INF/MANIFEST.MF
@@ -27,7 +27,8 @@ Require-Bundle: org.eclipse.xtext,
  com.avaloq.tools.ddk.xtext,
  org.apache.commons.lang3,
  org.apache.commons.text,
- org.objectweb.asm;resolution:=optional
+ org.objectweb.asm;resolution:=optional,
+ org.eclipse.equinox.app
 Export-Package: com.avaloq.tools.ddk.check,
  com.avaloq.tools.ddk.check.check,
  com.avaloq.tools.ddk.check.check.impl,
@@ -44,6 +45,7 @@ Export-Package: com.avaloq.tools.ddk.check,
  com.avaloq.tools.ddk.check.scoping,
  com.avaloq.tools.ddk.check.serializer,
  com.avaloq.tools.ddk.check.services,
+ com.avaloq.tools.ddk.check.standalone,
  com.avaloq.tools.ddk.check.typing,
  com.avaloq.tools.ddk.check.util,
  com.avaloq.tools.ddk.check.validation

diff --git a/com.avaloq.tools.ddk.check.core/plugin.xml b/com.avaloq.tools.ddk.check.core/plugin.xml
@@ -11,4 +11,12 @@
 
   </extension>
 
+  <extension
+       id="docApplication"
+       point="org.eclipse.core.runtime.applications">
+    <application cardinality="singleton-global" thread="main" visible="true">
+       <run class="com.avaloq.tools.ddk.check.standalone.CheckDocApplication"/>
+    </application>
+  </extension>
+
 </plugin>
diff --git a/...ddk.check.core/src/com/avaloq/tools/ddk/check/generator/CheckDocumentationTemplates.xtend b/...ddk.check.core/src/com/avaloq/tools/ddk/check/generator/CheckDocumentationTemplates.xtend
@@ -0,0 +1,285 @@
+/*******************************************************************************
+ * Copyright (c) 2026 Avaloq Group AG and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     Avaloq Group AG - initial API and implementation
+ *******************************************************************************/
+package com.avaloq.tools.ddk.check.generator
+
+import com.avaloq.tools.ddk.check.check.CheckCatalog
+import com.google.inject.Inject
+
+import static extension com.avaloq.tools.ddk.check.generator.CheckGeneratorNaming.*
+
+/**
+ * Emits the Eclipse-Help {@code toc.xml} and context-help {@code contexts.xml}
+ * files for a set of {@link CheckCatalog}s as plain XML strings, plus the
+ * standalone-browser {@code index.html} landing page. Also exposes the shared
+ * {@link #STYLE} block used by both the index and the per-catalog pages.
+ */
+class CheckDocumentationTemplates {
+
+  static val TOC_LABEL = "Check Catalogs"
+  static val TOC_ANCHOR = "../com.avaloq.tools.ddk.check.runtime.ui/toc.xml#checkdocumentation"
+  static val DOCS_REF_PREFIX = "docs/content/"
+
+  /**
+   * Single-source-of-truth stylesheet used by the index page and every per-catalog
+   * HTML page. Inlined into the page {@code <head>} so the output is self-contained
+   * and renders in any standard browser without external assets.
+   */
+  public static val String STYLE = '''
+    :root {
+      --bg: #ffffff;
+      --text: #1f2328;
+      --text-muted: #57606a;
+      --border: #d0d7de;
+      --card-bg: #f6f8fa;
+      --code-bg: #f6f8fa;
+      --link: #0969da;
+      --accent: #218bff;
+      --sev-error-bg: #ffe5e5; --sev-error-text: #82071e; --sev-error-border: #ffadb0;
+      --sev-warning-bg: #fff8c5; --sev-warning-text: #633c01; --sev-warning-border: #f3df5b;
+      --sev-info-bg: #ddf4ff; --sev-info-text: #054a72; --sev-info-border: #80ccff;
+      --sev-ignore-bg: #eaeef2; --sev-ignore-text: #57606a; --sev-ignore-border: #d0d7de;
+    }
+    @media (prefers-color-scheme: dark) {
+      :root {
+        --bg: #0d1117;
+        --text: #e6edf3;
+        --text-muted: #8d96a0;
+        --border: #30363d;
+        --card-bg: #161b22;
+        --code-bg: #161b22;
+        --link: #58a6ff;
+        --accent: #1f6feb;
+        --sev-error-bg: #3d1419; --sev-error-text: #ffa198; --sev-error-border: #6e1216;
+        --sev-warning-bg: #3a2c00; --sev-warning-text: #f0d97c; --sev-warning-border: #7a5a00;
+        --sev-info-bg: #0c2d4a; --sev-info-text: #79c0ff; --sev-info-border: #1f6feb;
+        --sev-ignore-bg: #1c2128; --sev-ignore-text: #8d96a0; --sev-ignore-border: #30363d;
+      }
+    }
+    * { box-sizing: border-box; }
+    body {
+      font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif;
+      font-size: 16px;
+      line-height: 1.55;
+      color: var(--text);
+      background: var(--bg);
+      max-width: 820px;
+      margin: 0 auto;
+      padding: 2rem 1.25rem 4rem;
+    }
+    h1 { font-size: 1.875rem; margin: 0 0 0.5rem; }
+    h2 { font-size: 1.375rem; margin: 2rem 0 1rem; padding-bottom: 0.4rem; border-bottom: 1px solid var(--border); }
+    h3 { font-size: 1.05rem; margin: 0; }
+    p { margin: 0.5rem 0; }
+    a { color: var(--link); text-decoration: none; }
+    a:hover { text-decoration: underline; }
+    header.catalog-header { margin-bottom: 1.5rem; padding-bottom: 1rem; border-bottom: 1px solid var(--border); }
+    header.catalog-header p { color: var(--text-muted); }
+    a.back-link { display: inline-block; margin-bottom: 0.75rem; font-size: 0.875rem; color: var(--text-muted); }
+    a.back-link:hover { color: var(--link); }
+    nav.jump {
+      margin-top: 1rem;
+      padding: 0.75rem 1rem;
+      background: var(--card-bg);
+      border: 1px solid var(--border);
+      border-radius: 6px;
+      font-size: 0.9rem;
+    }
+    nav.jump strong { display: block; margin-bottom: 0.4rem; font-size: 0.8rem; text-transform: uppercase; letter-spacing: 0.05em; color: var(--text-muted); }
+    nav.jump ul { margin: 0; padding-left: 1.25rem; }
+    nav.jump li { margin: 0.15rem 0; }
+    section.category { margin: 2rem 0; }
+    section.category > p { color: var(--text-muted); margin-bottom: 0.75rem; }
+    article.check {
+      margin: 0.75rem 0;
+      padding: 0.85rem 1.15rem;
+      background: var(--card-bg);
+      border: 1px solid var(--border);
+      border-radius: 6px;
+    }
+    article.check > header {
+      display: flex;
+      align-items: baseline;
+      gap: 0.6rem;
+      flex-wrap: wrap;
+    }
+    article.check a.anchor {
+      visibility: hidden;
+      color: var(--text-muted);
+      font-weight: 400;
+      font-size: 0.85em;
+    }
+    article.check > header:hover a.anchor { visibility: visible; }
+    article.check:target {
+      border-color: var(--accent);
+      box-shadow: 0 0 0 3px rgba(33, 139, 255, 0.18);
+    }
+    .severity {
+      display: inline-block;
+      padding: 0.1rem 0.6rem;
+      font-size: 0.72rem;
+      font-weight: 600;
+      text-transform: uppercase;
+      letter-spacing: 0.05em;
+      border-radius: 999px;
+      border: 1px solid transparent;
+      white-space: nowrap;
+    }
+    .severity.sev-error   { background: var(--sev-error-bg);   color: var(--sev-error-text);   border-color: var(--sev-error-border); }
+    .severity.sev-warning { background: var(--sev-warning-bg); color: var(--sev-warning-text); border-color: var(--sev-warning-border); }
+    .severity.sev-info    { background: var(--sev-info-bg);    color: var(--sev-info-text);    border-color: var(--sev-info-border); }
+    .severity.sev-ignore  { background: var(--sev-ignore-bg);  color: var(--sev-ignore-text);  border-color: var(--sev-ignore-border); }
+    pre.message {
+      margin: 0.6rem 0 0;
+      padding: 0.55rem 0.8rem;
+      background: var(--code-bg);
+      border: 1px solid var(--border);
+      border-radius: 6px;
+      font-family: ui-monospace, SFMono-Regular, "SF Mono", Menlo, Consolas, monospace;
+      font-size: 0.85rem;
+      white-space: pre-wrap;
+      word-break: break-word;
+    }
+    pre.message::before {
+      content: "Message";
+      display: block;
+      font-family: inherit;
+      font-size: 0.68rem;
+      font-weight: 600;
+      text-transform: uppercase;
+      letter-spacing: 0.05em;
+      color: var(--text-muted);
+      margin-bottom: 0.2rem;
+    }
+    ul.catalog-list { list-style: none; padding: 0; margin: 1.5rem 0 0; }
+    ul.catalog-list li {
+      margin: 0.75rem 0;
+      padding: 1rem 1.25rem;
+      background: var(--card-bg);
+      border: 1px solid var(--border);
+      border-radius: 6px;
+    }
+    ul.catalog-list li h2 { margin: 0; border-bottom: none; padding-bottom: 0; font-size: 1.2rem; }
+    ul.catalog-list li p { color: var(--text-muted); margin: 0.25rem 0 0; }
+  '''
+
+  @Inject extension CheckGeneratorNaming naming
+  @Inject extension CheckGeneratorExtensions extensions
+
+  /** Build the contents of {@code docs/toc.xml} aggregating every catalog in {@code catalogs}. */
+  def CharSequence compileToc(Iterable<CheckCatalog> catalogs) {
+    val sorted = catalogs.sortBy[name]
+    '''
+      <?xml version="1.0" encoding="UTF-8"?>
+      <toc label="«TOC_LABEL»" link_to="«TOC_ANCHOR»">
+      «FOR catalog : sorted»
+         <topic href="«catalog.docRef»" label="«catalog.name»" sort="false">
+      «FOR category : catalog.categories»
+            <topic href="«catalog.docRef»#«category.contextId»" label="«category.label.attrEscape»">
+      «FOR check : category.checks»
+               <topic href="«catalog.docRef»#«check.contextId»" label="«check.label.attrEscape»">
+               </topic>
+      «ENDFOR»
+            </topic>
+      «ENDFOR»
+      «FOR check : catalog.checks»
+            <topic href="«catalog.docRef»#«check.contextId»" label="«check.label.attrEscape»">
+            </topic>
+      «ENDFOR»
+         </topic>
+      «ENDFOR»
+      </toc>
+    '''
+  }
+
+  /** Build the contents of {@code docs/contexts.xml} aggregating every check across {@code catalogs}. */
+  def CharSequence compileContexts(Iterable<CheckCatalog> catalogs) {
+    val entries = catalogs
+      .flatMap[allChecks]
+      .map[check | new ContextEntry(check.contextId, check.label.attrEscape, parentCatalog(check).docRef + "#" + check.contextId)]
+      .sortBy[id]
+    '''
+      <?xml version="1.0" encoding="UTF-8"?>
+      <contexts>
+      «FOR e : entries»
+         <context id="«e.id»">
+            <topic href="«e.href»" label="«e.label»"/>
+         </context>
+      «ENDFOR»
+      </contexts>
+    '''
+  }
+
+  /** Build the contents of {@code docs/index.html} listing every catalog with a link to its page. */
+  def CharSequence compileIndex(Iterable<CheckCatalog> catalogs) {
+    val sorted = catalogs.sortBy[name]
+    '''
+      <!DOCTYPE html>
+      <html lang="en">
+      <head>
+        <meta charset="UTF-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+        <title>Check Catalogs</title>
+        <style>
+      «STYLE»
+        </style>
+      </head>
+      <body>
+        <header class="catalog-header">
+          <h1>Check Catalogs</h1>
+          <p>«sorted.size» catalog«IF sorted.size != 1»s«ENDIF» documented.</p>
+        </header>
+        <main>
+          <ul class="catalog-list">
+            «FOR catalog : sorted»
+            <li id="«catalog.name»">
+              <h2><a href="«catalog.indexRef»">«catalog.name»</a></h2>
+              «val description = catalog.description.formatDescription»
+              «IF description !== null»
+              <p>«description»</p>
+              «ENDIF»
+            </li>
+            «ENDFOR»
+          </ul>
+        </main>
+      </body>
+      </html>
+    '''
+  }
+
+  def private String docRef(CheckCatalog c) {
+    DOCS_REF_PREFIX + c.docFileName
+  }
+
+  def private CheckCatalog parentCatalog(org.eclipse.emf.ecore.EObject o) {
+    org.eclipse.xtext.EcoreUtil2.getContainerOfType(o, CheckCatalog)
+  }
+
+  /** Path used from {@code index.html} (same directory as {@code content/}). */
+  def private String indexRef(CheckCatalog c) {
+    "content/" + c.docFileName
+  }
+
+  /** Escape characters that have special meaning inside an XML attribute value. */
+  def private String attrEscape(String s) {
+    s?.replace("&", "&amp;")
+      ?.replace("'", "&apos;")
+      ?.replace("\"", "&quot;")
+      ?.replace("<", "&lt;")
+      ?.replace(">", "&gt;")
+  }
+
+  @org.eclipse.xtend.lib.annotations.Data
+  private static class ContextEntry {
+    String id
+    String label
+    String href
+  }
+}