README.md in caracal-1.0.9 vs README.md in caracal-1.0.10
- old
+ new
@@ -676,10 +676,27 @@
cell_style cols[0], width: 6000
end
```
+## Experimental Features
+
+### IFrames
+
+You can include an external Word document into your working Caracal document by specifying a URL or by supplying the data directly.
+
+*It should be noted that the metaphor here is imperfect. Caracal fully includes the external file at the time of insertion. Further changes to the external file will not be reflected in your Caracal output.*
+
+```ruby
+# this example loads the file from the internet
+docx.iframe url: 'http://www.some-website.org/snippet.docx'
+
+# this example loads the data directly
+docx.iframe data: File.read('my/path/to/snippet.docx')
+
+```
+
## Template Rendering
Caracal includes [Tilt](https://github.com/rtomayko/tilt) integration to facilitate its inclusion in other frameworks.
Rails integration can be added via the [Caracal-Rails](https://github.com/trade-informatics/caracal-rails) gem.
@@ -688,15 +705,17 @@
## Filing an Issue
Caracal was written for and tested against Word 2010, 2013, and Office365. It should also open in LibreOffice
with high fidelity.
+
### Older Versions
If you are using a version of Word that predates 2010, Caracal may or may not work for you. (Probably it won't.)
We don't ever plan to support versions before 2010, but if you choose to embark on that endeavor, we'd be
happy to answer questions and provide what guidance we can. We just won't write any code in that direction.
+
### Newer Versions
For those using reasonably current versions of Word, please consider the following:
- Before you file an issue, please run the example Caracal project [caracal-example](https://github.com/trade-informatics/caracal-example) in your development environment and
@@ -706,9 +725,10 @@
- If you don't see your issue in the example project's implementation of the same feature, chances are you
made a mistake in your document's syntax or have an environment-specific, non-caracal problem.
- If you do see the same behavior in the example project, you've probably uncovered a variance in the way
your particular permutation of Windows/Word interprets the OOXML.
+
### How to Work on a Problem
Caracal is essentially an exercise in reverse engineering OOXML output. When developing features, we
typically start by building the simplest Word document we can that includes the desired behavior.