search

haml / haml-contrib

Addons to Haml (Ruby)
MIT License
7 stars 7 forks source link

Documentation? #3

Open ghost opened 11 years ago

ghost commented 11 years ago

Is there any documentation for this? I've tried countless times to use the PHP filter provided yet HAML still returns "Filter "php" is not defined." even though I have both gems installed.

mattwildig commented 11 years ago

You need to require haml/filters/php as well as have haml-contrib installed. From the command line:

~ $ haml -rhaml/filters/php
:php
  Foo

result:

<?php
  Foo
?>

From a script just add require 'haml/filters/php' after you require 'haml'.

It’s not obvious though, so I agree we could do with some documentation. I added docs for #2 as rdoc in the code, but I’m not sure where the best place would be generally. Perhaps we need a REFERENCE like the main Haml project where the docs for each addition could be added.

ghost commented 11 years ago

Ah, that makes sense - I was just a few directories short trying to simply require 'haml-contrib'.

Hopefully my issue didn't come across as abrupt - I didn't mean it to sound so but I realise that the wording might have been rough.

Thank you, though!