From 8bef54f488996ec6193204dcdd576c7c9402a044 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Fri, 19 Jul 2013 14:16:17 -0700 Subject: whitespace in css file --- .../_themes/eldocs/static/asset/css/common.css | 136 ++++++++++----------- 1 file changed, 68 insertions(+), 68 deletions(-) (limited to 'user_guide_src/source') diff --git a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css index 648e33032..10e4de1d5 100644 --- a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css +++ b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css @@ -22,7 +22,7 @@ http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0) html, body, h1, h2, h3, h4, h5, h6, -p, ul, ol, li, dl, dd, dt, pre, form, fieldset{ margin: 0; padding: 0; } +p, ul, ol, li, dl, dd, dt, pre, form, fieldset{ margin: 0; padding: 0; } body{ background-color: #F9F9F9; color: #444444; font: normal normal 14px "Helvetica", "Arial", Sans-Serif; } @@ -34,10 +34,10 @@ pre, #table-contents .toctree-wrapper{ font-size: 12px; } dfn, var, -em.dfn, em.var{ - background-color: #FFFDED; - color: #578236; - font-style: italic; +em.dfn, em.var{ + background-color: #FFFDED; + color: #578236; + font-style: italic; padding: 3px; } @@ -53,7 +53,7 @@ h2{ font-size: 24px; font-weight: normal; } h1, h2, h3, h4, h5, h6{ margin-bottom: 20px; } -h2, h3{ border-bottom: 2px solid #EEEEEE; padding: 0 0 3px; } +h2, h3{ border-bottom: 2px solid #EEEEEE; padding: 0 0 3px; } h3{ border-color: #E5E5E5; border-width: 1px; } @@ -62,7 +62,7 @@ h4{ background-color: #FFFDED; display: inline-block; font-size: 18px; margin: 0 h1 a, h2 a{ font-weight: normal; } h1 a, h2 a, h3 a{ text-decoration: none; } - + h3, h5, h6{ font-size: 18px; margin: 20px 0; } h4, h5, h6{ font-size: 14px; } @@ -75,55 +75,55 @@ p, dl, ul, ol{ margin: 20px 0; } li > ol{ margin: 0; margin-left: 40px; } dl > dd{ margin-left: 20px; } - + li > p { margin: 0; } #expressionengine-user-guide li em { font-style: normal; } p, li, dd, dt, pre{ line-height: 1.5; } -table{ +table{ background-color: #F5FBFF; border: 1px solid #C8DEF0; border-collapse: collapse; margin-bottom: 20px; } - th, td{ - border: 0; + th, td{ + border: 0; border-bottom: 1px solid #C8DEF0; - padding: 8px; + padding: 8px; } - - th{ - background-color: #326B95; + + th{ + background-color: #326B95; color: #FFFFFF; - text-align: left; + text-align: left; } - + td{ font-size: 12px; } .descname{ color: #000080; font-weight: bold; } .descclassname{ color: #094776; } - + .class .descname{ font-size: 18px; font-style: italic; } .method .descname{ font-style: normal; } - + .class .property{ color: #094776; } - + .method big, .method .optional{ color: #094776; padding: 0 4px 0 6px; } - + .class em, .method em{ color: #008080; } - + .method dt{ margin: 20px 0; } - + .method table{ margin-bottom: 0; margin-left: 20px; } - + .method th, .method td{ padding: 10px; } - + .method td > ul{ margin: 0; margin-left: 20px; } .method td.field-body > p { margin: 0; margin-left: 20px; } @@ -137,7 +137,7 @@ a.headerlink{ visibility: hidden; } :hover > a.headerlink { visibility: visible; } -a img{ +a img{ border: 0; outline: 0; } @@ -158,36 +158,36 @@ fieldset{ border: 0; } .highlight-perl, .highlight-php, .cp-path, -.codeblock{ - background-color: #F9FEFF; - border: 1px solid #C8DEF0; +.codeblock{ + background-color: #F9FEFF; + border: 1px solid #C8DEF0; -moz-box-shadow: 4px 4px 0 rgba(0,0,0,0.03); -webkit-box-shadow: 4px 4px 0 rgba(0,0,0,0.03); box-shadow: 4px 4px 0 rgba(0,0,0,0.03); - margin: 20px 0; - padding: 10px 10px 8px; + margin: 20px 0; + padding: 10px 10px 8px; } .highlight-ci{ background-color: #FEFEFE; border-color: #E5E5E5; } .admonition p{ margin: 0; } - + .codeblock{ margin: 10px 0; } - + .cp-path{ background-color: #FAFFF6; border-color: #D1CDB0; } .important, .note{ background-color: #FFFFF2; border-color: #C8C8A5; } - -.admonition-title{ + +.admonition-title{ float: left; - font-weight: bold; - padding-right: 4px; - text-transform: uppercase; + font-weight: bold; + padding-right: 4px; + text-transform: uppercase; } .admonition-title:after{ content: ': '; } .highlighted{ background-color: #FFF09B; } - + #table-contents{ bottom: 0; left: -520px; @@ -195,7 +195,7 @@ fieldset{ border: 0; } top: 0; } -#table-contents .toctree-wrapper{ +#table-contents .toctree-wrapper{ background-color: #444444; background-color: rgba(0,0,0,0.9); *+background-color: #444444; @@ -209,16 +209,16 @@ fieldset{ border: 0; } } #table-contents .toctree-wrapper ul{margin-bottom: 0; margin-top: 0; } - + #table-contents .toctree-wrapper li{ color: #999999; line-height: 1.7; padding: 1px 0; } - + #table-contents .toctree-l1{ list-style-type: none; } - - #table-contents .toctree-l1 > a{ - background: transparent url(../../asset/img/paper-ico.gif) no-repeat 0 0; - font-size: 14px; + + #table-contents .toctree-l1 > a{ + background: transparent url(../../asset/img/paper-ico.gif) no-repeat 0 0; + font-size: 14px; font-weight: bold; - padding-left: 20px; + padding-left: 20px; } #header a:link, @@ -233,15 +233,15 @@ fieldset{ border: 0; } #content{ background-color: #FFFFFF; padding: 40px 40px 20px; } -#brand{ - background-color: #F5F5F5; - color: #FFFFFF; +#brand{ + background-color: #F5F5F5; + color: #FFFFFF; overflow: hidden; - padding: 10px 20px 13px; + padding: 10px 20px 13px; } #brand > *{ float: left; } - + #brand p{ font-size: 14px; margin: 2px 0 0 5px; } #brand.ci p{ margin-top: 8px; } @@ -250,18 +250,18 @@ fieldset{ border: 0; } #brand.mm{ background-color: #222627; } #brand.el{ background-color: #4A0202; } -#header{ +#header{ background-color: #3B7EB0; border-top: 2px solid #539ECC; - color: #FFFFFF; - overflow: hidden; - padding: 15px 15px 16px 20px; + color: #FFFFFF; + overflow: hidden; + padding: 15px 15px 16px 20px; } #header form{ float: right; overflow: hidden; } - + #header input{ float: left; } - + #header input[type="text"]{ background-color: #FFFFFF; border: 1px solid; @@ -271,9 +271,9 @@ fieldset{ border: 0; } padding: 5px; width: 175px; } - + #header input[type="text"]:focus{ background-color: #FFFDED; outline: 0; } - + #header input[type="submit"]{ background: #F0F9FF url(../../asset/img/grades.gif) repeat-x 0 -58px; border: 1px solid #033861; @@ -283,18 +283,18 @@ fieldset{ border: 0; } padding: 5px 10px 4px; text-transform: uppercase; } - + #header input[type="submit"]:hover{ background-position: 0 -83px; } - - #header ul{ + + #header ul{ float: left; list-style-type: none; - margin: 0; + margin: 0; overflow: hidden; } - + #header li{ float: left; margin: 4px 5px 0 0; } - + #footer{ background-color: #F9F9F9; border-top: 1px solid #CCCCCC; padding: 20px; } #footer p{ margin: 0; } @@ -322,8 +322,8 @@ fieldset{ border: 0; } -webkit-box-sizing: border-box; box-sizing: border-box; margin-bottom: 10px; - resize: none; - width: 100%; + resize: none; + width: 100%; } #comment_form input[type="submit"]{ margin-top: 10px; } -- cgit v1.2.3-24-g4f1b From 6290ed1922842812dddcfdaeb4973babc6ed8436 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Fri, 19 Jul 2013 14:16:43 -0700 Subject: adding HTML highlight block rule --- user_guide_src/source/_themes/eldocs/static/asset/css/common.css | 1 + 1 file changed, 1 insertion(+) (limited to 'user_guide_src/source') diff --git a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css index 10e4de1d5..d1e9fe2d9 100644 --- a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css +++ b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css @@ -157,6 +157,7 @@ fieldset{ border: 0; } .highlight-bash, .highlight-perl, .highlight-php, +.highlight-html, .cp-path, .codeblock{ background-color: #F9FEFF; -- cgit v1.2.3-24-g4f1b From e7dfb679cf4f1a683d837aaea94b5b5125204779 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Fri, 19 Jul 2013 14:16:56 -0700 Subject: updating XML helper docs --- user_guide_src/source/helpers/xml_helper.rst | 42 ++++++++++++++++++++-------- 1 file changed, 30 insertions(+), 12 deletions(-) (limited to 'user_guide_src/source') diff --git a/user_guide_src/source/helpers/xml_helper.rst b/user_guide_src/source/helpers/xml_helper.rst index be848bcd1..681408e03 100644 --- a/user_guide_src/source/helpers/xml_helper.rst +++ b/user_guide_src/source/helpers/xml_helper.rst @@ -5,7 +5,9 @@ XML Helper The XML Helper file contains functions that assist in working with XML data. -.. contents:: Page Contents + +.. contents:: + :local: Loading this Helper =================== @@ -16,23 +18,39 @@ This helper is loaded using the following code $this->load->helper('xml'); +Available Functions +=================== + The following functions are available: + xml_convert() -===================== +------------- -Takes a string as input and converts the following reserved XML -characters to entities: +.. method:: xml_convert($str[, $protect_all = FALSE]) -- Ampersands: & -- Less then and greater than characters: < > -- Single and double quotes: ' " -- Dashes: - + :param string $str: the text string to convert + :param bool $protect_all: Whether to protect all content that looks like a potential entity instead of just numbered entities, e.g. &foo; + :returns: converted string + :rtype: string -This function ignores ampersands if they are part of existing character -entities. Example + Takes a string as input and converts the following reserved XML + characters to entities: -:: + - Ampersands: & + - Less then and greater than characters: < > + - Single and double quotes: ' " + - Dashes: - + + This function ignores ampersands if they are part of existing numbered + character entities, e.g. {. Example:: + + $string = '

Here is a paragraph & an entity ({).

'; + $string = xml_convert($string); + echo $string; + + outputs: - $string = xml_convert($string); + .. code-block:: html + <p>Here is a paragraph & an entity ({).</p> -- cgit v1.2.3-24-g4f1b From 1e617c9b0cab036cff4de14f36ba9a2903462e51 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Fri, 19 Jul 2013 15:34:49 -0700 Subject: Allowing creation of dynamic local ToC for method / function names --- user_guide_src/source/_themes/eldocs/layout.html | 12 +++--- .../_themes/eldocs/static/asset/js/method-toc.js | 44 ++++++++++++++++++++++ 2 files changed, 51 insertions(+), 5 deletions(-) create mode 100644 user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js (limited to 'user_guide_src/source') diff --git a/user_guide_src/source/_themes/eldocs/layout.html b/user_guide_src/source/_themes/eldocs/layout.html index 7f2fe1a34..535c2f194 100644 --- a/user_guide_src/source/_themes/eldocs/layout.html +++ b/user_guide_src/source/_themes/eldocs/layout.html @@ -31,7 +31,7 @@ {%- for cssfile in css_files %} {%- endfor %} - + {%- if not embedded %} {%- endfor %} + + {%- if favicon %} {%- endif %} {%- endif %} - + {%- block linktags %} {%- if hasdoc('about') %} @@ -96,7 +98,7 @@ {%- block rootrellink %}
  • User Guide Home{%- if pagename != 'index' %}  {{ reldelim1 }}{%- endif %}
  • {%- endblock %} - + {%- for parent in parents %}
  • {{ parent.title }}   {{ reldelim1 }}
  • {%- endfor %} @@ -117,8 +119,8 @@ {% if pagename not in exclude_comments -%} {% endif %} - - {%- block footer %} + + {%- block footer %}