feat: 関数の定義のメソッドの見出しにツールチップを追加

Author: 3w36zj6

static/assets/icons/16-warn.svg

@@ -528,6 +528,15 @@ h1 .pill {
   margin-bottom: -3px
 }
 
+.deprecation {
+  align-items: baseline;
+}
+
+.deprecation svg {
+  margin-bottom: -4px;
+  padding: 0;
+}
+
 .tooltip-context {
   position: relative
 }

static/styles/docs.css

@@ -3,8 +3,17 @@
 {% extends "base_template.html.j2" %}
 {% block content %}
 
-<h1 id="summary"><code>{{ body['content']['name'] }}</code><small>{% if body['content']['element'] %}{{
-  macros.tooltip_display('Element', 'Element functions can be customized with <code>set</code> and <code>show</code> rules.') }}{% endif %}</small></h1>
+<h1 id="summary">
+  <code>{{ body['content']['name'] }}</code>
+  <small>
+    {% if body['content']['element'] %}
+      {{ macros.tooltip_display('Element', 'Element functions can be customized with <code>set</code> and <code>show</code> rules.') }}
+    {% endif %}
+    {% if body['content']['contextual'] %}
+      {{ macros.tooltip_display('Contextual', 'Contextual functions can only be used when the context is known') }}
+    {% endif %}
+  </small>
+</h1>
 {{ body['content']['details'] | safe }}
 <h2 id="parameters">
   {{ macros.tooltip_display('引数', 'Parameters are the inputs to a function. They are specified in parentheses after the function name.', prefix='parameters') }}
@@ -22,7 +31,34 @@
 </h2>
 {% endif %}
 {% for method in body['content']['scope'] %}
-  <h3 id="{{ prefix }}-{{ method['name'] }}" class="method-head"><span><code>{{ method['name'] }}</code></span></h3>
+  <h3 id="definitions-{{ method['name'] }}" class="method-head">
+    <code{% if method['deprecation'] %} style="text-decoration: line-through;"{% endif %}>{{ method['name'] }}</code>
+
+    <small>
+      {% if method['element'] %}
+        {{ macros.tooltip_display('Element', 'Element functions can be customized with <code>set</code> and <code>show</code> rules.') }}
+      {% endif %}
+      {% if method['contextual'] %}
+        {{ macros.tooltip_display('Contextual', 'Contextual functions can only be used when the context is known') }}
+      {% endif %}
+    </small>
+    {% if method['deprecation'] %}
+      <small class="deprecation">
+        <div class="tooltip-context">
+          <svg width="16" height="16" viewBox="0 0 16 16" tabindex="0" role="img"
+              aria-labelledby="definitions-{{ method['name'] }}-deprecation-tooltip">
+            <title id="definitions-{{ method['name'] }}-deprecation-tooltip">
+              Warning
+            </title>
+            <use href="/assets/icons/16-warn.svg#icon"></use>
+          </svg>
+        </div>
+        <span>
+          <span>{{ method['deprecation'] }}</span>
+        </span>
+      </small>
+    {% endif %}
+  </h3>
   {{ macros.function_display(method, type2href, type2class, gen_path, prefix='definitions-' + method['name']) }}
 {% endfor %}
 

templates/func_template.html.j2

@@ -20,7 +20,17 @@
 </h2>
 {% endif %}
 {% for method in body['content']['scope'] %}
-  <h3 id="{{ prefix }}-{{ method['name'] }}" class="method-head"><span><code>{{ method['name'] }}</code></span></h3>
+  <h3 id="definitions-{{ method['name'] }}" class="method-head">
+    <code>{{ method['name'] }}</code>
+    <small>
+      {% if method['element'] %}
+        {{ macros.tooltip_display('Element', 'Element functions can be customized with <code>set</code> and <code>show</code> rules.') }}
+      {% endif %}
+      {% if method['contextual'] %}
+        {{ macros.tooltip_display('Contextual', 'Contextual functions can only be used when the context is known') }}
+      {% endif %}
+    </small>
+  </h3>
   {{ macros.function_display(method, type2href, type2class, gen_path, prefix='definitions-' + method['name']) }}
 {% endfor %}