PiotrLegnica's Jogger

SithTemplate 1.1a2 released

Sat, 05 Sep 2009 21:29:08 +0200

Another preview version of SithTemplate 1.1 is available on bitbucket.

To get unprocessed source, use bitbucket's snapshots (above link), or use:

hg clone https://bitbucket.org/piotrlegnica/sithtemplate/
cd sithtemplate
hg up release-1.1a2

Main 1.1a2 features are few Django-compatibility fixes, and (finally) finished (and comments are more than welcome) tutorial and the standard library reference - with examples! "Extending" part is still in TODO, though.

The most important changes:

Documentation! Examples!
{% block N append %} has been replaced by Django-compatible (and far more flexible) {{ block.super }} special variable
TemplateEnviron::getMeta now strips the user: prefix
Added "openbrace" and "closebrace" to {% templatetag %}
Fixed incorrect pluralize filter behaviour
Using {% extends %} more than once in a template is now explicitly forbidden, and raises an E_INVALID_SYNTAX

Full Mercurial-generated changelog:

changeset:   808:8cad1d88b70c
tag:         release-1.1a2
user:        PiotrLegnica <...>
date:        Sat Sep 05 21:12:48 2009 +0200
summary:     Releasing 1.1a2, updated TODO.

changeset:   807:5877816dd7e2
user:        PiotrLegnica <...>
date:        Sat Sep 05 21:02:06 2009 +0200
summary:     Examples for special variables.

changeset:   806:eb5b0c603128
user:        PiotrLegnica <...>
date:        Sat Sep 05 20:55:29 2009 +0200
summary:     Examples for {% widthratio %}, {% with %} and all filters.

changeset:   805:70da728a8b98
user:        PiotrLegnica <...>
date:        Sat Sep 05 20:54:34 2009 +0200
summary:     Changed linebreaksbr internals - use nl2br rather than str_replace. This modifies its behaviour - raw newlines are now preserved.

changeset:   804:d576098ae0e3
user:        PiotrLegnica <...>
date:        Sat Sep 05 20:27:32 2009 +0200
summary:     Examples for {% include %}, {% load %}, {% meta %}, {% now %}, {% putblock %} and {% spaceless %}. Removed 00_tag_templatetag.html example.

changeset:   803:1c5768a393c6
user:        PiotrLegnica <...>
date:        Sat Sep 05 20:22:53 2009 +0200
summary:     Added id (identical) and nid (not identical) operators to {% if %}. Named after PHP's documentation - http://www.php.net/manual/en/language.operators.comparison.php

changeset:   802:05879dcfde42
user:        PiotrLegnica <...>
date:        Sat Sep 05 20:14:00 2009 +0200
summary:     Examples for {% cycle %}, {% extends %}, {% filter %}, {% firstof %}, {% for %}, {% if %}.

changeset:   801:34e652805bf6
user:        PiotrLegnica <...>
date:        Sat Sep 05 20:13:37 2009 +0200
summary:     Removed 00_tag_ifequal_ifnotequal.html example.

changeset:   800:e541dfb45722
user:        PiotrLegnica <...>
date:        Sat Sep 05 20:07:19 2009 +0200
summary:     Using {% extends %} more than once in one template is no longer undefined, and raises a E_INVALID_SYNTAX instead (also added a test case to enforce).

changeset:   799:88f38a5f0128
user:        PiotrLegnica <...>
date:        Sat Sep 05 19:58:13 2009 +0200
summary:     Wrong - {% cycle %} uses non-quoted string as name.

changeset:   798:0aa536df0782
user:        PiotrLegnica <...>
date:        Sat Sep 05 19:55:45 2009 +0200
summary:     Examples for {% autoescape %}, {% block %} and {% call %}.

changeset:   797:ff86a708ab67
user:        PiotrLegnica <...>
date:        Sat Sep 05 19:44:00 2009 +0200
summary:     Fixed pluralize behaviour, when only one suffix was provided (it should be treated as plural suffix in this case, not singular one).

