This is a (slightly dodgy) way of keeping template documentation with

[maypole.git] / templates / factory / view

diff --git a/templates/factory/view b/templates/factory/view
index 64c760b11cc0f9672957bf8669828e143e5b2276..0ea412e2291831ecef58891ce43c3f22bd8ac0c2 100644 (file)
--- a/templates/factory/view
+++ b/templates/factory/view
@@ -1,3 +1,13 @@
+[%#
+
+=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 %]
 
@@ -14,20 +24,66 @@
     NEXT UNLESS item.$col;
 %]
 
-<TR>
+[%# 
+
+=for doc
+
+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> [%
 
+#=cut
+
     IF col == "url";  # Possibly too much magic.
                 "<A HREF="; item.url; "> "; item.url; "</A>";
     ELSE;
-    maybe_link_view(item.$col); END;
-    %] </TD>
+
+#=for doc
+
+#One interesting macro used in this template is C<maybe_link_view>:
+
+        maybe_link_view(item.$col); 
+%]
+
+[%#
+
+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
+
+#%] 
+
+[% END; %]
+ </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);
+
+#=cut
+
     button(item, "edit");
     button(item, "delete");
 %]