Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/goetas/twital
Twital is a "plugin" for Twig that adds some sugar syntax, which makes its templates similar to PHPTal or VueJS.
https://github.com/goetas/twital
angularjs html5 php phptal template-engine twig twig-syntax twig-templates xml
Last synced: 18 days ago
JSON representation
Twital is a "plugin" for Twig that adds some sugar syntax, which makes its templates similar to PHPTal or VueJS.
- Host: GitHub
- URL: https://github.com/goetas/twital
- Owner: goetas
- License: mit
- Created: 2014-01-31T08:50:49.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2021-12-21T09:35:48.000Z (almost 3 years ago)
- Last Synced: 2024-05-05T14:02:56.805Z (6 months ago)
- Topics: angularjs, html5, php, phptal, template-engine, twig, twig-syntax, twig-templates, xml
- Language: PHP
- Homepage: http://twital.readthedocs.org
- Size: 1.16 MB
- Stars: 128
- Watchers: 11
- Forks: 13
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/goetas/twital)
[](https://scrutinizer-ci.com/g/goetas/twital/)
[](https://scrutinizer-ci.com/g/goetas/twital/)
[](https://raw.githubusercontent.com/goetas/twital/master/LICENSE)
[](https://packagist.org/packages/goetas/twital)
What is Twital?
==============
Twital is a template engine built on top of [Twig](http://twig.sensiolabs.org/)
(a template engine for PHP and default template engine on Symfony)
that adds some shortcuts and makes Twig's syntax more suitable for HTML based (XML, HTML5, XHTML, SGML) templates.
Twital takes inspiration from [PHPTal](http://phptal.org/), [TAL](http://en.wikipedia.org/wiki/Template_Attribute_Language)
and [AngularJS](http://angularjs.org/) or [Vue.js](https://vuejs.org/) (just for some aspects),
mixing their language syntaxes with the powerful Twig templating engine system.
Twital is fully compatible with Twig, all Twig templates can be rendered using Twital.
To better understand the Twital's benefits, consider the following **Twital** template, which
simply shows a list of users from an array:
```xml
-
{{ user.name }}
```
To do the same thing using Twig, you need:
```jinja
{% if users %}
-
{{ user.name }}
{% for user in users %}
{% endfor %}
{% endif %}
```
As you can see, the Twital template is **more readable**, **less verbose** and
and **you don't have to worry about opening and closing block instructions**
(they are inherited from the HTML structure).
One of the main advantages of Twital is the *implicit* presence of control statements, which makes
templates more readable and less verbose. Furthermore, it has all Twig functionalities,
such as template inheritance, translations, looping, filtering, escaping, etc.
If some Twig functionality is not directly available for Twital,
you can **freely mix Twig and Twital** syntaxes.
In the example below, we have mixed Twital and Twig syntaxes to use Twig custom tags:
```xml
{% custom_tag %}
{{ someUnsafeVariable }}
{% endcustom_tag %}
```
When needed, you can extend from a Twig template:
```xml
Hello {{name}}!
```
You can also extend from Twig a Twital template:
```jinja
{% extends "layout.twital" %}
{% block content %}
Hello {{name}}!
{% endblock %}
```
A presentation of Twital features and advantages is available on [this presentation](https://goetas.bitbucket.io/twital-02-08-2016-berlin-ug/#/).
Installation
------------
The recommended ways install Twital is via [Composer](https://getcomposer.org/).
```bash
composer require goetas/twital
```
Documentation
-------------
Go here http://twital.readthedocs.org/ to read a more detailed documentation about Twital.
Getting started
---------------
First, you have to create a file that contains your template
(named for example `demo.twital.html`):
```xml
Hello {{ name }}
```
Afterwards, you have to create a PHP script that instantiate the required objects:
```php
require_once '/path/to/composer/vendor/autoload.php';
use Goetas\Twital\TwitalLoader;
$fileLoader = new Twig_Loader_Filesystem('/path/to/templates');
$twitalLoader = new TwitalLoader($fileLoader);
$twig = new Twig_Environment($twitalLoader);
echo $twig->render('demo.twital.html', array('name' => 'John'));
```
That's it!
Symfony Users
--------------
If you are a [Symfony](http://symfony.com/) user, you can add Twital to your project using the
[TwitalBundle](https://github.com/goetas/twital-bundle).
The bundle integrates all most common functionalities as Assetic, Forms, Translations, Routing, etc.
Twig Users
----------
Starting from version Twital 1.0.0, both twig 1.x and 2.x versions are supported.
## Note
The code in this project is provided under the
[MIT](https://opensource.org/licenses/MIT) license.
For professional support
contact [[email protected]](mailto:[email protected])
or visit [https://www.goetas.com](https://www.goetas.com)