RubyGems - rrtf - Versions diffs - 0.1.2 → 1.0.0 - Mend

rrtf 0.1.2 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (137) hide show

checksums.yaml +4 -4
data/.byebug_history +6 -3
data/CHANGELOG.md +24 -0
data/README.md +194 -84
data/documentation/RRTF.html +5 -5
data/documentation/RRTF/AnonymousStyle.html +792 -0
data/documentation/RRTF/BorderFormatting.html +821 -0
data/documentation/RRTF/BorderStyle.html +493 -0
data/documentation/RRTF/CharacterFormatting.html +293 -162
data/documentation/RRTF/CharacterStyle.html +53 -109
data/documentation/RRTF/Colour.html +61 -1
data/documentation/RRTF/ColourTable.html +52 -52
data/documentation/RRTF/CommandNode.html +367 -971
data/documentation/RRTF/ContainerNode.html +44 -44
data/documentation/RRTF/Converters.html +1 -1
data/documentation/RRTF/Converters/HTML.html +1 -1
data/documentation/RRTF/Converters/HTML/Helpers.html +1 -1
data/documentation/RRTF/Converters/HTML/Node.html +1 -1
data/documentation/RRTF/Converters/HTML/NodeSet.html +1 -1
data/documentation/RRTF/Document.html +267 -255
data/documentation/RRTF/DocumentFormatting.html +833 -0
data/documentation/RRTF/DocumentProperties.html +444 -0
data/documentation/RRTF/Font.html +1 -1
data/documentation/RRTF/FontTable.html +1 -1
data/documentation/RRTF/FooterNode.html +16 -16
data/documentation/RRTF/GeometryNode.html +774 -0
data/documentation/RRTF/GeometryProperties.html +1014 -0
data/documentation/RRTF/HeaderNode.html +16 -16
data/documentation/RRTF/ImageNode.html +705 -492
data/documentation/RRTF/Information.html +1 -1
data/documentation/RRTF/LinkNode.html +10 -10
data/documentation/RRTF/ListLevel.html +1 -1
data/documentation/RRTF/ListLevelNode.html +37 -37
data/documentation/RRTF/ListMarker.html +1 -1
data/documentation/RRTF/ListNode.html +19 -19
data/documentation/RRTF/ListTable.html +1 -1
data/documentation/RRTF/ListTemplate.html +1 -1
data/documentation/RRTF/ListTextNode.html +14 -14
data/documentation/RRTF/Node.html +26 -26
data/documentation/RRTF/Page.html +129 -0
data/documentation/RRTF/Page/Margin.html +1158 -0
data/documentation/RRTF/Page/Size.html +946 -0
data/documentation/RRTF/PageFormatting.html +954 -0
data/documentation/RRTF/ParagraphFormatting.html +338 -56
data/documentation/RRTF/ParagraphNode.html +10 -10
data/documentation/RRTF/ParagraphStyle.html +72 -111
data/documentation/RRTF/PositionFormatting.html +780 -0
data/documentation/RRTF/PositionStyle.html +424 -0
data/documentation/RRTF/Properties.html +243 -0
data/documentation/RRTF/RTFError.html +21 -10
data/documentation/RRTF/ShadingFormatting.html +712 -0
data/documentation/RRTF/ShadingStyle.html +424 -0
data/documentation/RRTF/Style.html +284 -697
data/documentation/RRTF/Stylesheet.html +36 -3
data/documentation/RRTF/TableCellNode.html +131 -131
data/documentation/RRTF/TableNode.html +82 -82
data/documentation/RRTF/TableRowNode.html +53 -53
data/documentation/RRTF/TextNode.html +46 -46
data/documentation/RRTF/Utilities.html +837 -17
data/documentation/_index.html +139 -6
data/documentation/class_list.html +1 -1
data/documentation/file.README.html +218 -87
data/documentation/index.html +218 -87
data/documentation/method_list.html +631 -391
data/documentation/top-level-namespace.html +1 -1
data/examples/01.rtf +947 -20
data/examples/01_everything.rb +176 -0
data/examples/02.rtf +13 -0
data/examples/02_basic_paragraph.rb +10 -0
data/examples/03.rtf +20 -0
data/examples/03_paragraph_inline_style.rb +14 -0
data/examples/04.rtf +21 -0
data/examples/04_paragraph_with_character_style.rb +18 -0
data/examples/05.rtf +21 -0
data/examples/05_hyperlinks.rb +21 -0
data/examples/06.rtf +21 -0
data/examples/06_basic_list.rb +21 -0
data/examples/07.rtf +28 -0
data/examples/07_nested_list.rb +27 -0
data/examples/08.rtf +807 -0
data/examples/08_images.rb +17 -0
data/examples/09.rtf +84 -0
data/examples/09_shapes.rb +56 -0
data/examples/10.rtf +34 -0
data/examples/10_stylesheet.rb +18 -0
data/examples/resources/images/redshirt.png +0 -0
data/examples/resources/images/redshirts.jpg +0 -0
data/examples/resources/json/redshirt_styles.json +72 -8
data/examples/~$01.rtf +0 -0
data/lib/rrtf.rb +4 -16
data/lib/rrtf/colour.rb +8 -0
data/lib/rrtf/formatting.rb +988 -0
data/lib/rrtf/node.rb +17 -1851
data/lib/rrtf/node/command_node.rb +242 -0
data/lib/rrtf/node/container_node.rb +75 -0
data/lib/rrtf/node/document.rb +339 -0
data/lib/rrtf/node/footer_node.rb +47 -0
data/lib/rrtf/node/geometry_node.rb +65 -0
data/lib/rrtf/node/header_node.rb +47 -0
data/lib/rrtf/node/image_node.rb +175 -0
data/lib/rrtf/node/link_node.rb +10 -0
data/lib/rrtf/node/list_level_node.rb +44 -0
data/lib/rrtf/node/list_node.rb +30 -0
data/lib/rrtf/node/list_text_node.rb +22 -0
data/lib/rrtf/node/node.rb +53 -0
data/lib/rrtf/node/paragraph_node.rb +11 -0
data/lib/rrtf/node/table_cell_node.rb +233 -0
data/lib/rrtf/node/table_node.rb +136 -0
data/lib/rrtf/node/table_row_node.rb +92 -0
data/lib/rrtf/node/text_node.rb +76 -0
data/lib/rrtf/page.rb +7 -0
data/lib/rrtf/page/margin.rb +98 -0
data/lib/rrtf/page/size.rb +98 -0
data/lib/rrtf/properties.rb +3 -0
data/lib/rrtf/properties/document_properties.rb +34 -0
data/lib/rrtf/properties/geometry_properties.rb +380 -0
data/lib/rrtf/properties/properties.rb +13 -0
data/lib/rrtf/style.rb +4 -5
data/lib/rrtf/style/anonymous_style.rb +73 -0
data/lib/rrtf/style/border_style.rb +27 -0
data/lib/rrtf/style/character_style.rb +1 -7
data/lib/rrtf/style/paragraph_style.rb +0 -6
data/lib/rrtf/style/position_style.rb +26 -0
data/lib/rrtf/style/shading_style.rb +26 -0
data/lib/rrtf/style/style.rb +60 -101
data/lib/rrtf/utilities.rb +138 -0
data/lib/rrtf/version.rb +1 -1
data/rrtf.gemspec +1 -0
metadata +85 -10
data/examples/01_mac_libreoffice5_2_3_3.png +0 -0
data/examples/01_mac_pages6_2.png +0 -0
data/examples/01_mac_textedit1_12.png +0 -0
data/examples/01_mac_word15_36.png +0 -0
data/examples/01_styles_and_paragraphs.rb +0 -32
data/lib/rrtf/paper.rb +0 -53
data/lib/rrtf/style/document_style.rb +0 -116
data/lib/rrtf/style/formatting.rb +0 -320

