rvm_substr (v0.3)

ruud · 2008-12-02 14:31:50

This plugin allows you to cut a string of XHTML at a specific character limit, without causing invalid XHTML or utf8, unlike the sab_substr plugin which is meant for non HTML encoded plain text only.

Download

Features:

XHTML tag aware: tags are ignored when calculating the length for cutting the string, but are preserved and closed properly.
UTF8 aware: the length limit refers to the number of characters, not the number of bytes (which is typically greater when using a multibyte character set)
HTML escape code aware: something like & is counted as one character instead of four.
Automatically adds an ellipsis when the original string length exceeds the specified limit.

Changelog:

version 0.1 (2008-03-18)
version 0.2 (2008-12-02)
- fix missing ellipsis when dealing with strings without tags (thanks wet/Robert)
- corrected typo in documentation (thanks Thomas)
version 0.3 (2008-12-10)
- fix incorrectly auto-closed tags when the tag element was over 1 char long (thanks wet/Robert)

wet · 2008-12-10 09:50:16

Looks like this (yummy) testcase lets rvm_substr lose its ability to close tags:

$in = <<<EOT
	<h3>Zutaten für zwei Portionen</h3>

	<ul>
		<li>150 g Dinkelflocken</li>
		<li>3 Eier</li>
		<li>150 g Emmentaler Käse</li>
		<li>Salz und Pfeffer</li>
		<li>3 Jungzwiebel</li>
		<li>Eine Knoblauchzehe</li>
	</ul>


	<h3>Zubereitung</h3>

	<ul>
		<li>Jungzwiebel hacken und anschwitzen</li>
		<li>Käse reiben und mit den Eiern, den Dinkelflocken und den Jungzwiebeln zu einer Teigmasse vermengen</li>
		<li>Die Knoblauchzehe in die Dinkelmasse drücken</li>
		<li>Die Masse salzen und pfeffern und danach 15 Minuten ruhen lassen</li>
		<li>Vier Laibchen formen und in goldbraun braten</li>
	</ul>
EOT;

$out = rvm_substr(array('length' => 350), $in);

Result in $out:

<h3>Zutaten für zwei Portionen</h3>

	<ul>
		<li>150 g Dinkelflocken</li>
		<li>3 Eier</li>
		<li>150 g Emmentaler Käse</li>
		<li>Salz und Pfeffer</li>
		<li>3 Jungzwiebel</li>
		<li>Eine Knoblauchzehe</li>
	</ul>


	<h3>Zubereitung</h3>

	<ul>
		<li>Jungzwiebel hacken und anschwitzen</li>
		<li>Käse reiben und mit den Eiern, den Dinkelflocken und den Jungzwiebeln zu einer Teigmasse vermengen</li>
		<li>Die Knoblauchzehe in die Dinkelmasse drücken</li>
		<li>Die Masse salzen und pfeffern und danach 15…</i></l>

NB: the closing tags at the very end.

Expected result:

ruud · 2008-12-10 20:57:04

Thanks. Version 0.3 uploaded. It just needed a ) moved one character. The buggy version actually showed me something interesting. If you use a multi-matching () in PCRE, the last match is remembered. Not sure if that’s ‘last’ in a string-length context or ‘last’ in the actual pattern matching routine, although the latter is more likely.

maxvoltar · 2008-12-21 23:34:25

Looks like there’s still a small bug in it:

<txp:link_to_prev><txp:rvm_substr length="20"><txp:prev_title /></txp:rvm_substr></txp:link_to_prev>
Results in: “The power and proble”
Instead of: “The power and proble…”

Any idea what might be causing this?

ruud · 2008-12-22 11:36:46

Tim, did you install the latest version (0.3) of this plugin?
I just tested it and if the string is indeed longer than what is shown (for example: “The power and problem”), the ellipsis is added.

maxvoltar · 2008-12-22 11:44:54

I’ll update it!

Kjeld · 2008-12-30 08:23:38

Nice plugin, Ruud!

I am looking for the option to have it cut off text before a certain character, instead of a specific character limit. I would like to select the first word (the one before the first comma) in the list of keywords for an article. Would that be possible to do?

ruud · 2008-12-30 09:53:46

Kjeld, that’s outside the scope of this plugin, but you can easily do it like this (not tested):

<txp:php>
  // turn string of keywords into an array
  $keywords = do_list($GLOBALS['thisarticle']['keywords']);
  // if keywords exist, output the first keyword only
  if ($keywords) echo htmlspecialchars($keywords[0]);
</txp:php>

Jaro · 2009-11-08 19:42:41

Thanks for the plugin, Ruud.

I’m getting some extra html entities after the truncated title:

My Title ...

And I’m using this setup:

<txp:permlink><txp:sab_substr limit="35" trail="..."><txp:title /></txp:sab_substr></txp:permlink>

Last edited by Jaro (2009-11-08 19:45:04)

ruud · 2009-11-08 20:35:45

You posted in the right topic, but you’re using the wrong plugin ;)
Try rvm_substr instead of sab_substr

Jaro · 2009-11-09 05:41:29

Haha, you are right! How embarrasing :/

Anyway, your plugin works fine, thanks :)

alanfluff · 2010-04-17 12:13:51

First: Thanks for the plugin!

Anyone know of an easy way to get this? <txp:if_rvm_substr length="27">some content</txp:if_rvm_substr>? Note: if_ is my invention, not a tag that’s included.

I’ve a case where it’d be nice to server-side detect this condition, w/o actually doing the truncation.

Thanks in advance for any comments, cheers, -Alan

Textpattern CMS

Textpattern CMS support forum

#1 2008-12-02 14:31:50

rvm_substr (v0.3)

#2 2008-12-10 09:50:16

Re: rvm_substr (v0.3)

#3 2008-12-10 20:57:04

Re: rvm_substr (v0.3)

#4 2008-12-21 23:34:25

Re: rvm_substr (v0.3)

#5 2008-12-22 11:36:46

Re: rvm_substr (v0.3)

#6 2008-12-22 11:44:54

Re: rvm_substr (v0.3)

#7 2008-12-30 08:23:38

Re: rvm_substr (v0.3)

#8 2008-12-30 09:53:46

Re: rvm_substr (v0.3)

#9 2009-11-08 19:42:41

Re: rvm_substr (v0.3)

#10 2009-11-08 20:35:45

Re: rvm_substr (v0.3)

#11 2009-11-09 05:41:29

Re: rvm_substr (v0.3)

#12 2010-04-17 12:13:51

Re: rvm_substr (v0.3)

Board footer