changeset:   796:56375a639da6
user:        PiotrLegnica <...>
date:        Sat Sep 05 19:40:59 2009 +0200
summary:     Documented filters and {{ internal }}.

changeset:   795:9efbc65cb844
user:        PiotrLegnica <...>
date:        Sat Sep 05 19:36:17 2009 +0200
summary:     Added cut:variable test case, split pluralize test case into three separate ones.

changeset:   794:f07cd35c70e6
user:        PiotrLegnica <...>
date:        Tue Sep 01 22:04:10 2009 +0200
summary:     Documented {{ block }} and {{ forloop }}.

changeset:   793:f6658ec3a551
user:        PiotrLegnica <...>
date:        Tue Sep 01 21:53:39 2009 +0200
summary:     Added "openbrace" and "closebrace" to {% templatetag %}.

changeset:   792:25ea1c706a86
user:        PiotrLegnica <...>
date:        Tue Sep 01 21:46:01 2009 +0200
summary:     Done documenting standard tags.

changeset:   791:f04448226a02
user:        PiotrLegnica <...>
date:        Tue Sep 01 20:08:27 2009 +0200
summary:     As SithTemplate2 won't be happening anytime soon, no point in mentioning it.

changeset:   790:0ddce1370768
user:        PiotrLegnica <...>
date:        Tue Sep 01 18:54:47 2009 +0200
summary:     Docs, docs, docs.

changeset:   789:2b01ed677922
user:        PiotrLegnica <...>
date:        Tue Sep 01 15:51:04 2009 +0200
summary:     Added note about default I/O driver.

changeset:   788:0e7f8e7f2e5d
user:        PiotrLegnica <...>
date:        Mon Aug 31 09:59:02 2009 +0200
summary:     A bit of comments for test suite.

changeset:   787:0d298c5462b7
user:        PiotrLegnica <...>
date:        Mon Aug 31 09:07:55 2009 +0200
summary:     Somehow previous commit didn't work on PHP >= 5.2. Changed in-place filtering to copying.

changeset:   786:d14b270b33c6
user:        PiotrLegnica <...>
date:        Mon Aug 31 08:59:59 2009 +0200
summary:     "user:" prefix for custom metadata is now strictly internal - TemplateEnviron::getMeta will strip it.

changeset:   785:2d1d50b5b85e
user:        PiotrLegnica <...>
date:        Tue Aug 25 17:08:06 2009 +0200
summary:     Added stdlib examples (TODO), started first draft of stdlib docs.

changeset:   784:635c23c8006c
user:        PiotrLegnica <...>
date:        Tue Aug 25 15:58:26 2009 +0200
summary:     Changed WARN_NO_PARAMDOC to YES.

changeset:   783:9a88ccbf24d7
user:        PiotrLegnica <...>
date:        Mon Aug 24 21:50:42 2009 +0200
summary:     Fixed previous commit.

changeset:   782:221eff29381a
user:        PiotrLegnica <...>
date:        Mon Aug 24 21:45:21 2009 +0200
summary:     DRY: got rid of the throw new's.

changeset:   781:52a7f611fd8e
user:        PiotrLegnica <...>
date:        Mon Aug 24 20:50:36 2009 +0200
summary:     Added tut-errors section to the tutorial and 09_errors.php example.

changeset:   780:49481380f52e
user:        PiotrLegnica <...>
date:        Mon Aug 24 20:41:12 2009 +0200
summary:     Security settings example.

changeset:   779:54046e565081
user:        PiotrLegnica <...>
date:        Mon Aug 24 20:19:24 2009 +0200
summary:     Finished first draft of the tutorial.

changeset:   778:ac506b52c1db
user:        PiotrLegnica <...>
date:        Mon Aug 24 20:06:09 2009 +0200
summary:     Inheritance examples.

