EXT: Pagebrowser¶

TypoScript templates¶

Once the extension is installed, you have to insert the pagebrowser at the point in your TypoScript template where you want to show the pagination. Just copy or reference plugin.tx_cagpagebrowser and you're done.

page.10.subparts.contentarea = COA
page.10.subparts.contentarea {

  # insert content from database
  10 < styles.content.get

  # include pagination menu
  20 < plugin.tx_cagpagebrowser
}

Templavoilà¶

For Templavoilà you should first create a TypoScript object path for the pagebrowser in your datastructure. Then enter the name of the plugin between the <TypoScriptObjPath> tags (you can copy the snippet below and paste it into your DS).

<field_pagebrowser type="array">
        <tx_templavoila type="array">
                <title>cag_pagebrowser</title>
                <sample_data type="array">
                        <numIndex index="0"></numIndex>
                </sample_data>
                <eType>TypoScriptObject</eType>
                <TypoScriptObjPath>plugin.tx_cagpagebrowser</TypoScriptObjPath>
        </tx_templavoila>
</field_pagebrowser>

Version 1 (v.1)¶

This is the “classic” pagebrowser that dates all the years back to 2006. The pagination consists of up to 6 elements, but only 4 are shown at the same time. The elements in their respective order are

LAST | PREVIOUS | SUBSECTION | INDEX | NEXT | FIRST

The FIRST and LAST elements are only inserted on the first and last page of a section instead of the PREVIOUS and NEXT elements. The SUBSECTION element is only inserted if there are subpages to the current page. Have a look at the following screenshot:

On page “One” you will see the link to the LAST page (“Six”), the INDEX page (“Recursive”) and the NEXT page (“Two”). On page “Three” you will see the link to the PREVIOUS page (“Two”), the SUBSECTION (“Three.one”), the INDEX (“Recursive”) and the NEXT page (“Four”).

In version 1, the pagebrowser is configured to loop through sections by default. Pagebrowser elements are always linked. Inactive Elements are taken out of the pagination depending on your current position in the pagetree.

Version 2 (v.2)¶

This rewritten version of the pagebrowser brings some new features. The basic pagination consists of at least 5 elements that remain stable (are always shown). The order of the elements is more logical than in v.1:

INDEX | SUBSECTION | FIRST | PREVIOUS | NEXT | LAST

The SUBSECTION element is only inserted if there are subpages to the current page. A looping through the current section is also possible, but it has to be activated in the constant editor. As long as no looping is configured, the FIRST, PREVIOUS, NEXT and LAST elements are rendered inactive if the user is on the first or last page of the section respectively. Have a look:

In the above example, being on page “One” and no looping configured, the pagebrowser will consist of the INDEX element (“Pagebrowser v.2”), the inactive FIRST and PREVIOUS elements, the NEXT element (“Two”) and the LAST element (“Nine”). The order and amount of elements will remain stable when the user navigates through the pagetree.

If browserLoop = 1 is configured in the constant editor and being on page “One”, the FIRST element will be active and link to “One” (= first page of section), the PREVIOUS element will link to “Nine” ( = last page of section). On page “Nine”, the LAST element will be active and link to “Nine” ( = last page of section), the NEXT element will link to “One” ( = first page of section).

On page “Three”, regardless if browserLoop = 1 is configured or not, the INDEX element links to “Pagebrowser v.2”, the SUBSECTION element is inserted and links to “Three.One”, FIRST links to “One”, PREVIOUS to “Two”, NEXT to “Four”, and LAST to “Nine”.

Entry links¶

You can insert “entry links” to pagebrowser sections. This means that a link is generated on the pagebrowser page which leads to the first page of the pagebrowser section. You need to include the additional TS snippet labelled “Pagebrowser: Entry links (v.1/v.2)” after the basic TS snippet and copy/reference it to a place of your liking in your TS Setup.

page.10.subparts.contentarea = COA
page.10.subparts.contentarea {

  # insert content from database
  10 < styles.content.get

  # include pagination menu
  20 < plugin.tx_cagpagebrowser

  # insert entry links on pagebrowser pages
  25 < plugin.tx_cagpagebrowser.entryLink
}

Pagenumbers¶

It is also possible to render the pages of a pagebrowser section as numbered elements. All valid pages of a section will be counted (valid means not disabled or hidden or of an excluded doktype) and inserted between the PREVIOUS and NEXT elements. You can limit the display of numbers to a certain amount of pages (for example in stable steps of five). If you use this, you should always show the previous/next links, otherwise the user will not be able to move forward/backward to the next/previous number ranges of the pagination. The order of the pagination when using pagenumbers is the same for both versions (v.1/v.2):

