X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=templates%2Ffactory%2Fview;h=6736da61c4f9fc825bcda2f9feeb6740a7171a46;hb=d77cc42a2fd0ae059128043822ef127199e55ed2;hp=64c760b11cc0f9672957bf8669828e143e5b2276;hpb=e419be5cf346381154e2256548e94968db293d02;p=maypole.git

diff --git a/templates/factory/view b/templates/factory/view
index 64c760b..6736da6 100644
--- a/templates/factory/view
+++ b/templates/factory/view
@@ -1,35 +1,73 @@
+[%#
+
+=for doc
+
+The C<view> template takes some objects (usually just one) from
+C<objects> and displays the object's properties in a table. 
+
+=cut
+
+#%]
 [% PROCESS macros %]
 [% INCLUDE header %]
-
 [% FOR item = objects %]
-<h2> [% item.name %]</h2>
+    [% SET string = item.stringify_column %]
+    <h2> [% item.$string %]</h2>
+    [% INCLUDE navbar %]
+    <table class="view">
+        <tr>
+            <td class="field">[% classmetadata.colnames.$string %]</td>
+            <td>[% item.$string %]</td>
+        </tr>
+        [% FOR col = classmetadata.columns.list;
+            NEXT IF col == "id" OR col == string;
+            NEXT UNLESS item.$col;
+        %]
+[%# 
 
-[% INCLUDE navbar %]
+=for doc
 
-<TABLE class="view">
-    <TR><TD class="field">Name</TD><TD> [% item.name %] </TD></TR>
-[% 
-    FOR col = classmetadata.columns.list;
-    NEXT IF col == "id" OR col == "name";
-    NEXT UNLESS item.$col;
-%]
+It gets the displayable form of a column's name from the hash returned
+from the C<column_names> method:
 
-<TR>
-    <TD class="field"> [% classmetadata.colnames.$col; %] </TD>
-    <TD> [%
+#%]
+            <tr>
+                <td class="field">[% classmetadata.colnames.$col; %]</td>
+                <td>
+                    [% IF col == "url";  # Possibly too much magic.
+                        "<a href="; item.url; "> "; item.url; "</a>";
+                    ELSE;
+                        maybe_link_view(item.$col); 
+                    END; %]
+[%#
 
-    IF col == "url";  # Possibly too much magic.
-                "<A HREF="; item.url; "> "; item.url; "</A>";
-    ELSE;
-    maybe_link_view(item.$col); END;
-    %] </TD>
-</TR>
-[% END; %]
-</TABLE>
+This tests whether or not the returned value is an object, and if so,
+creates a link to a page viewing that object; if not, it just displays
+the text as normal. The object is linked using its stringified name;
+by default this calls the C<name> method, or returns the object's ID
+if there is no C<name> method or other stringification method defined.
+
+=cut
+
+#%] 
+                </td>
+            </tr>
+        [% END; %]
+    </table>
+[%#
+
+=for doc
+
+The C<view> template also displays a list of other objects related to the first
+one via C<has_many> style relationships; this is done by calling the
+C<related_accessors> method - see L<Model/related_accessors> - to return
+a list of has-many accessors. Next it calls each of those accessors, and
+displays the results in a table.
+
+#%]
 [%
     view_related(item);
     button(item, "edit");
     button(item, "delete");
 %]
 [% END; %]
-