changeset:   777:85f6545c0f4a
user:        PiotrLegnica <...>
date:        Mon Aug 24 19:58:13 2009 +0200
summary:     Moved 07_security to 08_security.

changeset:   776:b719c6a22fe4
user:        PiotrLegnica <...>
date:        Mon Aug 24 19:39:21 2009 +0200
summary:     Added is_null checking (isset returns false, if variable is set but NULL), changed {% block N append %} tests into {{ block.super }} tests.

changeset:   775:0cf290faebe1
user:        PiotrLegnica <...>
date:        Mon Aug 24 19:29:55 2009 +0200
summary:     Added default_if_none filter and two testcases for it. Also fixed a copypasta (oops).

changeset:   774:218477ef1e3c
user:        PiotrLegnica <...>
date:        Mon Aug 24 19:25:52 2009 +0200
summary:     Removed {% block N append %} support, added {{ block.super }} special var for Django-compatible way of accessing parent block.

changeset:   773:85200e583180
user:        PiotrLegnica <...>
date:        Mon Aug 24 19:01:16 2009 +0200
summary:     Doxygen doesn't like  in section titles.

changeset:   772:1a7d686085b7
user:        PiotrLegnica <...>
date:        Mon Aug 24 18:58:46 2009 +0200
summary:     Moved {% comment %} from stdlib to core, added minArgs and two tests for {% load %}.

changeset:   771:cdd369a53cb2
user:        PiotrLegnica <...>
date:        Mon Aug 24 18:54:37 2009 +0200
summary:     Syntax example.

changeset:   770:7f9ecaca7bd6
user:        PiotrLegnica <...>
date:        Mon Aug 24 18:51:39 2009 +0200
summary:     Context and variable expressions example.

changeset:   769:00b479923bac
user:        PiotrLegnica <...>
date:        Mon Aug 24 17:19:05 2009 +0200
summary:     Small documentation changes on main page.

changeset:   768:e647547dcc2e
user:        PiotrLegnica <...>
date:        Mon Aug 24 17:00:16 2009 +0200
summary:     Added stdlib-internal.

changeset:   767:86ddabf05392
user:        PiotrLegnica <...>
date:        Sat Aug 22 23:26:28 2009 +0200
summary:     Added zip support to make-release.

changeset:   766:7da664edc5d0
user:        PiotrLegnica <...>
date:        Thu Aug 13 17:53:02 2009 +0200
summary:     Updated TODO.

changeset:   765:06b8fc0a9060
user:        PiotrLegnica <...>
date:        Thu Aug 13 16:24:02 2009 +0200
summary:     Fixed ToC order in CHM.

changeset:   764:4ca92e1fd8b4
user:        PiotrLegnica <...>
date:        Thu Aug 13 16:16:44 2009 +0200
summary:     Added tag release-1.1a1 for changeset d7d5b311fb81

changeset:   763:d7d5b311fb81
tag:         release-1.1a1
user:        PiotrLegnica <...>
date:        Thu Aug 13 16:16:21 2009 +0200
summary:     Updated make-release tool. Releasing 1.1a1.

SithTemplate 1.1a1 released

Thu, 13 Aug 2009 16:45:23 +0200

New preview version of SithTemplate 1.1 is available on BitBucket.

Documentation is still not complete, but I'll be gone for a week or so, and won't be able to finish it. Releasing it mainly because of the broken 5.1 support in 1.1a0.

Main changes in this release are:

fixed PHP 5.1 compatibility, and more unittests (ran on 5.1, 5.2 and 5.3)
addition of custom metadata, set by {% meta key "value" %} tag, and retrieved by TemplateEnviron::getMeta call
added TemplateEnviron::render shortcut call
new security settings to restrict {{ internal }} - allowInternalConstants and allowInternalRequest
I/O restricting and restrictExtendIO and restrictIncludeIO settings
Fixed {% extends %} not being able to use different I/O driver

