rrtf 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a0351a0d1b28be98c4798d675b2f7a179ad0ad4
-  data.tar.gz: c6861c1a5b968868ca685009a2774c97116640fd
+  metadata.gz: cc70901e84aadb460e92e00edce17a81a70cd993
+  data.tar.gz: 9cbfde57e949d1479bf77b7f0773d9502a4436e9
 SHA512:
-  metadata.gz: 6d64ee68829290eec6c28107e1cae8f61010e8400c4f972b8de159b6cf1c8aa364fb8b308ebe1f60be69e95430edbf2380b823d638d1e9e4b43181eed09a5fdc
-  data.tar.gz: 1884c08c045e80c581d5899ae990c06d4263b3251efd7a9693fd99a1f787d7fb7ef49b2132bc1ed8515f8b1e983abe87bf8e56f47b4d94b3b2fd69751c685270
+  metadata.gz: 01d07f75d2b50486c3e55174e10dff2954e235ce6c999be4b8a9d6abb1d5904df7c7a6578c9cebc3606d7ad59fd829031e3d5210233d1d172dd56b1a8cf6bb33
+  data.tar.gz: 0a74b57a08c94e549579b21196109718c3e2eac0fb042c760f3820224a21898e249997e4483ce2511cbccdc90527c7484c464c5755282768fc2fd574f3c1ba30

data/.byebug_history

@@ -1,4 +1,7 @@
+exit
+step
+(num2pt(num, units) * 20.0).round
+num2pt(num, units).round
+num2pt(num, units)
+step
 next
-document
-next
-document

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+_Version 0.0.1:_
+
+- Initial RRTF release based on the ifad-rtf gem with stylesheet support added.
+
+_Version 0.0.2:_
+
+- Simplified style syntax and changed all options hash keys to strings.
+- Extract paragraph & character style formatting attributes into modules.
+
+_Version 1.0.0:_
+
+- Migrate DocumentStyle to DocumentProperties since DocumentStyle was not logically a descendent of the Style class (a style can be added to a stylesheet and applied to elements within a document, e.g. paragraphs, characters, tables, but use properties to style an entire document).
+- Extract document and page formatting attributes into modules.
+- Create Page module and Page::Margin and Page::Size classes to assist in parsing page size and margin from strings.
+- Use the FastImage gem to identify image type and dimensions in place of custom byte-level functions.
+- Remove character formatting helpers (bold, italic, font, etc.); use apply() with anonymous styles instead.
+- Remove crop options from ImageNode; Word 2016 improperly parses them and LibreOffice ignores them.
+- Remove x_scaling and y_scaling attributes from ImageNode; the same behavior can be accomplished with display_width & display_height.
+- Add sizing_mode attribute to ImageNode to allow absolute sizing and fixed aspect ratio sizing.
+- Allow anonymous paragraph and character styles.
+- Add AnonymousStyle base class to support other style types (e.g. border styling).
+- Add BorderFormatting module and BorderStyle class to allow border definition on paragraphs and images.
+- Add ShadingFormatting module and ShadingStyle class to allow paragraph shading.
+- Add ShapeNode class to implement basic shapes.

data/README.md

@@ -1,12 +1,17 @@
 # RRTF: Ruby Rich-Text-Format Document Generator
 
