From cc231fe7dc8d61e4d4f5d6a054e6131ea0659909 Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Mon, 23 Sep 2013 16:46:52 +0300 Subject: [ci skip] Update the Typography library docs --- user_guide_src/source/libraries/typography.rst | 137 ++++++++++++------------- 1 file changed, 68 insertions(+), 69 deletions(-) (limited to 'user_guide_src/source/libraries/typography.rst') diff --git a/user_guide_src/source/libraries/typography.rst b/user_guide_src/source/libraries/typography.rst index db3f227be..8dab053ba 100644 --- a/user_guide_src/source/libraries/typography.rst +++ b/user_guide_src/source/libraries/typography.rst @@ -2,104 +2,103 @@ Typography Class ################ -The Typography Class provides functions that help you format text. +The Typography Class provides methods that help you format text. + +.. content:: + :local: + +.. raw:: html + +
+ +************************** +Using the Typography Class +************************** Initializing the Class ====================== Like most other classes in CodeIgniter, the Typography class is -initialized in your controller using the $this->load->library function:: +initialized in your controller using the ``$this->load->library()`` method:: $this->load->library('typography'); -Once loaded, the Typography library object will be available using: -$this->typography +Once loaded, the Typography library object will be available using:: -auto_typography() -================== + $this->typography -Formats text so that it is semantically and typographically correct -HTML. Takes a string as input and returns it with the following -formatting: +*************** +Class Reference +*************** -- Surrounds paragraphs within

(looks for double line breaks to - identify paragraphs). -- Single line breaks are converted to
, except those that appear - within 
 tags.
--  Block level elements, like 
 tags, are not wrapped within
-   paragraphs, but their contained text is if it contains paragraphs.
--  Quotes are converted to correctly facing curly quote entities, except
-   those that appear within tags.
--  Apostrophes are converted to curly apostrophe entities.
--  Double dashes (either like -- this or like--this) are converted to
-   em—dashes.
--  Three consecutive periods either preceding or following a word are
-   converted to ellipsis…
--  Double spaces following sentences are converted to non-breaking
-   spaces to mimic double spacing.
+.. class:: CI_Typography
 
-Usage example::
+	.. attribute:: $protect_braced_quotes = FALSE
 
-	$string = $this->typography->auto_typography($string);
+		When using the Typography library in conjunction with the :doc:`Template Parser library <../parser>`
+		it can often be desirable to protect single and double quotes within curly braces.
+		To enable this, set the ``protect_braced_quotes`` class property to TRUE.
 
-Parameters
-----------
+		Usage example::
 
-There is one optional parameters that determines whether the parser
-should reduce more then two consecutive line breaks down to two. Use
-boolean TRUE or FALSE.
+			$this->load->library('typography');
+			$this->typography->protect_braced_quotes = TRUE;
 
-By default the parser does not reduce line breaks. In other words, if no
-parameters are submitted, it is the same as doing this::
+	.. method auto_typography($str[, $reduce_linebreaks = FALSE])
 
-	$string = $this->typography->auto_typography($string, FALSE);
+		:param string $str: input string
+		:param bool $reduce_linebreaks: whether to reduce consequitive linebreaks
+		:returns: string
 
-.. note:: Typographic formatting can be processor intensive,
-	particularly if you have a lot of content being formatted. If you choose
-	to use this function you may want to consider :doc:`caching <../general/caching>`
-	your pages.
+		Formats text so that it is semantically and typographically correct HTML.
+		Takes a string as input and returns it with the following formatting:
 
-format_characters()
-====================
+		 -  Surrounds paragraphs within 
 (looks for double line breaks to identify paragraphs).
+		 -  Single line breaks are converted to 
, except those that appear within 
 tags.
+		 -  Block level elements, like 
 tags, are not wrapped within paragraphs, but their contained text is if it contains paragraphs.
+		 -  Quotes are converted to correctly facing curly quote entities, except those that appear within tags.
+		 -  Apostrophes are converted to curly apostrophe entities.
+		 -  Double dashes (either like -- this or like--this) are converted to em—dashes.
+		 -  Three consecutive periods either preceding or following a word are converted to ellipsis (…).
+		 -  Double spaces following sentences are converted to non-breaking spaces to mimic double spacing.
 