data/documentation/RRTF/RTFError.html CHANGED

@@ -96,12 +96,23 @@
   <dl>
     <dt>Defined in:</dt>
-    <dd>lib/rrtf.rb</dd>
+    <dd>lib/rrtf/utilities.rb</dd>
   </dl>
 </div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>class Utilities</p>
+  </div>
+</div>
+<div class="tags">
+</div>
@@ -206,12 +217,12 @@
       <pre class="lines">
-13
-14
-15</pre>
+130
+131
+132</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rrtf.rb', line 13</span>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/utilities.rb', line 130</span>
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span> <span class='op'>==</span> <span class='kw'>nil</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>No error message available.</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
@@ -265,12 +276,12 @@
       <pre class="lines">
-17
-18
-19</pre>
+134
+135
+136</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rrtf.rb', line 17</span>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/utilities.rb', line 134</span>
 <span class='kw'>def</span> <span class='const'><span class='object_link'><a href="" title="RRTF::RTFError (class)">RTFError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fire'>fire</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="" title="RRTF::RTFError (class)">RTFError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RRTF::RTFError#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
@@ -285,7 +296,7 @@
 </div>
       <div id="footer">
-  Generated on Mon Jul 24 15:48:59 2017 by
+  Generated on Mon Jul 31 21:48:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.3).
 </div>

