Changes between Version 2 and Version 3 of Development/Code/TemplateToolkit

Timestamp:

Apr 25, 2012, 1:46:25 AM (12 years ago)

Author:

munoz

Comment:

--

Development/Code/TemplateToolkit

@@ -1 +1 @@
 = Using Template::Toolkit in Quattor components =
+
+== Introduction ==
 
 In some cases, most of the code deals with printing correctly to a file, and it could be simplified a lot by using a basic template instead of zillions of print statements.
@@ -34 +36 @@
 
 Also, we have to be careful so that we don't replace ugly code with even uglier templates!!
+
+== Proposal for the Template Toolkit ==
+
+=== Template storage ===
+
+Since there may be several components using the Template toolkit, I suggest to store them under `/usr/share/quattor/templates`. We'd then create one subdir for each component, like this:
+
+ * `/usr/share/quattor/templates/accounts/`
+ * `/usr/share/quattor/templates/sudo/`
+
+Does it cause any confusion with the Pan templates (mis-)installed under `/usr/share/doc`? If so, we can choose `/usr/share/quattor/tt`.
+
+=== Invoking the templates ===
+
+All components using `Template::Toolkit` will need the smae configuration, namely; the `INCLUDE_PATH` (that should be configurable) and the ability to access variables that start with an underscore. It's easiest to encapsulate all this in the base class. Then, our component would just request this base class the Template object:
+
+{{{
+#!perl
+my ($self, $config) = @_;
+
+my $t = $config->getElement("/software/components/foo")->getTree();
+my $tpl = $self->template();
+my $fh = CAF::FileWriter->open("/etc/file", log => $self);
+print $fh "#A common header\n";
+$tpl->process("component/template.tt", $t, $fh);
+}}}
+
+Alternatively, the base class '''may''' do the parsing on our behalf ('''is this preferred?'''):
+
+{{{
+#!perl
+my $t = ...->getTree();
+my $fh = CAF::FileWriter->open(...);
+$self->process_template("component/template.tt", $t, $fh);
+}}}