Issue 1170 - [adblockplus.org Anwiki to CMS migration] Migrate content

includes/interface.tmpl

Index: includes/interface.tmpl
diff --git a/includes/interface.tmpl b/includes/interface.tmpl
new file mode 100644
index 0000000000000000000000000000000000000000..4738467b958beba7a505ffc8ca31757e0ca5c634
--- /dev/null
+++ b/includes/interface.tmpl
@@ -0,0 +1,96 @@
+{#
+ # This file is part of the Adblock Plus website,
+ # Copyright (C) 2006-2015 Eyeo GmbH
+ #
+ # Adblock Plus is free software: you can redistribute it and/or modify
+ # it under the terms of the GNU General Public License version 3 as
+ # published by the Free Software Foundation.
+ #
+ # Adblock Plus is distributed in the hope that it will be useful,
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ # GNU General Public License for more details.
+ #
+ # You should have received a copy of the GNU General Public License
+ # along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
+ #}
+{% from "includes/common" import description with context %}

[Wladimir Palant, 2015/03/06 23:21:06]

I changed the converter script and implemented a better solution here. Instead
of implicit assumptions about the structure of various descriptions,
corresponding localization strings and mapping to links the template defines a
bunch of macros for the descriptions. It then references these macros as part of
the interface structure - "description" property is a macro that generates
property/method description, there are also "description-arg" and
"description-return" properties. The macros are localized exactly like all the
pages we have.

So in order to add the description for a property this template now only needs
to say:

{{ property.description() }}

For a method argument it is slightly more complicated:

{{ property["description-" + argument.name]() }}

It would be great if you could implement these changes.

+
+{% macro return_type(return_type) %}
+  {% if return_type|truncate(1, True, "") == "I" %}
+    {{ return_type|linkify }}
+      {{ return_type -}}
+    </a>
+  {% else %}
+    {{ return_type }}
+  {% endif %}
+{% endmacro %}
+
+{% macro display_interface(interface, links) %}
+  {% set interface=interface|parse_interface %}
+
+  <h2>{{ "toc_header"|translate }}</h2>
+  <ul>
+    {% for property in interface %}
+      {% if property.type == "method" %}
+        <li>
+          {{ return_type(property.return_type) }}
+          <a href="#method_{{ property.name }}" class="methodname">{{ property.name }}</a>
+          (
+          {% for argument in property.arguments %}
+            {{ argument.type }} {{argument.name }}
+            {%- if not loop.last %},{% endif %}
+          {% endfor %}
+          )
+        </li>
+      {% else %}
+      <li>
+        {{ property.modifier }} {{ property.type }}
+        <a href="#prop_{{ property.name }}" class="propname">{{ property.name }}</a>
+      </li>
+      {% endif %}
+    {% endfor %}
+  </ul>
+
+  {% for property in interface %}
+    <hr>
+    {% if property.type == "method" %}
+      <p id="method_{{ property.name }}">
+        {{ return_type(property.return_type) }}
+        <span class="methodname">{{ property.name }}</span>
+        (
+        {% for argument in property.arguments %}
+          {{ argument.modifier }} {{ argument.type }} {{ argument.name }}
+          {%- if not loop.last %},{% endif %}
+        {% endfor %}
+        )
+      </p>
+      {{ description(property.name + "Description", links, "<p>", "</p>") }}
+      <dl>
+        {% if property.version %}
+          <dt>Version:</dt>
+          <dd>{{ property.version }} and higher</dd>
+        {% endif %}
+        {% if property.arguments|length %}
+          <dt>Arguments:</dt>
+          {% for argument in property.arguments %}
+            <dd>
+              <span class="argumentname">{{ argument.name }}</span>:
+              {{ description(property.name + "-" + argument.name + "Description", links) }}
+            </dd>
+          {% endfor %}
+        {% endif %}
+        {% if (property.name + "-returnDescription") in localedata %}
+          <dt>Returns:</dt>
+          <dd>{{ description(property.name + "-returnDescription", links) }}</dd>
+        {% endif %}
+      </dl>
+    {% else %}
+      <p id="prop_{{ property.name }}">
+        {{ property.modifier }} {{ property.type }}
+        <span class="propname">{{ property.name }}</span>
+      </p>
+      {{ description(property.name + "Description", links, "<p>", "</p>") }}
+    {% endif %}
+  {% endfor %}
+{% endmacro %}