rrtf 1.2.0 → 1.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +19 -0
- data/documentation/RRTF.html +5 -5
- data/documentation/RRTF/AnonymousStyle.html +2 -2
- data/documentation/RRTF/BorderFormatting.html +48 -48
- data/documentation/RRTF/BorderStyle.html +1 -1
- data/documentation/RRTF/CharacterFormatting.html +1 -1
- data/documentation/RRTF/CharacterStyle.html +1 -1
- data/documentation/RRTF/Colour.html +1 -1
- data/documentation/RRTF/ColourTable.html +1 -1
- data/documentation/RRTF/CommandNode.html +333 -93
- data/documentation/RRTF/ContainerNode.html +1 -1
- 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 +2 -2
- data/documentation/RRTF/DocumentFormatting.html +48 -48
- data/documentation/RRTF/DocumentProperties.html +8 -3
- data/documentation/RRTF/Font.html +1 -1
- data/documentation/RRTF/FontTable.html +1 -1
- data/documentation/RRTF/FooterNode.html +2 -2
- data/documentation/RRTF/GeometryNode.html +2 -2
- data/documentation/RRTF/GeometryProperties.html +9 -9
- data/documentation/RRTF/HeaderNode.html +2 -2
- data/documentation/RRTF/ImageNode.html +64 -61
- data/documentation/RRTF/Information.html +1 -1
- data/documentation/RRTF/LinkNode.html +2 -2
- data/documentation/RRTF/ListLevel.html +1 -1
- data/documentation/RRTF/ListLevelNode.html +2 -2
- data/documentation/RRTF/ListMarker.html +1 -1
- data/documentation/RRTF/ListNode.html +2 -2
- data/documentation/RRTF/ListTable.html +1 -1
- data/documentation/RRTF/ListTemplate.html +1 -1
- data/documentation/RRTF/ListTextNode.html +2 -2
- data/documentation/RRTF/Node.html +1 -1
- data/documentation/RRTF/Page.html +1 -1
- data/documentation/RRTF/Page/Margin.html +1 -1
- data/documentation/RRTF/Page/Size.html +1 -1
- data/documentation/RRTF/PageFormatting.html +184 -195
- data/documentation/RRTF/ParagraphFormatting.html +75 -48
- data/documentation/RRTF/ParagraphNode.html +2 -2
- data/documentation/RRTF/ParagraphStyle.html +1 -1
- data/documentation/RRTF/PositionFormatting.html +48 -48
- data/documentation/RRTF/PositionStyle.html +1 -1
- data/documentation/RRTF/Properties.html +1 -1
- data/documentation/RRTF/RTFError.html +1 -1
- data/documentation/RRTF/SectionFormatting.html +750 -0
- data/documentation/RRTF/SectionNode.html +383 -0
- data/documentation/RRTF/SectionStyle.html +830 -0
- data/documentation/RRTF/ShadingFormatting.html +48 -48
- data/documentation/RRTF/ShadingStyle.html +1 -1
- data/documentation/RRTF/Style.html +2 -2
- data/documentation/RRTF/Stylesheet.html +1 -1
- data/documentation/RRTF/TabStyle.html +698 -0
- data/documentation/RRTF/TableCellNode.html +2 -2
- data/documentation/RRTF/TableNode.html +1 -1
- data/documentation/RRTF/TableRowNode.html +1 -1
- data/documentation/RRTF/TextNode.html +1 -1
- data/documentation/RRTF/Utilities.html +1 -1
- data/documentation/_index.html +33 -5
- data/documentation/class_list.html +1 -1
- data/documentation/file.README.html +32 -1
- data/documentation/index.html +32 -1
- data/documentation/method_list.html +499 -355
- data/documentation/top-level-namespace.html +1 -1
- data/examples/11.rtf +9 -8
- data/examples/12.rtf +19 -0
- data/examples/12_tabs.rb +21 -0
- data/lib/rrtf/formatting.rb +27 -0
- data/lib/rrtf/node/command_node.rb +8 -0
- data/lib/rrtf/style.rb +1 -0
- data/lib/rrtf/style/tab_style.rb +55 -0
- data/lib/rrtf/version.rb +1 -1
- metadata +8 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 818039d9ed50f8f6697ffbee314aed93b4fa967d
|
4
|
+
data.tar.gz: 5711cb030eb2119041076ddfa87f0289ec1af5fe
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: dab386dea4bbd4361f5b23eec771dffabe44ae1c4f91ddc7968b23ce2c3afb53bc3c3c3e0b49e5787f37ee872602d4ef8e4b19c6c0dcb8994917bcd9f7eda7ec
|
7
|
+
data.tar.gz: 59a319ea689c5367a1e65f3b9726004e89460d6ddb410423000a5f540eb1136532eb286ff6837a31aa827a19fd2c58c1962d0597595c1fc29e5cf4fcb72e56c5
|
data/CHANGELOG.md
CHANGED
@@ -31,3 +31,11 @@ _Version 1.0.1:_
|
|
31
31
|
_Version 1.1.0:_
|
32
32
|
|
33
33
|
- Add support for sections.
|
34
|
+
|
35
|
+
_Version 1.2.0:_
|
36
|
+
|
37
|
+
- Add support for column breaks.
|
38
|
+
|
39
|
+
_Version 1.3.0:_
|
40
|
+
|
41
|
+
- Add support for tab stops (`tab` method in `CommandNode` class, "tabs" option for paragraph formatting, and `TabStyle` class).
|
data/README.md
CHANGED
@@ -11,6 +11,7 @@ RRTF enables programatic creation of Rich Text Format (RTF) documents in Ruby, f
|
|
11
11
|
- __Shapes__: Draw basic shapes, custom shapes, and text boxes.
|
12
12
|
- __Stylesheets__: Define paragraph and character styles, enabling the end user to easily modify the look of RTF documents.
|
13
13
|
- __Sections__: Add sections to a document with custom page and column formatting.
|
14
|
+
- __Tabs__: Define tab stops with optional leaders for paragraphs.
|
14
15
|
|
15
16
|
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).
|
16
17
|
|
@@ -231,6 +232,24 @@ rtf.section("columns" => 2)
|
|
231
232
|
rtf.paragraph << "Section Text"
|
232
233
|
```
|
233
234
|
|
235
|
+
#### Tabs
|
236
|
+
|
237
|
+
```ruby
|
238
|
+
rtf.paragraph("tabs" => {
|
239
|
+
"leader" => "DOT",
|
240
|
+
"type" => "FLUSH_RIGHT",
|
241
|
+
"position" => "2in"
|
242
|
+
}) do |p|
|
243
|
+
p << "Engineers"
|
244
|
+
p.tab
|
245
|
+
p << "10"
|
246
|
+
p.line_break
|
247
|
+
p << "Redshirts"
|
248
|
+
p.tab
|
249
|
+
p << "100"
|
250
|
+
end
|
251
|
+
```
|
252
|
+
|
234
253
|
## TODO
|
235
254
|
|
236
255
|
- Develop rspec examples to replace the unit tests for the classes in the original ifad-rtf gem.
|
data/documentation/RRTF.html
CHANGED
@@ -79,7 +79,7 @@
|
|
79
79
|
<dl>
|
80
80
|
<dt>Defined in:</dt>
|
81
81
|
<dd>lib/rrtf.rb<span class="defines">,<br />
|
82
|
-
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>
|
82
|
+
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/style/tab_style.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/section_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/section_style.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>
|
83
83
|
</dd>
|
84
84
|
</dl>
|
85
85
|
|
@@ -89,11 +89,11 @@
|
|
89
89
|
<p class="children">
|
90
90
|
|
91
91
|
|
92
|
-
<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>
|
92
|
+
<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/SectionFormatting.html" title="RRTF::SectionFormatting (module)">SectionFormatting</a></span>, <span class='object_link'><a href="RRTF/ShadingFormatting.html" title="RRTF::ShadingFormatting (module)">ShadingFormatting</a></span>
|
93
93
|
|
94
94
|
|
95
95
|
|
96
|
-
<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>
|
96
|
+
<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/SectionNode.html" title="RRTF::SectionNode (class)">SectionNode</a></span>, <span class='object_link'><a href="RRTF/SectionStyle.html" title="RRTF::SectionStyle (class)">SectionStyle</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/TabStyle.html" title="RRTF::TabStyle (class)">TabStyle</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>
|
97
97
|
|
98
98
|
|
99
99
|
</p>
|
@@ -104,7 +104,7 @@
|
|
104
104
|
<dt id="VERSION-constant" class="">VERSION =
|
105
105
|
|
106
106
|
</dt>
|
107
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1.
|
107
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1.2.0</span><span class='tstring_end'>"</span></span></pre></dd>
|
108
108
|
|
109
109
|
</dl>
|
110
110
|
|
@@ -119,7 +119,7 @@
|
|
119
119
|
</div>
|
120
120
|
|
121
121
|
<div id="footer">
|
122
|
-
Generated on
|
122
|
+
Generated on Wed Aug 2 23:05:14 2017 by
|
123
123
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
124
124
|
0.9.9 (ruby-2.3.3).
|
125
125
|
</div>
|
@@ -149,7 +149,7 @@ RTF document (e.g. paragraph, characters, border, table, etc.)</p>
|
|
149
149
|
|
150
150
|
</div><div id="subclasses">
|
151
151
|
<h2>Direct Known Subclasses</h2>
|
152
|
-
<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>
|
152
|
+
<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>, <span class='object_link'><a href="TabStyle.html" title="RRTF::TabStyle (class)">TabStyle</a></span></p>
|
153
153
|
</div>
|
154
154
|
|
155
155
|
|
@@ -782,7 +782,7 @@ classes as needed.</p>
|
|
782
782
|
</div>
|
783
783
|
|
784
784
|
<div id="footer">
|
785
|
-
Generated on
|
785
|
+
Generated on Wed Aug 2 23:05:19 2017 by
|
786
786
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
787
787
|
0.9.9 (ruby-2.3.3).
|
788
788
|
</div>
|
@@ -399,17 +399,17 @@ is included in another module or class.</p>
|
|
399
399
|
<pre class="lines">
|
400
400
|
|
401
401
|
|
402
|
-
|
403
|
-
|
404
|
-
|
405
|
-
|
406
|
-
|
407
|
-
|
408
|
-
|
409
|
-
|
402
|
+
492
|
403
|
+
493
|
404
|
+
494
|
405
|
+
495
|
406
|
+
496
|
407
|
+
497
|
408
|
+
498
|
409
|
+
499</pre>
|
410
410
|
</td>
|
411
411
|
<td>
|
412
|
-
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line
|
412
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 492</span>
|
413
413
|
|
414
414
|
<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>
|
415
415
|
<span class='comment'># define accessors in base for paragraph attributes
|
@@ -502,22 +502,22 @@ be found in the document's colour and font tables, respectively.</p>
|
|
502
502
|
<pre class="lines">
|
503
503
|
|
504
504
|
|
505
|
-
|
506
|
-
|
507
|
-
|
508
|
-
|
509
|
-
|
510
|
-
|
511
|
-
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
|
505
|
+
541
|
506
|
+
542
|
507
|
+
543
|
508
|
+
544
|
509
|
+
545
|
510
|
+
546
|
511
|
+
547
|
512
|
+
548
|
513
|
+
549
|
514
|
+
550
|
515
|
+
551
|
516
|
+
552
|
517
|
+
553</pre>
|
518
518
|
</td>
|
519
519
|
<td>
|
520
|
-
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line
|
520
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 541</span>
|
521
521
|
|
522
522
|
<span class='kw'>def</span> <span class='id identifier rubyid_border_formatting_to_rtf'>border_formatting_to_rtf</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='rparen'>)</span>
|
523
523
|
<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>
|
@@ -695,17 +695,17 @@ string, see <span class='object_link'><a href="Utilities.html#value2twips-class_
|
|
695
695
|
<pre class="lines">
|
696
696
|
|
697
697
|
|
698
|
-
|
699
|
-
|
700
|
-
|
701
|
-
|
702
|
-
|
703
|
-
|
704
|
-
|
705
|
-
|
698
|
+
509
|
699
|
+
510
|
700
|
+
511
|
701
|
+
512
|
702
|
+
513
|
703
|
+
514
|
704
|
+
515
|
705
|
+
516</pre>
|
706
706
|
</td>
|
707
707
|
<td>
|
708
|
-
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line
|
708
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 509</span>
|
709
709
|
|
710
710
|
<span class='kw'>def</span> <span class='id identifier rubyid_initialize_border_formatting'>initialize_border_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>
|
711
711
|
<span class='comment'># load default attribute values
|
@@ -769,23 +769,23 @@ string, see <span class='object_link'><a href="Utilities.html#value2twips-class_
|
|
769
769
|
<pre class="lines">
|
770
770
|
|
771
771
|
|
772
|
-
|
773
|
-
|
774
|
-
|
775
|
-
|
776
|
-
|
777
|
-
|
778
|
-
|
779
|
-
|
780
|
-
|
781
|
-
|
782
|
-
|
783
|
-
|
784
|
-
|
785
|
-
|
772
|
+
520
|
773
|
+
521
|
774
|
+
522
|
775
|
+
523
|
776
|
+
524
|
777
|
+
525
|
778
|
+
526
|
779
|
+
527
|
780
|
+
528
|
781
|
+
529
|
782
|
+
530
|
783
|
+
531
|
784
|
+
532
|
785
|
+
533</pre>
|
786
786
|
</td>
|
787
787
|
<td>
|
788
|
-
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line
|
788
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 520</span>
|
789
789
|
|
790
790
|
<span class='kw'>def</span> <span class='id identifier rubyid_set_border_formatting_from_hashmap'>set_border_formatting_from_hashmap</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
|
791
791
|
<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>
|
@@ -811,7 +811,7 @@ string, see <span class='object_link'><a href="Utilities.html#value2twips-class_
|
|
811
811
|
</div>
|
812
812
|
|
813
813
|
<div id="footer">
|
814
|
-
Generated on
|
814
|
+
Generated on Wed Aug 2 23:05:15 2017 by
|
815
815
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
816
816
|
0.9.9 (ruby-2.3.3).
|
817
817
|
</div>
|
@@ -483,7 +483,7 @@ style object. Equivalent to <span class='object_link'><a href="#rtf_formatting-i
|
|
483
483
|
</div>
|
484
484
|
|
485
485
|
<div id="footer">
|
486
|
-
Generated on
|
486
|
+
Generated on Wed Aug 2 23:05:18 2017 by
|
487
487
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
488
488
|
0.9.9 (ruby-2.3.3).
|
489
489
|
</div>
|
@@ -1123,7 +1123,7 @@ format.</p>
|
|
1123
1123
|
</div>
|
1124
1124
|
|
1125
1125
|
<div id="footer">
|
1126
|
-
Generated on
|
1126
|
+
Generated on Wed Aug 2 23:05:14 2017 by
|
1127
1127
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1128
1128
|
0.9.9 (ruby-2.3.3).
|
1129
1129
|
</div>
|
@@ -992,7 +992,7 @@ stylesheet)</p>
|
|
992
992
|
</div>
|
993
993
|
|
994
994
|
<div id="footer">
|
995
|
-
Generated on
|
995
|
+
Generated on Wed Aug 2 23:05:19 2017 by
|
996
996
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
997
997
|
0.9.9 (ruby-2.3.3).
|
998
998
|
</div>
|
@@ -863,7 +863,7 @@ to zero.</p>
|
|
863
863
|
</div>
|
864
864
|
|
865
865
|
<div id="footer">
|
866
|
-
Generated on
|
866
|
+
Generated on Wed Aug 2 23:05:15 2017 by
|
867
867
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
868
868
|
0.9.9 (ruby-2.3.3).
|
869
869
|
</div>
|
@@ -760,7 +760,7 @@ Defaults to zero.</p>
|
|
760
760
|
</div>
|
761
761
|
|
762
762
|
<div id="footer">
|
763
|
-
Generated on
|
763
|
+
Generated on Wed Aug 2 23:05:15 2017 by
|
764
764
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
765
765
|
0.9.9 (ruby-2.3.3).
|
766
766
|
</div>
|
@@ -118,7 +118,7 @@ class for some specific command node types.</p>
|
|
118
118
|
|
119
119
|
</div><div id="subclasses">
|
120
120
|
<h2>Direct Known Subclasses</h2>
|
121
|
-
<p class="children"><span class='object_link'><a href="Document.html" title="RRTF::Document (class)">Document</a></span>, <span class='object_link'><a href="FooterNode.html" title="RRTF::FooterNode (class)">FooterNode</a></span>, <span class='object_link'><a href="GeometryNode.html" title="RRTF::GeometryNode (class)">GeometryNode</a></span>, <span class='object_link'><a href="HeaderNode.html" title="RRTF::HeaderNode (class)">HeaderNode</a></span>, <span class='object_link'><a href="LinkNode.html" title="RRTF::LinkNode (class)">LinkNode</a></span>, <span class='object_link'><a href="ListLevelNode.html" title="RRTF::ListLevelNode (class)">ListLevelNode</a></span>, <span class='object_link'><a href="ListNode.html" title="RRTF::ListNode (class)">ListNode</a></span>, <span class='object_link'><a href="ListTextNode.html" title="RRTF::ListTextNode (class)">ListTextNode</a></span>, <span class='object_link'><a href="ParagraphNode.html" title="RRTF::ParagraphNode (class)">ParagraphNode</a></span>, <span class='object_link'><a href="TableCellNode.html" title="RRTF::TableCellNode (class)">TableCellNode</a></span></p>
|
121
|
+
<p class="children"><span class='object_link'><a href="Document.html" title="RRTF::Document (class)">Document</a></span>, <span class='object_link'><a href="FooterNode.html" title="RRTF::FooterNode (class)">FooterNode</a></span>, <span class='object_link'><a href="GeometryNode.html" title="RRTF::GeometryNode (class)">GeometryNode</a></span>, <span class='object_link'><a href="HeaderNode.html" title="RRTF::HeaderNode (class)">HeaderNode</a></span>, <span class='object_link'><a href="LinkNode.html" title="RRTF::LinkNode (class)">LinkNode</a></span>, <span class='object_link'><a href="ListLevelNode.html" title="RRTF::ListLevelNode (class)">ListLevelNode</a></span>, <span class='object_link'><a href="ListNode.html" title="RRTF::ListNode (class)">ListNode</a></span>, <span class='object_link'><a href="ListTextNode.html" title="RRTF::ListTextNode (class)">ListTextNode</a></span>, <span class='object_link'><a href="ParagraphNode.html" title="RRTF::ParagraphNode (class)">ParagraphNode</a></span>, <span class='object_link'><a href="SectionNode.html" title="RRTF::SectionNode (class)">SectionNode</a></span>, <span class='object_link'><a href="TableCellNode.html" title="RRTF::TableCellNode (class)">TableCellNode</a></span></p>
|
122
122
|
</div>
|
123
123
|
|
124
124
|
|
@@ -312,6 +312,31 @@ curly braces.</p>
|
|
312
312
|
single command node.</p>
|
313
313
|
</div></span>
|
314
314
|
|
315
|
+
</li>
|
316
|
+
|
317
|
+
|
318
|
+
<li class="public ">
|
319
|
+
<span class="summary_signature">
|
320
|
+
|
321
|
+
<a href="#column_break-instance_method" title="#column_break (instance method)">#<strong>column_break</strong> ⇒ Object </a>
|
322
|
+
|
323
|
+
|
324
|
+
|
325
|
+
</span>
|
326
|
+
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
|
331
|
+
|
332
|
+
|
333
|
+
|
334
|
+
|
335
|
+
<span class="summary_desc"><div class='inline'>
|
336
|
+
<p>This method provides a short cut means of creating a column break command
|
337
|
+
node.</p>
|
338
|
+
</div></span>
|
339
|
+
|
315
340
|
</li>
|
316
341
|
|
317
342
|
|
@@ -505,6 +530,52 @@ unordered list.</p>
|
|
505
530
|
node.</p>
|
506
531
|
</div></span>
|
507
532
|
|
533
|
+
</li>
|
534
|
+
|
535
|
+
|
536
|
+
<li class="public ">
|
537
|
+
<span class="summary_signature">
|
538
|
+
|
539
|
+
<a href="#section-instance_method" title="#section (instance method)">#<strong>section</strong>(style = nil) {|node| ... } ⇒ Object </a>
|
540
|
+
|
541
|
+
|
542
|
+
|
543
|
+
</span>
|
544
|
+
|
545
|
+
|
546
|
+
|
547
|
+
|
548
|
+
|
549
|
+
|
550
|
+
|
551
|
+
|
552
|
+
|
553
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
554
|
+
|
555
|
+
</li>
|
556
|
+
|
557
|
+
|
558
|
+
<li class="public ">
|
559
|
+
<span class="summary_signature">
|
560
|
+
|
561
|
+
<a href="#tab-instance_method" title="#tab (instance method)">#<strong>tab</strong> ⇒ Object </a>
|
562
|
+
|
563
|
+
|
564
|
+
|
565
|
+
</span>
|
566
|
+
|
567
|
+
|
568
|
+
|
569
|
+
|
570
|
+
|
571
|
+
|
572
|
+
|
573
|
+
|
574
|
+
|
575
|
+
<span class="summary_desc"><div class='inline'>
|
576
|
+
<p>This method provides a short cut means of creating a tab command node.</p>
|
577
|
+
</div></span>
|
578
|
+
|
508
579
|
</li>
|
509
580
|
|
510
581
|
|
@@ -1008,29 +1079,29 @@ style).</p>
|
|
1008
1079
|
<pre class="lines">
|
1009
1080
|
|
1010
1081
|
|
1011
|
-
|
1012
|
-
|
1013
|
-
|
1014
|
-
|
1015
|
-
|
1016
|
-
|
1017
|
-
|
1018
|
-
|
1019
|
-
|
1020
|
-
|
1021
|
-
|
1022
|
-
|
1023
|
-
|
1024
|
-
|
1025
|
-
|
1026
|
-
|
1027
|
-
|
1028
|
-
|
1029
|
-
|
1030
|
-
|
1082
|
+
251
|
1083
|
+
252
|
1084
|
+
253
|
1085
|
+
254
|
1086
|
+
255
|
1087
|
+
256
|
1088
|
+
257
|
1089
|
+
258
|
1090
|
+
259
|
1091
|
+
260
|
1092
|
+
261
|
1093
|
+
262
|
1094
|
+
263
|
1095
|
+
264
|
1096
|
+
265
|
1097
|
+
266
|
1098
|
+
267
|
1099
|
+
268
|
1100
|
+
269
|
1101
|
+
270</pre>
|
1031
1102
|
</td>
|
1032
1103
|
<td>
|
1033
|
-
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line
|
1104
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line 251</span>
|
1034
1105
|
|
1035
1106
|
<span class='kw'>def</span> <span class='id identifier rubyid_apply'>apply</span><span class='lparen'>(</span><span class='id identifier rubyid_style'>style</span><span class='rparen'>)</span>
|
1036
1107
|
<span class='comment'># Check the input style.
|
@@ -1055,6 +1126,51 @@ style).</p>
|
|
1055
1126
|
</td>
|
1056
1127
|
</tr>
|
1057
1128
|
</table>
|
1129
|
+
</div>
|
1130
|
+
|
1131
|
+
<div class="method_details ">
|
1132
|
+
<h3 class="signature " id="column_break-instance_method">
|
1133
|
+
|
1134
|
+
#<strong>column_break</strong> ⇒ <tt>Object</tt>
|
1135
|
+
|
1136
|
+
|
1137
|
+
|
1138
|
+
|
1139
|
+
|
1140
|
+
</h3><div class="docstring">
|
1141
|
+
<div class="discussion">
|
1142
|
+
|
1143
|
+
<p>This method provides a short cut means of creating a column break command
|
1144
|
+
node. This command node does not take a block and may possess no other
|
1145
|
+
content.</p>
|
1146
|
+
|
1147
|
+
|
1148
|
+
</div>
|
1149
|
+
</div>
|
1150
|
+
<div class="tags">
|
1151
|
+
|
1152
|
+
|
1153
|
+
</div><table class="source_code">
|
1154
|
+
<tr>
|
1155
|
+
<td>
|
1156
|
+
<pre class="lines">
|
1157
|
+
|
1158
|
+
|
1159
|
+
170
|
1160
|
+
171
|
1161
|
+
172
|
1162
|
+
173</pre>
|
1163
|
+
</td>
|
1164
|
+
<td>
|
1165
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line 170</span>
|
1166
|
+
|
1167
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_column_break'>column_break</span>
|
1168
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_store'>store</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="" title="RRTF::CommandNode (class)">CommandNode</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RRTF::CommandNode#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>\column</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
1169
|
+
<span class='kw'>nil</span>
|
1170
|
+
<span class='kw'>end</span></pre>
|
1171
|
+
</td>
|
1172
|
+
</tr>
|
1173
|
+
</table>
|
1058
1174
|
</div>
|
1059
1175
|
|
1060
1176
|
<div class="method_details ">
|
@@ -1089,18 +1205,18 @@ style).</p>
|
|
1089
1205
|
<pre class="lines">
|
1090
1206
|
|
1091
1207
|
|
1092
|
-
|
1093
|
-
|
1094
|
-
|
1095
|
-
|
1096
|
-
|
1097
|
-
|
1098
|
-
|
1099
|
-
|
1100
|
-
|
1208
|
+
187
|
1209
|
+
188
|
1210
|
+
189
|
1211
|
+
190
|
1212
|
+
191
|
1213
|
+
192
|
1214
|
+
193
|
1215
|
+
194
|
1216
|
+
195</pre>
|
1101
1217
|
</td>
|
1102
1218
|
<td>
|
1103
|
-
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line
|
1219
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line 187</span>
|
1104
1220
|
|
1105
1221
|
<span class='kw'>def</span> <span class='id identifier rubyid_footnote'>footnote</span><span class='lparen'>(</span><span class='id identifier rubyid_text'>text</span><span class='rparen'>)</span>
|
1106
1222
|
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>and</span> <span class='id identifier rubyid_text'>text</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span>
|
@@ -1153,15 +1269,15 @@ style).</p>
|
|
1153
1269
|
<pre class="lines">
|
1154
1270
|
|
1155
1271
|
|
1156
|
-
|
1157
|
-
|
1158
|
-
|
1159
|
-
|
1160
|
-
|
1161
|
-
|
1272
|
+
226
|
1273
|
+
227
|
1274
|
+
228
|
1275
|
+
229
|
1276
|
+
230
|
1277
|
+
231</pre>
|
1162
1278
|
</td>
|
1163
1279
|
<td>
|
1164
|
-
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line
|
1280
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line 226</span>
|
1165
1281
|
|
1166
1282
|
<span class='kw'>def</span> <span class='id identifier rubyid_geometry'>geometry</span><span class='lparen'>(</span><span class='id identifier rubyid_properties'>properties</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1167
1283
|
<span class='id identifier rubyid_node'>node</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="GeometryNode.html" title="RRTF::GeometryNode (class)">GeometryNode</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="GeometryNode.html#initialize-instance_method" title="RRTF::GeometryNode#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_properties'>properties</span><span class='rparen'>)</span>
|
@@ -1265,12 +1381,12 @@ type is not supported.</p>
|
|
1265
1381
|
<pre class="lines">
|
1266
1382
|
|
1267
1383
|
|
1268
|
-
|
1269
|
-
|
1270
|
-
|
1384
|
+
206
|
1385
|
+
207
|
1386
|
+
208</pre>
|
1271
1387
|
</td>
|
1272
1388
|
<td>
|
1273
|
-
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line
|
1389
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line 206</span>
|
1274
1390
|
|
1275
1391
|
<span class='kw'>def</span> <span class='id identifier rubyid_image'>image</span><span class='lparen'>(</span><span class='id identifier rubyid_source'>source</span><span class='comma'>,</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>
|
1276
1392
|
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_store'>store</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="ImageNode.html" title="RRTF::ImageNode (class)">ImageNode</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ImageNode.html#initialize-instance_method" title="RRTF::ImageNode#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_source'>source</span><span class='comma'>,</span> <span class='id identifier rubyid_root'><span class='object_link'><a href="../top-level-namespace.html" title="Top Level Namespace (root)">root</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get_id'>get_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
@@ -1308,13 +1424,13 @@ content.</p>
|
|
1308
1424
|
<pre class="lines">
|
1309
1425
|
|
1310
1426
|
|
1311
|
-
|
1312
|
-
|
1313
|
-
|
1314
|
-
|
1427
|
+
162
|
1428
|
+
163
|
1429
|
+
164
|
1430
|
+
165</pre>
|
1315
1431
|
</td>
|
1316
1432
|
<td>
|
1317
|
-
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line
|
1433
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line 162</span>
|
1318
1434
|
|
1319
1435
|
<span class='kw'>def</span> <span class='id identifier rubyid_line_break'>line_break</span>
|
1320
1436
|
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_store'>store</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="" title="RRTF::CommandNode (class)">CommandNode</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RRTF::CommandNode#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>\line</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
@@ -1362,15 +1478,15 @@ content.</p>
|
|
1362
1478
|
<pre class="lines">
|
1363
1479
|
|
1364
1480
|
|
1365
|
-
|
1366
|
-
|
1367
|
-
|
1368
|
-
|
1369
|
-
|
1370
|
-
|
1481
|
+
152
|
1482
|
+
153
|
1483
|
+
154
|
1484
|
+
155
|
1485
|
+
156
|
1486
|
+
157</pre>
|
1371
1487
|
</td>
|
1372
1488
|
<td>
|
1373
|
-
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line
|
1489
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line 152</span>
|
1374
1490
|
|
1375
1491
|
<span class='kw'>def</span> <span class='id identifier rubyid_link'>link</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_text'>text</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
|
1376
1492
|
<span class='id identifier rubyid_node'>node</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="LinkNode.html" title="RRTF::LinkNode (class)">LinkNode</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="LinkNode.html#initialize-instance_method" title="RRTF::LinkNode#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
|
@@ -1440,14 +1556,14 @@ the <code>ListLevelNode</code> doc for more information.</p>
|
|
1440
1556
|
<pre class="lines">
|
1441
1557
|
|
1442
1558
|
|
1443
|
-
|
1444
|
-
|
1445
|
-
|
1446
|
-
|
1447
|
-
|
1559
|
+
146
|
1560
|
+
147
|
1561
|
+
148
|
1562
|
+
149
|
1563
|
+
150</pre>
|
1448
1564
|
</td>
|
1449
1565
|
<td>
|
1450
|
-
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line
|
1566
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line 146</span>
|
1451
1567
|
|
1452
1568
|
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='id identifier rubyid_kind'>kind</span><span class='op'>=</span><span class='symbol'>:bullets</span><span class='rparen'>)</span>
|
1453
1569
|
<span class='id identifier rubyid_node'>node</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="ListNode.html" title="RRTF::ListNode (class)">ListNode</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ListNode.html#initialize-instance_method" title="RRTF::ListNode#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
|
@@ -1559,32 +1675,32 @@ style).</p>
|
|
1559
1675
|
<pre class="lines">
|
1560
1676
|
|
1561
1677
|
|
1562
|
-
87
|
1563
|
-
88
|
1564
|
-
89
|
1565
|
-
90
|
1566
|
-
91
|
1567
|
-
92
|
1568
|
-
93
|
1569
|
-
94
|
1570
|
-
95
|
1571
|
-
96
|
1572
|
-
97
|
1573
|
-
98
|
1574
|
-
99
|
1575
|
-
100
|
1576
|
-
101
|
1577
|
-
102
|
1578
|
-
103
|
1579
|
-
104
|
1580
1678
|
105
|
1581
1679
|
106
|
1582
|
-
107
|
1680
|
+
107
|
1681
|
+
108
|
1682
|
+
109
|
1683
|
+
110
|
1684
|
+
111
|
1685
|
+
112
|
1686
|
+
113
|
1687
|
+
114
|
1688
|
+
115
|
1689
|
+
116
|
1690
|
+
117
|
1691
|
+
118
|
1692
|
+
119
|
1693
|
+
120
|
1694
|
+
121
|
1695
|
+
122
|
1696
|
+
123
|
1697
|
+
124
|
1698
|
+
125</pre>
|
1583
1699
|
</td>
|
1584
1700
|
<td>
|
1585
|
-
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line
|
1701
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line 105</span>
|
1586
1702
|
|
1587
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_paragraph'>paragraph</span><span class='lparen'>(</span><span class='id identifier rubyid_style'>style</span
|
1703
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_paragraph'>paragraph</span><span class='lparen'>(</span><span class='id identifier rubyid_style'>style</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1588
1704
|
<span class='comment'># parse style
|
1589
1705
|
</span> <span class='kw'>case</span> <span class='id identifier rubyid_style'>style</span>
|
1590
1706
|
<span class='kw'>when</span> <span class='const'>Hash</span>
|
@@ -1601,9 +1717,133 @@ style).</p>
|
|
1601
1717
|
</span> <span class='id identifier rubyid_style'>style</span><span class='period'>.</span><span class='id identifier rubyid_push_colours'>push_colours</span><span class='lparen'>(</span><span class='id identifier rubyid_root'><span class='object_link'><a href="../top-level-namespace.html" title="Top Level Namespace (root)">root</a></span></span><span class='period'>.</span><span class='id identifier rubyid_colours'>colours</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_style'>style</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
1602
1718
|
<span class='id identifier rubyid_style'>style</span><span class='period'>.</span><span class='id identifier rubyid_push_fonts'>push_fonts</span><span class='lparen'>(</span><span class='id identifier rubyid_root'><span class='object_link'><a href="../top-level-namespace.html" title="Top Level Namespace (root)">root</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fonts'>fonts</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_style'>style</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
1603
1719
|
|
1604
|
-
|
1605
|
-
|
1606
|
-
|
1720
|
+
<span class='id identifier rubyid_node'>node</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="ParagraphNode.html" title="RRTF::ParagraphNode (class)">ParagraphNode</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ParagraphNode.html#initialize-instance_method" title="RRTF::ParagraphNode#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_style'>style</span><span class='rparen'>)</span>
|
1721
|
+
<span class='kw'>yield</span> <span class='id identifier rubyid_node'>node</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
|
1722
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_store'>store</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span>
|
1723
|
+
<span class='kw'>end</span></pre>
|
1724
|
+
</td>
|
1725
|
+
</tr>
|
1726
|
+
</table>
|
1727
|
+
</div>
|
1728
|
+
|
1729
|
+
<div class="method_details ">
|
1730
|
+
<h3 class="signature " id="section-instance_method">
|
1731
|
+
|
1732
|
+
#<strong>section</strong>(style = nil) {|node| ... } ⇒ <tt>Object</tt>
|
1733
|
+
|
1734
|
+
|
1735
|
+
|
1736
|
+
|
1737
|
+
|
1738
|
+
</h3><div class="docstring">
|
1739
|
+
<div class="discussion">
|
1740
|
+
|
1741
|
+
|
1742
|
+
</div>
|
1743
|
+
</div>
|
1744
|
+
<div class="tags">
|
1745
|
+
|
1746
|
+
<p class="tag_title">Yields:</p>
|
1747
|
+
<ul class="yield">
|
1748
|
+
|
1749
|
+
<li>
|
1750
|
+
|
1751
|
+
|
1752
|
+
<span class='type'>(<tt>node</tt>)</span>
|
1753
|
+
|
1754
|
+
|
1755
|
+
|
1756
|
+
</li>
|
1757
|
+
|
1758
|
+
</ul>
|
1759
|
+
|
1760
|
+
</div><table class="source_code">
|
1761
|
+
<tr>
|
1762
|
+
<td>
|
1763
|
+
<pre class="lines">
|
1764
|
+
|
1765
|
+
|
1766
|
+
71
|
1767
|
+
72
|
1768
|
+
73
|
1769
|
+
74
|
1770
|
+
75
|
1771
|
+
76
|
1772
|
+
77
|
1773
|
+
78
|
1774
|
+
79
|
1775
|
+
80
|
1776
|
+
81
|
1777
|
+
82
|
1778
|
+
83
|
1779
|
+
84
|
1780
|
+
85
|
1781
|
+
86
|
1782
|
+
87</pre>
|
1783
|
+
</td>
|
1784
|
+
<td>
|
1785
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line 71</span>
|
1786
|
+
|
1787
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_section'>section</span><span class='lparen'>(</span><span class='id identifier rubyid_style'>style</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1788
|
+
<span class='comment'># parse style
|
1789
|
+
</span> <span class='kw'>case</span> <span class='id identifier rubyid_style'>style</span>
|
1790
|
+
<span class='kw'>when</span> <span class='const'>Hash</span>
|
1791
|
+
<span class='id identifier rubyid_style'>style</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="SectionStyle.html" title="RRTF::SectionStyle (class)">SectionStyle</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="SectionStyle.html#initialize-instance_method" title="RRTF::SectionStyle#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_style'>style</span><span class='rparen'>)</span>
|
1792
|
+
<span class='kw'>when</span> <span class='const'><span class='object_link'><a href="SectionStyle.html" title="RRTF::SectionStyle (class)">SectionStyle</a></span></span>
|
1793
|
+
<span class='comment'># use without modification
|
1794
|
+
</span> <span class='kw'>when</span> <span class='kw'>nil</span>
|
1795
|
+
<span class='comment'># allow nil style
|
1796
|
+
</span> <span class='kw'>else</span>
|
1797
|
+
<span class='const'><span class='object_link'><a href="RTFError.html" title="RRTF::RTFError (class)">RTFError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fire'><span class='object_link'><a href="RTFError.html#fire-class_method" title="RRTF::RTFError.fire (method)">fire</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Invalid section style '</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_style'>style</span><span class='embexpr_end'>}</span><span class='tstring_content'>'.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1798
|
+
<span class='kw'>end</span> <span class='comment'># case
|
1799
|
+
</span>
|
1800
|
+
<span class='id identifier rubyid_node'>node</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="SectionNode.html" title="RRTF::SectionNode (class)">SectionNode</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="SectionNode.html#initialize-instance_method" title="RRTF::SectionNode#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_style'>style</span><span class='rparen'>)</span>
|
1801
|
+
<span class='kw'>yield</span> <span class='id identifier rubyid_node'>node</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
|
1802
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_store'>store</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span>
|
1803
|
+
<span class='kw'>end</span></pre>
|
1804
|
+
</td>
|
1805
|
+
</tr>
|
1806
|
+
</table>
|
1807
|
+
</div>
|
1808
|
+
|
1809
|
+
<div class="method_details ">
|
1810
|
+
<h3 class="signature " id="tab-instance_method">
|
1811
|
+
|
1812
|
+
#<strong>tab</strong> ⇒ <tt>Object</tt>
|
1813
|
+
|
1814
|
+
|
1815
|
+
|
1816
|
+
|
1817
|
+
|
1818
|
+
</h3><div class="docstring">
|
1819
|
+
<div class="discussion">
|
1820
|
+
|
1821
|
+
<p>This method provides a short cut means of creating a tab command node. This
|
1822
|
+
command node does not take a block and may possess no other content.</p>
|
1823
|
+
|
1824
|
+
|
1825
|
+
</div>
|
1826
|
+
</div>
|
1827
|
+
<div class="tags">
|
1828
|
+
|
1829
|
+
|
1830
|
+
</div><table class="source_code">
|
1831
|
+
<tr>
|
1832
|
+
<td>
|
1833
|
+
<pre class="lines">
|
1834
|
+
|
1835
|
+
|
1836
|
+
178
|
1837
|
+
179
|
1838
|
+
180
|
1839
|
+
181</pre>
|
1840
|
+
</td>
|
1841
|
+
<td>
|
1842
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line 178</span>
|
1843
|
+
|
1844
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_tab'>tab</span>
|
1845
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_store'>store</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="" title="RRTF::CommandNode (class)">CommandNode</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RRTF::CommandNode#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>\tab</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
1846
|
+
<span class='kw'>nil</span>
|
1607
1847
|
<span class='kw'>end</span></pre>
|
1608
1848
|
</td>
|
1609
1849
|
</tr>
|
@@ -1663,15 +1903,15 @@ the node the method is called upon after the block is complete.</p>
|
|
1663
1903
|
<pre class="lines">
|
1664
1904
|
|
1665
1905
|
|
1666
|
-
|
1667
|
-
|
1668
|
-
|
1669
|
-
|
1670
|
-
|
1671
|
-
|
1906
|
+
219
|
1907
|
+
220
|
1908
|
+
221
|
1909
|
+
222
|
1910
|
+
223
|
1911
|
+
224</pre>
|
1672
1912
|
</td>
|
1673
1913
|
<td>
|
1674
|
-
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line
|
1914
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node/command_node.rb', line 219</span>
|
1675
1915
|
|
1676
1916
|
<span class='kw'>def</span> <span class='id identifier rubyid_table'>table</span><span class='lparen'>(</span><span class='id identifier rubyid_rows'>rows</span><span class='comma'>,</span> <span class='id identifier rubyid_columns'>columns</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_widths'>widths</span><span class='rparen'>)</span>
|
1677
1917
|
<span class='id identifier rubyid_node'>node</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="TableNode.html" title="RRTF::TableNode (class)">TableNode</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="TableNode.html#initialize-instance_method" title="RRTF::TableNode#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_rows'>rows</span><span class='comma'>,</span> <span class='id identifier rubyid_columns'>columns</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_widths'>widths</span><span class='rparen'>)</span>
|
@@ -1758,7 +1998,7 @@ the node the method is called upon after the block is complete.</p>
|
|
1758
1998
|
</div>
|
1759
1999
|
|
1760
2000
|
<div id="footer">
|
1761
|
-
Generated on
|
2001
|
+
Generated on Wed Aug 2 23:05:18 2017 by
|
1762
2002
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1763
2003
|
0.9.9 (ruby-2.3.3).
|
1764
2004
|
</div>
|