Go to main content

Textpattern CMS support forum

You are not logged in. Register | Login | Help

#1 2007-11-12 18:43:01

baby
Plugin Author
From: Buenos Aires, Argentina
Registered: 2005-10-16
Posts: 95
Website

which zem_tpl plugin? (html help)

Hi there,

which is the official zem_tpl plugin compiler?

There is a supposedly newer version in http://svn.textpattern.com/development/4.0-plugin-template/ so I started using this one… but I just noticed it silently ignores plain html in the help section…

Is this a bug? or a feature?

Which version should I use?

I checked the svn log and it seems that, at some point, zem put something about allowing html help… but I don’t see any doc about this anywhere…

 $ svn log zem_tpl.php 
------------------------------------------------------------------------
r2633 | mary | 2007-09-05 11:35:57 -0300 (Wed, 05 Sep 2007) | 1 line

Gzip plugin
------------------------------------------------------------------------
r1798 | zem | 2006-09-05 20:39:50 -0300 (Tue, 05 Sep 2006) | 1 line

remove compression; add allow_html_help (off) to default template
------------------------------------------------------------------------
r1779 | sencer | 2006-08-29 20:51:37 -0300 (Tue, 29 Aug 2006) | 1 line

a few more minor changes to plugin-installation
------------------------------------------------------------------------
r1778 | sencer | 2006-08-29 20:02:45 -0300 (Tue, 29 Aug 2006) | 1 line

plugin-compiler: Option to allow html in help.
------------------------------------------------------------------------
r1774 | sencer | 2006-08-29 17:42:21 -0300 (Tue, 29 Aug 2006) | 1 line

Minor fixes for plugin-compiler and -example
------------------------------------------------------------------------
r1773 | sencer | 2006-08-29 16:46:04 -0300 (Tue, 29 Aug 2006) | 1 line

Change plugin-template, -compiler and -installer to make it more backwards-compatible
------------------------------------------------------------------------
r1728 | sencer | 2006-08-16 04:44:01 -0300 (Wed, 16 Aug 2006) | 1 line

we need to be able to show <txp:my_plugin /> style tags in the help. (thanks zem)
------------------------------------------------------------------------
r1635 | sencer | 2006-08-06 19:39:38 -0300 (Sun, 06 Aug 2006) | 1 line

Add (updated) plugin-template and plugin compiler to repo. Adds compression (optional) and unprocessed help-text.
------------------------------------------------------------------------

Mariano AbsatzEl Baby

I don’t suffer from insanity. I enjoy every minute of it.

Offline

#2 2007-11-12 19:13:04

ruud
Developer Emeritus
From: a galaxy far far away
Registered: 2006-06-04
Posts: 5,068
Website

Re: which zem_tpl plugin? (html help)

Look at the zem_plugin.php file:

// 0 = Plugin help is in Textile format, no raw HTML allowed (default).
// 1 = Plugin help is in raw HTML.  Not recommended.
# $plugin['allow_html_help'] = 1;

Offline

#3 2007-11-12 19:33:51

baby
Plugin Author
From: Buenos Aires, Argentina
Registered: 2005-10-16
Posts: 95
Website

Re: which zem_tpl plugin? (html help)

Thanx a lot, ruud… that happens to me for using a plugin written for the older version (that didn’t had that commented-out line).


Mariano AbsatzEl Baby

I don’t suffer from insanity. I enjoy every minute of it.

Offline

#4 2007-11-12 20:06:11

hakjoon
Member
From: Arlington, VA
Registered: 2004-07-29
Posts: 1,634
Website

Re: which zem_tpl plugin? (html help)

Why is html help not recommended?


Shoving is the answer – pusher robot

Offline

#5 2007-11-12 21:52:46

ruud
Developer Emeritus
From: a galaxy far far away
Registered: 2006-06-04
Posts: 5,068
Website

Re: which zem_tpl plugin? (html help)

I have no idea. I set that option to ‘1’ all the time.

Offline

#6 2007-11-12 23:26:48

Mary
Sock Enthusiast
Registered: 2004-06-27
Posts: 6,236

Re: which zem_tpl plugin? (html help)

I think it was due to a complaint about the potential security risk (XSS). I seem to recall I bugged about keeping the possibility because some things simply can’t be done in Textile, plus we have the preview.

Offline

#7 2007-12-06 21:04:56

Logoleptic
Plugin Author
From: Kansas, USA
Registered: 2004-02-29
Posts: 482

Re: which zem_tpl plugin? (html help)

Is there a reason why style attributes applied with Textile vanish from the compiled plugin help? For example:

h2{background:#ffc}. A Heading

Produces this:

<h2>A Heading</h2>

Also, any attempt to use angle brackets results in the entity codes (< and >) appearing in the help. That makes it really tough to give plugin tag examples. Am I doing something wrong?

Offline

#8 2007-12-11 03:11:06

Mary
Sock Enthusiast
Registered: 2004-06-27
Posts: 6,236

Re: which zem_tpl plugin? (html help)

Restricted Textile is used for plugin help. See my previous comment.

Offline

#9 2007-12-11 03:53:36

Logoleptic
Plugin Author
From: Kansas, USA
Registered: 2004-02-29
Posts: 482

Re: which zem_tpl plugin? (html help)

Mary wrote:

Restricted Textile is used for plugin help. See my previous comment.

Oh, I see now that the Textileing is actually done in the core (txp_plugin.php) and not by zem_tpl.php. Thanks for setting me straight.

Offline

Board footer

Powered by FluxBB