-This function is similar to the auto_typography function above, except
-that it only does character conversion:
+		Usage example::
 
--  Quotes are converted to correctly facing curly quote entities, except
-   those that appear within tags.
--  Apostrophes are converted to curly apostrophe entities.
--  Double dashes (either like -- this or like--this) are converted to
-   em—dashes.
--  Three consecutive periods either preceding or following a word are
-   converted to ellipsis…
--  Double spaces following sentences are converted to non-breaking
-   spaces to mimic double spacing.
+			$string = $this->typography->auto_typography($string);
 
-Usage example::
+		There is one optional parameter that determines whether the parser should reduce more then two consecutive line breaks down to two.
+		Pass boolean TRUE to enable reducing line breaks::
 
-	$string = $this->typography->format_characters($string);
+			$string = $this->typography->auto_typography($string, TRUE);
 
-nl2br_except_pre()
-====================
+		.. note:: Typographic formatting can be processor intensive, particularly if you have a lot of content being formatted.
+			If you choose to use this method you may want to consider :doc:`caching <../general/caching>` your pages.
 
-Converts newlines to 
 tags unless they appear within 
 tags.
-This function is identical to the native PHP nl2br() function, except
-that it ignores 
 tags.
+	.. method:: format_characters($str)
 
-Usage example::
+		:param string $str: input string
+		:returns: string
 
-	$string = $this->typography->nl2br_except_pre($string);
+		This method is similar to ``auto_typography()`` above, except that it only does character conversion:
 
-protect_braced_quotes
-=======================
+		 -  Quotes are converted to correctly facing curly quote entities, except those that appear within tags.
+		 -  Apostrophes are converted to curly apostrophe entities.
+		 -  Double dashes (either like -- this or like--this) are converted to em—dashes.
+		 -  Three consecutive periods either preceding or following a word are converted to ellipsis (…).
+		 -  Double spaces following sentences are converted to non-breaking spaces to mimic double spacing.
 
-When using the Typography library in conjunction with the Template
-Parser library it can often be desirable to protect single and double
-quotes within curly braces. To enable this, set the
-protect_braced_quotes class property to TRUE.
+		Usage example::
 
-Usage example::
+			$string = $this->typography->format_characters($string);
 
-	$this->load->library('typography');
-	$this->typography->protect_braced_quotes = TRUE;
+	.. method:: nl2br_except_pre($str)
+
+		:param string $str: input string
+		:returns: string
+
+		Converts newlines to 
 tags unless they appear within 
 tags.
+		This method is identical to the native PHP :php:func:`nl2br()` function, except that it ignores 
 tags.
+
+		Usage example::
 
+			$string = $this->typography->nl2br_except_pre($string);
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From cc042095bcce9856402cc04997f44310074716e0 Mon Sep 17 00:00:00 2001
From: Andrey Andreev 
Date: Fri, 3 Jan 2014 17:08:27 +0200
Subject: [ci skip] Some more generic user guide cleanup

---
 user_guide_src/source/libraries/typography.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source/libraries/typography.rst')

diff --git a/user_guide_src/source/libraries/typography.rst b/user_guide_src/source/libraries/typography.rst
index 8dab053ba..006e77d56 100644
--- a/user_guide_src/source/libraries/typography.rst
+++ b/user_guide_src/source/libraries/typography.rst
@@ -5,11 +5,11 @@ Typography Class
 The Typography Class provides methods that help you format text.
 
 .. content::
-	:local:
+  :local:
 
 .. raw:: html
 
-	

+  

 
 **************************
 Using the Typography Class
-- 
cgit v1.2.3-24-g4f1b


From 75b3fb26a324c71ff18fa19b2a3caa357f8133ec Mon Sep 17 00:00:00 2001
From: Connor Tumbleson 
Date: Sat, 11 Jan 2014 06:58:43 -0600
Subject: cleanup warnings

Signed-off-by: Connor Tumbleson 
---
 user_guide_src/source/libraries/typography.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source/libraries/typography.rst')

