smd_macro: Create custom virtual Txp tags that do stuff

jpdupont · 2011-04-11 07:15:10

+1
I’m not very happy with those containers …

Is it possible to modify the way textile act ???
(As an option, for compatibility)

Bloke · 2011-04-11 08:54:08

jpdupont wrote:

Is it possible to modify the way textile act ???

Your best place to find out that sort of thing is on the Textile repo. The conversations on the Issues tracker might give you some ideas. The various experimental dev branches add support for defining your own block level elements so I guess, in theory, you could find some way to kill them.

Last edited by Bloke (2011-04-11 08:54:33)

jcd · 2011-04-11 15:15:39

jakob wrote:

How about using pax_grep or a snippet of php in your smd_macro to remove the  and  from the output as outline here? That would happen server-side prior to code output.

Thanks jakob, but as far as I understand there is nothing you can do from within a macro to influence the surrounding tags added by Textile. If I used this strategy outside of the macro this would probably work, but adding a space in front of the macro tag inside of the article seems a lot easier for the client.

els · 2011-04-11 22:18:48

jcd wrote:

Thanks jakob, but as far as I understand there is nothing you can do from within a macro to influence the surrounding tags added by Textile.

You could do something like this in your article form I guess. Assuming the macro output is wrapped in <ul> tags (don’t know pax_grep so this is with rah_replace):

<txp:rah_replace from="<p><ul>,</ul></p>" to="<ul>,</ul>"><txp:body /></txp:rah_replace>

phuture303 · 2011-04-22 06:52:41

Stef, just solved my first tiny steps with this plugin. It is FUCKING BRILLIANT! Wonderful, I just made the output of image galleries (in combination with a left-sided dropdown custom field of the existing image categories) the most easy thing I’ve ever seen :-)

End Els, thanks for the tip with rah_replace for deleting the -tags surrounding the gallery. Just for the noobs like I am: if you need your <ul>-tag with a class or an id, then use:

<txp:rah_replace from="<ul,</ul>" to="<ul,</ul>"><txp:body /></txp:rah_replace> just without the closing braket at the opening <ul>-tag.

Perfect, this forum made my day. Again. Textpattern rocks – and you pros do, too.

David

Bloke · 2011-05-04 13:00:02

By way of an example macro suite, here’s my attempt at an interface to jQuery Tools tabs. Save the link and you can import them directly into smd_macro.

On your tabbable page(s), just include the jQuery Tools .js file as normal and ensure you have obtained a reference to the API using something like this code:

<script type="text/javascript">
   var api = jQuery("#wrapper").data("scrollable");
</script>

where wrapper is the DOM element that contains your tab panes. You can use a different variable name other than api if you wish, just remember to tell the macros what you’ve called it via the api_ref attribute (or edit the defaults in the macro definitions).

You or your clients can then use the following tags to present tab navigation links:

<txp:prev_tab /> : jump to the previous tab (will wrap if permitted). Attributes:
- text = the text label. Default: « Previous
- class = the class to apply to the anchor link. Default: learnmore
- api_ref = the name of your javascript api variable. Default: api
<txp:next_tab /> : jump to the next tab (will wrap if permitted). Same attributes as above (text = Next »)
<txp:goto_tab /> : jump to the designated tab number. Attributes:
- number = the tab to jump to, indexed from 1. Default: 1
- class = the class to apply to the anchor link. Default: learnmore
- api_ref = the name of your javascript api variable. Default: api
<txp:tab_nav /> : display a Goooogle style nav bar. Attributes:
- tabs = the number of tabs in your set. Default: 1
- class = the class to apply to the navigation wrapper div. Default: tabnav
- breakclass = the class to apply to each anchor link. Default: learnmore
- prev_text = the text label for the ‘prev’ link. Default: Previous
- next_text = the text label for the ‘next’ link. Default: Next
- api_ref = the name of your javascript api variable. Default: api

If you’re using MLP you can probably edit the macros to use ##snippet## syntax (untested).

Note that the macros are totally unsupported, they’re just available as examples for you to tweak and play around with. Hope they’re useful to someone.

jakob · 2011-05-08 22:08:57

How might I test whether a custom smd_macro attribute has been specified (as opposed to empty) within the macro code, for example using smd_if? As soon as I use txp:if_variable, I define a txpvar, even if it is empty, so I can’t do a three way test with it.

Use case example: a tag that outputs a figure tag with attributes id and caption:

if the attribute caption is not specified (=undefined), then output the image’s own caption
if the attribute caption="custom text", i.e. is specified, override and use the custom caption
if the attribute caption="", i.e. is explicitly set to empty (=isempty) do not show a caption

