Merge pull request #3362 from jim-parry/userguide/pagination

Enhance Pagination Class Writeup in User Guide

1 files changed, 26 insertions, 52 deletions

diff --git a/user_guide_src/source/libraries/pagination.rst b/user_guide_src/source/libraries/pagination.rst
index 8a62376f1..8c5c2c63a 100644
--- a/user_guide_src/source/libraries/pagination.rst
+++ b/user_guide_src/source/libraries/pagination.rst
@@ -73,29 +73,25 @@ Customizing the Pagination
 The following is a list of all the preferences you can pass to the
 initialization function to tailor the display.
 
-$config['uri_segment'] = 3;
-===========================
+**$config['uri_segment'] = 3;**
 
 The pagination function automatically determines which segment of your
 URI contains the page number. If you need something different you can
 specify it.
 
-$config['num_links'] = 2;
-=========================
+**$config['num_links'] = 2;**
 
 The number of "digit" links you would like before and after the selected
 page number. For example, the number 2 will place two digits on either
 side, as in the example links at the very top of this page.
 
-$config['use_page_numbers'] = TRUE;
-===================================
+**$config['use_page_numbers'] = TRUE;**
 
 By default, the URI segment will use the starting index for the items
 you are paginating. If you prefer to show the the actual page number,
 set this to TRUE.
 
-$config['page_query_string'] = TRUE;
-====================================
+**$config['page_query_string'] = TRUE;**
 
 By default, the pagination library assume you are using :doc:`URI
 Segments <../general/urls>`, and constructs your links something
@@ -113,8 +109,7 @@ the pagination link will become::
 Note that "per_page" is the default query string passed, however can be
 configured using ``$config['query_string_segment'] = 'your_string'``
 
-$config['reuse_query_string'] = FALSE;
-======================================
+**$config['reuse_query_string'] = FALSE;**
 
 By default your Query String arguments (nothing to do with other
 query string options) will be ignored. Setting this config to
@@ -126,14 +121,12 @@ URL after the URI segment and before the suffix.::
 This helps you mix together normal :doc:`URI Segments <../general/urls>`
 as well as query string arguments, which until 3.0 was not possible.
 
-$config['prefix'] = '';
-=======================
+**$config['prefix'] = '';**
 
 A custom prefix added to the path. The prefix value will be right before
 the offset segment.
 
-$config['suffix'] = '';
-=======================
+**$config['suffix'] = '';**
 
 A custom suffix added to the path. The sufix value will be right after
 the offset segment.
@@ -145,13 +138,11 @@ Adding Enclosing Markup
 If you would like to surround the entire pagination with some markup you
 can do it with these two preferences:
 
-$config['full_tag_open'] = '<p>';
-=================================
+**$config['full_tag_open'] = '<p>';**
 
 The opening tag placed on the left side of the entire result.
 
-$config['full_tag_close'] = '</p>';
-===================================
+**$config['full_tag_close'] = '</p>';**
 
 The closing tag placed on the right side of the entire result.
 
@@ -159,26 +150,22 @@ The closing tag placed on the right side of the entire result.
 Customizing the First Link
 **************************
 
-$config['first_link'] = 'First';
-================================
+**$config['first_link'] = 'First';**
 
 The text you would like shown in the "first" link on the left. If you do
 not want this link rendered, you can set its value to FALSE.
 
 .. note:: This value can also be translated via a language file.
 
-$config['first_tag_open'] = '<div>';
-====================================
+**$config['first_tag_open'] = '<div>';**
 
 The opening tag for the "first" link.
 
-$config['first_tag_close'] = '</div>';
-======================================
+**$config['first_tag_close'] = '</div>';**
 
 The closing tag for the "first" link.
 
-$config['first_url'] = '';
-==========================
+**$config['first_url'] = '';**
 
 An alternative URL to use for the "first page" link.
 
@@ -186,21 +173,18 @@ An alternative URL to use for the "first page" link.
 Customizing the Last Link
 *************************
 
-$config['last_link'] = 'Last';
-==============================
+**$config['last_link'] = 'Last';**
 
 The text you would like shown in the "last" link on the right. If you do
 not want this link rendered, you can set its value to FALSE.
 
 .. note:: This value can also be translated via a language file.
 
-$config['last_tag_open'] = '<div>';
-===================================
+**$config['last_tag_open'] = '<div>';**
 
 The opening tag for the "last" link.
 
-$config['last_tag_close'] = '</div>';
-=====================================
+**$config['last_tag_close'] = '</div>';**
 
 The closing tag for the "last" link.
 
@@ -208,21 +192,18 @@ The closing tag for the "last" link.
 Customizing the "Next" Link
 ***************************
 
-$config['next_link'] = '&gt;';
-==============================
+**$config['next_link'] = '&gt;';**
 
 The text you would like shown in the "next" page link. If you do not
 want this link rendered, you can set its value to FALSE.
 
 .. note:: This value can also be translated via a language file.
 
-$config['next_tag_open'] = '<div>';
-===================================
+**$config['next_tag_open'] = '<div>';**
 
 The opening tag for the "next" link.
 
-$config['next_tag_close'] = '</div>';
-=====================================
+**$config['next_tag_close'] = '</div>';**
 
 The closing tag for the "next" link.
 
@@ -230,21 +211,18 @@ The closing tag for the "next" link.
 Customizing the "Previous" Link
 *******************************
 
-$config['prev_link'] = '&lt;';
-==============================
+**$config['prev_link'] = '&lt;';**
 
 The text you would like shown in the "previous" page link. If you do not
 want this link rendered, you can set its value to FALSE.
 
 .. note:: This value can also be translated via a language file.
 
-$config['prev_tag_open'] = '<div>';
-===================================
+**$config['prev_tag_open'] = '<div>';**
 
 The opening tag for the "previous" link.
 
-$config['prev_tag_close'] = '</div>';
-=====================================
+**$config['prev_tag_close'] = '</div>';**
 
 The closing tag for the "previous" link.
 
@@ -252,13 +230,11 @@ The closing tag for the "previous" link.
 Customizing the "Current Page" Link
 ***********************************
 
-$config['cur_tag_open'] = '<b>';
-================================
+**$config['cur_tag_open'] = '<b>';**
 
 The opening tag for the "current" link.
 
-$config['cur_tag_close'] = '</b>';
-==================================
+**$config['cur_tag_close'] = '</b>';**
 
 The closing tag for the "current" link.
 
@@ -266,13 +242,11 @@ The closing tag for the "current" link.
 Customizing the "Digit" Link
 ****************************
 
-$config['num_tag_open'] = '<div>';
-==================================
+**$config['num_tag_open'] = '<div>';**
 
 The opening tag for the "digit" link.
 
-$config['num_tag_close'] = '</div>';
-====================================
+**$config['num_tag_close'] = '</div>';**
 
 The closing tag for the "digit" link.