Sourcefabric Manuals

 English |  Español |  Français |  Italiano |  Português |  Русский |  Shqip

Newscoop 4.2 Cookbook

Using javascript and PHP in templates

The Newscoop template engine comes with a set of custom functions which are used in examples in this Cookbook. A full template reference can be found at the end of the book. Everything involving the $gimme object is Newscoop related.

But You are not limited only to Newscoop templating system. You can use every javascript library You want or/and write Your own code. 

Including jQuery in your templates

jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. If you haven't used jQuery yet, you could start getting familiar with it by reading the tutorial on the jQuery site:

To use jQuery with Newscoop, you just need to add libraries in your _html-header.tpl file, and that's it! It will be much easier if you follow our recommendations and put all your own jQuery code in a separate file (prefarably in _js folder).

So the first thing to do will be to include all required jQuery libraries in the html header:

<!DOCTYPE html>
<html xmlns="">
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta http-equiv="Content-Language" content="en" />
<!-- You can use Google's CDN -->
  <script type="text/javascript" src=""></script>
  <script type="text/javascript" src=""></script>
  <link type="text/css" href="" rel="stylesheet" />
<!-- or include js scripts from local folder -->
  <script src="{{ url static_file='_js/jquery.js' }}" type="text/javascript"></script>

Using PHP in your templates

The {{ php }} tag allows PHP code to be embedded directly into the template. This is for advanced users only, not normally needed and not recommended. The following information was taken from

Example PHP code within {{ php }} tags:

{{ php }}
  // including a php script directly from the template.
{{ /php }}

Passing on variables between $gimme and PHP

When using PHP, you might want to work with $gimme values inside PHP, as well as pass on PHP variables to the template. In order to do this, you need to assign the variables first, then you can access them inside PHP. Important: use backticks ` in the assign function. Here's a little example:

Assigning a variable in the template to use with PHP

{{ assign var="profile_email" value=`$gimme->comment->reader_email` }}
{{ php }}
$profile_email = $template->get_template_vars('profile_email');
print $profile_email;
{{ /php }}

Note: there seems to be no way to pass on variables from an included file into the parent. We could not figure it out. If you can, please add your code here!

Assign a variable in PHP to use in the template

{{* a {{php}} block that assigns the variable $varX *}}
{{* output the variable in the template *}}
<strong>{{$varX}}</strong> is my favourite ice cream :-)


There has been error in communication with Booktype server. Not sure right now where is the problem.

You should refresh this page.