I tried smd_if with field="phpvar:caption" and field="phpvar:lAtts[caption]" but to no avail:

<figure>
  <txp:image id="{img_id}" />
  <txp:smd_if field="phpvar:caption" operator="defined">
    <txp:smd_if field="NULL" operator="isempty" value="{caption}">
    <txp:else />
      <figcaption>{caption}</figcaption>
    </txp:smd_if>
  <txp:else />
    <figcaption><txp:image_info id="{img_id}" type="caption" /></figcaption>
  </txp:smd_if>
</figure>

Last edited by jakob (2011-05-08 22:14:11)

Bloke · 2011-05-09 00:55:55

jakob wrote:

How might I test whether a custom smd_macro attribute has been specified (as opposed to empty) within the macro code

Along with the problem of container macros, this scenario — the detection of whether an attribute is set or not — did occur to me as I was writing the plugin but I never came up with a satisfactory solution. There are times when you simply want to completely omit an attribute inside your macro — for example, whan an empty macro attribute is passed in and you want the TXP tag inside to take on its defaults. Currently there’s no neat way of doing that, which is a shame.

To further compound things, the $atts array doesn’t behave as you’d expect, probably because the function is actually not a real function. Certainly if you simply try to dmp($atts); you get nothing back which, I suspect, is due to the way the parser works. Or that it’s late and my brain’s slowly giving up. You can get funky with PHP5’s new ReflectionFunction() but it gets messy very quickly inside a php block.

In your case, smd_if can indeed come to the rescue and do a 3-way test but you have to be cunning. Give the macro’s caption attribute a default value that you will never reasonably expect people to type — I’ve chosen SMD_NONE here. Then you can proceed as follows:

<figure>
  <txp:image id="{img_id}" />
  <txp:smd_if field="{caption}" operator="eq" value="SMD_NONE">
    <figcaption><txp:image_info id="{img_id}" type="caption" /></figcaption>
  <txp:else />
    <txp:smd_if field="NULL" operator="eq" value="{caption}">
    <txp:else />
      <figcaption>{caption}</figcaption>
    </txp:smd_if>
  </txp:smd_if>
</figure>

How’s that?

Last edited by Bloke (2011-05-09 00:57:41)

jakob · 2011-05-09 06:50:44

Cool! and cunning. That works!

BTW: for those, like me, who may not initially understand the logic, it is ESSENTIAL to insert SMD_NONE (or a non-word of your choice) as the default value in the attributes section above the code:

That gives you a tag that behaves as follows:

<txp:figure id=123" caption="My custom caption" /> – inserts image 123 with an HTML5 figcaption entitled “My custom caption”.
<txp:figure id=123" /> – inserts image 123 with an HTML5 figcaption with whatever is set in your images caption field.
<txp:figure id=123" caption="" /> – inserts image 123 with an HTML5 figure and no figcaption.

Last edited by jakob (2011-05-09 06:55:11)

stephan · 2011-09-05 14:25:14

Tried it, loved it. But one thing I really need your help with:
I have a macro with several attributes and I do not wish to type the entire thing in each time. How can I integrate the marco in the write tab (e.g. insert the specific macro at the push of a button so all I would have to do is fill in the values of the attributes)?

The idea is to create a review rating table with a star rating via macro and the individual ratings in five categories would be the attributes (as the name of the object under review).

Textpattern CMS

Textpattern CMS support forum

#41 2011-04-11 07:15:10

Re: smd_macro: Create custom virtual Txp tags that do stuff

#42 2011-04-11 08:54:08

Re: smd_macro: Create custom virtual Txp tags that do stuff

#43 2011-04-11 15:15:39

Re: smd_macro: Create custom virtual Txp tags that do stuff

#44 2011-04-11 22:18:48

Re: smd_macro: Create custom virtual Txp tags that do stuff

#45 2011-04-22 06:52:41

Re: smd_macro: Create custom virtual Txp tags that do stuff

#46 2011-05-04 13:00:02

Re: smd_macro: Create custom virtual Txp tags that do stuff

#47 2011-05-08 22:08:57

Re: smd_macro: Create custom virtual Txp tags that do stuff

#48 2011-05-09 00:55:55

Re: smd_macro: Create custom virtual Txp tags that do stuff

#49 2011-05-09 06:50:44

Re: smd_macro: Create custom virtual Txp tags that do stuff

#50 2011-09-05 14:25:14

Re: smd_macro: Create custom virtual Txp tags that do stuff

Board footer