summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source
diff options
context:
space:
mode:
Diffstat (limited to 'user_guide_src/source')
-rw-r--r--user_guide_src/source/changelog.rst5
-rw-r--r--user_guide_src/source/libraries/pagination.rst40
2 files changed, 22 insertions, 23 deletions
diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index dd6fa4603..4054a04ff 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -162,7 +162,10 @@ Release Date: Not Released
- Added dsn (delivery status notification) option to the :doc:`Email Library <libraries/email>`.
- Renamed method _set_header() to set_header() and made it public to enable adding custom headers in the :doc:`Email Library <libraries/email>`.
- Added an "index" parameter to the data() method in the :doc:`Upload Library <libraries/file_uploading>`.
- - Added support for the anchor "rel" attribute in the :doc:`Pagination Library <libraries/pagination>`.
+ - :doc:`Pagination Library <libraries/pagination>` changes include:
+ - Added support for the anchor "rel" attribute.
+ - Added support for setting custom attributes.
+ - Deprecated usage of the "anchor_class" setting (use the new "attributes" setting instead).
- Core
diff --git a/user_guide_src/source/libraries/pagination.rst b/user_guide_src/source/libraries/pagination.rst
index 560755fb6..c4398d739 100644
--- a/user_guide_src/source/libraries/pagination.rst
+++ b/user_guide_src/source/libraries/pagination.rst
@@ -247,34 +247,30 @@ adding::
$config['display_pages'] = FALSE;
-******************************
-Adding a class to every anchor
-******************************
+****************************
+Adding attributes to anchors
+****************************
-If you want to add a class attribute to every link rendered by the
-pagination class, you can set the config "anchor_class" equal to the
-classname you want.
+If you want to add an extra attribute to be added to every link rendered
+by the pagination class, you can set them as key/value pairs in the
+"attributes" config
::
- $config['anchor_class'] = 'myclass'; // class="myclass"
+ // Produces: class="myclass"
+ $config['attributes'] = array('class' => 'myclass');
-**********************************
-Changing the "rel" attribute value
-**********************************
+.. note:: Usage of the old method of setting classes via "anchor_class"
+ is deprecated.
-By default, the rel attribute will be automatically put under the
-following conditions:
+*****************************
+Disabling the "rel" attribute
+*****************************
-- rel="start" for the "first" link
-- rel="prev" for the "previous" link
-- rel="next" for the "next" link
+By default the rel attribute is dynamically generated and appended to
+the appropriate anchors. If for some reason you want to turn it off,
+you can pass boolean FALSE as a regular attribute
-If you want to disable the rel attribute, or change its value, you
-can set the 'attr_rel' config option::
-
- // Disable
- $config['attr_rel'] = FALSE;
+::
- // Use a custom value on all anchors
- $config['attr_rel'] = 'custom_value'; // produces: rel="custom_value" \ No newline at end of file
+ $config['attributes']['rel'] = FALSE; \ No newline at end of file