some docu for the contact templates

diff --git a/templates/contact_template.tpl b/templates/contact_template.tpl
index 13ca175ebefde26757e4d22314339cac031824df..21241d0ab022fc12ca509f5d176a21b049d01ff5 100644 (file)
--- a/templates/contact_template.tpl
+++ b/templates/contact_template.tpl
@@ -1,6 +1,7 @@
 
 <div class="contact-wrapper media" id="contact-entry-wrapper-{{$id}}" >
-       
+
+               {{* This is a wrapper for the contact picture and the dropdown menu with contact relating actions *}}
                <div class="contact-photo-wrapper dropdown pull-left" >
                        <div class="contact-photo mframe" id="contact-entry-photo-{{$contact.id}}" >
 
@@ -33,6 +34,7 @@
                </div>
 
                <div class="media-body">
+                       {{* The contact description (e.g. Name, Network, kind of connection and so on *}}
                        <div class="contact-entry-desc">
                                <div class="contact-entry-name" id="contact-entry-name-{{$contact.id}}" >
                                        <h4 class="media-heading">{{$contact.name}}
@@ -46,6 +48,7 @@
                                {{if $contact.network}}<div class="contact-entry-details" id="contact-entry-network-{{$contact.id}}" >{{$contact.network}}</div>{{/if}}
                        </div>
 
+                       {{* The checkbox to perform batch actions to these contacts (for batch actions have a look at contacts-template.tpl) *}}
                        {{* if !$no_contacts_checkbox *}}
                        {{if $multiselect}}
                        <div class="checkbox contact-entry-checkbox pull-right">
@@ -54,6 +57,5 @@
                        </div>
                        {{/if}}
                </div>
-       
 
 </div>

diff --git a/templates/contacts-template.tpl b/templates/contacts-template.tpl
index 98a2d62fccd66d5f74663a19f177b2fc011576cf..e33855b6d54f20af65c334049f54a35f3e1ed43b 100644 (file)
--- a/templates/contacts-template.tpl
+++ b/templates/contacts-template.tpl
@@ -3,10 +3,12 @@
 
        {{$tabs}}
 
+       {{* The page headding with it's contacts counter *}}
        <h2 class="headding">{{$header}} {{if $total}} ({{$total}}) {{/if}}</h2>
 
        {{if $finding}}<h4>{{$finding}}</h4>{{/if}}
 
+       {{* The search input field to search for contacts *}}
        <div id="contacts-search-wrapper">
                <form id="contacts-search-form" class="navbar-form" action="{{$cmd}}" method="get" >
                        <label for="contacts-search" class="contacts-search-desc">{{$desc}}</label><br/>
@@ -22,7 +24,9 @@
        <hr>
        <div id="contacts-search-end"></div>
 
+       {{* we need the form container to make batch actions work *}}
        <form action="{{$baseurl}}/contacts/batch/" method="POST">
+               {{* We put the contact batch actions in a dropdown menu *}}
                <ul class="nav nav-pills preferences">
                        <li class="dropdown pull-right">
                                <a class="btn btn-link dropdown-toggle" type="button" id="BatchActionDropdownMenuTools" data-toggle="dropdown" aria-expanded="true">
@@ -39,6 +43,7 @@
                </ul>
                <div class="clear">
 
+               {{* format each contact with the contact_template.tpl *}}
                <ul id="viewcontact_wrapper" class="viewcontact_wrapper media-list">
                {{foreach $contacts as $contact}}
                        <li>{{include file="contact_template.tpl"}}</li>
@@ -50,6 +55,8 @@
        {{$paginate}}
 </div>
 
+{{* The modals for Poke and Messages
+this needs to be removed and do it with js *}}
 <div class="modal" id="PokeModal" tabindex="-1" role="dialog" aria-labelledby="PokeModal" aria-hidden="true">
        <div class="modal-dialog">
                <div class="modal-content">

diff --git a/templates/viewcontact_template.tpl b/templates/viewcontact_template.tpl
index 0cc1f24b8f47291eebd0ce12aede4c31766c53e5..4af3a9c28aaece65e9fc2b0b547f5d76a4aa5eb4 100644 (file)
--- a/templates/viewcontact_template.tpl
+++ b/templates/viewcontact_template.tpl
@@ -1,4 +1,7 @@
 
+{{* This is the standard template for showing contact lists. It is used e.g. 
+at the suggest page and also at many other places *}}
+
 {{include file="section_title.tpl"}}
 
 {{$tab_str}}