An open API service indexing awesome lists of open source software.

https://github.com/gocom/zem_nth

Fork of zem_nth plugin
https://github.com/gocom/zem_nth

Last synced: about 1 month ago
JSON representation

Fork of zem_nth plugin

Awesome Lists containing this project

README

          

h1. zem_nth

"Download":https://github.com/gocom/zem_nth/releases | "Packagist":https://packagist.org/packages/rah/zem_nth | "Twitter":http://twitter.com/gocom | "Donate":http://rahforum.biz/donate/zem_nth

Step in a list. The zem_nth plugin adds a conditional tag to "Textpattern CMS":http://textpattern.com, which can be used to matches every nth item in a group of items based on the given step and group of. This tag works similarly to the ":nth-child":https://developer.mozilla.org/en-US/docs/CSS/:nth-child pseudo-selector found in CSS.

h2. Installing

Using "Composer":http://getcomposer.org:

bc. $ composer require rah/zem_nth:*

Or "download":https://github.com/gocom/zem_nth/releases a plugin package.

h2. Tag attributes

bc.
...every third...

...first and second...

The tag can also be used as a single, self-closing tag to return the current counter value:

bc.

Attributes are as follows:

*step*
The step to jump.
Example: @step="2"@ Default: @"2"@

*of*
Step of how many.
Example: @off="4"@ Default: @undefined@

*id*
The identifier assigned to the counter. By default counters are identified by their contents. If you need multiple counters for identical code blocks, you can use the @id@ attribute to set your own identifier to prevent collisions. The @id@ attribute can also be used to connect two counters with different contents that wouldn't normally be connected.
Example: @id="article_sidebar_stripes"@ Default: @undefined@

*start*
The value the counter starts from. This allows resuming a previous counter, or just to add padding.
Example: @start="25"@ Default: @"0"@

*reset*
If set to @1@, resets the current counter back to the starting value set with @start@.
Example: @reset="1"@ Default: @"0"@

h2. Toolshed notice

This is a toolshed project. Experimental and not part of the main supported product line of Rah. Not yet at least. Please use at your own risk.

h2. Examples

h3. Striped article list

Adds even and odd classes to posts.

bc.

oddeven">



h3. Return current counter value

Display article number.

bc.

#:

h2. Changelog

h3. Version 0.3.0 - 2014/03/18

* Fixed: Prevent possible collisions within the step, contained statement and of when calculating identifier.
* Added: If used as a self-closing tag, returns the current counter value.
* Now requires PHP 5.2.0 or newer.

h3. Version 0.2.2 - 2013/05/05

* Fixed: Reported version number.

h3. Version 0.2.1 - 2013/05/05

* Fixed: Composer package requirements.

h3. Version 0.2.0 - 2013/05/05

* Added: @@ support.
* Added: @id@ attribute. Allows avoiding collisions and starting new counters, where the contents and the attributes are the identical, but the counter should restart from zero. Can also be used to connect counters that wouldn't normally match.
* Added: @start@ attribute. Allows changing the counter's starting value.
* Added: @reset@ attribute. Resets the counter back to zero.

h3. Version 0.1.0 - 2004/08/26

* Initial release.