data/documentation/RRTF/ShadingFormatting.html ADDED

@@ -0,0 +1,712 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: RRTF::ShadingFormatting
+    &mdash; Documentation by YARD 0.9.9
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "RRTF::ShadingFormatting";
+  relpath = '../';
+</script>
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="../_index.html">Index (S)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span>
+     &raquo;
+    <span class="title">ShadingFormatting</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Module: RRTF::ShadingFormatting
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Included in:</dt>
+    <dd><span class='object_link'><a href="ShadingStyle.html" title="RRTF::ShadingStyle (class)">ShadingStyle</a></span></dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/rrtf/formatting.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Paragraph shading formatting attributes and methods.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Author:</p>
+<ul class="author">
+    <li>
+        <div class='inline'>
+<p>Wesley Hileman</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Since:</p>
+<ul class="since">
+    <li>
+        <div class='inline'>
+<p>1.0.0</p>
+</div>
+    </li>
+</ul>
+</div>
+  <h2>Constant Summary</h2>
+  <dl class="constants">
+      <dt id="SHADING_ATTRIBUTES-constant" class="">SHADING_ATTRIBUTES =
+        <div class="docstring">
+  <div class="discussion">
+<p>Formatting attributes that can be applied to shade the background of
+paragraphs.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Since:</p>
+<ul class="since">
+    <li>
+        <div class='inline'>
+<p>1.0.0</p>
+</div>
+    </li>
+</ul>
+</div>
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+  <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>opacity</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span>
+    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>default</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>100</span><span class='comma'>,</span>
+    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>from_user</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Utilities.html" title="RRTF::Utilities (class)">Utilities</a></span></span><span class='period'>.</span><span class='id identifier rubyid_value2hunpercent'><span class='object_link'><a href="Utilities.html#value2hunpercent-class_method" title="RRTF::Utilities.value2hunpercent (method)">value2hunpercent</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='comma'>,</span>
+    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>to_rtf</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\shading</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='rbrace'>}</span>
+  <span class='rbrace'>}</span><span class='comma'>,</span>
+  <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>foreground_color</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span>
+    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>default</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='kw'>nil</span><span class='comma'>,</span>
+    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>from_user</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Colour.html" title="RRTF::Colour (class)">Colour</a></span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>:</span> <span class='const'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Colour.html" title="RRTF::Colour (class)">Colour</a></span></span><span class='period'>.</span><span class='id identifier rubyid_from_string'><span class='object_link'><a href="Colour.html#from_string-class_method" title="RRTF::Colour.from_string (method)">from_string</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='comma'>,</span>
+    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>to_rtf</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\cfpat</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_document'>document</span><span class='period'>.</span><span class='id identifier rubyid_colours'>colours</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='rbrace'>}</span>
+  <span class='rbrace'>}</span><span class='comma'>,</span>
+  <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>background_color</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span>
+    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>default</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='kw'>nil</span><span class='comma'>,</span>
+    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>from_user</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Colour.html" title="RRTF::Colour (class)">Colour</a></span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>:</span> <span class='const'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Colour.html" title="RRTF::Colour (class)">Colour</a></span></span><span class='period'>.</span><span class='id identifier rubyid_from_string'><span class='object_link'><a href="Colour.html#from_string-class_method" title="RRTF::Colour.from_string (method)">from_string</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='comma'>,</span>
+    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>to_rtf</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\cbpat</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_document'>document</span><span class='period'>.</span><span class='id identifier rubyid_colours'>colours</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='rbrace'>}</span>
+  <span class='rbrace'>}</span>
+<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
+  </dl>
+    <h2>
+      Class Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#included-class_method" title="included (class method)">.<strong>included</strong>(base)  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Generates attribute accessors for all position attributes when the module
+is included in another module or class.</p>
+</div></span>
+</li>
+    </ul>
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize_shading_formatting-instance_method" title="#initialize_shading_formatting (instance method)">#<strong>initialize_shading_formatting</strong>(options = {})  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Initializes position formatting attributes.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#set_shading_formatting_from_hashmap-instance_method" title="#set_shading_formatting_from_hashmap (instance method)">#<strong>set_shading_formatting_from_hashmap</strong>(hash)  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Sets formatting attributes according to the supplied hashmap.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#shading_formatting_to_rtf-instance_method" title="#shading_formatting_to_rtf (instance method)">#<strong>shading_formatting_to_rtf</strong>(document)  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Generates an RTF string representing all applied position formatting.</p>
+</div></span>
+</li>
+    </ul>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="included-class_method">
+    .<strong>included</strong>(base)  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Generates attribute accessors for all position attributes when the module
+is included in another module or class.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Since:</p>
+<ul class="since">
+    <li>
+        <div class='inline'>
+<p>1.0.0</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+709
+710
+711
+712
+713
+714
+715
+716</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 709</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span><span class='rparen'>)</span>
+  <span class='comment'># define accessors in base for position attributes
+</span>  <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_class_eval'>class_eval</span> <span class='kw'>do</span>
+    <span class='const'><span class='object_link'><a href="#SHADING_ATTRIBUTES-constant" title="RRTF::ShadingFormatting::SHADING_ATTRIBUTES (constant)">SHADING_ATTRIBUTES</a></span></span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>|</span>
+      <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+    <span class='kw'>end</span> <span class='comment'># each
+</span>  <span class='kw'>end</span> <span class='comment'># class_eval
+</span><span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="initialize_shading_formatting-instance_method">
+    #<strong>initialize_shading_formatting</strong>(options = {})  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Initializes position formatting attributes.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>options</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>the border formatting options.</p>
+</div>
+    </li>
+</ul>
+    <p class="tag_title">Options Hash (<tt>options</tt>):</p>
+    <ul class="option">
+        <li>
+          <span class="name">"sides"</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+              &mdash; default:
+              <tt>&#39;ALL&#39;</tt>
+          </span>
+            &mdash; <div class='inline'>
+<p>the sides to which the border applied (“ALL”, “LEFT”, “RIGHT”, “TOP”, or
+“BOTTOM”).</p>
+</div>
+        </li>
+    </ul>
+<p class="tag_title">Since:</p>
+<ul class="since">
+    <li>
+        <div class='inline'>
+<p>1.0.0</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+722
+723
+724
+725
+726
+727
+728
+729</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 722</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize_shading_formatting'>initialize_shading_formatting</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='comment'># load default attribute values
+</span>  <span class='const'><span class='object_link'><a href="#SHADING_ATTRIBUTES-constant" title="RRTF::ShadingFormatting::SHADING_ATTRIBUTES (constant)">SHADING_ATTRIBUTES</a></span></span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>|</span>
+    <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>default</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
+  <span class='kw'>end</span> <span class='comment'># each
+</span>  <span class='comment'># overwrite default attribute values with given values
+</span>  <span class='id identifier rubyid_set_shading_formatting_from_hashmap'>set_shading_formatting_from_hashmap</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="set_shading_formatting_from_hashmap-instance_method">
+    #<strong>set_shading_formatting_from_hashmap</strong>(hash)  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Sets formatting attributes according to the supplied hashmap.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#initialize_shading_formatting-instance_method" title="RRTF::ShadingFormatting#initialize_shading_formatting (method)">#initialize_shading_formatting</a></span></li>
+  </ul>
+<p class="tag_title">Since:</p>
+<ul class="since">
+    <li>
+        <div class='inline'>
+<p>1.0.0</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+733
+734
+735
+736
+737
+738
+739
+740
+741
+742
+743
+744
+745
+746</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 733</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_set_shading_formatting_from_hashmap'>set_shading_formatting_from_hashmap</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_attribute'>attribute</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
+    <span class='comment'># skip unreconized attributes
+</span>    <span class='kw'>next</span> <span class='kw'>unless</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#SHADING_ATTRIBUTES-constant" title="RRTF::ShadingFormatting::SHADING_ATTRIBUTES (constant)">SHADING_ATTRIBUTES</a></span></span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rparen'>)</span><span class='rparen'>)</span>
+    <span class='comment'># preprocess value if nessesary
+</span>    <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="#SHADING_ATTRIBUTES-constant" title="RRTF::ShadingFormatting::SHADING_ATTRIBUTES (constant)">SHADING_ATTRIBUTES</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>from_user</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+      <span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#SHADING_ATTRIBUTES-constant" title="RRTF::ShadingFormatting::SHADING_ATTRIBUTES (constant)">SHADING_ATTRIBUTES</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>from_user</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
+    <span class='kw'>elsif</span> <span class='const'><span class='object_link'><a href="#SHADING_ATTRIBUTES-constant" title="RRTF::ShadingFormatting::SHADING_ATTRIBUTES (constant)">SHADING_ATTRIBUTES</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>dictionary</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span>
+      <span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#SHADING_ATTRIBUTES-constant" title="RRTF::ShadingFormatting::SHADING_ATTRIBUTES (constant)">SHADING_ATTRIBUTES</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>dictionary</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_value'>value</span><span class='rbracket'>]</span>
+    <span class='kw'>end</span> <span class='comment'># if
+</span>    <span class='comment'># set attribute value
+</span>    <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_attribute'>attribute</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
+  <span class='kw'>end</span> <span class='comment'># each
+</span><span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="shading_formatting_to_rtf-instance_method">
+    #<strong>shading_formatting_to_rtf</strong>(document)  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+  <div class="note notetag">
+    <strong>Note:</strong>
+    <div class='inline'>
+<p>To generate correct RTF control words for colours and fonts, a document
+object must be provided to this method so that colour and font indicies may
+be found in the document&#39;s colour and font tables, respectively.</p>
+</div>
+  </div>
+<p>Generates an RTF string representing all applied position formatting.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>document</span>
+        <span class='type'>(<tt><span class='object_link'><a href="Document.html" title="RRTF::Document (class)">Document</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the document for which the RTF is to be generated.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Since:</p>
+<ul class="since">
+    <li>
+        <div class='inline'>
+<p>1.0.0</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+754
+755
+756
+757
+758
+759
+760
+761
+762
+763
+764
+765
+766</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 754</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_shading_formatting_to_rtf'>shading_formatting_to_rtf</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_text'>text</span> <span class='op'>=</span> <span class='const'>StringIO</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+  <span class='comment'># accumulate RTF representations of paragraph attributes
+</span>  <span class='const'><span class='object_link'><a href="#SHADING_ATTRIBUTES-constant" title="RRTF::ShadingFormatting::SHADING_ATTRIBUTES (constant)">SHADING_ATTRIBUTES</a></span></span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>|</span>
+    <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>to_rtf</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+      <span class='id identifier rubyid_rtf'>rtf</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>to_rtf</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='rparen'>)</span>
+      <span class='id identifier rubyid_text'>text</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_rtf'>rtf</span> <span class='kw'>unless</span> <span class='id identifier rubyid_rtf'>rtf</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+    <span class='kw'>end</span> <span class='comment'># if
+</span>  <span class='kw'>end</span> <span class='comment'># each
+</span>
+  <span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+      <div id="footer">
+  Generated on Mon Jul 31 21:48:57 2017 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.9 (ruby-2.3.3).
+</div>
+    </div>
+  </body>
+</html>