Full Mercurial-generated changelog:

changeset:   763:d7d5b311fb81
tag:         release-1.1a1
user:        PiotrLegnica <...>
date:        Thu Aug 13 16:16:21 2009 +0200
summary:     Updated make-release tool. Releasing 1.1a1.

changeset:   762:e816f8f564ea
user:        PiotrLegnica <...>
date:        Wed Aug 12 20:46:22 2009 +0200
summary:     Changed unneccessary panics in I/O drivers into normal, descriptive exceptions.

changeset:   761:e183115d3806
user:        PiotrLegnica <...>
date:        Wed Aug 12 20:45:38 2009 +0200
summary:     Documented error codes.

changeset:   760:eefdaa0d63d6
user:        PiotrLegnica <...>
date:        Wed Aug 12 19:57:15 2009 +0200
summary:     File summary.

changeset:   759:9ddd73698732
user:        PiotrLegnica <...>
date:        Tue Aug 11 21:03:31 2009 +0200
summary:     Docs, docs, docs.

changeset:   758:d1adfd9c07b1
user:        PiotrLegnica <...>
date:        Mon Aug 10 19:21:14 2009 +0200
summary:     Added "allowInternalRequest" and "allowInternalConstants" as security restrictions for {{ internal }}, added {{ internal.request.ENV }} support.

changeset:   757:c1f2c8a6eabf
user:        PiotrLegnica <...>
date:        Mon Aug 10 18:47:31 2009 +0200
summary:     Added defaults reminder.

changeset:   756:470abf281cd9
user:        PiotrLegnica <...>
date:        Mon Aug 10 18:47:22 2009 +0200
summary:     Added TemplateEnviron::render shortcut.

changeset:   755:4c07e0d273df
user:        PiotrLegnica <...>
date:        Mon Aug 10 18:36:40 2009 +0200
summary:     Added variable checking code silencing.

changeset:   754:324e2e68784c
user:        PiotrLegnica <...>
date:        Sun Aug 09 20:41:44 2009 +0200
summary:     Added {% for %} block uniqueness test case (to prevent an old bug from reappearing).

changeset:   753:93fe0ef4fa1f
user:        PiotrLegnica <...>
date:        Sun Aug 09 00:06:25 2009 +0200
summary:     Added even more examples (TODO), and started tutorial.

changeset:   752:8d37e0c6960c
user:        PiotrLegnica <...>
date:        Sat Aug 08 23:50:59 2009 +0200
summary:     Added 01_io example.

changeset:   751:b2c94314129b
user:        PiotrLegnica <...>
date:        Sat Aug 08 23:06:49 2009 +0200
summary:     Set EXAMPLE_PATH for Doxygen, and added first example.

changeset:   750:08211c1efbf9
user:        PiotrLegnica <...>
date:        Sat Aug 08 22:52:14 2009 +0200
summary:     Changed ignore filter.

changeset:   749:d4ad17fb81f4
user:        PiotrLegnica <...>
date:        Sat Aug 08 21:28:40 2009 +0200
summary:     Removed SVNish $Id$ keywords.

changeset:   748:2f278b4e17dd
user:        PiotrLegnica <...>
date:        Sat Aug 08 21:11:54 2009 +0200
summary:     Updated TODO.

changeset:   747:05ecf42429d0
user:        PiotrLegnica <...>
date:        Sat Aug 08 21:08:36 2009 +0200
summary:     Added custom metadata mechanism - TemplateEnviron::getMeta, {% meta %} tag, and testcase for that.

changeset:   746:87987547863d
user:        PiotrLegnica <...>
date:        Sat Aug 08 19:05:42 2009 +0200
summary:     Forgot about sprintf.

changeset:   745:688da1ed44d9
user:        PiotrLegnica <...>
date:        Sat Aug 08 18:58:18 2009 +0200
summary:     Moved I/O restriction checking to TemplateUtils, restrictIncludeIO now works.