INDEX | SUBSECTION | FIRST | PREVIOUS | 1 2 3 4 ... N | NEXT | LAST

To activate pagenumbers, do the following: In v.1 include the static TS snippet labelled “Pagebrowser (v.1): Pagenumbers” after the “Pagebrowser (v.1): Basics” snippet in your template. In v.2 , simply go to the constant editor and activate the pagenumbers feature. In both cases, you have additional configuration options in the constant editor.

Consider the following screenshot:

There are three pages in this section that are excluded from the pagination: “Two” ( = not in menu), “Six” ( = disabled) and “Eight” (sysfolder). The total amount of valid pages for this section therefore is five, not eight. Let's say we are on page “Three”. This is the second page of the section, since page “Two” is hidden from the navigation. The INDEX page always points to the parent page. The SUBSECTION points to “Three.One”. FIRST and PREVIOUS elements point to page “One” since the pagination jumps over the hidden page “Two”. The pagenumber elements consist of the five valid pages of the section: “One”, “Three”, “Four”, “Five” and “Seven” - don't get confused by the pagetitles ;). The NEXT page on page “Three” is page “Four”. The LAST page in the section is “Seven”.

Tree Prev/Next¶

The “Tree Prev/Next” feature (new in v.2) allows you to “flatten out” the tree hierarchy and have a pagination menu that runs back and forth from the very first page below a pagebrowser page to the very last page in the branch regardless of any levels. For this feature you need to include the snippet “Pagebrowser (v.2): Tree Prev/Next” right after your basic pagebrowser snippet in the “Include static from extensions” field. Consider the following page structure:

When flattening out the tree structure obviously some things have to be taken into account. What about shortcuts? Pages below a sysfolder? External links? Etc. The pagebrowser tries to solve all those pitfalls intelligently depending on the current position in the pagetree.

In the above example standing on page “Two”, the PREVIOUS and FIRST element is page “One”. The NEXT element in the flattened tree is page “Two.One”. The LAST element is page “Five” and the INDEX points to the parent page.

Things are different when we are on page “Three.One”. Normally page “Three” would be the previous page – but its a shortcut that points to page “Three.One”. Moving forwards, no problem. But moving backwards, we would never be able to go beyond that page since it always pushes us back to where we are. D'oh. In such a situation, the pagebrowser analyses the target of the shortcut and quite logically forces a jump beyond to the very next page in the flattened tree. So, in our case and moving backwards, the PREVIOUS page is page “Two.Three”! The FIRST page is page “One”. The NEXT page is page “Three.Two”, the LAST page is page “Five” and the INDEX page is the parent page. Note that in a flattened tree there can be no SUBSECTION ;)

A more complicated example:

What a mean branch ;) Let's step through the examples:

1) Current page is “Page 1.1”: PREVIOUS and FIRST are the same - “Page 1”. The next page is a shortcut. Due to this the browser directly jumps to the target “Page 1.2.1” which is the NEXT page in the section. The LAST page is “Page 5.3.1”.

2) Current page is “Page 1.2.3”: FIRST page is “Page 1”. PREVIOUS page is “Page 1.2.2”. NEXT page must be “Page 2.2” since “Page 2” is a shortcut that points to the first subpage “Page 2.1” which by coincidence is disabled. LAST page is “Page 5.3.1”.

3) Current page is “Page 3.1.3”: FIRST page is “Page 1”. PREVIOUS page must be “Page 3.1.1” since the direct previous page is a sysfolder. NEXT page must be “Page 3.2.1” since the direct next page is disabled. LAST page is still “Page 5.3.1”.

4) Current page is “Page 4”: FIRST page is “Page 1”. PREVIOUS must be “Page 3.2.3” since the admin has set “Page 3.3” in the excludeUid list. NEXT page is “Page 4.1” and LAST page is “Page 5.3.1”.

5) Current page is “Page 5.3”: FIRST page is still “Page 1”. PREVIOUS page is “Page 5.1”, BUT only because the admin has allowed the doktype “External links” in the constant editor. This means that the user will leave the current website as soon as he clicks on this navigation element. NEXT and LAST page are both “Page 5.3.1”.

You get the hang of it ;)

dtypes¶

browserMode¶

excludeUidList¶

browsewords¶

previous¶

next¶

last¶

first¶

indexword¶

subsection¶

wrapWhole¶

wrapLast¶

wrapPrevious¶

wrapIndex¶

wrapNext¶

wrapFirst¶

wrapSubsection¶

wrap¶

excludeUidList¶

word¶

wrapPageNumbers¶

wrapSingleNumbers¶

useNumbering¶

stepSize¶