-RRTF enables programatic creation of Rich Text Format (RTF) documents in Ruby, focusing on simplifying RTF document assembly and generating clean RTF source code. This gem is founded on the [ifad-rtf gem](https://github.com/clbustos/rtf), but differs in several respects:
+RRTF enables programatic creation of Rich Text Format (RTF) documents in Ruby, focusing on simplifying RTF document assembly and generating clean RTF source code. This gem is founded on the [ifad-rtf gem](https://github.com/clbustos/rtf), but has simpler syntax and supports more RTF constructs.
 
-- The syntax for creating documents and styles is simpler.
-- Paragraph styles can take on character formatting attributes (in accord to the RTF specification).
-- Document stylesheets can be defined, enabling the end user to easily modify the look larger RTF documents.
+- __Document__: Page orientation, size, margin, and gutter; mirror margins, tab width, enable/disable hyphenation, hyphenation width, maximum consecutive hyphenations, and enable/disable widow-and-orphan control.
+- __Text__: Bold, italic, underline, underline color, uppercase, subscript, superscript, strike, emboss, imprint, foreground color, background color, hidden, kerning, character spacing, highlight, font, font size.
+- __Paragraphs__: Justification, left indent, right indent, first line indent, space before, space after, line spacing, indentation, drop caps, keep-on-page, keep-with-next, enable/disable hyphenation, enable/disable widow-and-orphan control, absolute positioning (frames), borders, and shading.
+- __Hyperlinks__: Insert hyperlinks in text runs.
+- __Lists__: Basic unordered (bullet) lists.
+- __Images__: Embed, size, and define borders for PNG, JPEG, and BMP images.
+- __Shapes__: Draw basic shapes, custom shapes, and text boxes.
+- __Stylesheets__: Define paragraph and character styles, enabling the end user to easily modify the look of RTF documents.
 
-The gem was created with reference to the [Microsoft Office RTF Specification (v1.9.1)](https://www.microsoft.com/en-us/download/details.aspx?id=10725).
+The gem was created with reference to the [Microsoft Office RTF Specification (v1.9.1)](https://www.microsoft.com/en-us/download/details.aspx?id=10725). The syntax for custom shapes was determined by reverse engineering the RTF output from Word 2016 and reference to [Microsoft's Binary Format Specification (pp. 32-33)](https://www.loc.gov/preservation/digital/formats/digformatspecs/OfficeDrawing97-2007BinaryFormatSpecification.pdf).
 
 ## Installation
 
@@ -26,97 +31,203 @@ Or install it yourself as:
 
 ## Usage
 
-Define the paragraph and character styles your document is to leverage in
-a hashmap array or JSON file:
-
-```json
-[
-  {
-    "type": "paragraph",
-    "id": "TITLE",
-    "name": "Title",
-    "primary": true,
-    "auto_update": true,
-    "next_style": "BODY",
-    "base_style": "BODY",
-    "justification": "CENTER",
-    "space_after": 100,
-    "bold": true,
-    "underline": "DOUBLE",
-    "underline_color": "#ff0000",
-    "uppercase": true,
-    "font_size": 36
-  },
-  {
-    "type": "paragraph",
-    "id": "H1",
-    "name": "Heading 1",
-    "primary": true,
-    "next_style": "BODY",
-    "space_after": 40,
-    "space_before": 200,
-    "underline": "SINGLE",
-    "underline_color": "#ff0000",
-    "bold": true,
-    "font_size": 24
-  },
-  {
-    "type": "paragraph",
-    "id": "BODY",
-    "name": "Normal",
-    "primary": true,
-    "default": true,
-    "justification": "LEFT",
-    "font_size": 24,
-    "hyphenate": true
-  },
-  {
-    "type": "character",
-    "id": "EMPH",
-    "name": "Emphasis",
-    "additive": true,
-    "italic": true,
-    "bold": true,
-    "foreground_color": "#ff0000",
-    "locked": true
-  }
-]
+```ruby
+require 'rrtf'
+
+# Construct an object representing the RTF document
+rtf = RRTF::Document.new
+
+# ...
+# Call methods on `rtf` to generate content
+# ...
+
+# Convert document into RTF string
+rtf.to_rtf
 ```
 
-(Note that font size is given in _half points_ and spacing in _twentieth points_, or "twips" using the somewhat disagreeable abbreviation, in accord with the RTF specification.)
+#### Paragraphs
+
+- __Plain paragraph__
+
+   ```ruby
+    rtf.paragraph << \
+      "Should you ever find yourself on a spacefaring vessel "\
+      "wearing RED shirt, take heed and be on guard, for danger "\
+      "is immanent and you are likely expendable among the crew."
+    ```
+
+- __Paragraph with inline styling__
+
+    ```ruby
+    rtf.paragraph(
+      "justification" => "RIGHT",
+      "foreground_color" => '#ff0000',
+      "font" => "ROMAN:Times"
+    ) << \
+      "Should you ever find yourself on a spacefaring vessel "\
+      "wearing RED shirt, take heed and be on guard, for danger "\
+      "is immanent and you are likely expendable among the crew."
+    ```
+
+- __Paragraph with inline character styling__
+
+    ```ruby
+    rtf.paragraph do |p|
+      p << "Should you ever find yourself on a spacefaring vessel wearing a "
+      p.apply(
+        "foreground_color" => '#ff0000',
+        "underline_color" => '#ff0000',
+        "italic" => true,
+        "bold" => true,
+        "underline" => "SINGLE"
+      ) << "red"
+      p << " shirt, take heed and be on guard, for danger "
+      p << "is immanent and you are likely expendable among the crew."
+    end
+    ```
+
+#### Hyperlinks
 
-Create a RTF document object using the settings needed for your document, then build your document and save it in an RTF file:
+```ruby
+rtf.paragraph do |p|
+  p << "Should you ever find yourself on a spacefaring vessel wearing a "
+  p.apply(
+    "foreground_color" => '#ff0000',
+    "underline_color" => '#ff0000',
+    "italic" => true,
+    "bold" => true,
+    "underline" => "SINGLE"
+  ) do |emphasis|
+    emphasis.link(
+      "https://en.wikipedia.org/wiki/Redshirt_(character)", "red shirt")
+  end
+  p << ", take heed and be on guard, for danger "
+  p << "is immanent and you are likely expendable among the crew."
+end
+```
+
+#### Lists
 
 ```ruby
-require 'rrtf'
-require 'JSON'
+rtf.list do |l|
+  l.item do |li|
+    li << "Never venture into an ominous setting."
+  end
+
+  l.item do |li|
+    li << "Never attempt to disable an unknown entity. "
+    li << "Get away quickly."
+  end
+
+  l.item do |li|
+    li << "Never stand guard alone. Make certain at least three "
+    li << "other redshirts are present."
+  end
+end
+```
+
+#### Images
+
+```ruby
+rtf.image(DIR+'/resources/images/redshirt.png',
+  "width" => "2in",                     # can also set "height"
+  "sizing_mode" => "FIX_ASPECT_RATIO",  # can also be "ABSOLUTE"
+  "border" => {
+    "sides" => "ALL",
+    "color" => '#ff0000',
+    "line_type" => "DOT",
+    "width" => "5pt",
+    "spacing" => "12pt"
+  }
+)
+```
 
-raw_styles = JSON.parse File.read('styles.json')
+#### Shapes
+
+- __Basic shapes__
+
+    ```ruby
+    rtf.geometry(
+      "type" => "RECTANGLE",
+      "fill_color" => '#cccccc',
+      "top" => 0,
+      "left" => 0,
+      "width" => "2in",
+      "height" => "2in",
+      "horizontal_reference" => "PAGE",
+      "vertical_reference" => "PAGE"
+    )
+    ```
+
+- __Text boxes__
+
+    ```ruby
+    rtf.geometry(
+      "type" => "TEXT_BOX",
+      "line_color" => '#000000',
+      "line_width" => '3pt',
+      "top" => "5in",
+      "left" => "2.5in",
+      "width" => "3in",
+      "height" => "3in",
+      "horizontal_reference" => "PAGE",
+      "vertical_reference" => "PAGE"
+    ) do |box|
+      box.paragraph do |p|
+        p << "Should you ever find yourself on a spacefaring vessel wearing a "
+        p << "RED"
+        p << " shirt, take heed and be on guard, for danger "
+        p << "is immanent and you are likely expendable among the crew."
+      end
+    end
+    ```
+
+- __Custom shapes__
+
+    ```ruby
+    rtf.geometry(
+      "type" => "CUSTOM",
+      "top" => 0,
+      "left" => "4in",
+      "width" => "3in",
+      "height" => "3in",
+      "path" => [
+        # points are relative to the upper left corner of the shape as
+        # determined by "top"/"left"/"bottom"/"right"/"width"/"height"
+        ["START_AT",        [0,0]                                           ],
+        ["LINE_TO",         ['2in', 0]                                      ],
+        ["CUBIC_BEZIER_TO", ['3in', 0], ['3in', '1.5in'], ['3in', '3in']    ],
+        ["LINE_TO",         [0, 0]                                          ],
+        ["CLOSE_PATH"                                                       ],
+        ["END"                                                              ]
+      ],
+      "fill_color" => '#00cc00',
+      "line_color" => '#000099'
+    )
+    ```
+
+#### Stylesheet
 
+```ruby
+raw_styles = JSON.parse File.read(DIR+'/resources/json/redshirt_styles.json')
 rtf = RRTF::Document.new("stylesheet" => raw_styles)
 styles = rtf.stylesheet.styles
 
-rtf.paragraph(styles['TITLE']) << "RedShirts 101"
-rtf.paragraph(styles['BODY']) do |p|
-  p << "Should you ever find yourself on a spacefaring vessel wearing a"
-  p.apply(styles['EMPH']) << " red "
-  p << "shirt, take heed and be on guard, for danger is immanent and you are "
-  p << "likely expendable among the crew..."
-end
-rtf.paragraph(styles['H1']) << "1. The Danger of Away Missions"
-rtf.paragraph(styles['BODY']) do |p|
-  p << "If you're ever assigned an away mission, it's almost certain to be your doom. "
-  p << "The optimal strategy is to avoid away missions to begin with..."
-end
-rtf.paragraph(styles['H1']) << "2. Avoiding High-Ranking Officers"
-rtf.paragraph(styles['BODY']) do |p|
-  p << "You're likely to notice an influx of unfortunate outcomes around "
-  p << "certain high-ranking officers. Its to your advantage to quickly identify and "
-  p << "avoid these officers..."
+rtf.paragraph(styles['TITLE']) << "Redshirt Pocket Guide"
+rtf.paragraph(styles['SUBTITLE']) do |p|
+  p << "3"
+  p.apply("superscript" => true) << "rd"
+  p << " Edition"
 end
 ```
 
-![Opened in Word 2016](examples/01_mac_word15_36.png "Opened in Word 2016")
+## TODO
+
+- Develop rspec examples to replace the unit tests for the classes in the original ifad-rtf gem.
+- Make existing comments yard friendly.
+- Refactor interface between styles and colour/font tables: right now AnonymousStyle defines push_colours and push_fonts methods that are called by CommandNode#paragraph, CommandNode#apply, and ImageNode#initialize (these actions should rather be taken when a style is created or updated).
+- Fix list and nested list formatting issues (alignment).
+- Add support for tables.
 
 ## Development
 
@@ -128,7 +239,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/whileman133/rrtf.
 
-
 ## License
 
 Just like ifad-rtf, this gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/documentation/RRTF.html

@@ -79,7 +79,7 @@
   <dl>
     <dt>Defined in:</dt>
     <dd>lib/rrtf.rb<span class="defines">,<br />
-  lib/rrtf/font.rb,<br /> lib/rrtf/list.rb,<br /> lib/rrtf/node.rb,<br /> lib/rrtf/paper.rb,<br /> lib/rrtf/style.rb,<br /> lib/rrtf/colour.rb,<br /> lib/rrtf/version.rb,<br /> lib/rrtf/stylesheet.rb,<br /> lib/rrtf/information.rb,<br /> lib/rrtf/style/document_style.rb,<br /> lib/rrtf/style/character_style.rb,<br /> lib/rrtf/style/paragraph_style.rb</span>
+  lib/rrtf/font.rb,<br /> lib/rrtf/list.rb,<br /> lib/rrtf/colour.rb,<br /> lib/rrtf/version.rb,<br /> lib/rrtf/node/node.rb,<br /> lib/rrtf/utilities.rb,<br /> lib/rrtf/stylesheet.rb,<br /> lib/rrtf/information.rb,<br /> lib/rrtf/style/style.rb,<br /> lib/rrtf/node/document.rb,<br /> lib/rrtf/node/link_node.rb,<br /> lib/rrtf/node/list_node.rb,<br /> lib/rrtf/node/text_node.rb,<br /> lib/rrtf/node/image_node.rb,<br /> lib/rrtf/node/table_node.rb,<br /> lib/rrtf/node/footer_node.rb,<br /> lib/rrtf/node/header_node.rb,<br /> lib/rrtf/node/command_node.rb,<br /> lib/rrtf/node/geometry_node.rb,<br /> lib/rrtf/style/border_style.rb,<br /> lib/rrtf/node/container_node.rb,<br /> lib/rrtf/node/list_text_node.rb,<br /> lib/rrtf/node/paragraph_node.rb,<br /> lib/rrtf/node/table_row_node.rb,<br /> lib/rrtf/style/shading_style.rb,<br /> lib/rrtf/node/list_level_node.rb,<br /> lib/rrtf/node/table_cell_node.rb,<br /> lib/rrtf/style/position_style.rb,<br /> lib/rrtf/properties/properties.rb,<br /> lib/rrtf/style/anonymous_style.rb,<br /> lib/rrtf/style/character_style.rb,<br /> lib/rrtf/style/paragraph_style.rb,<br /> lib/rrtf/properties/document_properties.rb,<br /> lib/rrtf/properties/geometry_properties.rb</span>
 </dd>
   </dl>
   
@@ -89,11 +89,11 @@
 <p class="children">
   
     
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="RRTF/CharacterFormatting.html" title="RRTF::CharacterFormatting (module)">CharacterFormatting</a></span>, <span class='object_link'><a href="RRTF/Converters.html" title="RRTF::Converters (module)">Converters</a></span>, <span class='object_link'><a href="RRTF/ParagraphFormatting.html" title="RRTF::ParagraphFormatting (module)">ParagraphFormatting</a></span>
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="RRTF/BorderFormatting.html" title="RRTF::BorderFormatting (module)">BorderFormatting</a></span>, <span class='object_link'><a href="RRTF/CharacterFormatting.html" title="RRTF::CharacterFormatting (module)">CharacterFormatting</a></span>, <span class='object_link'><a href="RRTF/Converters.html" title="RRTF::Converters (module)">Converters</a></span>, <span class='object_link'><a href="RRTF/DocumentFormatting.html" title="RRTF::DocumentFormatting (module)">DocumentFormatting</a></span>, <span class='object_link'><a href="RRTF/Page.html" title="RRTF::Page (module)">Page</a></span>, <span class='object_link'><a href="RRTF/PageFormatting.html" title="RRTF::PageFormatting (module)">PageFormatting</a></span>, <span class='object_link'><a href="RRTF/ParagraphFormatting.html" title="RRTF::ParagraphFormatting (module)">ParagraphFormatting</a></span>, <span class='object_link'><a href="RRTF/PositionFormatting.html" title="RRTF::PositionFormatting (module)">PositionFormatting</a></span>, <span class='object_link'><a href="RRTF/ShadingFormatting.html" title="RRTF::ShadingFormatting (module)">ShadingFormatting</a></span>
     
   
     
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="RRTF/CharacterStyle.html" title="RRTF::CharacterStyle (class)">CharacterStyle</a></span>, <span class='object_link'><a href="RRTF/Colour.html" title="RRTF::Colour (class)">Colour</a></span>, <span class='object_link'><a href="RRTF/ColourTable.html" title="RRTF::ColourTable (class)">ColourTable</a></span>, <span class='object_link'><a href="RRTF/CommandNode.html" title="RRTF::CommandNode (class)">CommandNode</a></span>, <span class='object_link'><a href="RRTF/ContainerNode.html" title="RRTF::ContainerNode (class)">ContainerNode</a></span>, <span class='object_link'><a href="RRTF/Document.html" title="RRTF::Document (class)">Document</a></span>, <span class='object_link'><a href="RRTF/DocumentStyle.html" title="RRTF::DocumentStyle (class)">DocumentStyle</a></span>, <span class='object_link'><a href="RRTF/Font.html" title="RRTF::Font (class)">Font</a></span>, <span class='object_link'><a href="RRTF/FontTable.html" title="RRTF::FontTable (class)">FontTable</a></span>, <span class='object_link'><a href="RRTF/FooterNode.html" title="RRTF::FooterNode (class)">FooterNode</a></span>, <span class='object_link'><a href="RRTF/HeaderNode.html" title="RRTF::HeaderNode (class)">HeaderNode</a></span>, <span class='object_link'><a href="RRTF/ImageNode.html" title="RRTF::ImageNode (class)">ImageNode</a></span>, <span class='object_link'><a href="RRTF/Information.html" title="RRTF::Information (class)">Information</a></span>, <span class='object_link'><a href="RRTF/LinkNode.html" title="RRTF::LinkNode (class)">LinkNode</a></span>, <span class='object_link'><a href="RRTF/ListLevel.html" title="RRTF::ListLevel (class)">ListLevel</a></span>, <span class='object_link'><a href="RRTF/ListLevelNode.html" title="RRTF::ListLevelNode (class)">ListLevelNode</a></span>, <span class='object_link'><a href="RRTF/ListMarker.html" title="RRTF::ListMarker (class)">ListMarker</a></span>, <span class='object_link'><a href="RRTF/ListNode.html" title="RRTF::ListNode (class)">ListNode</a></span>, <span class='object_link'><a href="RRTF/ListTable.html" title="RRTF::ListTable (class)">ListTable</a></span>, <span class='object_link'><a href="RRTF/ListTemplate.html" title="RRTF::ListTemplate (class)">ListTemplate</a></span>, <span class='object_link'><a href="RRTF/ListTextNode.html" title="RRTF::ListTextNode (class)">ListTextNode</a></span>, <span class='object_link'><a href="RRTF/Node.html" title="RRTF::Node (class)">Node</a></span>, <span class='object_link'><a href="RRTF/Paper.html" title="RRTF::Paper (class)">Paper</a></span>, <span class='object_link'><a href="RRTF/ParagraphNode.html" title="RRTF::ParagraphNode (class)">ParagraphNode</a></span>, <span class='object_link'><a href="RRTF/ParagraphStyle.html" title="RRTF::ParagraphStyle (class)">ParagraphStyle</a></span>, <span class='object_link'><a href="RRTF/RTFError.html" title="RRTF::RTFError (class)">RTFError</a></span>, <span class='object_link'><a href="RRTF/Style.html" title="RRTF::Style (class)">Style</a></span>, <span class='object_link'><a href="RRTF/Stylesheet.html" title="RRTF::Stylesheet (class)">Stylesheet</a></span>, <span class='object_link'><a href="RRTF/TableCellNode.html" title="RRTF::TableCellNode (class)">TableCellNode</a></span>, <span class='object_link'><a href="RRTF/TableNode.html" title="RRTF::TableNode (class)">TableNode</a></span>, <span class='object_link'><a href="RRTF/TableRowNode.html" title="RRTF::TableRowNode (class)">TableRowNode</a></span>, <span class='object_link'><a href="RRTF/TextNode.html" title="RRTF::TextNode (class)">TextNode</a></span>, <span class='object_link'><a href="RRTF/Utilities.html" title="RRTF::Utilities (class)">Utilities</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="RRTF/AnonymousStyle.html" title="RRTF::AnonymousStyle (class)">AnonymousStyle</a></span>, <span class='object_link'><a href="RRTF/BorderStyle.html" title="RRTF::BorderStyle (class)">BorderStyle</a></span>, <span class='object_link'><a href="RRTF/CharacterStyle.html" title="RRTF::CharacterStyle (class)">CharacterStyle</a></span>, <span class='object_link'><a href="RRTF/Colour.html" title="RRTF::Colour (class)">Colour</a></span>, <span class='object_link'><a href="RRTF/ColourTable.html" title="RRTF::ColourTable (class)">ColourTable</a></span>, <span class='object_link'><a href="RRTF/CommandNode.html" title="RRTF::CommandNode (class)">CommandNode</a></span>, <span class='object_link'><a href="RRTF/ContainerNode.html" title="RRTF::ContainerNode (class)">ContainerNode</a></span>, <span class='object_link'><a href="RRTF/Document.html" title="RRTF::Document (class)">Document</a></span>, <span class='object_link'><a href="RRTF/DocumentProperties.html" title="RRTF::DocumentProperties (class)">DocumentProperties</a></span>, <span class='object_link'><a href="RRTF/Font.html" title="RRTF::Font (class)">Font</a></span>, <span class='object_link'><a href="RRTF/FontTable.html" title="RRTF::FontTable (class)">FontTable</a></span>, <span class='object_link'><a href="RRTF/FooterNode.html" title="RRTF::FooterNode (class)">FooterNode</a></span>, <span class='object_link'><a href="RRTF/GeometryNode.html" title="RRTF::GeometryNode (class)">GeometryNode</a></span>, <span class='object_link'><a href="RRTF/GeometryProperties.html" title="RRTF::GeometryProperties (class)">GeometryProperties</a></span>, <span class='object_link'><a href="RRTF/HeaderNode.html" title="RRTF::HeaderNode (class)">HeaderNode</a></span>, <span class='object_link'><a href="RRTF/ImageNode.html" title="RRTF::ImageNode (class)">ImageNode</a></span>, <span class='object_link'><a href="RRTF/Information.html" title="RRTF::Information (class)">Information</a></span>, <span class='object_link'><a href="RRTF/LinkNode.html" title="RRTF::LinkNode (class)">LinkNode</a></span>, <span class='object_link'><a href="RRTF/ListLevel.html" title="RRTF::ListLevel (class)">ListLevel</a></span>, <span class='object_link'><a href="RRTF/ListLevelNode.html" title="RRTF::ListLevelNode (class)">ListLevelNode</a></span>, <span class='object_link'><a href="RRTF/ListMarker.html" title="RRTF::ListMarker (class)">ListMarker</a></span>, <span class='object_link'><a href="RRTF/ListNode.html" title="RRTF::ListNode (class)">ListNode</a></span>, <span class='object_link'><a href="RRTF/ListTable.html" title="RRTF::ListTable (class)">ListTable</a></span>, <span class='object_link'><a href="RRTF/ListTemplate.html" title="RRTF::ListTemplate (class)">ListTemplate</a></span>, <span class='object_link'><a href="RRTF/ListTextNode.html" title="RRTF::ListTextNode (class)">ListTextNode</a></span>, <span class='object_link'><a href="RRTF/Node.html" title="RRTF::Node (class)">Node</a></span>, <span class='object_link'><a href="RRTF/ParagraphNode.html" title="RRTF::ParagraphNode (class)">ParagraphNode</a></span>, <span class='object_link'><a href="RRTF/ParagraphStyle.html" title="RRTF::ParagraphStyle (class)">ParagraphStyle</a></span>, <span class='object_link'><a href="RRTF/PositionStyle.html" title="RRTF::PositionStyle (class)">PositionStyle</a></span>, <span class='object_link'><a href="RRTF/Properties.html" title="RRTF::Properties (class)">Properties</a></span>, <span class='object_link'><a href="RRTF/RTFError.html" title="RRTF::RTFError (class)">RTFError</a></span>, <span class='object_link'><a href="RRTF/ShadingStyle.html" title="RRTF::ShadingStyle (class)">ShadingStyle</a></span>, <span class='object_link'><a href="RRTF/Style.html" title="RRTF::Style (class)">Style</a></span>, <span class='object_link'><a href="RRTF/Stylesheet.html" title="RRTF::Stylesheet (class)">Stylesheet</a></span>, <span class='object_link'><a href="RRTF/TableCellNode.html" title="RRTF::TableCellNode (class)">TableCellNode</a></span>, <span class='object_link'><a href="RRTF/TableNode.html" title="RRTF::TableNode (class)">TableNode</a></span>, <span class='object_link'><a href="RRTF/TableRowNode.html" title="RRTF::TableRowNode (class)">TableRowNode</a></span>, <span class='object_link'><a href="RRTF/TextNode.html" title="RRTF::TextNode (class)">TextNode</a></span>, <span class='object_link'><a href="RRTF/Utilities.html" title="RRTF::Utilities (class)">Utilities</a></span>
     
   
 </p>
@@ -104,7 +104,7 @@
       <dt id="VERSION-constant" class="">VERSION =
         
       </dt>
-      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.1</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.0.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
     
   </dl>
 
@@ -119,7 +119,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Jul 24 15:48:59 2017 by
+  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>

data/documentation/RRTF/AnonymousStyle.html

@@ -0,0 +1,792 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: RRTF::AnonymousStyle
+  
+    &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::AnonymousStyle";
+  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 (A)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span>
+     &raquo; 
+    <span class="title">AnonymousStyle</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>Class: RRTF::AnonymousStyle
+  <span class="abstract note title">Abstract</span>
+  
+  
+</h1>
+<div class="box_info">
+  
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">RRTF::AnonymousStyle</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+    </dd>
+  </dl>
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/rrtf/style/anonymous_style.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <div class="note abstract">
+  <strong>This class is abstract.</strong>
+  <div class='inline'></div>
+</div>
+
+<p>Represents an arbitrary style that can be applied to an element within an
+RTF document (e.g. paragraph, characters, border, table, etc.)</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><div id="subclasses">
+  <h2>Direct Known Subclasses</h2>
+  <p class="children"><span class='object_link'><a href="BorderStyle.html" title="RRTF::BorderStyle (class)">BorderStyle</a></span>, <span class='object_link'><a href="PositionStyle.html" title="RRTF::PositionStyle (class)">PositionStyle</a></span>, <span class='object_link'><a href="ShadingStyle.html" title="RRTF::ShadingStyle (class)">ShadingStyle</a></span>, <span class='object_link'><a href="Style.html" title="RRTF::Style (class)">Style</a></span></p>
+</div>
+
+
+
+
+
+
+
+  
+    <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-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(options = {})  &#x21d2; AnonymousStyle </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Constructor (empty for now).</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#prefix-instance_method" title="#prefix (instance method)">#<strong>prefix</strong>(document)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  <span class="abstract note title">abstract</span>
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>This method retrieves the command prefix text associated with a Style
+object.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#push_colours-instance_method" title="#push_colours (instance method)">#<strong>push_colours</strong>(colours)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Pushes the colour objects present in formatting attributes onto the
+supplied colour table.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#push_fonts-instance_method" title="#push_fonts (instance method)">#<strong>push_fonts</strong>(fonts)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Pushes the font objects present in formatting attributes onto the supplied
+font table.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#rtf_formatting-instance_method" title="#rtf_formatting (instance method)">#<strong>rtf_formatting</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  <span class="abstract note title">abstract</span>
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Generates a string containing an RTF sequence that describes the formatting
+present in the style.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#suffix-instance_method" title="#suffix (instance method)">#<strong>suffix</strong>(document)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  <span class="abstract note title">abstract</span>
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>This method retrieves the command suffix text associated with a Style
+object.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+  
+    #<strong>initialize</strong>(options = {})  &#x21d2; <tt><span class='object_link'><a href="" title="RRTF::AnonymousStyle (class)">AnonymousStyle</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Constructor (empty for now).</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">
+
+
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/style/anonymous_style.rb', line 10</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</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='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="prefix-instance_method">
+  
+    #<strong>prefix</strong>(document)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <div class="note abstract">
+  <strong>This method is abstract.</strong>
+  <div class='inline'></div>
+</div>
+
+<p>This method retrieves the command prefix text associated with a Style
+object. This method always returns nil and should be overridden by derived
+classes as needed.</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">
+
+
+17
+18
+19</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/style/anonymous_style.rb', line 17</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_prefix'>prefix</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='rparen'>)</span>
+   <span class='kw'>nil</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="push_colours-instance_method">
+  
+    #<strong>push_colours</strong>(colours)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+  <div class="note notetag">
+    <strong>Note:</strong>
+    <div class='inline'>
+<p>All colours used in an RTF document must appear in the document&#39;s
+header as a colour table. This method assists in generating that table.</p>
+</div>
+  </div>
+
+
+<p>Pushes the colour objects present in formatting attributes onto the
+supplied colour table.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>colours</span>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="ColourTable.html" title="RRTF::ColourTable (class)">ColourTable</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the table in which the formatting colours will be stored.</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">
+
+
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/style/anonymous_style.rb', line 43</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_push_colours'>push_colours</span><span class='lparen'>(</span><span class='id identifier rubyid_colours'>colours</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_colours'>colours</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_foreground_color'>foreground_color</span> <span class='kw'>unless</span> <span class='op'>!</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:foreground_color</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_foreground_color'>foreground_color</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='id identifier rubyid_colours'>colours</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_background_color'>background_color</span> <span class='kw'>unless</span> <span class='op'>!</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:background_color</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_background_color'>background_color</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='id identifier rubyid_colours'>colours</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_underline_color'>underline_color</span> <span class='kw'>unless</span> <span class='op'>!</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:underline_color</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_underline_color'>underline_color</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='id identifier rubyid_colours'>colours</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_highlight_color'>highlight_color</span> <span class='kw'>unless</span> <span class='op'>!</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:highlight_color</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_highlight_color'>highlight_color</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='id identifier rubyid_colours'>colours</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_color'>color</span> <span class='kw'>unless</span> <span class='op'>!</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:color</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_color'>color</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+
+  <span class='comment'># border
+</span>  <span class='id identifier rubyid_border'>border</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_b'>b</span><span class='op'>|</span>
+    <span class='id identifier rubyid_colours'>colours</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_b'>b</span><span class='period'>.</span><span class='id identifier rubyid_color'>color</span> <span class='kw'>unless</span> <span class='id identifier rubyid_b'>b</span><span class='period'>.</span><span class='id identifier rubyid_color'>color</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='kw'>end</span> <span class='kw'>unless</span> <span class='op'>!</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:border</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_border'>border</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+
+  <span class='comment'># shading
+</span>  <span class='kw'>unless</span> <span class='op'>!</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:shading</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_shading'>shading</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+    <span class='id identifier rubyid_colours'>colours</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_shading'>shading</span><span class='period'>.</span><span class='id identifier rubyid_background_color'>background_color</span> <span class='kw'>unless</span> <span class='id identifier rubyid_shading'>shading</span><span class='period'>.</span><span class='id identifier rubyid_background_color'>background_color</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+    <span class='id identifier rubyid_colours'>colours</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_shading'>shading</span><span class='period'>.</span><span class='id identifier rubyid_foreground_color'>foreground_color</span> <span class='kw'>unless</span> <span class='id identifier rubyid_shading'>shading</span><span class='period'>.</span><span class='id identifier rubyid_foreground_color'>foreground_color</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="push_fonts-instance_method">
+  
+    #<strong>push_fonts</strong>(fonts)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+  <div class="note notetag">
+    <strong>Note:</strong>
+    <div class='inline'>
+<p>All fonts used in an RTF document must appear in the document&#39;s header
+as a font table. This method assists in generating that table.</p>
+</div>
+  </div>
+
+
+<p>Pushes the font objects present in formatting attributes onto the supplied
+font table.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>fonts</span>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="FontTable.html" title="RRTF::FontTable (class)">FontTable</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the table in which the character formatting fonts will be stored.</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">
+
+
+69
+70
+71</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/style/anonymous_style.rb', line 69</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_push_fonts'>push_fonts</span><span class='lparen'>(</span><span class='id identifier rubyid_fonts'>fonts</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_fonts'>fonts</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_font'>font</span> <span class='kw'>unless</span> <span class='id identifier rubyid_font'>font</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="rtf_formatting-instance_method">
+  
+    #<strong>rtf_formatting</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <div class="note abstract">
+  <strong>This method is abstract.</strong>
+  <div class='inline'></div>
+</div>
+
+<p>Generates a string containing an RTF sequence that describes the formatting
+present in the style. Override in derived classes.</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">
+
+
+32
+33
+34</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/style/anonymous_style.rb', line 32</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_rtf_formatting'>rtf_formatting</span>
+  <span class='kw'>nil</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="suffix-instance_method">
+  
+    #<strong>suffix</strong>(document)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <div class="note abstract">
+  <strong>This method is abstract.</strong>
+  <div class='inline'></div>
+</div>
+
+<p>This method retrieves the command suffix text associated with a Style
+object. This method always returns nil and should be overridden by derived
+classes as needed.</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">
+
+
+25
+26
+27</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/style/anonymous_style.rb', line 25</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_suffix'>suffix</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='rparen'>)</span>
+   <span class='kw'>nil</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+      <div id="footer">
+  Generated on Mon Jul 31 21:49:01 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>