Content last modified Monday 6 March 2017
hop to #bottom
Categories:
Author:
Current version:
0.2
About It:
Get it:
Rate it:
  • Helpful?
  • 4 Yes
  • 0 No
Flag it:

If you'd like to provide updated information and do not have access to directly edit, please contact the site admin; thanks!

cbs_article_index

Description

This plugin creates a list of links pointing to anchors present in heading titles in the body of an article, so the user can easily navigate through it. It must be used in an article form.

Prerequisite

In the body of the article, add an anchor (an “id” attribute) for each heading title you want to appear in the article index. This may be any kind of heading title, from <h1> to <h6>.

You can use any value for the “id” attribute, but make sure it is unique in your page.

Example:

Textile:

h3(#intro). Introduction

HTML:

<h3 id="intro">Introduction</h3>

Of course you can add other attributes to the heading title tag or add other tags inside the heading title such as <em> or <strong>, it will also work.

If the plugin does not find any heading title with an “id” attribute in the body of the article, it will not display anything.

Syntax

In an article form:

<txp:cbs_article_index />

Attributes

Required

none.

Optional

  • label: Label for the top of the list. Default is no label.
  • labeltag: Independent wraptag for label for the top of the list. Default is empty.
  • break: HTML tag to be used for line breaks, without brackets. Default is br.
  • wraptag: HTML tag to be used as the wraptag, without brackets. Default is empty.
  • class: CSS class attribute for wraptag, default is cbs_article_index.

Changes history

v0.2 (2006-09-27)

  • Code cleaning.

v0.1 (2006-09-16)

Initial release.

Article Request Count:
Initially released:
2006-09-16
Posted here:
16 Sep 2006
Article modified:
20 Apr 2015

Comments/questions? Leave a message in the form.

Commenting is closed for this article.

Subscribe to this article's comments RSS feed. [ ? ]   View Recent Comments across the site.

You know you want to visit the Archives.

Browse

Categories


Articles

There are also tag clouds, 'cause those are fun.
Published with Textpattern