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

includes/interface.tmpl

 {#
  # 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 %}
@@ skipping 30 matching lines @@
       <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>") }}
+      {{ property.description() }}
       <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) }}
+              {{ property["description-" + argument.name]() }}
             </dd>
           {% endfor %}
         {% endif %}
-        {% if (property.name + "-returnDescription") in localedata %}
+        {% if "description-return" in property %}
           <dt>Returns:</dt>
-          <dd>{{ description(property.name + "-returnDescription", links) }}</dd>
+          <dd>{{ property["description-return"]() }}</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>") }}
+      {{ property.description() }}
     {% endif %}
   {% endfor %}
 {% endmacro %}