From 282eec44ef01746ee25931fa6cd287ad083fd40b Mon Sep 17 00:00:00 2001 From: Zsolt Kozaroczy Date: Fri, 11 Sep 2020 00:36:29 +0200 Subject: 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. --- examples/comments_example.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 examples/comments_example.md (limited to 'examples/comments_example.md') diff --git a/examples/comments_example.md b/examples/comments_example.md new file mode 100644 index 00000000..3aa2e877 --- /dev/null +++ b/examples/comments_example.md @@ -0,0 +1,28 @@ +## Description + +You could add comments (visible or hidden) to the cells. + +## Code + +```ruby +require 'axlsx' + +p = Axlsx::Package.new +wb = p.workbook + +wb.add_worksheet(name: 'Comments') do |sheet| + sheet.add_row ['Can we build it?'] + sheet.add_comment ref: 'A1', author: 'Bob', text: 'Yes We Can!' + sheet.add_comment ref: 'A2', author: 'Bob', text: 'Yes We Can! - but I dont think you need to know about it!', visible: false +end + +p.serialize 'comments_example.xlsx' +``` + +## Output + +![Output](images/comments_example_1.png "Output") + +After hovering on the hidden comment: + +![Output](images/comments_example_2.png "Output") -- cgit v1.2.3