diff --git a/user_guide_src/source/libraries/typography.rst b/user_guide_src/source/libraries/typography.rst
index 006e77d56..f1a825d3d 100644
--- a/user_guide_src/source/libraries/typography.rst
+++ b/user_guide_src/source/libraries/typography.rst
@@ -4,7 +4,7 @@ Typography Class
 
 The Typography Class provides methods that help you format text.
 
-.. content::
+.. contents::
   :local:
 
 .. raw:: html
@@ -35,7 +35,7 @@ Class Reference
 
 	.. attribute:: $protect_braced_quotes = FALSE
 
-		When using the Typography library in conjunction with the :doc:`Template Parser library <../parser>`
+		When using the Typography library in conjunction with the :doc:`Template Parser library `
 		it can often be desirable to protect single and double quotes within curly braces.
 		To enable this, set the ``protect_braced_quotes`` class property to TRUE.
 
-- 
cgit v1.2.3-24-g4f1b


From ba231aab2b26279f536a52bf4ccdb4af0d191570 Mon Sep 17 00:00:00 2001
From: Andrey Andreev 
Date: Mon, 20 Jan 2014 16:43:41 +0200
Subject: [ci skip] Replace incorrect usage of 'then', where it should be
 'than'

---
 user_guide_src/source/libraries/typography.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source/libraries/typography.rst')

diff --git a/user_guide_src/source/libraries/typography.rst b/user_guide_src/source/libraries/typography.rst
index f1a825d3d..c1a864a3e 100644
--- a/user_guide_src/source/libraries/typography.rst
+++ b/user_guide_src/source/libraries/typography.rst
@@ -66,7 +66,7 @@ Class Reference
 
 			$string = $this->typography->auto_typography($string);
 
-		There is one optional parameter that determines whether the parser should reduce more then two consecutive line breaks down to two.
+		There is one optional parameter that determines whether the parser should reduce more than two consecutive line breaks down to two.
 		Pass boolean TRUE to enable reducing line breaks::
 
 			$string = $this->typography->auto_typography($string, TRUE);
-- 
cgit v1.2.3-24-g4f1b


From 28c2c975b118016d07212ed8e7c22ff280309f82 Mon Sep 17 00:00:00 2001
From: Andrey Andreev 
Date: Sat, 8 Feb 2014 04:27:48 +0200
Subject: [ci skip] Add return types to library docs

---
 user_guide_src/source/libraries/typography.rst | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

(limited to 'user_guide_src/source/libraries/typography.rst')

diff --git a/user_guide_src/source/libraries/typography.rst b/user_guide_src/source/libraries/typography.rst
index c1a864a3e..65fea9d8e 100644
--- a/user_guide_src/source/libraries/typography.rst
+++ b/user_guide_src/source/libraries/typography.rst
@@ -46,9 +46,10 @@ Class Reference
 
 	.. method auto_typography($str[, $reduce_linebreaks = FALSE])
 
-		:param string $str: input string
-		:param bool $reduce_linebreaks: whether to reduce consequitive linebreaks
-		:returns: string
+		:param	string	$str: Input string
+		:param	bool	$reduce_linebreaks: Whether to reduce consequitive linebreaks
+		:returns:	HTML typography-safe string
+		:rtype:	string
 
 		Formats text so that it is semantically and typographically correct HTML.
 		Takes a string as input and returns it with the following formatting:
@@ -76,8 +77,9 @@ Class Reference
 
 	.. method:: format_characters($str)
 
-		:param string $str: input string
-		:returns: string
+		:param	string	$str: Input string
+		:returns:	Formatted string
+		:rtype:	string
 
 		This method is similar to ``auto_typography()`` above, except that it only does character conversion:
 
@@ -93,8 +95,9 @@ Class Reference
 
 	.. method:: nl2br_except_pre($str)
 
-		:param string $str: input string
-		:returns: string
+		:param	string	$str: Input string
+		:returns:	Formatted string
+		:rtype:	string
 
 		Converts newlines to 
 tags unless they appear within 
 tags.
 		This method is identical to the native PHP :php:func:`nl2br()` function, except that it ignores 
 tags.
-- 
cgit v1.2.3-24-g4f1b