summaryrefslogtreecommitdiffhomepage
path: root/examples/shared_strings_example.md
diff options
context:
space:
mode:
authorZsolt Kozaroczy <[email protected]>2020-09-11 00:36:29 +0200
committerGitHub <[email protected]>2020-09-11 00:36:29 +0200
commit282eec44ef01746ee25931fa6cd287ad083fd40b (patch)
tree14504bf429ca264812679ca971c1592853d3f762 /examples/shared_strings_example.md
parent317e8244e4d17c394c1e181f86df3974623fb865 (diff)
downloadcaxlsx-282eec44ef01746ee25931fa6cd287ad083fd40b.tar.gz
caxlsx-282eec44ef01746ee25931fa6cd287ad083fd40b.zip
Restructure examples folder (#47)
Split examples into separate markdown files, each containing a description, sample code, and a screenshot of the resulting xlsx document. The script `generate.rb` is provided to actually generate the example documents by executing the sample code contained in the markdown files.
Diffstat (limited to 'examples/shared_strings_example.md')
-rw-r--r--examples/shared_strings_example.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/examples/shared_strings_example.md b/examples/shared_strings_example.md
new file mode 100644
index 00000000..cb6d811d
--- /dev/null
+++ b/examples/shared_strings_example.md
@@ -0,0 +1,24 @@
+## Description
+
+To work with Apple Numbers, you must set `use_shared_strings` to true. This is most conveniently done just before rendering by calling `p.use_shared_strings = true` prior to serialization.
+
+## Code
+
+```ruby
+require 'axlsx'
+
+p = Axlsx::Package.new
+wb = p.workbook
+
+wb.add_worksheet(name: 'Basic Worksheet') do |sheet|
+ sheet.add_row ['First', 'Second', 'Third']
+ sheet.add_row [1, 2, 3]
+end
+
+p.use_shared_strings = true
+p.serialize 'shared_strings_example.xlsx'
+```
+
+## Output
+
+No difference should be visible