changeset:   744:dddf08c5d3be
user:        PiotrLegnica <...>
date:        Sat Aug 08 18:52:32 2009 +0200
summary:     Minor documentation fixes.

changeset:   743:fdaaddee7c47
user:        PiotrLegnica <...>
date:        Sat Aug 08 18:23:19 2009 +0200
summary:     Fixed a test case.

changeset:   742:9cdc4a46d388
user:        PiotrLegnica <...>
date:        Sat Aug 08 18:22:30 2009 +0200
summary:     Fixed {% extends %} not being able to use different I/O driver, added I/O restriction to {% extends %}.

changeset:   741:3b7b554c04c0
user:        PiotrLegnica <...>
date:        Sat Aug 08 15:40:34 2009 +0200
summary:     Changed included file, included.html requires a variable to be present, and output is irrelevant here anyway.

changeset:   740:b392fcb53245
user:        PiotrLegnica <...>
date:        Sat Aug 08 15:32:41 2009 +0200
summary:     Changed TemplateUtils::splitIODSN signature and behaviour - it now accepts settings array, and returns default I/O driver name instead of null.

changeset:   739:8d782b596806
user:        PiotrLegnica <...>
date:        Sat Aug 08 15:28:16 2009 +0200
summary:     New test case for {% extends %} - extending from different I/O driver.

changeset:   738:3bea11c27867
user:        PiotrLegnica <...>
date:        Sat Aug 08 15:14:40 2009 +0200
summary:     Added I/O restriction settings and tests. Exposed I/O-related bug in {% extends %}.

changeset:   737:6b72d7175cf6
user:        PiotrLegnica <...>
date:        Sat Aug 08 14:55:31 2009 +0200
summary:     Removed outdated test templates.

changeset:   736:d8aa7bfcab4e
user:        PiotrLegnica <...>
date:        Sat Aug 08 13:54:26 2009 +0200
summary:     Version requirements.

changeset:   735:5b8d8050876f
user:        PiotrLegnica <...>
date:        Sat Aug 08 00:52:01 2009 +0200
summary:     Fixed testsuite compatibility with PHP 5.1.

changeset:   734:8834e2da72d7
user:        PiotrLegnica <...>
date:        Sat Aug 08 00:49:51 2009 +0200
summary:     Replaced array_fill_keys with array_combine/array_fill combination - fixes PHP 5.1 compatibility.

