[#2801] Documented the related item snippets

Also updated an instance of {% include %} to use snippets

ckan/templates/related/snippets/related_item.html

@@ -1,7 +1,19 @@
+{#
+Displays a single related item.
+
+related - The related item dict.
+pkg_id  - The id of the owner package. If present the edit button will be
+          displayed.
+
+Example:
+
+
+
+#}
 {% set placeholder_map = {
 'application':'/base/images/placeholder-application.png'
 } %}
-<li class="related-item media-item media media-vertical{% if first %} first{% endif %}{% if last %} last{% endif %}">
+<li class="related-item media-item media media-vertical{% if first %} first{% endif %}{% if last %} last{% endif %}" data-module="related-item">
   <a class="media-image" href="{{ related.url }}">
     <img src="{{ related.image_url or placeholder_map[related.type] or '/base/images/placeholder-image.png' }}" alt="{{ related.title }}" />
     <span class="banner">
@@ -27,7 +39,7 @@ <h3 class="media-heading">
     {% endif %}
     <a class="btn btn-small btn-primary" href="{{ related.url }}" target="_blank">{{ _('Go to {type}').format(type=related.type|replace('_', ' ')|title) }}</a>
     {% if pkg_id %}
-    {{ h.nav_link(_('Edit'), controller='related', action='edit', id=pkg_id, related_id=related.id, class_='btn btn-small') }}
+      {{ h.nav_link(_('Edit'), controller='related', action='edit', id=pkg_id, related_id=related.id, class_='btn btn-small') }}
     {% endif %}
   </div>
 </li>

ckan/templates/related/snippets/related_list.html

@@ -1,7 +1,22 @@
+{#
+Renders a list of related item elements
+
+related_items - A list of related items.
+pkg_id - A package id for the items used to determine if the edit button
+         should be displayed.
+first  - True if the first item in a row.
+last   - True if the last item in a row.
+
+Example:
+
+
+  {% snippet "related/snippets/related_list.html", related_items=c.pkg.related, pkg_id=c.pkg.name %}
+
+#}
 <ul class="media-grid">
   {% for related in related_items %}
     {% set first = loop.index0 % 3 == 0 %}
     {% set last  = loop.index0 % 3 == 2 %}
-    {% include "related/snippets/related_item.html" %}
+    {% snippet "related/snippets/related_item.html", pkg_id=pkg_id, related=related, first=first, last=last %}
   {% endfor %}
 </ul>