changeset:   733:afcebbe8572c
user:        PiotrLegnica <...>
date:        Sat Aug 08 00:35:50 2009 +0200
summary:     Merged tests/* glob ignore filters into one regexp-based.

changeset:   732:be4f94f16efb
user:        PiotrLegnica <...>
date:        Sat Aug 08 00:34:31 2009 +0200
summary:     Finally got this thing to work.

changeset:   731:80698d8be165
user:        PiotrLegnica <...>
date:        Sat Aug 08 00:20:03 2009 +0200
summary:     Removed PHP 6.0 from default run-config, added setting the PHPRC env var to the runner.

changeset:   730:0b8bdc158e11
user:        PiotrLegnica <...>
date:        Sat Aug 08 00:09:07 2009 +0200
summary:     Changed SVN tag to HG-tip.

changeset:   729:4cad405587db
user:        PiotrLegnica <...>
date:        Sat Aug 08 00:03:30 2009 +0200
summary:     Modified test runner a bit.

changeset:   728:12fc24eb9719
user:        PiotrLegnica <...>
date:        Thu Jul 30 19:25:46 2009 +0200
summary:     Changed bugtracker URL.

changeset:   727:1980819aecef
user:        PiotrLegnica <...>
date:        Thu Jul 30 19:23:34 2009 +0200
summary:     Added docs/* to ignore filter.

changeset:   726:d98afde3e992
user:        PiotrLegnica <...>
date:        Thu Jul 30 13:41:09 2009 +0200
summary:     Forgot about run-config.in.

changeset:   725:111de1e0a27a
user:        PiotrLegnica <...>
date:        Thu Jul 30 13:36:57 2009 +0200
summary:     Added .hgignore.

changeset:   724:33733b37b17e
user:        PiotrLegnica <...>
date:        Thu Jul 30 13:33:11 2009 +0200
summary:     Added tag old-release-1.0 for changeset 88b1441bc751

changeset:   723:39bd9456e915
user:        PiotrLegnica <...>
date:        Thu Jul 30 13:32:12 2009 +0200
summary:     Added tag release-1.1a0 for changeset 8eab6f7588e9

changeset:   722:d3eccb003581
user:        PiotrLegnica <...>
date:        Wed Jul 29 23:16:00 2009 +0200
summary:     Hg doesn't remember empty dirs.

changeset:   721:8eab6f7588e9
tag:         release-1.1a0
user:        piotrlegnica
date:        Mon Jul 27 21:44:40 2009 +0000
summary:     Updated TODO.

ST status update: 0.10 plugin system changes

Mon, 22 Sep 2008 23:46:16 +0200

In 0.9 and earlier, both libraries and I/O drivers were called "plugins". As of 0.10, plugin is a bundle, containing any number of elements.

Plugins need explicit loading on application side (either by new config var autoloadPlugins, or by TemplateCore::loadPlugin API).
Libraries can still be loaded from within templates (just for this template), and additionally from application (using either config var autoloadLibraries or TemplateCore::loadLibrary API; for all templates).
Libraries have to be referenced to as Plugin.Library.
Difference between runtime and compile time libraries is gone.
Hooks are no longer contained in libraries.
New extension types will be available - I/O filters and cache drivers.
The only remaining interfaces are those related to plugins (e.g. ITemplatePlugin, ITemplateLibrary).

I/O filters will be called in defined order (in filtersInput and filtersOutput config vars) on both template input (unparsed) and template output (not template PHP code, but the result of rendering).

Cache drivers - there will be one instance-wide (cacheDriver config var) driver, that will be passed to I/O drivers.

Example plugin's main class.

Sorry for chaotic Engrish, feel free to contact me if something is unclear, or if you have any suggestions.

SithTemplate 0.10 roadmap revision

Sat, 23 Aug 2008 18:08:44 +0200

Continuing this entry:

Expression parsing will be postponed at least until 0.11.
Library loading will be possible at both application- and template-side. Both will also be restricted to securityLibraries list (unless secure mode is disabled).
New plugin system, with new metadata system to declare tags, filters, hooks, I/O drivers, etc. I thought about using strict naming convention, but that wouldn't work well for e.g. hooks, where one hookpoint can have many handlers in many libraries attached. I'll post more info later.
And maybe, with new plugin system - tag/filter namespaces, either implicit (library name) or explicit.

As always - feedback is welcome.

What's new in SithTemplate 0.10

Wed, 13 Aug 2008 00:33:36 +0200

Even though 0.10 has no specific release date yet (trunk after nearly 100 revisions is still broken and unusable, and most of the code needs at least refactoring), here are the most important changes (in random order):

Hard-coded variable prefix (to [surprise] $).
Unicode awareness, and, (un)fortunately, mbstring dependency.
Expression parsing, without filtering support (parser is huge, ugly and hard to understand even without them. Better ideas, anyone? ^^). With this, you'll be able to do things like {% include $page~".html" %}.
Library loading moved to application code. So there will be something like $tpl->loadLibrary('CoreI18n'); instead of {% load CoreI18n %}.
New exception model. Both TemplateRuntimeError and TemplateSyntaxError are now combined into single TemplateError (with string-based IDs, and isXxxError methods).
Main class moved to TemplateCore.

Yes, that means API and template syntax changes. Sorry about that. Any of these changes can be reverted/not implemented, so all suggestions are welcome.

Sourceforge / Ohloh.